rechu.command.new package

Submodules

rechu.command.new.input module

Input source for new subcommand.

class rechu.command.new.input.InputSource

Bases: object

Abstract base class for a typed input source.

get_completion(text: str, state: int) → str | None

Retrieve a completion option for the current suggestions and text state. The text is a partial input that matches some part of the suggestions and state indicates the position of the suggestion in the sorted list of matching suggestions to choose.

If there is no match found or if the input source does not support completion suggestions, then None is returned.

get_date(default: datetime | None = None) → datetime

Retrieve a date input. The default may be used as a fallback if nothing is input or if a partial timestamp is provided.

get_input(name: str, input_type: type[InputT], options: str | None = None, default: InputT | None = None) → InputT

Retrieve an input cast to a certain type (string, integer or float). Optionally, the input source provides suggestions from a predefined completion source defined by the options name and may fall back to a default if nothing is input.

get_output() → TextIO

Retrieve an output stream to write content to.

update_suggestions(suggestions: dict[str, list[str]]) → None

Include additional suggestion completion sources.

class rechu.command.new.input.Prompt

Bases: InputSource

Standard input prompt.

display_matches(substitution: str, matches: Sequence[str], longest_match_length: int) → None

Write a display of matches to the standard output compatible with readline buffers.

get_completion(text: str, state: int) → str | None

Retrieve a completion option for the current suggestions and text state. The text is a partial input that matches some part of the suggestions and state indicates the position of the suggestion in the sorted list of matching suggestions to choose.

If there is no match found or if the input source does not support completion suggestions, then None is returned.

get_date(default: datetime | None = None) → datetime

Retrieve a date input. The default may be used as a fallback if nothing is input or if a partial timestamp is provided.

get_input(name: str, input_type: type[InputT], options: str | None = None, default: InputT | None = None) → InputT

Retrieve an input cast to a certain type (string, integer or float).

get_output() → TextIO

Retrieve an output stream to write content to.

register_readline() → None

Register completion method to the readline module.

update_suggestions(suggestions: dict[str, list[str]]) → None

Include additional suggestion completion sources.

rechu.command.new.step module

Steps for creating a receipt in new subcommand.

class rechu.command.new.step.Discounts(receipt: Receipt, input_source: InputSource, matcher: ProductMatcher)

Bases: Step

Step to add discounts.

add_discount() → bool

Request fields and items for a discount and add it to the receipt.

add_discount_item(discount: Discount, seen: int) → int

Request fields for a discount item.

property description: str

Usage message that explains what the step does.

run() → ResultMeta

Perform the step. Returns whether there is additional metadata which needs to be updated outside of the step.

class rechu.command.new.step.Edit(receipt: Receipt, input_source: InputSource, editor: str | None = None)

Bases: Step

Step to edit the receipt in its YAML representation via a temporary file.

property description: str

Usage message that explains what the step does.

run() → ResultMeta

Perform the step. Returns whether there is additional metadata which needs to be updated outside of the step.

class rechu.command.new.step.Help(receipt: Receipt, input_source: InputSource)

Bases: Step

Step to display help for steps that are usable from the menu.

property description: str

Usage message that explains what the step does.

run() → ResultMeta

Perform the step. Returns whether there is additional metadata which needs to be updated outside of the step.

class rechu.command.new.step.ProductMeta(receipt: Receipt, input_source: InputSource, matcher: ProductMatcher, products: set[Product])

Bases: Step

Step to add product metadata that matches one or more products.

MATCHERS: dict[str, _Matcher] = {'discount': {'key': 'label', 'model': <class 'rechu.models.product.DiscountMatch'>, 'options': 'discounts'}, 'label': {'key': 'name', 'model': <class 'rechu.models.product.LabelMatch'>, 'options': 'products'}, 'price': {'extra_key': 'indicator', 'input_type': <class 'rechu.types.quantized.Price'>, 'key': 'value', 'model': <class 'rechu.models.product.PriceMatch'>, 'options': 'prices'}}

add_product(item: ProductItem | None = None, initial_key: str | None = None, matched_items: set[ProductItem] | None = None) → tuple[bool, str | None]

Request fields for a product’s metadata and add it to the database as well as a products YAML file. item is an optional product item from the receipt to specifically match the metadata for. initial_key is a metadata key to use for the first prompt. Returns whether to no longer attempt to create product metadata and the current prompt answer.

property description: str

Usage message that explains what the step does.

run() → ResultMeta

Perform the step. Returns whether there is additional metadata which needs to be updated outside of the step.

class rechu.command.new.step.Products(receipt: Receipt, input_source: InputSource, matcher: ProductMatcher, products: set[Product])

Bases: Step

Step to add products.

add_product() → bool

Request fields for a product and add it to the receipt.

property description: str

Usage message that explains what the step does.

run() → ResultMeta

Perform the step. Returns whether there is additional metadata which needs to be updated outside of the step.

class rechu.command.new.step.Quit(receipt: Receipt, input_source: InputSource)

Bases: Step

Step to exit the receipt creation menu.

property description: str

Usage message that explains what the step does.

property final: bool

Whether this step finalizes the receipt generation.

run() → ResultMeta

Perform the step. Returns whether there is additional metadata which needs to be updated outside of the step.

class rechu.command.new.step.Read(receipt: Receipt, input_source: InputSource, matcher: ProductMatcher)

Bases: Step

Step to check if there are any new or updated product metadata entries in the file inventory that should be synchronized with the database inventory before creating and matching receipt products.

property description: str

Usage message that explains what the step does.

run() → ResultMeta

Perform the step. Returns whether there is additional metadata which needs to be updated outside of the step.

class rechu.command.new.step.ResultMeta

Bases: TypedDict

Result of a step being run, indicator additional metadata to update.

• ‘receipt_path’: Boolean indicating pdate the path of the receipt based on receipt metadata.

receipt_path: bool

exception rechu.command.new.step.ReturnToMenu(msg: str = '')

Bases: RuntimeError

Indication that the step is interrupted to return to a menu.

class rechu.command.new.step.Step(receipt: Receipt, input_source: InputSource)

Bases: object

Abstract base class for a step during receipt creation.

property description: str

Usage message that explains what the step does.

property final: bool

Whether this step finalizes the receipt generation.

run() → ResultMeta

Perform the step. Returns whether there is additional metadata which needs to be updated outside of the step.

class rechu.command.new.step.View(receipt: Receipt, input_source: InputSource, products: set[Product] | None = None)

Bases: Step

Step to display the receipt in its YAML representation.

property description: str

Usage message that explains what the step does.

run() → ResultMeta

Perform the step. Returns whether there is additional metadata which needs to be updated outside of the step.

class rechu.command.new.step.Write(receipt: Receipt, input_source: InputSource, matcher: ProductMatcher, products: set[Product] | None = None)

Bases: Step

Final step to write the receipt to a YAML file and store in the database.

property description: str

Usage message that explains what the step does.

property final: bool

Whether this step finalizes the receipt generation.

run() → ResultMeta

Perform the step. Returns whether there is additional metadata which needs to be updated outside of the step.

Module contents

Subcommand to create a new receipt YAML file and import it.

class rechu.command.new.New

Bases: Base

Create a YAML file for a receipt and import it to the database.

run() → None

Execute the command.

subcommand: str = 'new'

subparser_arguments: SubparserArguments = [(('-c', '--confirm'), {'action': 'store_true', 'default': False, 'help': 'Confirm before updating database files or exiting'})]

subparser_keywords: SubparserKeywords = {'description': 'Interactively fill in a YAML file for a receipt and import it to the database.', 'help': 'Create receipt file and import'}