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, invoke_without_command: bool = False, no_args_is_help: bool = False, subcommand_metavar: str | None = None, result_callback: Callable[[...], Any] | None = None, **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 0x7f42157464d0>]=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 0x7f4215746510>]=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 0x7f4215745550>]=None, list_all_models: Annotated[bool, <typer.models.OptionInfo object at 0x7f4216ccdc90>]=False, list_default_models: Annotated[bool, <typer.models.OptionInfo object at 0x7f4216356810>]=False, make_batches: Annotated[bool, <typer.models.OptionInfo object at 0x7f4215745490>]=False, key: Annotated[str, <typer.models.OptionInfo object at 0x7f4215745090>]=None, fields: Annotated[str, <typer.models.OptionInfo object at 0x7f42157451d0>]=None, exclude_fields: Annotated[str, <typer.models.OptionInfo object at 0x7f4215745110>]=None, fuzzy_fields: Annotated[str, <typer.models.OptionInfo object at 0x7f4215745350>]=None, fuzz_factor: Annotated[int, <typer.models.OptionInfo object at 0x7f4215744f90>]=1, create: Annotated[bool, <typer.models.OptionInfo object at 0x7f4215744f50>]=True, max_create: Annotated[int, <typer.models.OptionInfo object at 0x7f4215744dd0>]=None, update: Annotated[bool, <typer.models.OptionInfo object at 0x7f4215745650>]=True, max_update: Annotated[int, <typer.models.OptionInfo object at 0x7f4215747050>]=None, delete: Annotated[bool, <typer.models.OptionInfo object at 0x7f4215745950>]=False, max_delete: Annotated[int, <typer.models.OptionInfo object at 0x7f4215745bd0>]=None, max_total: Annotated[int, <typer.models.OptionInfo object at 0x7f42157459d0>]=None, start_date: datetime, <typer.models.OptionInfo object at 0x7f4215745a90>]=None, end_date: datetime, <typer.models.OptionInfo object at 0x7f4215745a10>]=None, year: Annotated[int, <typer.models.OptionInfo object at 0x7f4215745e50>]=None, batch_size: Annotated[int, <typer.models.OptionInfo object at 0x7f4215745cd0>]=200, collect_changes: Annotated[bool, <typer.models.OptionInfo object at 0x7f42157466d0>]=True, warnings: Annotated[bool, <typer.models.OptionInfo object at 0x7f4215746250>]=False, max_diffs: Annotated[int, <typer.models.OptionInfo object at 0x7f4215746290>]=None, dry_run: Annotated[bool, <typer.models.OptionInfo object at 0x7f4215746190>]=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 0x7f421572bf90>]=None, plus_config_paths: Path] | None, <typer.models.OptionInfo object at 0x7f4215744050>]=None, progress: Annotated[bool, <typer.models.OptionInfo object at 0x7f4215744290>]=False, no_init: Annotated[bool, <typer.models.OptionInfo object at 0x7f4215744090>]=False, no_extend_config: Annotated[bool, <typer.models.OptionInfo object at 0x7f42157441d0>]=False, verbose: Annotated[bool, <typer.models.OptionInfo object at 0x7f4215744450>]=False, progress_socket: Annotated[str, <typer.models.OptionInfo object at 0x7f4215744890>]=None, runas_username: Annotated[str, <typer.models.OptionInfo object at 0x7f4215744810>]=None, versioning: Annotated[bool, <typer.models.OptionInfo object at 0x7f4215744d10>]=False, no_versioning: Annotated[bool, <typer.models.OptionInfo object at 0x7f4215744ad0>]=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.