basecmd

Logging boilerplate for the command line.

Classes inheriting from BaseCmd get a self.log attribute — a standard Python logging.Logger — pre-configured to sys.stdout with color support when logging to a terminal.

Quick start

from basecmd import BaseCmd


class MyCmd(BaseCmd):
    "Demo command"

    def add_arguments(self):
        self.parser.add_argument("--foo", help="Custom option")

    def __call__(self):
        self.log.debug("options: %s", self.options)


if __name__ == "__main__":
    cmd = MyCmd()
    cmd()

Run with -h / --help to see the built-in logging options:

usage: __main__.py [-h] [-v {error,warning,info,debug}] [--log-file LOG_FILE]
                   [--foo FOO]

CLI options

BaseCmd registers two logging options on the parser; subclasses add their own via add_arguments:

After parsing, self.options holds the parsed arguments and self.parser the ArgumentParser used to build them.

Configuration

Defaults can be set via environment variables or a .env file. These are read once when the module is imported, so set them before importing BaseCmd: