buildgrid.server.app.cli module

CommandLineInterface

Any files in the commands/ folder with the name cmd_*.py will be attempted to be imported.

class buildgrid.server.app.cli.Context

Bases: object

class buildgrid.server.app.cli.App(name: str | None = None, commands: MutableMapping[str, Command] | Sequence[Command] | None = None, **attrs: Any)

Bases: Group

list_commands(ctx: Any) → list[str]

Lists available command names.

get_command(ctx: Any, cmd_name: str) → Command

Looks-up and loads a particular command by name.

class buildgrid.server.app.cli.DebugFilter(debug_domains: str, name: str = '')

Bases: Filter

filter(record: LogRecord) → bool

Determine if the specified record is to be logged.

Returns True if the record should be logged, or False otherwise. If deemed appropriate, the record may be modified in-place.

class buildgrid.server.app.cli.RequestIdFilter(name='')

Bases: Filter

filter(record: LogRecord) → bool

Determine if the specified record is to be logged.

Returns True if the record should be logged, or False otherwise. If deemed appropriate, the record may be modified in-place.

buildgrid.server.app.cli.setup_logging(verbosity: int = 0, json_logs: bool = False, debug_mode: bool = False) → None

Deals with loggers verbosity