dgbowl_schemas.tomato.payload_0_1 package

pydantic model dgbowl_schemas.tomato.payload_0_1.Payload

Bases: BaseModel

Show JSON schema

{
   "title": "Payload",
   "type": "object",
   "properties": {
      "version": {
         "const": "0.1",
         "title": "Version",
         "type": "string"
      },
      "tomato": {
         "$ref": "#/$defs/Tomato"
      },
      "sample": {
         "$ref": "#/$defs/Sample"
      },
      "method": {
         "items": {
            "$ref": "#/$defs/Method"
         },
         "title": "Method",
         "type": "array"
      }
   },
   "$defs": {
      "Method": {
         "additionalProperties": true,
         "properties": {
            "device": {
               "title": "Device",
               "type": "string"
            },
            "technique": {
               "title": "Technique",
               "type": "string"
            }
         },
         "required": [
            "device",
            "technique"
         ],
         "title": "Method",
         "type": "object"
      },
      "Output": {
         "additionalProperties": false,
         "properties": {
            "path": {
               "default": null,
               "title": "Path",
               "type": "string"
            },
            "prefix": {
               "default": null,
               "title": "Prefix",
               "type": "string"
            }
         },
         "title": "Output",
         "type": "object"
      },
      "Sample": {
         "additionalProperties": true,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            }
         },
         "required": [
            "name"
         ],
         "title": "Sample",
         "type": "object"
      },
      "Tomato": {
         "additionalProperties": false,
         "properties": {
            "unlock_when_done": {
               "default": false,
               "title": "Unlock When Done",
               "type": "boolean"
            },
            "verbosity": {
               "default": "WARNING",
               "enum": [
                  "DEBUG",
                  "INFO",
                  "WARNING",
                  "ERROR",
                  "CRITICAL"
               ],
               "title": "Verbosity",
               "type": "string"
            },
            "output": {
               "$ref": "#/$defs/Output"
            }
         },
         "title": "Tomato",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "version",
      "sample",
      "method"
   ]
}

Config:

extra: str = forbid

Validators:

extract_methodfile » all fields
extract_samplefile » all fields

field version: Literal['0.1'] [Required]

Validated by:

extract_methodfile
extract_samplefile

field tomato: Tomato [Optional]

Validated by:

extract_methodfile
extract_samplefile

field sample: Sample [Required]

Validated by:

extract_methodfile
extract_samplefile

field method: Sequence[Method] [Required]

Validated by:

extract_methodfile
extract_samplefile

validator extract_samplefile » all fields

validator extract_methodfile » all fields

update()

Submodules

dgbowl_schemas.tomato.payload_0_1.method module

pydantic model dgbowl_schemas.tomato.payload_0_1.method.Method

Bases: BaseModel

Show JSON schema

{
   "title": "Method",
   "type": "object",
   "properties": {
      "device": {
         "title": "Device",
         "type": "string"
      },
      "technique": {
         "title": "Technique",
         "type": "string"
      }
   },
   "additionalProperties": true,
   "required": [
      "device",
      "technique"
   ]
}

Config:

extra: str = allow

field device: str [Required]

field technique: str [Required]

dgbowl_schemas.tomato.payload_0_1.sample module

pydantic model dgbowl_schemas.tomato.payload_0_1.sample.Sample

Bases: BaseModel

Show JSON schema

{
   "title": "Sample",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      }
   },
   "additionalProperties": true,
   "required": [
      "name"
   ]
}

Config:

extra: str = allow

field name: str [Required]

dgbowl_schemas.tomato.payload_0_1.tomato module

pydantic model dgbowl_schemas.tomato.payload_0_1.tomato.Tomato

Bases: BaseModel

Show JSON schema

{
   "title": "Tomato",
   "type": "object",
   "properties": {
      "unlock_when_done": {
         "default": false,
         "title": "Unlock When Done",
         "type": "boolean"
      },
      "verbosity": {
         "default": "WARNING",
         "enum": [
            "DEBUG",
            "INFO",
            "WARNING",
            "ERROR",
            "CRITICAL"
         ],
         "title": "Verbosity",
         "type": "string"
      },
      "output": {
         "$ref": "#/$defs/Output"
      }
   },
   "$defs": {
      "Output": {
         "additionalProperties": false,
         "properties": {
            "path": {
               "default": null,
               "title": "Path",
               "type": "string"
            },
            "prefix": {
               "default": null,
               "title": "Prefix",
               "type": "string"
            }
         },
         "title": "Output",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid

pydantic model Output

Bases: BaseModel

Show JSON schema

{
   "title": "Output",
   "type": "object",
   "properties": {
      "path": {
         "default": null,
         "title": "Path",
         "type": "string"
      },
      "prefix": {
         "default": null,
         "title": "Prefix",
         "type": "string"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid

field path: str = None

field prefix: str = None

field unlock_when_done: bool = False

field verbosity: Literal['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'] = 'WARNING'

field output: Output [Optional]