cli — CLI

This module is intended to provide common utilities for command-line interface, ensuring consistency across different applications and allowing for the automation of common operations, such as the logging configuration.

Module documentation

Command-line arguments.

class astropix_analysis.cli._Formatter(prog, indent_increment=2, max_help_position=24, width=None)

Do nothing class combining our favorite formatting for the command-line options, i.e., the newlines in the descriptions are preserved and, at the same time, the argument defaults are printed out when the –help options is passed.

The inspiration for this is coming from one of the comments in https://stackoverflow.com/questions/3853722

class astropix_analysis.cli.ArgumentParser(description: str, epilog: str = None)

Application-wide argument parser.

static _expand_wildcards(file_list: list) → list

Expand the wildcards in a given list of file paths.

This is intended to emulate the bash shell expansion under Windows when the infiles command-line argument is passed.

See AstroPix/astropix-analysis#16

parse_args(args: list = None, namespace: Namespace = None) → Namespace

Overloaded method.

This is calling the method from the base class and, before returning the arguments, resets the logger with the proper level—so that this operation happens transparently for the user with no boilerplate code.

add_infile() → None

Add the infile argument.

add_infiles() → None

Add the infiles argument.

add_loglevel() → None

Add the loglevel argument.

add_multicast() → None

Add all the relevant multicast options.

add_refresh(default: float) → None

Add the refresh argument (interval in s).

add_start() → None

Add the start argument.