bayesline.api.equity.PortfolioOrganizerSettings

pydantic model bayesline.api.equity.PortfolioOrganizerSettings

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.

Show JSON schema

{
   "title": "PortfolioOrganizerSettings",
   "description": "Specifies which portfolios to enable (from different sources).\n\nDifferent sources (e.g. uploaded portfolios) can provide the same portfolio\nidentifiers. These settings allow to specify which portfolios to enable from\nwhich sources.",
   "type": "object",
   "properties": {
      "dataset": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The name of the underlying dataset to use for price data needed to forward fill portfolios, obtain corporate actions, etc.If none is given then the configured default dataset is used.",
         "examples": [
            "Bayesline-US"
         ],
         "title": "Dataset"
      },
      "enabled_portfolios": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "additionalProperties": {
                  "type": "string"
               },
               "type": "object"
            }
         ],
         "description": "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).",
         "title": "Enabled Portfolios"
      }
   },
   "additionalProperties": false,
   "required": [
      "enabled_portfolios"
   ]
}

Config:

• frozen: bool = True

• extra: str = forbid

Fields:

• dataset (str | None)

• enabled_portfolios (str | dict[str, str])

Validators:

• validate_enabled_portfolios » enabled_portfolios

field dataset: str | None = None

The name of the underlying dataset to use for price data needed to forward fill portfolios, obtain corporate actions, etc.If none is given then the configured default dataset is used.

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

property menu_type: type[PortfolioOrganizerSettingsMenu]

Get the menu type for this settings object.

Returns

type[SettingsMenuType]

The menu type for this settings object.

validator validate_enabled_portfolios → str | dict[str, str]  »  enabled_portfolios

describe(menu: PortfolioOrganizerSettingsMenu) → str

Describe the settings.

Parameters

menuPortfolioOrganizerSettingsMenu

The menu to get context information from.

Returns

str

A description of the settings.