Skip to content

equity

Equity instrument classes for the core domain model.

Classes:

  • CommonEquity –

    A class to represent common equity instruments.

CommonEquity 

CommonEquity(*, name: str = 'Common Equity')

Bases: Instrument

A class to represent common equity instruments.

Parameters:

  • name

    (str, default: 'Common Equity' ) –

    The name of the equity instrument. Defaults to "Common Equity".

Methods:

  • accept –

    Accept a visitor.

  • is_composite –

    Check if the instrument is composite.

  • repricing_date –

    Return the next repricing date for variable-rate instruments.

Attributes:

book_type property writable 

book_type: BookType | None

Get the book type of the instrument.

credit_rating property writable 

credit_rating: CreditRating

Get the instrument's credit rating.

issuer property writable 

issuer: Issuer

Get the instrument's issuer.

parent property writable 

parent: Instrument | None

Get the parent instrument.

accept 

accept(visitor: Visitor) -> None

Accept a visitor.

is_composite 

is_composite() -> bool

Check if the instrument is composite.

repricing_date 

repricing_date(as_of: date) -> date | None

Return the next repricing date for variable-rate instruments.

Returns None for fixed-rate instruments (repricing_frequency is None).