rechu.command.new.step package

Submodules

rechu.command.new.step.base module

Base classes and types for new subcommand steps.

class rechu.command.new.step.base.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.base.ReturnToMenu(msg: str = '')

Bases: RuntimeError

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

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

Bases: object

Abstract base class for a step during receipt creation.

abstract property description: str

Usage message that explains what the step does.

property final: bool

Whether this step finalizes the receipt generation.

input: InputSource

receipt: Receipt

abstractmethod run() → ResultMeta

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

rechu.command.new.step.discounts module

Discounts step of new subcommand.

class rechu.command.new.step.discounts.Discounts(receipt: Receipt, input: InputSource, matcher: ProductMatcher, more: bool = False)

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.

matcher: ProductMatcher

more: bool = False

run() → ResultMeta

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

rechu.command.new.step.edit module

Edit step of new subcommand.

class rechu.command.new.step.edit.Edit(receipt: Receipt, input: InputSource, matcher: ProductMatcher, 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.

editor: str | None = None

execute_editor(filename: str) → None

Open an editor to edit the provided filename.

matcher: ProductMatcher

run() → ResultMeta

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

rechu.command.new.step.help module

Help step of new subcommand.

class rechu.command.new.step.help.Help(receipt: ~rechu.models.receipt.Receipt, input: ~rechu.command.new.input.InputSource, menu: dict[str, ~rechu.command.new.step.base.Step] = <factory>)

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.

menu: dict[str, Step]

run() → ResultMeta

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

rechu.command.new.step.meta module

Meta step of new subcommand.

class rechu.command.new.step.meta.ProductMeta(receipt: ~rechu.models.receipt.Receipt, input: ~rechu.command.new.input.InputSource, matcher: ~rechu.matcher.product.ProductMatcher, more: bool = False, products: set[~rechu.models.product.Product] = <factory>, _suggestions_loaded: bool = False)

Bases: Step

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

add_product(item: ProductItem | None = None, initial_key: str | None = None, matched_items: set[ProductItem] | None = None, product: Product | 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. matched_items is a set of product items on the receipt that already have metadata. product is an existing product to start with, if any. 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.

get_choice(prompt: str, options: Sequence[str] = (), hidden_options: Sequence[str] = (), meta_fields: bool = True) → str

Obtain a key or metadata editing option by prompting a query and retrieving an input, possibly autocompleting the option.

matcher: ProductMatcher

more: bool = False

products: set[Product]

run() → ResultMeta

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

rechu.command.new.step.products module

Products step of new subcommand.

class rechu.command.new.step.products.Products(receipt: Receipt, input: InputSource, matcher: ProductMatcher)

Bases: Step

Step to add products.

add_product(first: bool = False) → bool

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

property description: str

Usage message that explains what the step does.

matcher: ProductMatcher

run() → ResultMeta

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

rechu.command.new.step.quit module

Quit step of new subcommand.

class rechu.command.new.step.quit.Quit(receipt: Receipt, input: 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.

rechu.command.new.step.read module

Read step of new subcommand.

class rechu.command.new.step.read.Read(receipt: Receipt, input: 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.

matcher: ProductMatcher

run() → ResultMeta

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

rechu.command.new.step.view module

View step of new subcommand.

class rechu.command.new.step.view.View(receipt: Receipt, input: 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.

products: set[Product] | None = None

run() → ResultMeta

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

rechu.command.new.step.write module

Write step of new subcommand.

class rechu.command.new.step.write.Write(receipt: Receipt, input: InputSource, matcher: ProductMatcher, _path: Path | 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.

matcher: ProductMatcher

property path: Path

Retrieve the path to which to write the receipt.

run() → ResultMeta

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

Module contents

Steps for creating a receipt in new subcommand.

class rechu.command.new.step.Discounts(receipt: Receipt, input: InputSource, matcher: ProductMatcher, more: bool = False)

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.

input: InputSource

matcher: ProductMatcher

more: bool = False

receipt: Receipt

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: InputSource, matcher: ProductMatcher, 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.

editor: str | None = None

execute_editor(filename: str) → None

Open an editor to edit the provided filename.

input: InputSource

matcher: ProductMatcher

receipt: Receipt

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: ~rechu.models.receipt.Receipt, input: ~rechu.command.new.input.InputSource, menu: dict[str, ~rechu.command.new.step.base.Step] = <factory>)

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.

input: InputSource

menu: dict[str, Step]

receipt: Receipt

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: ~rechu.models.receipt.Receipt, input: ~rechu.command.new.input.InputSource, matcher: ~rechu.matcher.product.ProductMatcher, more: bool = False, products: set[~rechu.models.product.Product] = <factory>, _suggestions_loaded: bool = False)

Bases: Step

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

add_product(item: ProductItem | None = None, initial_key: str | None = None, matched_items: set[ProductItem] | None = None, product: Product | 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. matched_items is a set of product items on the receipt that already have metadata. product is an existing product to start with, if any. 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.

get_choice(prompt: str, options: Sequence[str] = (), hidden_options: Sequence[str] = (), meta_fields: bool = True) → str

Obtain a key or metadata editing option by prompting a query and retrieving an input, possibly autocompleting the option.

input: InputSource

matcher: ProductMatcher

more: bool = False

products: set[Product]

receipt: Receipt

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: InputSource, matcher: ProductMatcher)

Bases: Step

Step to add products.

add_product(first: bool = False) → bool

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

property description: str

Usage message that explains what the step does.

input: InputSource

matcher: ProductMatcher

receipt: Receipt

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: 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: 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.

input: InputSource

matcher: ProductMatcher

receipt: Receipt

run() → ResultMeta

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

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: InputSource)

Bases: object

Abstract base class for a step during receipt creation.

abstract property description: str

Usage message that explains what the step does.

property final: bool

Whether this step finalizes the receipt generation.

input: InputSource

receipt: Receipt

abstractmethod 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: 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.

input: InputSource

products: set[Product] | None = None

receipt: Receipt

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: InputSource, matcher: ProductMatcher, _path: Path | 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.

input: InputSource

matcher: ProductMatcher

property path: Path

Retrieve the path to which to write the receipt.

receipt: Receipt

run() → ResultMeta

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