g_docformatter.cli

Module for the command line interface.

class g_docformatter.cli.ContainerGroup(name: str | None = None, commands: MutableMapping[str, Command] | Sequence[Command] | None = None, invoke_without_command: bool = False, no_args_is_help: bool | None = None, subcommand_metavar: str | None = None, chain: bool = False, result_callback: Callable[[...], Any] | None = None, **kwargs: Any)

Bases: Group

A Click command group that bootstraps the DI container.

invoke(ctx: Context) → Any

Given a context, this invokes the attached callback (if it exists) in the right way.

class g_docformatter.cli.FormatterSettingsInjectionCommand(name: str | None, context_settings: MutableMapping[str, Any] | None = None, callback: Callable[[...], Any] | None = None, params: list[Parameter] | None = None, help: str | None = None, epilog: str | None = None, short_help: str | None = None, options_metavar: str | None = '[OPTIONS]', add_help_option: bool = True, no_args_is_help: bool = False, hidden: bool = False, deprecated: bool | str = False)

Bases: Command

A Click command that injects format settings into the DI container.

invoke(ctx: Context) → Any

Given a context, this invokes the attached callback (if it exists) in the right way.