bayesline.api.equity.PortfolioCoverageReportSettings

pydantic model bayesline.api.equity.PortfolioCoverageReportSettings

Settings for dataset-backed portfolio coverage metrics.

Show JSON schema

{
   "title": "PortfolioCoverageReportSettings",
   "description": "Settings for dataset-backed portfolio coverage metrics.",
   "type": "object",
   "properties": {
      "report_type": {
         "const": "portfolio_coverage",
         "default": "portfolio_coverage",
         "title": "Report Type",
         "type": "string"
      },
      "portfolio_settings": {
         "$ref": "#/$defs/PortfolioSettings"
      }
   },
   "$defs": {
      "PortfolioOrganizerSettings": {
         "additionalProperties": false,
         "description": "Definition of where to source portfolio data from.\n\nSpecifies which portfolios to enable (from different sources).\nDifferent sources (e.g. uploaded portfolios) can provide the same portfolio\nidentifiers. These settings allow to specify which portfolios to enable from\nwhich sources.",
         "properties": {
            "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"
            },
            "auxiliary_portfolios": {
               "additionalProperties": {
                  "type": "string"
               },
               "description": "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.",
               "title": "Auxiliary Portfolios",
               "type": "object"
            }
         },
         "required": [
            "enabled_portfolios"
         ],
         "title": "PortfolioOrganizerSettings",
         "type": "object"
      },
      "PortfolioSettings": {
         "additionalProperties": false,
         "description": "Specifies different options of obtaining portfolios.",
         "properties": {
            "portfolio_schema": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "integer"
                  },
                  {
                     "$ref": "#/$defs/PortfolioOrganizerSettings"
                  }
               ],
               "description": "The portfolio organizer settings to use as an underlying schema of portfolios. The 'Default' schema is used by default.",
               "title": "Portfolio Schema"
            }
         },
         "required": [
            "portfolio_schema"
         ],
         "title": "PortfolioSettings",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "portfolio_settings"
   ]
}

Config:

• frozen: bool = True

• extra: str = forbid

Fields:

• portfolio_settings (bayesline.api._src.equity.portfolio_settings.PortfolioSettings)

• report_type (Literal['portfolio_coverage'])

Validators:

field report_type: Literal['portfolio_coverage'] = 'portfolio_coverage'

Validated by:

• _strip_unknown_on_load

field portfolio_settings: PortfolioSettings [Required]

Validated by:

• _strip_unknown_on_load