rattail.commands.typer

Typer-based command utilities

class rattail.commands.typer.OrderCommands(*, name: str | None = None, commands: dict[str, Command] | Sequence[Command] | None = None, rich_markup_mode: Literal['markdown', 'rich', None] = 'rich', rich_help_panel: str | None = None, suggest_commands: bool = True, **attrs: Any)

Custom base class for top-level Typer command.

This exists only to ensure the commands listing is sorted when displayed with --help param, since Typer “by design” will not sort them.

See also this Typer doc.

rattail.commands.typer.file_exporter_command(fn)

Decorator for file export commands. Adds common params based on file_exporter_command_template().

rattail.commands.typer.file_exporter_command_template(output_dir: Path, <typer.models.OptionInfo object at 0x7f60cc4c4990>]=Ellipsis)

Stub function to provide signature for exporter commands which produce data file(s) as output. Used with file_exporter_command().

rattail.commands.typer.file_importer_command(fn)

Decorator for file import commands. Adds common params based on file_importer_command_template().

rattail.commands.typer.file_importer_command_template(input_dir: Path, <typer.models.OptionInfo object at 0x7f60cc4c4a50>]=Ellipsis)

Stub function to provide signature for importer commands which require data file(s) as input. Used with file_importer_command().

rattail.commands.typer.importer_command(fn)

Decorator for import/export commands. Adds common params based on importer_command_template().

rattail.commands.typer.importer_command_template(models: List[str] | None, <typer.models.ArgumentInfo object at 0x7f60cc4b3890>]=None, list_all_models: Annotated[bool, <typer.models.OptionInfo object at 0x7f60cd574850>]=False, list_default_models: Annotated[bool, <typer.models.OptionInfo object at 0x7f60cc4b38d0>]=False, make_batches: Annotated[bool, <typer.models.OptionInfo object at 0x7f60cc4b3990>]=False, key: Annotated[str, <typer.models.OptionInfo object at 0x7f60cc4b3a50>]=None, fields: Annotated[str, <typer.models.OptionInfo object at 0x7f60cc4b3b10>]=None, exclude_fields: Annotated[str, <typer.models.OptionInfo object at 0x7f60cc4b3bd0>]=None, fuzzy_fields: Annotated[str, <typer.models.OptionInfo object at 0x7f60cc4b3c90>]=None, fuzz_factor: Annotated[int, <typer.models.OptionInfo object at 0x7f60cc4b3d50>]=1, create: Annotated[bool, <typer.models.OptionInfo object at 0x7f60cc4b3e10>]=True, max_create: Annotated[int, <typer.models.OptionInfo object at 0x7f60cc4b3ed0>]=None, update: Annotated[bool, <typer.models.OptionInfo object at 0x7f60cc4b3f90>]=True, max_update: Annotated[int, <typer.models.OptionInfo object at 0x7f60cc4c4090>]=None, delete: Annotated[bool, <typer.models.OptionInfo object at 0x7f60cc4c4150>]=False, max_delete: Annotated[int, <typer.models.OptionInfo object at 0x7f60cc4c4210>]=None, max_total: Annotated[int, <typer.models.OptionInfo object at 0x7f60cc4c42d0>]=None, start_date: datetime, <typer.models.OptionInfo object at 0x7f60cc4c4390>]=None, end_date: datetime, <typer.models.OptionInfo object at 0x7f60cc4c4450>]=None, year: Annotated[int, <typer.models.OptionInfo object at 0x7f60cc4c4510>]=None, batch_size: Annotated[int, <typer.models.OptionInfo object at 0x7f60cc4c45d0>]=200, collect_changes: Annotated[bool, <typer.models.OptionInfo object at 0x7f60cc4c4690>]=True, warnings: Annotated[bool, <typer.models.OptionInfo object at 0x7f60cc4c4750>]=False, max_diffs: Annotated[int, <typer.models.OptionInfo object at 0x7f60cc4c4810>]=None, dry_run: Annotated[bool, <typer.models.OptionInfo object at 0x7f60cc4c48d0>]=False)

Stub function which provides a common param signature; used with importer_command().

rattail.commands.typer.make_cli_config(ctx)

Make a config object according to the command-line context (params).

Parameters:

ctx – typer.Context instance

Returns:

RattailConfig instance

rattail.commands.typer.make_typer(**kwargs)

Create a Typer command instance, per Rattail conventions.

This function is used to create the top-level rattail command, rattail_typer. You can use it to create additional top-level commands for your app, as needed.

Returns:

typer.Typer instance

rattail.commands.typer.typer_callback(ctx: Context, config_paths: Path] | None, <typer.models.OptionInfo object at 0x7f60cc4b28d0>]=None, plus_config_paths: Path] | None, <typer.models.OptionInfo object at 0x7f60cc4b2910>]=None, progress: Annotated[bool, <typer.models.OptionInfo object at 0x7f60cc4b29d0>]=False, no_init: Annotated[bool, <typer.models.OptionInfo object at 0x7f60cc4b2ad0>]=False, no_extend_config: Annotated[bool, <typer.models.OptionInfo object at 0x7f60cc4b2c10>]=False, verbose: Annotated[bool, <typer.models.OptionInfo object at 0x7f60cc4b2d90>]=False, progress_socket: Annotated[str, <typer.models.OptionInfo object at 0x7f60cc4b2f10>]=None, runas_username: Annotated[str, <typer.models.OptionInfo object at 0x7f60cc4b3090>]=None, versioning: Annotated[bool, <typer.models.OptionInfo object at 0x7f60cc4b3210>]=False, no_versioning: Annotated[bool, <typer.models.OptionInfo object at 0x7f60cc4b3390>]=False)

Generic callback for use with top-level commands.

rattail.commands.typer.typer_eager_imports(group: [<class 'typer.main.Typer'>, <class 'str'>])

Eagerly import all modules which are registered as having subcommands belonging to the given group.

This is used to locate subcommands which may be defined by multiple different packages. It is mostly needed for the main rattail command, since e.g. various POS integration packages may define additional subcommands for it.

Most custom apps will define their own top-level command and some subcommands, but will have no need to “discover” additional subcommands defined elsewhere. Hence you normally would not need to call this function.

However if you wish to define a rattail subcommand(s), you would need to register the entry point for your module(s) containing the subcommand(s) like so (in pyproject.toml):

[project.entry-points."rattail.typer_imports"]
poser = "poser.commands"

Note that rattail.typer_imports indicates you are registering a module which defines rattail subcommands. The poser name is arbitrary but should match your package name.

Parameters:

group – Typer group command, or the name of one.

rattail.commands.typer.typer_get_runas_user(ctx, session=None)

Convenience function to get the “runas” User object for the current command.

Uses rattail.app.AppHandler.get_runas_user() under the hood, but the --runas command line param provides the default username.