bayesline.api.equity.ReportAccessorSettings

pydantic model bayesline.api.equity.ReportAccessorSettings

Settings for report accessor configuration.

This class defines the configuration for accessing and processing reports, including axes, metrics, pivot columns, and additional report linking.

Show JSON schema

{
   "title": "ReportAccessorSettings",
   "description": "Settings for report accessor configuration.\n\nThis class defines the configuration for accessing and processing reports,\nincluding axes, metrics, pivot columns, and additional report linking.",
   "type": "object",
   "properties": {
      "axes": {
         "additionalProperties": {
            "items": {
               "type": "string"
            },
            "type": "array"
         },
         "title": "Axes",
         "type": "object"
      },
      "metric_cols": {
         "items": {
            "type": "string"
         },
         "title": "Metric Cols",
         "type": "array"
      },
      "pivot_cols": {
         "items": {
            "type": "string"
         },
         "title": "Pivot Cols",
         "type": "array"
      },
      "extra_paths": {
         "items": {
            "items": {
               "type": "string"
            },
            "type": "array"
         },
         "title": "Extra Paths",
         "type": "array"
      },
      "extra_cols": {
         "items": {
            "type": "string"
         },
         "title": "Extra Cols",
         "type": "array"
      },
      "linked_reports": {
         "items": {
            "type": "integer"
         },
         "title": "Linked Reports",
         "type": "array"
      },
      "tags": {
         "items": {
            "type": "string"
         },
         "title": "Tags",
         "type": "array"
      }
   },
   "additionalProperties": false,
   "required": [
      "axes",
      "metric_cols",
      "pivot_cols"
   ]
}

Config:

• frozen: bool = True

• extra: str = forbid

Fields:

• axes (dict[str, list[str]])

• extra_cols (list[str])

• extra_paths (list[list[str]])

• linked_reports (list[int])

• metric_cols (list[str])

• pivot_cols (list[str])

• tags (list[str])

field axes: dict[str, list[str]] [Required]

field metric_cols: list[str] [Required]

field pivot_cols: list[str] [Required]

field extra_paths: list[list[str]] [Optional]

field extra_cols: list[str] [Optional]

field linked_reports: list[int] [Optional]

field tags: list[str] [Optional]

property menu_type: type[EmptySettingsMenu]

Get the menu type for this settings object.

Returns

type[SettingsMenuType]

The menu type for this settings object.

describe(menu: EmptySettingsMenu) → str

Describe the report accessor settings.

Parameters

menuEmptySettingsMenu

The menu to use to describe the settings.

Returns

str

A description of the report accessor settings.