cli

Module that contains the command line application.

Functions:

• get_parser –

  Return the CLI argument parser.

• main –

  Run the main program.

get_parser

get_parser() -> ArgumentParser

Return the CLI argument parser.

Returns:

• ArgumentParser –

  An argparse parser.

Source code in src/unibox/cli.py

def get_parser() -> argparse.ArgumentParser:
    """Return the CLI argument parser.

    Returns:
        An argparse parser.
    """
    parser = argparse.ArgumentParser(prog="unibox")
    parser.add_argument("-V", "--version", action="version", version=f"%(prog)s {debug.get_version()}")
    parser.add_argument("--debug-info", action=_DebugInfo, help="Print debug information.")
    return parser

main

main(args: list[str] | None = None) -> int

Run the main program.

This function is executed when you type unibox or python -m unibox.

Parameters:

• args (list[str] | None, default: None ) –

  Arguments passed from the command line.

Returns:

• int –

  An exit code.

Source code in src/unibox/cli.py

def main(args: list[str] | None = None) -> int:
    """Run the main program.

    This function is executed when you type `unibox` or `python -m unibox`.

    Parameters:
        args: Arguments passed from the command line.

    Returns:
        An exit code.
    """
    parser = get_parser()
    opts = parser.parse_args(args=args)
    print(opts)
    return 0

Feedback