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, **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: ~pathlib.Annotated[~pathlib.Path, <typer.models.OptionInfo object at 0x7fd2a0477290>] = 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: ~pathlib.Annotated[~pathlib.Path, <typer.models.OptionInfo object at 0x7fd2a0476f50>] = 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: ~typing.Annotated[~typing.List[str] | None, <typer.models.ArgumentInfo object at 0x7fd2a0285dd0>] = None, list_all_models: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fd2a0285c50>] = False, list_default_models: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fd2a0285a90>] = False, make_batches: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fd2a0285910>] = False, key: ~typing.Annotated[str, <typer.models.OptionInfo object at 0x7fd2a0285790>] = None, fields: ~typing.Annotated[str, <typer.models.OptionInfo object at 0x7fd2a0285650>] = None, exclude_fields: ~typing.Annotated[str, <typer.models.OptionInfo object at 0x7fd2a0284c50>] = None, fuzzy_fields: ~typing.Annotated[str, <typer.models.OptionInfo object at 0x7fd2a0284d10>] = None, fuzz_factor: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7fd2a0284ad0>] = 1, create: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fd2a02848d0>] = True, max_create: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7fd2a0284750>] = None, update: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fd2a027f0d0>] = True, max_update: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7fd2a027c6d0>] = None, delete: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fd2a027c310>] = False, max_delete: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7fd2a027f090>] = None, max_total: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7fd2a027f310>] = None, start_date: ~datetime.Annotated[~datetime.datetime, <typer.models.OptionInfo object at 0x7fd2a0224890>] = None, end_date: ~datetime.Annotated[~datetime.datetime, <typer.models.OptionInfo object at 0x7fd2a02249d0>] = None, year: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7fd2a0224710>] = None, batch_size: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7fd2a0224450>] = 200, collect_changes: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fd2a0224210>] = True, warnings: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fd2a0224090>] = False, max_diffs: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7fd2a0477a10>] = None, dry_run: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fd2a04776d0>] = 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: ~typer.models.Context, config_paths: ~typing.Annotated[~typing.List[~pathlib.Path] | None, <typer.models.OptionInfo object at 0x7fd2a0285190>] = None, plus_config_paths: ~typing.Annotated[~typing.List[~pathlib.Path] | None, <typer.models.OptionInfo object at 0x7fd2a0285150>] = None, progress: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fd2a0285090>] = False, no_init: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fd2a0286710>] = False, no_extend_config: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fd2a02866d0>] = False, verbose: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fd2a0285d10>] = False, progress_socket: ~typing.Annotated[str, <typer.models.OptionInfo object at 0x7fd2a02862d0>] = None, runas_username: ~typing.Annotated[str, <typer.models.OptionInfo object at 0x7fd2a0286250>] = None, versioning: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fd2a0285cd0>] = False, no_versioning: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fd2a0285f90>] = 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.