aeat.core._ledger_sort module

Closed sort axes for the aeat app ledger list surface.

The ledger-interface-contract ADR (D5) adds a stable, operator-selectable sort to ledger list. The two axes are declared here in core/ — the innermost hexagonal ring — so the Typer boundary can render the accepted-value Choice([...]) from the enum directly (aeat-architecture-boundaries), production code routes on enum members, and tests assert against members rather than raw strings.

LedgerSortField selects the projection axis and LedgerSortOrder selects the direction. The CLI parser and the ledger projection service both use these enum members rather than raw string tokens, threading them through aeat.entrypoints.cli._ledger_read_cli._register_ledger_list_command(), aeat.entrypoints.cli._ledger_list.project_ledger_list(), and the stable aeat.entrypoints.cli._ledger_list._sort_results() helper.

This module deliberately declares tokens only. It does not project transactions, compare rows, page results, or decide missing-key ordering; those rules stay in the ledger-list projection helpers so the CLI and tests exercise one implementation.

class LedgerSortField(*values)[source]

Bases: StrEnum

The closed set of fields a ledger list result may be sorted by.

date is the effective value date (value_date or booked_date); value_date is the raw value date; amount is the non-negative magnitude; description, lifecycle_state, and classification are the lexical / categorical axes; created_at / modified_at are the D6 persistence-record lifecycle timestamps; classified_at is the active-decision timestamp. A row missing the chosen key (a None timestamp on a row authored before the axis existed) sorts deterministically last under both orders, never crashing the sort.

The value set is consumed as a Typer choice and by aeat.entrypoints.cli._ledger_list._sort_field_value(), so any new member must be added with a projection over Transaction and covered by the real repository sort tests.

Variables:

  • DATE – Effective value date, falling back to booked date.

  • VALUE_DATE – Raw value date from the imported/manual transaction.

  • AMOUNT – Non-negative transaction magnitude.

  • DESCRIPTION – Operator-facing transaction description.

  • CREATED_AT – Persistence-record creation timestamp.

  • MODIFIED_AT – Persistence-record modification timestamp.

  • CLASSIFIED_AT – Timestamp for the active classification decision.

  • LIFECYCLE_STATE – Transaction lifecycle state token.

  • CLASSIFICATION – Business classification token.

DATE
VALUE_DATE
AMOUNT
DESCRIPTION
CREATED_AT
MODIFIED_AT
CLASSIFIED_AT
LIFECYCLE_STATE
CLASSIFICATION
class LedgerSortOrder(*values)[source]

Bases: StrEnum

Ascending or descending order for a ledger list sort.

LedgerSortOrder controls only the primary axis selected by LedgerSortField; the final content-addressed transaction_id tie-break remains ascending in aeat.entrypoints.cli._ledger_list._sort_results().

Variables:

  • ASC – Sort the primary axis ascending.

  • DESC – Sort the primary axis descending.

ASC
DESC