bayesline.api.equity.RegionSettings

pydantic model bayesline.api.equity.RegionSettings

Specifies include and exclude filters for countries and regions.

Assets are includes if they are part of at least one include and not part of any exclude.

By default all countries for the given hierarchy are included.

Show JSON schema

{
   "title": "RegionSettings",
   "description": "Specifies include and exclude filters for countries and regions.\n\nAssets are includes if they are part of at least one include\nand not part of any exclude.\n\nBy default all countries for the given hierarchy are included.",
   "type": "object",
   "properties": {
      "hierarchy": {
         "default": "continent",
         "description": "The region hierarchy to use.",
         "examples": [
            "continent"
         ],
         "minLength": 1,
         "title": "Hierarchy",
         "type": "string"
      },
      "include": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "const": "All",
               "type": "string"
            }
         ],
         "default": "All",
         "description": "Valid country/region codes or labels at any level. If labels are used which may be duplicated, then the code with the highest level is used.",
         "examples": [
            [
               "Europe",
               "CAN"
            ],
            "All"
         ],
         "title": "Include"
      },
      "exclude": {
         "description": "Valid country/region codes or labels at any level. If labels are used which may be duplicated, then the code with the lowest level is used.",
         "examples": [
            [
               "DEU"
            ]
         ],
         "items": {
            "type": "string"
         },
         "title": "Exclude",
         "type": "array"
      }
   },
   "additionalProperties": false
}

Config:

• frozen: bool = True

• extra: str = forbid

Fields:

• exclude (list[str])

• hierarchy (str)

• include (list[str] | Literal['All'])

field hierarchy: str = 'continent'

The region hierarchy to use.

Constraints:

• min_length = 1

field include: Union[list[str], Literal['All']] = 'All'

Valid country/region codes or labels at any level. If labels are used which may be duplicated, then the code with the highest level is used.

field exclude: list[str] [Optional]

Valid country/region codes or labels at any level. If labels are used which may be duplicated, then the code with the lowest level is used.