dgbowl_schemas.yadg.dataschema_5_1 package
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.DataSchema
Bases:
BaseModelA
pydantic.BaseModelimplementingDataSchema-5.1model introduced inyadg-5.1.Show JSON schema
{ "title": "DataSchema", "description": "A :class:`pydantic.BaseModel` implementing ``DataSchema-5.1`` model\nintroduced in ``yadg-5.1``.", "type": "object", "properties": { "version": { "const": "5.1", "enum": [ "5.1" ], "title": "Version", "type": "string" }, "metadata": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "step_defaults": { "$ref": "#/$defs/StepDefaults" }, "steps": { "items": { "$ref": "#/$defs/Step" }, "title": "Steps", "type": "array" } }, "$defs": { "Agilent_ch": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "agilent.ch", "agilent-ch" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Agilent_ch", "type": "object" }, "Agilent_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "agilent.csv", "enum": [ "agilent.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Agilent_csv", "type": "object" }, "Agilent_dx": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "agilent.dx", "agilent-dx" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Agilent_dx", "type": "object" }, "Basic_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "basic.csv", "enum": [ "basic.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_1__filetype__Basic_csv__Parameters" } }, "required": [ "filetype" ], "title": "Basic_csv", "type": "object" }, "Drycal_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.csv", "enum": [ "drycal.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Drycal_csv", "type": "object" }, "Drycal_rtf": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.rtf", "enum": [ "drycal.rtf" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Drycal_rtf", "type": "object" }, "Drycal_txt": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.txt", "enum": [ "drycal.txt" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Drycal_txt", "type": "object" }, "EClab_mpr": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "eclab.mpr", "biologic-mpr" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EClab_mpr", "type": "object" }, "EClab_mpt": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "eclab.mpt", "biologic-mpt" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "windows-1252", "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EClab_mpt", "type": "object" }, "EZChrom_asc": { "additionalProperties": false, "properties": { "filetype": { "const": "ezchrom.asc", "enum": [ "ezchrom.asc" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "windows-1252", "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EZChrom_asc", "type": "object" }, "EZChrom_dat": { "additionalProperties": false, "properties": { "filetype": { "const": "ezchrom.dat", "enum": [ "ezchrom.dat" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EZChrom_dat", "type": "object" }, "EmpaLC_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "empalc.csv", "enum": [ "empalc.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EmpaLC_csv", "type": "object" }, "EmpaLC_xlsx": { "additionalProperties": false, "properties": { "filetype": { "const": "empalc.xlsx", "enum": [ "empalc.xlsx" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EmpaLC_xlsx", "type": "object" }, "Example": { "additionalProperties": false, "properties": { "filetype": { "const": "example", "enum": [ "example" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_1__filetype__Example__Parameters" } }, "required": [ "filetype" ], "title": "Example", "type": "object" }, "ExternalDate": { "additionalProperties": false, "description": "Supply timestamping information that are external to the processed file.", "properties": { "using": { "anyOf": [ { "$ref": "#/$defs/ExternalDateFile" }, { "$ref": "#/$defs/ExternalDateFilename" }, { "$ref": "#/$defs/ExternalDateISOString" }, { "$ref": "#/$defs/ExternalDateUTSOffset" } ], "title": "Using" }, "mode": { "default": "add", "enum": [ "add", "replace" ], "title": "Mode", "type": "string" } }, "required": [ "using" ], "title": "ExternalDate", "type": "object" }, "ExternalDateFile": { "additionalProperties": false, "description": "Read external date information from file.", "properties": { "file": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_1__externaldate__ExternalDateFile__Content" } }, "required": [ "file" ], "title": "ExternalDateFile", "type": "object" }, "ExternalDateFilename": { "additionalProperties": false, "description": "Read external date information from the file name.", "properties": { "filename": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_1__externaldate__ExternalDateFilename__Content" } }, "required": [ "filename" ], "title": "ExternalDateFilename", "type": "object" }, "ExternalDateISOString": { "additionalProperties": false, "description": "Read a constant external date using an ISO-formatted string.", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "required": [ "isostring" ], "title": "ExternalDateISOString", "type": "object" }, "ExternalDateUTSOffset": { "additionalProperties": false, "description": "Read a constant external date using a Unix timestamp offset.", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "required": [ "utsoffset" ], "title": "ExternalDateUTSOffset", "type": "object" }, "FHI_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "fhimcpt.csv", "enum": [ "fhimcpt.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_1__filetype__FHI_csv__Parameters" } }, "required": [ "filetype" ], "title": "FHI_csv", "type": "object" }, "FHI_vna": { "additionalProperties": false, "properties": { "filetype": { "const": "fhimcpt.vna", "enum": [ "fhimcpt.vna" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "FHI_vna", "type": "object" }, "Fusion_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.csv", "enum": [ "fusion.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Fusion_csv", "type": "object" }, "Fusion_json": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.json", "enum": [ "fusion.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Fusion_json", "type": "object" }, "Fusion_zip": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.zip", "enum": [ "fusion.zip" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Fusion_zip", "type": "object" }, "Input": { "additionalProperties": false, "description": "Specification of input files/folders to be processed by the :class:`Step`.", "properties": { "folders": { "items": { "type": "string" }, "title": "Folders", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Suffix" }, "contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Contains" }, "exclude": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exclude" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Panalytical_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "panalytical.csv", "enum": [ "panalytical.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Panalytical_csv", "type": "object" }, "Panalytical_xrdml": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "panalytical.xrdml", "panalytical-xrdml" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Panalytical_xrdml", "type": "object" }, "Panalytical_xy": { "additionalProperties": false, "properties": { "filetype": { "const": "panalytical.xy", "enum": [ "panalytical.xy" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Panalytical_xy", "type": "object" }, "Phi_spe": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "phi.spe", "phi-spe" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Phi_spe", "type": "object" }, "PicoLog_tc08": { "additionalProperties": false, "properties": { "filetype": { "const": "picolog.tc08", "enum": [ "picolog.tc08" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "PicoLog_tc08", "type": "object" }, "Quadstar_sac": { "additionalProperties": false, "properties": { "filetype": { "const": "quadstar.sac", "enum": [ "quadstar.sac" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Quadstar_sac", "type": "object" }, "Step": { "additionalProperties": false, "properties": { "extractor": { "anyOf": [ { "$ref": "#/$defs/Agilent_ch" }, { "$ref": "#/$defs/Agilent_csv" }, { "$ref": "#/$defs/Agilent_dx" }, { "$ref": "#/$defs/Basic_csv" }, { "$ref": "#/$defs/Drycal_csv" }, { "$ref": "#/$defs/Drycal_rtf" }, { "$ref": "#/$defs/Drycal_txt" }, { "$ref": "#/$defs/EClab_mpr" }, { "$ref": "#/$defs/EClab_mpt" }, { "$ref": "#/$defs/EZChrom_asc" }, { "$ref": "#/$defs/EZChrom_dat" }, { "$ref": "#/$defs/EmpaLC_csv" }, { "$ref": "#/$defs/EmpaLC_xlsx" }, { "$ref": "#/$defs/Example" }, { "$ref": "#/$defs/FHI_csv" }, { "$ref": "#/$defs/FHI_vna" }, { "$ref": "#/$defs/Fusion_csv" }, { "$ref": "#/$defs/Fusion_json" }, { "$ref": "#/$defs/Fusion_zip" }, { "$ref": "#/$defs/Panalytical_csv" }, { "$ref": "#/$defs/Panalytical_xrdml" }, { "$ref": "#/$defs/Panalytical_xy" }, { "$ref": "#/$defs/Phi_spe" }, { "$ref": "#/$defs/PicoLog_tc08" }, { "$ref": "#/$defs/Quadstar_sac" }, { "$ref": "#/$defs/Tomato_json" }, { "$ref": "#/$defs/Touchstone_snp" } ], "title": "Extractor" }, "input": { "$ref": "#/$defs/Input" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "required": [ "extractor", "input" ], "title": "Step", "type": "object" }, "StepDefaults": { "additionalProperties": false, "description": "Configuration of defaults applicable for all steps.", "properties": { "timezone": { "default": "localtime", "title": "Timezone", "type": "string" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "utf-8", "title": "Encoding" } }, "title": "StepDefaults", "type": "object" }, "TimeDate": { "additionalProperties": false, "description": "Timestamp from a separate date and/or time column.", "properties": { "date": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null }, "time": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null } }, "title": "TimeDate", "type": "object" }, "Timestamp": { "additionalProperties": false, "description": "Timestamp from a column containing a single timestamp string.", "properties": { "timestamp": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "timestamp" ], "title": "Timestamp", "type": "object" }, "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" }, "Tomato_json": { "additionalProperties": false, "properties": { "filetype": { "const": "tomato.json", "enum": [ "tomato.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Tomato_json", "type": "object" }, "Touchstone_snp": { "additionalProperties": false, "properties": { "filetype": { "const": "touchstone.snp", "enum": [ "touchstone.snp" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Touchstone_snp", "type": "object" }, "UTS": { "additionalProperties": false, "description": "Timestamp from a column containing a Unix timestamp.", "properties": { "uts": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "uts" ], "title": "UTS", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_1__externaldate__ExternalDateFile__Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_1__externaldate__ExternalDateFilename__Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_1__filetype__Basic_csv__Parameters": { "additionalProperties": false, "properties": { "sep": { "default": ",", "title": "Sep", "type": "string" }, "strip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Strip" }, "units": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Units" }, "timestamp": { "anyOf": [ { "$ref": "#/$defs/Timestamp" }, { "$ref": "#/$defs/TimeDate" }, { "$ref": "#/$defs/UTS" }, { "type": "null" } ], "default": null, "title": "Timestamp" } }, "title": "Parameters", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_1__filetype__Example__Parameters": { "additionalProperties": true, "properties": {}, "title": "Parameters", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_1__filetype__FHI_csv__Parameters": { "additionalProperties": false, "properties": { "timestamp": { "anyOf": [ { "$ref": "#/$defs/Timestamp" }, { "$ref": "#/$defs/TimeDate" }, { "$ref": "#/$defs/UTS" } ], "default": { "timestamp": { "format": "%Y-%m-%d-%H-%M-%S", "index": 0 } }, "title": "Timestamp" } }, "title": "Parameters", "type": "object" } }, "additionalProperties": false, "required": [ "version", "metadata", "steps" ] }
- Config:
extra: str = forbid
- field version: Literal['5.1'] [Required]
- field step_defaults: StepDefaults [Optional]
Default values for configuration of each
Step.
- field steps: Sequence[Step] [Required]
Input commands for
yadg’s extractors, organised as aSequenceofSteps.
- update()
Submodules
dgbowl_schemas.yadg.dataschema_5_1.externaldate module
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.externaldate.ExternalDateFile
Bases:
BaseModelRead external date information from file.
Show JSON schema
{ "title": "ExternalDateFile", "description": "Read external date information from file.", "type": "object", "properties": { "file": { "$ref": "#/$defs/Content" } }, "$defs": { "Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "file" ] }
- Config:
extra: str = forbid
- pydantic model Content
Bases:
BaseModelShow JSON schema
{ "title": "Content", "type": "object", "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "additionalProperties": false, "required": [ "path", "type" ] }
- Config:
extra: str = forbid
- field path: str [Required]
Path to the external date information file.
- field type: str [Required]
Type of the external date information file.
- field match: str | None = None
String to be matched within the file.
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.externaldate.ExternalDateFilename
Bases:
BaseModelRead external date information from the file name.
Show JSON schema
{ "title": "ExternalDateFilename", "description": "Read external date information from the file name.", "type": "object", "properties": { "filename": { "$ref": "#/$defs/Content" } }, "$defs": { "Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "filename" ] }
- Config:
extra: str = forbid
- pydantic model Content
Bases:
BaseModelShow JSON schema
{ "title": "Content", "type": "object", "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "additionalProperties": false, "required": [ "format", "len" ] }
- Config:
extra: str = forbid
- field format: str [Required]
strptime-like format string for processing the date.
- field len: int [Required]
Number of characters from the start of the filename to parse.
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.externaldate.ExternalDateISOString
Bases:
BaseModelRead a constant external date using an ISO-formatted string.
Show JSON schema
{ "title": "ExternalDateISOString", "description": "Read a constant external date using an ISO-formatted string.", "type": "object", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "additionalProperties": false, "required": [ "isostring" ] }
- Config:
extra: str = forbid
- field isostring: str [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.externaldate.ExternalDateUTSOffset
Bases:
BaseModelRead a constant external date using a Unix timestamp offset.
Show JSON schema
{ "title": "ExternalDateUTSOffset", "description": "Read a constant external date using a Unix timestamp offset.", "type": "object", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "additionalProperties": false, "required": [ "utsoffset" ] }
- Config:
extra: str = forbid
- field utsoffset: float [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.externaldate.ExternalDate
Bases:
BaseModelSupply timestamping information that are external to the processed file.
Show JSON schema
{ "title": "ExternalDate", "description": "Supply timestamping information that are external to the processed file.", "type": "object", "properties": { "using": { "anyOf": [ { "$ref": "#/$defs/ExternalDateFile" }, { "$ref": "#/$defs/ExternalDateFilename" }, { "$ref": "#/$defs/ExternalDateISOString" }, { "$ref": "#/$defs/ExternalDateUTSOffset" } ], "title": "Using" }, "mode": { "default": "add", "enum": [ "add", "replace" ], "title": "Mode", "type": "string" } }, "$defs": { "ExternalDateFile": { "additionalProperties": false, "description": "Read external date information from file.", "properties": { "file": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_1__externaldate__ExternalDateFile__Content" } }, "required": [ "file" ], "title": "ExternalDateFile", "type": "object" }, "ExternalDateFilename": { "additionalProperties": false, "description": "Read external date information from the file name.", "properties": { "filename": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_1__externaldate__ExternalDateFilename__Content" } }, "required": [ "filename" ], "title": "ExternalDateFilename", "type": "object" }, "ExternalDateISOString": { "additionalProperties": false, "description": "Read a constant external date using an ISO-formatted string.", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "required": [ "isostring" ], "title": "ExternalDateISOString", "type": "object" }, "ExternalDateUTSOffset": { "additionalProperties": false, "description": "Read a constant external date using a Unix timestamp offset.", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "required": [ "utsoffset" ], "title": "ExternalDateUTSOffset", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_1__externaldate__ExternalDateFile__Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_1__externaldate__ExternalDateFilename__Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" } }, "additionalProperties": false, "required": [ "using" ] }
- Config:
extra: str = forbid
- field using: ExternalDateFile | ExternalDateFilename | ExternalDateISOString | ExternalDateUTSOffset [Required]
Specification of the external date format.
- field mode: Literal['add', 'replace'] = 'add'
Whether the external timestamps should be added to or should replace the parsed data.
dgbowl_schemas.yadg.dataschema_5_1.filetype module
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.FileType
Bases:
BaseModel,ABCTemplate abstract base class for parser classes.
Show JSON schema
{ "title": "FileType", "description": "Template abstract base class for parser classes.", "type": "object", "properties": { "filetype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Filetype" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- Validators:
- field filetype: str | None = None
- field timezone: str | None = None
- Validated by:
- field locale: str | None = None
- Validated by:
- field encoding: str | None = None
- field parameters: Any | None = None
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Example
Bases:
FileTypeShow JSON schema
{ "title": "Example", "type": "object", "properties": { "filetype": { "const": "example", "enum": [ "example" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "$ref": "#/$defs/Parameters" } }, "$defs": { "Parameters": { "additionalProperties": true, "properties": {}, "title": "Parameters", "type": "object" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- pydantic model Parameters
Bases:
BaseModelShow JSON schema
{ "title": "Parameters", "type": "object", "properties": {}, "additionalProperties": true }
- Config:
extra: str = allow
- field parameters: Parameters [Optional]
- field filetype: Literal['example'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Agilent_ch
Bases:
FileTypeShow JSON schema
{ "title": "Agilent_ch", "type": "object", "properties": { "filetype": { "enum": [ "agilent.ch", "agilent-ch" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['agilent.ch', 'agilent-ch'] [Required]
- Validated by:
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Agilent_dx
Bases:
FileTypeShow JSON schema
{ "title": "Agilent_dx", "type": "object", "properties": { "filetype": { "enum": [ "agilent.dx", "agilent-dx" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['agilent.dx', 'agilent-dx'] [Required]
- Validated by:
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Agilent_csv
Bases:
FileTypeShow JSON schema
{ "title": "Agilent_csv", "type": "object", "properties": { "filetype": { "const": "agilent.csv", "enum": [ "agilent.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['agilent.csv'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Basic_csv
Bases:
FileTypeShow JSON schema
{ "title": "Basic_csv", "type": "object", "properties": { "filetype": { "const": "basic.csv", "enum": [ "basic.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "$ref": "#/$defs/Parameters" } }, "$defs": { "Parameters": { "additionalProperties": false, "properties": { "sep": { "default": ",", "title": "Sep", "type": "string" }, "strip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Strip" }, "units": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Units" }, "timestamp": { "anyOf": [ { "$ref": "#/$defs/Timestamp" }, { "$ref": "#/$defs/TimeDate" }, { "$ref": "#/$defs/UTS" }, { "type": "null" } ], "default": null, "title": "Timestamp" } }, "title": "Parameters", "type": "object" }, "TimeDate": { "additionalProperties": false, "description": "Timestamp from a separate date and/or time column.", "properties": { "date": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null }, "time": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null } }, "title": "TimeDate", "type": "object" }, "Timestamp": { "additionalProperties": false, "description": "Timestamp from a column containing a single timestamp string.", "properties": { "timestamp": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "timestamp" ], "title": "Timestamp", "type": "object" }, "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" }, "UTS": { "additionalProperties": false, "description": "Timestamp from a column containing a Unix timestamp.", "properties": { "uts": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "uts" ], "title": "UTS", "type": "object" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- pydantic model Parameters
Bases:
BaseModelShow JSON schema
{ "title": "Parameters", "type": "object", "properties": { "sep": { "default": ",", "title": "Sep", "type": "string" }, "strip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Strip" }, "units": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Units" }, "timestamp": { "anyOf": [ { "$ref": "#/$defs/Timestamp" }, { "$ref": "#/$defs/TimeDate" }, { "$ref": "#/$defs/UTS" }, { "type": "null" } ], "default": null, "title": "Timestamp" } }, "$defs": { "TimeDate": { "additionalProperties": false, "description": "Timestamp from a separate date and/or time column.", "properties": { "date": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null }, "time": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null } }, "title": "TimeDate", "type": "object" }, "Timestamp": { "additionalProperties": false, "description": "Timestamp from a column containing a single timestamp string.", "properties": { "timestamp": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "timestamp" ], "title": "Timestamp", "type": "object" }, "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" }, "UTS": { "additionalProperties": false, "description": "Timestamp from a column containing a Unix timestamp.", "properties": { "uts": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "uts" ], "title": "UTS", "type": "object" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field sep: str = ','
Separator of table columns.
- field strip: str | None = None
A
strof characters to strip from headers & data.
- field units: Mapping[str, str] | None = None
A
dictcontainingcolumn: unitkeypairs.
- field parameters: Parameters [Optional]
- field filetype: Literal['basic.csv'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Drycal_csv
Bases:
FileTypeShow JSON schema
{ "title": "Drycal_csv", "type": "object", "properties": { "filetype": { "const": "drycal.csv", "enum": [ "drycal.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['drycal.csv'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Drycal_rtf
Bases:
FileTypeShow JSON schema
{ "title": "Drycal_rtf", "type": "object", "properties": { "filetype": { "const": "drycal.rtf", "enum": [ "drycal.rtf" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['drycal.rtf'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Drycal_txt
Bases:
FileTypeShow JSON schema
{ "title": "Drycal_txt", "type": "object", "properties": { "filetype": { "const": "drycal.txt", "enum": [ "drycal.txt" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['drycal.txt'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.EClab_mpr
Bases:
FileTypeShow JSON schema
{ "title": "EClab_mpr", "type": "object", "properties": { "filetype": { "enum": [ "eclab.mpr", "biologic-mpr" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['eclab.mpr', 'biologic-mpr'] [Required]
- Validated by:
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.EClab_mpt
Bases:
FileTypeShow JSON schema
{ "title": "EClab_mpt", "type": "object", "properties": { "filetype": { "enum": [ "eclab.mpt", "biologic-mpt" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "windows-1252", "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['eclab.mpt', 'biologic-mpt'] [Required]
- Validated by:
- field encoding: str | None = 'windows-1252'
- Validated by:
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.EmpaLC_csv
Bases:
FileTypeShow JSON schema
{ "title": "EmpaLC_csv", "type": "object", "properties": { "filetype": { "const": "empalc.csv", "enum": [ "empalc.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['empalc.csv'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.EmpaLC_xlsx
Bases:
FileTypeShow JSON schema
{ "title": "EmpaLC_xlsx", "type": "object", "properties": { "filetype": { "const": "empalc.xlsx", "enum": [ "empalc.xlsx" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['empalc.xlsx'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.EZChrom_dat
Bases:
FileTypeShow JSON schema
{ "title": "EZChrom_dat", "type": "object", "properties": { "filetype": { "const": "ezchrom.dat", "enum": [ "ezchrom.dat" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['ezchrom.dat'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.EZChrom_asc
Bases:
FileTypeShow JSON schema
{ "title": "EZChrom_asc", "type": "object", "properties": { "filetype": { "const": "ezchrom.asc", "enum": [ "ezchrom.asc" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "windows-1252", "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['ezchrom.asc'] [Required]
- field encoding: str | None = 'windows-1252'
- Validated by:
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.FHI_csv
Bases:
FileTypeShow JSON schema
{ "title": "FHI_csv", "type": "object", "properties": { "filetype": { "const": "fhimcpt.csv", "enum": [ "fhimcpt.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "$ref": "#/$defs/Parameters" } }, "$defs": { "Parameters": { "additionalProperties": false, "properties": { "timestamp": { "anyOf": [ { "$ref": "#/$defs/Timestamp" }, { "$ref": "#/$defs/TimeDate" }, { "$ref": "#/$defs/UTS" } ], "default": { "timestamp": { "format": "%Y-%m-%d-%H-%M-%S", "index": 0 } }, "title": "Timestamp" } }, "title": "Parameters", "type": "object" }, "TimeDate": { "additionalProperties": false, "description": "Timestamp from a separate date and/or time column.", "properties": { "date": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null }, "time": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null } }, "title": "TimeDate", "type": "object" }, "Timestamp": { "additionalProperties": false, "description": "Timestamp from a column containing a single timestamp string.", "properties": { "timestamp": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "timestamp" ], "title": "Timestamp", "type": "object" }, "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" }, "UTS": { "additionalProperties": false, "description": "Timestamp from a column containing a Unix timestamp.", "properties": { "uts": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "uts" ], "title": "UTS", "type": "object" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- pydantic model Parameters
Bases:
BaseModelShow JSON schema
{ "title": "Parameters", "type": "object", "properties": { "timestamp": { "anyOf": [ { "$ref": "#/$defs/Timestamp" }, { "$ref": "#/$defs/TimeDate" }, { "$ref": "#/$defs/UTS" } ], "default": { "timestamp": { "format": "%Y-%m-%d-%H-%M-%S", "index": 0 } }, "title": "Timestamp" } }, "$defs": { "TimeDate": { "additionalProperties": false, "description": "Timestamp from a separate date and/or time column.", "properties": { "date": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null }, "time": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null } }, "title": "TimeDate", "type": "object" }, "Timestamp": { "additionalProperties": false, "description": "Timestamp from a column containing a single timestamp string.", "properties": { "timestamp": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "timestamp" ], "title": "Timestamp", "type": "object" }, "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" }, "UTS": { "additionalProperties": false, "description": "Timestamp from a column containing a Unix timestamp.", "properties": { "uts": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "uts" ], "title": "UTS", "type": "object" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field parameters: Parameters [Optional]
- field filetype: Literal['fhimcpt.csv'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.FHI_vna
Bases:
FileTypeShow JSON schema
{ "title": "FHI_vna", "type": "object", "properties": { "filetype": { "const": "fhimcpt.vna", "enum": [ "fhimcpt.vna" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['fhimcpt.vna'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Fusion_json
Bases:
FileTypeShow JSON schema
{ "title": "Fusion_json", "type": "object", "properties": { "filetype": { "const": "fusion.json", "enum": [ "fusion.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['fusion.json'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Fusion_zip
Bases:
FileTypeShow JSON schema
{ "title": "Fusion_zip", "type": "object", "properties": { "filetype": { "const": "fusion.zip", "enum": [ "fusion.zip" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['fusion.zip'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Fusion_csv
Bases:
FileTypeShow JSON schema
{ "title": "Fusion_csv", "type": "object", "properties": { "filetype": { "const": "fusion.csv", "enum": [ "fusion.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['fusion.csv'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Panalytical_xy
Bases:
FileTypeShow JSON schema
{ "title": "Panalytical_xy", "type": "object", "properties": { "filetype": { "const": "panalytical.xy", "enum": [ "panalytical.xy" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['panalytical.xy'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Panalytical_csv
Bases:
FileTypeShow JSON schema
{ "title": "Panalytical_csv", "type": "object", "properties": { "filetype": { "const": "panalytical.csv", "enum": [ "panalytical.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['panalytical.csv'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.PicoLog_tc08
Bases:
FileTypeShow JSON schema
{ "title": "PicoLog_tc08", "type": "object", "properties": { "filetype": { "const": "picolog.tc08", "enum": [ "picolog.tc08" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['picolog.tc08'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Panalytical_xrdml
Bases:
FileTypeShow JSON schema
{ "title": "Panalytical_xrdml", "type": "object", "properties": { "filetype": { "enum": [ "panalytical.xrdml", "panalytical-xrdml" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['panalytical.xrdml', 'panalytical-xrdml'] [Required]
- Validated by:
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Phi_spe
Bases:
FileTypeShow JSON schema
{ "title": "Phi_spe", "type": "object", "properties": { "filetype": { "enum": [ "phi.spe", "phi-spe" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['phi.spe', 'phi-spe'] [Required]
- Validated by:
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Quadstar_sac
Bases:
FileTypeShow JSON schema
{ "title": "Quadstar_sac", "type": "object", "properties": { "filetype": { "const": "quadstar.sac", "enum": [ "quadstar.sac" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['quadstar.sac'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Tomato_json
Bases:
FileTypeShow JSON schema
{ "title": "Tomato_json", "type": "object", "properties": { "filetype": { "const": "tomato.json", "enum": [ "tomato.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['tomato.json'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.Touchstone_snp
Bases:
FileTypeShow JSON schema
{ "title": "Touchstone_snp", "type": "object", "properties": { "filetype": { "const": "touchstone.snp", "enum": [ "touchstone.snp" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "additionalProperties": false, "required": [ "filetype" ] }
- Config:
extra: str = forbid
- Validators:
- field filetype: Literal['touchstone.snp'] [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.filetype.ExtractorFactory
Bases:
BaseModelExtractor factory class.
Given an
extractor=dict(filetype=k, ...)argument, attempts to determine the correctFileType, parses any additionally supplied parameters for thatFileType, and back-fills defaults such astimezone,locale, andencoding.The following is the current usage pattern in
yadg:ftype = ExtractorFactory(extractor={"filetype": k}).extractor
Show JSON schema
{ "title": "ExtractorFactory", "description": "Extractor factory class.\n\nGiven an ``extractor=dict(filetype=k, ...)`` argument, attempts to determine the\ncorrect :class:`FileType`, parses any additionally supplied parameters for that\n:class:`FileType`, and back-fills defaults such as ``timezone``, ``locale``, and\n``encoding``.\n\nThe following is the current usage pattern in :mod:`yadg`:\n\n.. code-block::\n\n ftype = ExtractorFactory(extractor={\"filetype\": k}).extractor", "type": "object", "properties": { "extractor": { "discriminator": { "mapping": { "agilent-ch": "#/$defs/Agilent_ch", "agilent-dx": "#/$defs/Agilent_dx", "agilent.ch": "#/$defs/Agilent_ch", "agilent.csv": "#/$defs/Agilent_csv", "agilent.dx": "#/$defs/Agilent_dx", "basic.csv": "#/$defs/Basic_csv", "biologic-mpr": "#/$defs/EClab_mpr", "biologic-mpt": "#/$defs/EClab_mpt", "drycal.csv": "#/$defs/Drycal_csv", "drycal.rtf": "#/$defs/Drycal_rtf", "drycal.txt": "#/$defs/Drycal_txt", "eclab.mpr": "#/$defs/EClab_mpr", "eclab.mpt": "#/$defs/EClab_mpt", "empalc.csv": "#/$defs/EmpaLC_csv", "empalc.xlsx": "#/$defs/EmpaLC_xlsx", "example": "#/$defs/Example", "ezchrom.asc": "#/$defs/EZChrom_asc", "ezchrom.dat": "#/$defs/EZChrom_dat", "fhimcpt.csv": "#/$defs/FHI_csv", "fhimcpt.vna": "#/$defs/FHI_vna", "fusion.csv": "#/$defs/Fusion_csv", "fusion.json": "#/$defs/Fusion_json", "fusion.zip": "#/$defs/Fusion_zip", "panalytical-xrdml": "#/$defs/Panalytical_xrdml", "panalytical.csv": "#/$defs/Panalytical_csv", "panalytical.xrdml": "#/$defs/Panalytical_xrdml", "panalytical.xy": "#/$defs/Panalytical_xy", "phi-spe": "#/$defs/Phi_spe", "phi.spe": "#/$defs/Phi_spe", "picolog.tc08": "#/$defs/PicoLog_tc08", "quadstar.sac": "#/$defs/Quadstar_sac", "tomato.json": "#/$defs/Tomato_json", "touchstone.snp": "#/$defs/Touchstone_snp" }, "propertyName": "filetype" }, "oneOf": [ { "$ref": "#/$defs/Agilent_ch" }, { "$ref": "#/$defs/Agilent_csv" }, { "$ref": "#/$defs/Agilent_dx" }, { "$ref": "#/$defs/Basic_csv" }, { "$ref": "#/$defs/Drycal_csv" }, { "$ref": "#/$defs/Drycal_rtf" }, { "$ref": "#/$defs/Drycal_txt" }, { "$ref": "#/$defs/EClab_mpr" }, { "$ref": "#/$defs/EClab_mpt" }, { "$ref": "#/$defs/EZChrom_asc" }, { "$ref": "#/$defs/EZChrom_dat" }, { "$ref": "#/$defs/EmpaLC_csv" }, { "$ref": "#/$defs/EmpaLC_xlsx" }, { "$ref": "#/$defs/Example" }, { "$ref": "#/$defs/FHI_csv" }, { "$ref": "#/$defs/FHI_vna" }, { "$ref": "#/$defs/Fusion_csv" }, { "$ref": "#/$defs/Fusion_json" }, { "$ref": "#/$defs/Fusion_zip" }, { "$ref": "#/$defs/Panalytical_csv" }, { "$ref": "#/$defs/Panalytical_xrdml" }, { "$ref": "#/$defs/Panalytical_xy" }, { "$ref": "#/$defs/Phi_spe" }, { "$ref": "#/$defs/PicoLog_tc08" }, { "$ref": "#/$defs/Quadstar_sac" }, { "$ref": "#/$defs/Tomato_json" }, { "$ref": "#/$defs/Touchstone_snp" } ], "title": "Extractor" } }, "$defs": { "Agilent_ch": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "agilent.ch", "agilent-ch" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Agilent_ch", "type": "object" }, "Agilent_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "agilent.csv", "enum": [ "agilent.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Agilent_csv", "type": "object" }, "Agilent_dx": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "agilent.dx", "agilent-dx" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Agilent_dx", "type": "object" }, "Basic_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "basic.csv", "enum": [ "basic.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_1__filetype__Basic_csv__Parameters" } }, "required": [ "filetype" ], "title": "Basic_csv", "type": "object" }, "Drycal_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.csv", "enum": [ "drycal.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Drycal_csv", "type": "object" }, "Drycal_rtf": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.rtf", "enum": [ "drycal.rtf" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Drycal_rtf", "type": "object" }, "Drycal_txt": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.txt", "enum": [ "drycal.txt" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Drycal_txt", "type": "object" }, "EClab_mpr": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "eclab.mpr", "biologic-mpr" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EClab_mpr", "type": "object" }, "EClab_mpt": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "eclab.mpt", "biologic-mpt" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "windows-1252", "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EClab_mpt", "type": "object" }, "EZChrom_asc": { "additionalProperties": false, "properties": { "filetype": { "const": "ezchrom.asc", "enum": [ "ezchrom.asc" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "windows-1252", "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EZChrom_asc", "type": "object" }, "EZChrom_dat": { "additionalProperties": false, "properties": { "filetype": { "const": "ezchrom.dat", "enum": [ "ezchrom.dat" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EZChrom_dat", "type": "object" }, "EmpaLC_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "empalc.csv", "enum": [ "empalc.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EmpaLC_csv", "type": "object" }, "EmpaLC_xlsx": { "additionalProperties": false, "properties": { "filetype": { "const": "empalc.xlsx", "enum": [ "empalc.xlsx" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EmpaLC_xlsx", "type": "object" }, "Example": { "additionalProperties": false, "properties": { "filetype": { "const": "example", "enum": [ "example" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_1__filetype__Example__Parameters" } }, "required": [ "filetype" ], "title": "Example", "type": "object" }, "FHI_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "fhimcpt.csv", "enum": [ "fhimcpt.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_1__filetype__FHI_csv__Parameters" } }, "required": [ "filetype" ], "title": "FHI_csv", "type": "object" }, "FHI_vna": { "additionalProperties": false, "properties": { "filetype": { "const": "fhimcpt.vna", "enum": [ "fhimcpt.vna" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "FHI_vna", "type": "object" }, "Fusion_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.csv", "enum": [ "fusion.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Fusion_csv", "type": "object" }, "Fusion_json": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.json", "enum": [ "fusion.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Fusion_json", "type": "object" }, "Fusion_zip": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.zip", "enum": [ "fusion.zip" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Fusion_zip", "type": "object" }, "Panalytical_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "panalytical.csv", "enum": [ "panalytical.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Panalytical_csv", "type": "object" }, "Panalytical_xrdml": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "panalytical.xrdml", "panalytical-xrdml" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Panalytical_xrdml", "type": "object" }, "Panalytical_xy": { "additionalProperties": false, "properties": { "filetype": { "const": "panalytical.xy", "enum": [ "panalytical.xy" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Panalytical_xy", "type": "object" }, "Phi_spe": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "phi.spe", "phi-spe" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Phi_spe", "type": "object" }, "PicoLog_tc08": { "additionalProperties": false, "properties": { "filetype": { "const": "picolog.tc08", "enum": [ "picolog.tc08" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "PicoLog_tc08", "type": "object" }, "Quadstar_sac": { "additionalProperties": false, "properties": { "filetype": { "const": "quadstar.sac", "enum": [ "quadstar.sac" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Quadstar_sac", "type": "object" }, "TimeDate": { "additionalProperties": false, "description": "Timestamp from a separate date and/or time column.", "properties": { "date": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null }, "time": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null } }, "title": "TimeDate", "type": "object" }, "Timestamp": { "additionalProperties": false, "description": "Timestamp from a column containing a single timestamp string.", "properties": { "timestamp": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "timestamp" ], "title": "Timestamp", "type": "object" }, "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" }, "Tomato_json": { "additionalProperties": false, "properties": { "filetype": { "const": "tomato.json", "enum": [ "tomato.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Tomato_json", "type": "object" }, "Touchstone_snp": { "additionalProperties": false, "properties": { "filetype": { "const": "touchstone.snp", "enum": [ "touchstone.snp" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Touchstone_snp", "type": "object" }, "UTS": { "additionalProperties": false, "description": "Timestamp from a column containing a Unix timestamp.", "properties": { "uts": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "uts" ], "title": "UTS", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_1__filetype__Basic_csv__Parameters": { "additionalProperties": false, "properties": { "sep": { "default": ",", "title": "Sep", "type": "string" }, "strip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Strip" }, "units": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Units" }, "timestamp": { "anyOf": [ { "$ref": "#/$defs/Timestamp" }, { "$ref": "#/$defs/TimeDate" }, { "$ref": "#/$defs/UTS" }, { "type": "null" } ], "default": null, "title": "Timestamp" } }, "title": "Parameters", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_1__filetype__Example__Parameters": { "additionalProperties": true, "properties": {}, "title": "Parameters", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_1__filetype__FHI_csv__Parameters": { "additionalProperties": false, "properties": { "timestamp": { "anyOf": [ { "$ref": "#/$defs/Timestamp" }, { "$ref": "#/$defs/TimeDate" }, { "$ref": "#/$defs/UTS" } ], "default": { "timestamp": { "format": "%Y-%m-%d-%H-%M-%S", "index": 0 } }, "title": "Timestamp" } }, "title": "Parameters", "type": "object" } }, "required": [ "extractor" ] }
- Validators:
- field extractor: FileTypes [Required]
- Validated by:
dgbowl_schemas.yadg.dataschema_5_1.input module
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.input.Input
Bases:
BaseModelSpecification of input files/folders to be processed by the
Step.Show JSON schema
{ "title": "Input", "description": "Specification of input files/folders to be processed by the :class:`Step`.", "type": "object", "properties": { "folders": { "items": { "type": "string" }, "title": "Folders", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Suffix" }, "contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Contains" }, "exclude": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exclude" } }, "additionalProperties": false, "required": [ "folders" ] }
- Config:
extra: str = forbid
populate_by_name: bool = True
- field files: Sequence[str] [Required] (alias 'folders')
Files, or folders to be searched for matching files.
- field prefix: str | None = None
Prefix of the filenames to be matched.
- field suffix: str | None = None
Suffix of the filenames to be matched.
- field contains: str | None = None
A string the matched filenames must contain.
- field exclude: str | None = None
A string the matched filenames must not contain.
- paths() List[str]
Returns a list of files to be processed by the
Step.
dgbowl_schemas.yadg.dataschema_5_1.parameters module
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.parameters.Parameters
Bases:
BaseModelEmpty parameters specification with no extras allowed.
Show JSON schema
{ "title": "Parameters", "description": "Empty parameters specification with no extras allowed.", "type": "object", "properties": {}, "additionalProperties": false }
- Config:
extra: str = forbid
dgbowl_schemas.yadg.dataschema_5_1.step module
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.step.Step
Bases:
BaseModelShow JSON schema
{ "title": "Step", "type": "object", "properties": { "extractor": { "anyOf": [ { "$ref": "#/$defs/Agilent_ch" }, { "$ref": "#/$defs/Agilent_csv" }, { "$ref": "#/$defs/Agilent_dx" }, { "$ref": "#/$defs/Basic_csv" }, { "$ref": "#/$defs/Drycal_csv" }, { "$ref": "#/$defs/Drycal_rtf" }, { "$ref": "#/$defs/Drycal_txt" }, { "$ref": "#/$defs/EClab_mpr" }, { "$ref": "#/$defs/EClab_mpt" }, { "$ref": "#/$defs/EZChrom_asc" }, { "$ref": "#/$defs/EZChrom_dat" }, { "$ref": "#/$defs/EmpaLC_csv" }, { "$ref": "#/$defs/EmpaLC_xlsx" }, { "$ref": "#/$defs/Example" }, { "$ref": "#/$defs/FHI_csv" }, { "$ref": "#/$defs/FHI_vna" }, { "$ref": "#/$defs/Fusion_csv" }, { "$ref": "#/$defs/Fusion_json" }, { "$ref": "#/$defs/Fusion_zip" }, { "$ref": "#/$defs/Panalytical_csv" }, { "$ref": "#/$defs/Panalytical_xrdml" }, { "$ref": "#/$defs/Panalytical_xy" }, { "$ref": "#/$defs/Phi_spe" }, { "$ref": "#/$defs/PicoLog_tc08" }, { "$ref": "#/$defs/Quadstar_sac" }, { "$ref": "#/$defs/Tomato_json" }, { "$ref": "#/$defs/Touchstone_snp" } ], "title": "Extractor" }, "input": { "$ref": "#/$defs/Input" }, "tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tag" }, "externaldate": { "anyOf": [ { "$ref": "#/$defs/ExternalDate" }, { "type": "null" } ], "default": null } }, "$defs": { "Agilent_ch": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "agilent.ch", "agilent-ch" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Agilent_ch", "type": "object" }, "Agilent_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "agilent.csv", "enum": [ "agilent.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Agilent_csv", "type": "object" }, "Agilent_dx": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "agilent.dx", "agilent-dx" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Agilent_dx", "type": "object" }, "Basic_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "basic.csv", "enum": [ "basic.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_1__filetype__Basic_csv__Parameters" } }, "required": [ "filetype" ], "title": "Basic_csv", "type": "object" }, "Drycal_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.csv", "enum": [ "drycal.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Drycal_csv", "type": "object" }, "Drycal_rtf": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.rtf", "enum": [ "drycal.rtf" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Drycal_rtf", "type": "object" }, "Drycal_txt": { "additionalProperties": false, "properties": { "filetype": { "const": "drycal.txt", "enum": [ "drycal.txt" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Drycal_txt", "type": "object" }, "EClab_mpr": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "eclab.mpr", "biologic-mpr" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EClab_mpr", "type": "object" }, "EClab_mpt": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "eclab.mpt", "biologic-mpt" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "windows-1252", "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EClab_mpt", "type": "object" }, "EZChrom_asc": { "additionalProperties": false, "properties": { "filetype": { "const": "ezchrom.asc", "enum": [ "ezchrom.asc" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "windows-1252", "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EZChrom_asc", "type": "object" }, "EZChrom_dat": { "additionalProperties": false, "properties": { "filetype": { "const": "ezchrom.dat", "enum": [ "ezchrom.dat" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EZChrom_dat", "type": "object" }, "EmpaLC_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "empalc.csv", "enum": [ "empalc.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EmpaLC_csv", "type": "object" }, "EmpaLC_xlsx": { "additionalProperties": false, "properties": { "filetype": { "const": "empalc.xlsx", "enum": [ "empalc.xlsx" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "EmpaLC_xlsx", "type": "object" }, "Example": { "additionalProperties": false, "properties": { "filetype": { "const": "example", "enum": [ "example" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_1__filetype__Example__Parameters" } }, "required": [ "filetype" ], "title": "Example", "type": "object" }, "ExternalDate": { "additionalProperties": false, "description": "Supply timestamping information that are external to the processed file.", "properties": { "using": { "anyOf": [ { "$ref": "#/$defs/ExternalDateFile" }, { "$ref": "#/$defs/ExternalDateFilename" }, { "$ref": "#/$defs/ExternalDateISOString" }, { "$ref": "#/$defs/ExternalDateUTSOffset" } ], "title": "Using" }, "mode": { "default": "add", "enum": [ "add", "replace" ], "title": "Mode", "type": "string" } }, "required": [ "using" ], "title": "ExternalDate", "type": "object" }, "ExternalDateFile": { "additionalProperties": false, "description": "Read external date information from file.", "properties": { "file": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_1__externaldate__ExternalDateFile__Content" } }, "required": [ "file" ], "title": "ExternalDateFile", "type": "object" }, "ExternalDateFilename": { "additionalProperties": false, "description": "Read external date information from the file name.", "properties": { "filename": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_1__externaldate__ExternalDateFilename__Content" } }, "required": [ "filename" ], "title": "ExternalDateFilename", "type": "object" }, "ExternalDateISOString": { "additionalProperties": false, "description": "Read a constant external date using an ISO-formatted string.", "properties": { "isostring": { "title": "Isostring", "type": "string" } }, "required": [ "isostring" ], "title": "ExternalDateISOString", "type": "object" }, "ExternalDateUTSOffset": { "additionalProperties": false, "description": "Read a constant external date using a Unix timestamp offset.", "properties": { "utsoffset": { "title": "Utsoffset", "type": "number" } }, "required": [ "utsoffset" ], "title": "ExternalDateUTSOffset", "type": "object" }, "FHI_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "fhimcpt.csv", "enum": [ "fhimcpt.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_5_1__filetype__FHI_csv__Parameters" } }, "required": [ "filetype" ], "title": "FHI_csv", "type": "object" }, "FHI_vna": { "additionalProperties": false, "properties": { "filetype": { "const": "fhimcpt.vna", "enum": [ "fhimcpt.vna" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "FHI_vna", "type": "object" }, "Fusion_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.csv", "enum": [ "fusion.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Fusion_csv", "type": "object" }, "Fusion_json": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.json", "enum": [ "fusion.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Fusion_json", "type": "object" }, "Fusion_zip": { "additionalProperties": false, "properties": { "filetype": { "const": "fusion.zip", "enum": [ "fusion.zip" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Fusion_zip", "type": "object" }, "Input": { "additionalProperties": false, "description": "Specification of input files/folders to be processed by the :class:`Step`.", "properties": { "folders": { "items": { "type": "string" }, "title": "Folders", "type": "array" }, "prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Prefix" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Suffix" }, "contains": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Contains" }, "exclude": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Exclude" } }, "required": [ "folders" ], "title": "Input", "type": "object" }, "Panalytical_csv": { "additionalProperties": false, "properties": { "filetype": { "const": "panalytical.csv", "enum": [ "panalytical.csv" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Panalytical_csv", "type": "object" }, "Panalytical_xrdml": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "panalytical.xrdml", "panalytical-xrdml" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Panalytical_xrdml", "type": "object" }, "Panalytical_xy": { "additionalProperties": false, "properties": { "filetype": { "const": "panalytical.xy", "enum": [ "panalytical.xy" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Panalytical_xy", "type": "object" }, "Phi_spe": { "additionalProperties": false, "properties": { "filetype": { "enum": [ "phi.spe", "phi-spe" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Phi_spe", "type": "object" }, "PicoLog_tc08": { "additionalProperties": false, "properties": { "filetype": { "const": "picolog.tc08", "enum": [ "picolog.tc08" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "PicoLog_tc08", "type": "object" }, "Quadstar_sac": { "additionalProperties": false, "properties": { "filetype": { "const": "quadstar.sac", "enum": [ "quadstar.sac" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Quadstar_sac", "type": "object" }, "TimeDate": { "additionalProperties": false, "description": "Timestamp from a separate date and/or time column.", "properties": { "date": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null }, "time": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null } }, "title": "TimeDate", "type": "object" }, "Timestamp": { "additionalProperties": false, "description": "Timestamp from a column containing a single timestamp string.", "properties": { "timestamp": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "timestamp" ], "title": "Timestamp", "type": "object" }, "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" }, "Tomato_json": { "additionalProperties": false, "properties": { "filetype": { "const": "tomato.json", "enum": [ "tomato.json" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Tomato_json", "type": "object" }, "Touchstone_snp": { "additionalProperties": false, "properties": { "filetype": { "const": "touchstone.snp", "enum": [ "touchstone.snp" ], "title": "Filetype", "type": "string" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Timezone" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Encoding" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Parameters" } }, "required": [ "filetype" ], "title": "Touchstone_snp", "type": "object" }, "UTS": { "additionalProperties": false, "description": "Timestamp from a column containing a Unix timestamp.", "properties": { "uts": { "$ref": "#/$defs/TimestampSpec" } }, "required": [ "uts" ], "title": "UTS", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_1__externaldate__ExternalDateFile__Content": { "additionalProperties": false, "properties": { "path": { "title": "Path", "type": "string" }, "type": { "title": "Type", "type": "string" }, "match": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Match" } }, "required": [ "path", "type" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_1__externaldate__ExternalDateFilename__Content": { "additionalProperties": false, "properties": { "format": { "title": "Format", "type": "string" }, "len": { "title": "Len", "type": "integer" } }, "required": [ "format", "len" ], "title": "Content", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_1__filetype__Basic_csv__Parameters": { "additionalProperties": false, "properties": { "sep": { "default": ",", "title": "Sep", "type": "string" }, "strip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Strip" }, "units": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Units" }, "timestamp": { "anyOf": [ { "$ref": "#/$defs/Timestamp" }, { "$ref": "#/$defs/TimeDate" }, { "$ref": "#/$defs/UTS" }, { "type": "null" } ], "default": null, "title": "Timestamp" } }, "title": "Parameters", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_1__filetype__Example__Parameters": { "additionalProperties": true, "properties": {}, "title": "Parameters", "type": "object" }, "dgbowl_schemas__yadg__dataschema_5_1__filetype__FHI_csv__Parameters": { "additionalProperties": false, "properties": { "timestamp": { "anyOf": [ { "$ref": "#/$defs/Timestamp" }, { "$ref": "#/$defs/TimeDate" }, { "$ref": "#/$defs/UTS" } ], "default": { "timestamp": { "format": "%Y-%m-%d-%H-%M-%S", "index": 0 } }, "title": "Timestamp" } }, "title": "Parameters", "type": "object" } }, "additionalProperties": false, "required": [ "extractor", "input" ] }
- Config:
extra: str = forbid
- field extractor: FileTypes [Required]
- field tag: str | None = None
- field externaldate: ExternalDate | None = None
dgbowl_schemas.yadg.dataschema_5_1.stepdefaults module
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.stepdefaults.StepDefaults
Bases:
BaseModelConfiguration of defaults applicable for all steps.
Show JSON schema
{ "title": "StepDefaults", "description": "Configuration of defaults applicable for all steps.", "type": "object", "properties": { "timezone": { "default": "localtime", "title": "Timezone", "type": "string" }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Locale" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "utf-8", "title": "Encoding" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- Validators:
- field timezone: str = 'localtime'
Global timezone specification.
Note
This should be set to the timezone where the measurements have been performed, as opposed to the timezone where
yadgis being executed. Otherwise timezone offsets may not be accounted for correctly.- Validated by:
- field locale: str | None = None
Global locale specification. Will default to current locale.
- Validated by:
- field encoding: str | None = 'utf-8'
Global filetype encoding. Will default to
utf-8.
dgbowl_schemas.yadg.dataschema_5_1.timestamp module
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.timestamp.TimestampSpec
Bases:
BaseModelSpecification of the column index and string format of the timestamp.
Show JSON schema
{ "title": "TimestampSpec", "description": "Specification of the column index and string format of the timestamp.", "type": "object", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field index: int | None = None
- field format: str | None = None
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.timestamp.Timestamp
Bases:
BaseModelTimestamp from a column containing a single timestamp string.
Show JSON schema
{ "title": "Timestamp", "description": "Timestamp from a column containing a single timestamp string.", "type": "object", "properties": { "timestamp": { "$ref": "#/$defs/TimestampSpec" } }, "$defs": { "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" } }, "additionalProperties": false, "required": [ "timestamp" ] }
- Config:
extra: str = forbid
- field timestamp: TimestampSpec [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.timestamp.UTS
Bases:
BaseModelTimestamp from a column containing a Unix timestamp.
Show JSON schema
{ "title": "UTS", "description": "Timestamp from a column containing a Unix timestamp.", "type": "object", "properties": { "uts": { "$ref": "#/$defs/TimestampSpec" } }, "$defs": { "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" } }, "additionalProperties": false, "required": [ "uts" ] }
- Config:
extra: str = forbid
- field uts: TimestampSpec [Required]
- pydantic model dgbowl_schemas.yadg.dataschema_5_1.timestamp.TimeDate
Bases:
BaseModelTimestamp from a separate date and/or time column.
Show JSON schema
{ "title": "TimeDate", "description": "Timestamp from a separate date and/or time column.", "type": "object", "properties": { "date": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null }, "time": { "anyOf": [ { "$ref": "#/$defs/TimestampSpec" }, { "type": "null" } ], "default": null } }, "$defs": { "TimestampSpec": { "additionalProperties": false, "description": "Specification of the column index and string format of the timestamp.", "properties": { "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Index" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Format" } }, "title": "TimestampSpec", "type": "object" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field date: TimestampSpec | None = None
- field time: TimestampSpec | None = None