bayesline.api.equity.PortfolioOrganizerSettings

bayesline.api.equity.PortfolioOrganizerSettings#

model PortfolioOrganizerSettings#

Definition of where to source portfolio data from.

Specifies which portfolios to enable (from different sources). Different sources (e.g. uploaded portfolios) can provide the same portfolio identifiers. These settings allow to specify which portfolios to enable from which sources.

Fields#

Field

Type

Required

Default

auxiliary_portfolios

dict[str, str]

No

factory

enabled_portfolios

str | dict[str, str]

Yes

Validators#

Validator

Mode

Fields

validate_enabled_portfolios

after

enabled_portfolios

field auxiliary_portfolios: dict[str, str] [Optional]#

Portfolios pulled in by fund-of-funds (FoF) cascade. Informational: always recomputed from enabled_portfolios plus the FoF graph at load time. Persisted as-is on save; any stale values are overwritten on the next normalize. The loader’s effective enabled set is the union of enabled_portfolios and auxiliary_portfolios with user-explicit entries winning on key collision.

field enabled_portfolios: str | dict[str, str] [Required]#

The enabled portfolios from different sources. The key is the portfolio ID, and the value is the source (name of the underlying portfolio service). Pass a str to reference an entire portfolio source (e.g. all portfolios from an upload).

Validated by:

validate_enabled_portfolios

validator validate_enabled_portfolios(mode=after)#
Validates:

enabled_portfolios