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 0x7fb8d1742ed0>]=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 0x7fb8d1742fd0>]=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 0x7fb8d163cb90>]=None, list_all_models: Annotated[bool, <typer.models.OptionInfo object at 0x7fb8d1c9eb10>]=False, list_default_models: Annotated[bool, <typer.models.OptionInfo object at 0x7fb8d2628490>]=False, make_batches: Annotated[bool, <typer.models.OptionInfo object at 0x7fb8d2633610>]=False, key: Annotated[str, <typer.models.OptionInfo object at 0x7fb8d1aaf850>]=None, fields: Annotated[str, <typer.models.OptionInfo object at 0x7fb8d161cfd0>]=None, exclude_fields: Annotated[str, <typer.models.OptionInfo object at 0x7fb8d161fa50>]=None, fuzzy_fields: Annotated[str, <typer.models.OptionInfo object at 0x7fb8d161f050>]=None, fuzz_factor: Annotated[int, <typer.models.OptionInfo object at 0x7fb8d161f390>]=1, create: Annotated[bool, <typer.models.OptionInfo object at 0x7fb8d1623e50>]=True, max_create: Annotated[int, <typer.models.OptionInfo object at 0x7fb8d1620290>]=None, update: Annotated[bool, <typer.models.OptionInfo object at 0x7fb8d1620210>]=True, max_update: Annotated[int, <typer.models.OptionInfo object at 0x7fb8d1620b90>]=None, delete: Annotated[bool, <typer.models.OptionInfo object at 0x7fb8d1621250>]=False, max_delete: Annotated[int, <typer.models.OptionInfo object at 0x7fb8d163a450>]=None, max_total: Annotated[int, <typer.models.OptionInfo object at 0x7fb8d163a950>]=None, start_date: datetime, <typer.models.OptionInfo object at 0x7fb8d163ab10>]=None, end_date: datetime, <typer.models.OptionInfo object at 0x7fb8d163ad50>]=None, year: Annotated[int, <typer.models.OptionInfo object at 0x7fb8d1740e10>]=None, batch_size: Annotated[int, <typer.models.OptionInfo object at 0x7fb8d17417d0>]=200, collect_changes: Annotated[bool, <typer.models.OptionInfo object at 0x7fb8d1742ad0>]=True, warnings: Annotated[bool, <typer.models.OptionInfo object at 0x7fb8d1742bd0>]=False, max_diffs: Annotated[int, <typer.models.OptionInfo object at 0x7fb8d1742cd0>]=None, dry_run: Annotated[bool, <typer.models.OptionInfo object at 0x7fb8d1742dd0>]=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 0x7fb8d1a37590>]=None, plus_config_paths: Path] | None, <typer.models.OptionInfo object at 0x7fb8d307b290>]=None, progress: Annotated[bool, <typer.models.OptionInfo object at 0x7fb8d1a23e90>]=False, no_init: Annotated[bool, <typer.models.OptionInfo object at 0x7fb8d162f090>]=False, no_extend_config: Annotated[bool, <typer.models.OptionInfo object at 0x7fb8d1601610>]=False, verbose: Annotated[bool, <typer.models.OptionInfo object at 0x7fb8d1602890>]=False, progress_socket: Annotated[str, <typer.models.OptionInfo object at 0x7fb8d160b510>]=None, runas_username: Annotated[str, <typer.models.OptionInfo object at 0x7fb8d160b3d0>]=None, versioning: Annotated[bool, <typer.models.OptionInfo object at 0x7fb8d160b410>]=False, no_versioning: Annotated[bool, <typer.models.OptionInfo object at 0x7fb8d160b790>]=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.