seismometer.configuration.model.DictionaryItem

pydantic model seismometer.configuration.model.DictionaryItem

Defines a generic dictionary item.

Show Entity Relationship Diagram

Show JSON schema

{
   "title": "DictionaryItem",
   "description": "Defines a generic dictionary item.",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "display_name": {
         "default": "",
         "title": "Display Name",
         "type": "string"
      },
      "dtype": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Dtype"
      },
      "definition": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Definition"
      }
   },
   "required": [
      "name"
   ]
}

Fields:

• definition (str | None)

• display_name (str)

• dtype (str | None)

• name (str)

Validators:

• default_display_name » display_name

field definition: str | None = None

The definition of the item.

field display_name: str = ''

The name to display for the item, defaults to name, currently ignored.

Validated by:

• default_display_name

field dtype: str | None = None

The pandas-compatible type of data, currently ignored.

field name: str [Required]

The source name of the item, should match raw data.

validator default_display_name  »  display_name

Ensures that the display_name is set to the name if not provided.

Parameters:

• display_name (str) – The display name of the item.

• values (dict) – The values of the instance.

Returns:

The resolved display name.

Return type:

str