dgbowl_schemas.yadg.dataschema_3_1 package
- pydantic model dgbowl_schemas.yadg.dataschema_3_1.DataSchema
Bases:
BaseModelA
pydantic.BaseModelimplementingDataSchema-3.1model introduced inyadg-7.0.Show JSON schema
{ "title": "DataSchema", "description": "A :class:`pydantic.BaseModel` implementing ``DataSchema-3.1`` model\nintroduced in ``yadg-7.0``.", "type": "object", "properties": { "version": { "const": "3.1", "title": "Version", "type": "string" }, "steps": { "items": { "discriminator": { "mapping": { "gctrace": "#/$defs/GCTrace", "meascsv": "#/$defs/MeasCSV", "qftrace": "#/$defs/QFTrace" }, "propertyName": "datagram" }, "oneOf": [ { "$ref": "#/$defs/MeasCSV" }, { "$ref": "#/$defs/QFTrace" }, { "$ref": "#/$defs/GCTrace" } ] }, "title": "Steps", "type": "array" } }, "$defs": { "GCTrace": { "additionalProperties": false, "properties": { "datagram": { "const": "gctrace", "title": "Datagram", "type": "string" }, "import": { "$ref": "#/$defs/Input" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_3_1__step__GCTrace__Params" }, "export": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Export" } }, "required": [ "datagram", "import" ], "title": "GCTrace", "type": "object" }, "Input": { "additionalProperties": false, "properties": { "files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Files" }, "folders": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Folders" }, "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" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "UTF-8", "title": "Encoding" } }, "title": "Input", "type": "object" }, "MeasCSV": { "additionalProperties": false, "properties": { "datagram": { "const": "meascsv", "title": "Datagram", "type": "string" }, "import": { "$ref": "#/$defs/Input" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_3_1__step__MeasCSV__Params" }, "export": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Export" } }, "required": [ "datagram", "import" ], "title": "MeasCSV", "type": "object" }, "QFTrace": { "additionalProperties": false, "properties": { "datagram": { "const": "qftrace", "title": "Datagram", "type": "string" }, "import": { "$ref": "#/$defs/Input" }, "parameters": { "$ref": "#/$defs/dgbowl_schemas__yadg__dataschema_3_1__step__QFTrace__Params" }, "export": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Export" } }, "required": [ "datagram", "import" ], "title": "QFTrace", "type": "object" }, "dgbowl_schemas__yadg__dataschema_3_1__step__GCTrace__Params": { "additionalProperties": false, "properties": { "calfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Calfile" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_3_1__step__MeasCSV__Params": { "additionalProperties": false, "properties": { "Tcalfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tcalfile" }, "MFCcalfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Mfccalfile" } }, "title": "Params", "type": "object" }, "dgbowl_schemas__yadg__dataschema_3_1__step__QFTrace__Params": { "additionalProperties": false, "properties": { "method": { "default": "kajfez", "enum": [ "naive", "lorentz", "kajfez", "q0refl" ], "title": "Method", "type": "string" }, "cutoff": { "default": 0.4, "title": "Cutoff", "type": "number" } }, "title": "Params", "type": "object" } }, "additionalProperties": false, "required": [ "version", "steps" ] }
- Config:
extra: str = forbid
- field version: Literal['3.1'] [Required]
- field steps: Sequence[MeasCSV | QFTrace | GCTrace] [Required]
Input commands for
yadg’s extractors, organised as aSequenceofSteps.
- update()
Submodules
dgbowl_schemas.yadg.dataschema_3_1.input module
- pydantic model dgbowl_schemas.yadg.dataschema_3_1.input.Input
Bases:
BaseModelShow JSON schema
{ "title": "Input", "type": "object", "properties": { "files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Files" }, "folders": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Folders" }, "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" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "UTF-8", "title": "Encoding" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- Validators:
files_or_folders»all fields
- field files: Sequence[str] | None = None
- Validated by:
- field folders: Sequence[str] | None = None
- Validated by:
- field prefix: str | None = None
- Validated by:
- field suffix: str | None = None
- Validated by:
- field contains: str | None = None
- Validated by:
- field exclude: str | None = None
- Validated by:
- field encoding: str | None = 'UTF-8'
- Validated by:
- validator files_or_folders » all fields
- paths() List[str]
dgbowl_schemas.yadg.dataschema_3_1.step module
- pydantic model dgbowl_schemas.yadg.dataschema_3_1.step.MeasCSV
Bases:
BaseModelShow JSON schema
{ "title": "MeasCSV", "type": "object", "properties": { "datagram": { "const": "meascsv", "title": "Datagram", "type": "string" }, "import": { "$ref": "#/$defs/Input" }, "parameters": { "$ref": "#/$defs/Params" }, "export": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Export" } }, "$defs": { "Input": { "additionalProperties": false, "properties": { "files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Files" }, "folders": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Folders" }, "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" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "UTF-8", "title": "Encoding" } }, "title": "Input", "type": "object" }, "Params": { "additionalProperties": false, "properties": { "Tcalfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tcalfile" }, "MFCcalfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Mfccalfile" } }, "title": "Params", "type": "object" } }, "additionalProperties": false, "required": [ "datagram", "import" ] }
- Config:
extra: str = forbid
populate_by_name: bool = True
validate_by_alias: bool = True
validate_by_name: bool = True
- pydantic model Params
Bases:
BaseModelShow JSON schema
{ "title": "Params", "type": "object", "properties": { "Tcalfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Tcalfile" }, "MFCcalfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Mfccalfile" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field Tcalfile: str | None = None
- field MFCcalfile: str | None = None
- field datagram: Literal['meascsv'] [Required]
- field export: str | None = None
- pydantic model dgbowl_schemas.yadg.dataschema_3_1.step.QFTrace
Bases:
BaseModelShow JSON schema
{ "title": "QFTrace", "type": "object", "properties": { "datagram": { "const": "qftrace", "title": "Datagram", "type": "string" }, "import": { "$ref": "#/$defs/Input" }, "parameters": { "$ref": "#/$defs/Params" }, "export": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Export" } }, "$defs": { "Input": { "additionalProperties": false, "properties": { "files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Files" }, "folders": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Folders" }, "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" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "UTF-8", "title": "Encoding" } }, "title": "Input", "type": "object" }, "Params": { "additionalProperties": false, "properties": { "method": { "default": "kajfez", "enum": [ "naive", "lorentz", "kajfez", "q0refl" ], "title": "Method", "type": "string" }, "cutoff": { "default": 0.4, "title": "Cutoff", "type": "number" } }, "title": "Params", "type": "object" } }, "additionalProperties": false, "required": [ "datagram", "import" ] }
- Config:
extra: str = forbid
populate_by_name: bool = True
validate_by_alias: bool = True
validate_by_name: bool = True
- pydantic model Params
Bases:
BaseModelShow JSON schema
{ "title": "Params", "type": "object", "properties": { "method": { "default": "kajfez", "enum": [ "naive", "lorentz", "kajfez", "q0refl" ], "title": "Method", "type": "string" }, "cutoff": { "default": 0.4, "title": "Cutoff", "type": "number" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field method: Literal['naive', 'lorentz', 'kajfez', 'q0refl'] = 'kajfez'
- field cutoff: float = 0.4
- field datagram: Literal['qftrace'] [Required]
- field export: str | None = None
- pydantic model dgbowl_schemas.yadg.dataschema_3_1.step.GCTrace
Bases:
BaseModelShow JSON schema
{ "title": "GCTrace", "type": "object", "properties": { "datagram": { "const": "gctrace", "title": "Datagram", "type": "string" }, "import": { "$ref": "#/$defs/Input" }, "parameters": { "$ref": "#/$defs/Params" }, "export": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Export" } }, "$defs": { "Input": { "additionalProperties": false, "properties": { "files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Files" }, "folders": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Folders" }, "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" }, "encoding": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "UTF-8", "title": "Encoding" } }, "title": "Input", "type": "object" }, "Params": { "additionalProperties": false, "properties": { "calfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Calfile" } }, "title": "Params", "type": "object" } }, "additionalProperties": false, "required": [ "datagram", "import" ] }
- Config:
extra: str = forbid
populate_by_name: bool = True
validate_by_alias: bool = True
validate_by_name: bool = True
- pydantic model Params
Bases:
BaseModelShow JSON schema
{ "title": "Params", "type": "object", "properties": { "calfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Calfile" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field calfile: str | None = None
- field datagram: Literal['gctrace'] [Required]
- field export: str | None = None