freeports_analysis.output.files_schema
Data schema definitions for financial investment data validation.
This module defines the data schemas used to validate and structure financial investment data extracted from PDF documents. It includes DataFrame schemas for tabular data and Pydantic models for structured data validation.
Classes
|
Additional information specific to bond investments. |
- class freeports_analysis.output.files_schema.BondAdditionalInfos(*, maturity: date | None, interest_rate: Annotated[float, None, Interval(gt=None, ge=0.0, lt=1.0, le=None), None, None] | None)
Additional information specific to bond investments.
This model captures bond-specific attributes that are not part of the core investment data structure.
- maturity
The date when the bond reaches maturity and principal is repaid
- Type:
Optional[datetime.date]
- interest_rate
The annual interest rate as a decimal value between 0.0 and 1.0
- Type:
Optional[confloat(ge=0.0, lt=1.0)]
Notes
This model is used to store bond-specific information separately from the main investment data structure, allowing for cleaner separation between common investment attributes and bond-specific ones.
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].