visitors

Core visitors package for instrument processing.

Modules:

• base –

  Defines the Visitor abstract base class for instrument visitors.

• inspection –

  Inspection visitors for examining instrument and transaction attributes.

• valuation –

  Contain valuation visitor classes for banking and trading books.

Classes:

• InspectionVisitor –

  Base class for inspection visitors. Owns the result dict and shared helpers.

• InstrumentInspectionVisitor –

  Visitor for inspecting instrument attributes.

• TransactionInspectionVisitor –

  Visitor for inspecting transaction details, including related position, instrument, and journal entries.

• Visitor –

  Abstract base class for instrument visitors.

InspectionVisitor

InspectionVisitor()

Base class for inspection visitors. Owns the result dict and shared helpers.

Methods:

• get_result –

  Return the result of the inspection.

get_result

get_result() -> dict[str, Any]

Return the result of the inspection.

InstrumentInspectionVisitor

InstrumentInspectionVisitor()

Bases: InspectionVisitor, Visitor

Visitor for inspecting instrument attributes.

Methods:

• get_result –

  Return the result of the inspection.

• visit_amortizing_fixed_rate_loan –

  Inspect an amortizing fixed rate loan.

• visit_cash –

  Inspect cash.

• visit_common_equity –

  Inspect common equity.

• visit_covered_bond –

  Inspect a covered bond.

• visit_credit_card –

  Inspect a credit card.

• visit_deposit –

  Inspect deposit.

• visit_fixed_rate_bond –

  Inspect a fixed rate bond.

• visit_personal_loan –

  Inspect a personal loan.

• visit_variable_rate_loan –

  Inspect a variable rate loan.

get_result

get_result() -> dict[str, Any]

Return the result of the inspection.

visit_amortizing_fixed_rate_loan

visit_amortizing_fixed_rate_loan(
    instrument: AmortizingFixedRateLoan,
) -> None

Inspect an amortizing fixed rate loan.

visit_cash

visit_cash(instrument: Cash) -> None

Inspect cash.

visit_common_equity

visit_common_equity(instrument: CommonEquity) -> None

Inspect common equity.

visit_covered_bond

visit_covered_bond(instrument: CoveredBond) -> None

Inspect a covered bond.

visit_credit_card

visit_credit_card(instrument: CreditCard) -> None

Inspect a credit card.

visit_deposit

visit_deposit(instrument: Deposit) -> None

Inspect deposit.

visit_fixed_rate_bond

visit_fixed_rate_bond(instrument: FixedRateBond) -> None

Inspect a fixed rate bond.

visit_personal_loan

visit_personal_loan(instrument: PersonalLoan) -> None

Inspect a personal loan.

visit_variable_rate_loan

visit_variable_rate_loan(
    instrument: VariableRateLoan,
) -> None

Inspect a variable rate loan.

TransactionInspectionVisitor

TransactionInspectionVisitor(bank: Bank, journal: Journal)

Bases: InspectionVisitor

Visitor for inspecting transaction details, including related position, instrument, and journal entries.

Methods:

• get_result –

  Return the result of the inspection.

• visit_transaction –

  Inspect a transaction and its related objects.

get_result

get_result() -> dict[str, Any]

Return the result of the inspection.

visit_transaction

visit_transaction(transaction: Transaction) -> None

Inspect a transaction and its related objects.

Visitor

Bases: ABC

Abstract base class for instrument visitors.

Methods:

• visit_amortizing_fixed_rate_loan –

  Visit an amortizing fixed rate loan.

• visit_cash –

  Visit cash.

• visit_common_equity –

  Visit common equity.

• visit_covered_bond –

  Visit a covered bond.

• visit_credit_card –

  Visit a credit card.

• visit_deposit –

  Visit deposit.

• visit_fixed_rate_bond –

  Visit a fixed rate bond.

• visit_personal_loan –

  Visit a personal loan.

• visit_variable_rate_loan –

  Visit a variable rate loan.

visit_amortizing_fixed_rate_loan abstractmethod

visit_amortizing_fixed_rate_loan(
    instrument: AmortizingFixedRateLoan,
) -> None

Visit an amortizing fixed rate loan.

visit_cash abstractmethod

visit_cash(instrument: Cash) -> None

Visit cash.

visit_common_equity abstractmethod

visit_common_equity(instrument: CommonEquity) -> None

Visit common equity.

visit_covered_bond abstractmethod

visit_covered_bond(instrument: CoveredBond) -> None

Visit a covered bond.

visit_credit_card abstractmethod

visit_credit_card(instrument: CreditCard) -> None

Visit a credit card.

visit_deposit abstractmethod

visit_deposit(instrument: Deposit) -> None

Visit deposit.

visit_fixed_rate_bond abstractmethod

visit_fixed_rate_bond(instrument: FixedRateBond) -> None

Visit a fixed rate bond.

visit_personal_loan abstractmethod

visit_personal_loan(instrument: PersonalLoan) -> None

Visit a personal loan.

visit_variable_rate_loan abstractmethod

visit_variable_rate_loan(
    instrument: VariableRateLoan,
) -> None

Visit a variable rate loan.