dgbowl_schemas.dgpost.recipe_1_0 package
- pydantic model dgbowl_schemas.dgpost.recipe_1_0.Recipe
Bases:
BaseModelShow JSON schema
{ "title": "Recipe", "type": "object", "properties": { "version": { "enum": [ "v1.0", "1.0", "1.1", "2.0" ], "title": "Version", "type": "string" }, "load": { "anyOf": [ { "items": { "$ref": "#/$defs/Load" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Load" }, "extract": { "anyOf": [ { "items": { "$ref": "#/$defs/Extract" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Extract" }, "transform": { "anyOf": [ { "items": { "$ref": "#/$defs/Transform" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Transform" }, "plot": { "anyOf": [ { "items": { "$ref": "#/$defs/Plot" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Plot" }, "save": { "anyOf": [ { "items": { "$ref": "#/$defs/Save" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Save" } }, "$defs": { "At": { "additionalProperties": false, "properties": { "steps": { "default": null, "items": { "type": "string" }, "title": "Steps", "type": "array" }, "indices": { "default": null, "items": { "type": "integer" }, "title": "Indices", "type": "array" }, "timestamps": { "default": null, "items": { "type": "number" }, "title": "Timestamps", "type": "array" } }, "title": "At", "type": "object" }, "AxArgs": { "additionalProperties": true, "properties": { "cols": { "anyOf": [ { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "type": "array" }, { "type": "null" } ], "default": null, "title": "Cols" }, "rows": { "anyOf": [ { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "type": "array" }, { "type": "null" } ], "default": null, "title": "Rows" }, "series": { "items": { "$ref": "#/$defs/Series" }, "title": "Series", "type": "array" }, "methods": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Methods" }, "legend": { "default": false, "title": "Legend", "type": "boolean" } }, "required": [ "series" ], "title": "AxArgs", "type": "object" }, "Column": { "additionalProperties": false, "properties": { "key": { "title": "Key", "type": "string" }, "as": { "title": "As", "type": "string" } }, "required": [ "key", "as" ], "title": "Column", "type": "object" }, "Constant": { "additionalProperties": false, "properties": { "value": { "title": "Value" }, "as": { "title": "As", "type": "string" }, "units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Units" } }, "required": [ "value", "as" ], "title": "Constant", "type": "object" }, "Extract": { "additionalProperties": false, "properties": { "into": { "title": "Into", "type": "string" }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "From" }, "at": { "anyOf": [ { "$ref": "#/$defs/At" }, { "type": "null" } ], "default": null }, "constants": { "anyOf": [ { "items": { "$ref": "#/$defs/Constant" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Constants" }, "columns": { "anyOf": [ { "items": { "$ref": "#/$defs/Column" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Columns" } }, "required": [ "into" ], "title": "Extract", "type": "object" }, "Load": { "additionalProperties": false, "properties": { "as": { "title": "As", "type": "string" }, "path": { "title": "Path", "type": "string" }, "type": { "default": "datagram", "enum": [ "datagram", "table" ], "title": "Type", "type": "string" }, "check": { "default": true, "title": "Check", "type": "boolean" } }, "required": [ "as", "path" ], "title": "Load", "type": "object" }, "Plot": { "additionalProperties": false, "properties": { "table": { "title": "Table", "type": "string" }, "ax_args": { "items": { "$ref": "#/$defs/AxArgs" }, "title": "Ax Args", "type": "array" }, "fig_args": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Fig Args" }, "style": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Style" }, "nrows": { "default": 1, "title": "Nrows", "type": "integer" }, "ncols": { "default": 1, "title": "Ncols", "type": "integer" }, "save": { "anyOf": [ { "$ref": "#/$defs/PlotSave" }, { "type": "null" } ], "default": null } }, "required": [ "table", "ax_args" ], "title": "Plot", "type": "object" }, "PlotSave": { "additionalProperties": true, "properties": { "as": { "title": "As", "type": "string" }, "tight_layout": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Tight Layout" } }, "required": [ "as" ], "title": "PlotSave", "type": "object" }, "Save": { "additionalProperties": false, "properties": { "table": { "title": "Table", "type": "string" }, "as": { "title": "As", "type": "string" }, "type": { "default": null, "enum": [ "pkl", "json", "xlsx", "csv" ], "title": "Type", "type": "string" }, "sigma": { "default": true, "title": "Sigma", "type": "boolean" } }, "required": [ "table", "as" ], "title": "Save", "type": "object" }, "Series": { "additionalProperties": true, "properties": { "y": { "title": "Y", "type": "string" }, "x": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "X" }, "kind": { "default": "scatter", "enum": [ "scatter", "line", "errorbar" ], "title": "Kind", "type": "string" }, "index": { "anyOf": [ { "$ref": "#/$defs/SeriesIndex" }, { "type": "null" } ], "default": { "from_zero": true, "to_units": null } } }, "required": [ "y" ], "title": "Series", "type": "object" }, "SeriesIndex": { "additionalProperties": false, "properties": { "from_zero": { "default": true, "title": "From Zero", "type": "boolean" }, "to_units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "To Units" } }, "title": "SeriesIndex", "type": "object" }, "Transform": { "additionalProperties": false, "properties": { "table": { "title": "Table", "type": "string" }, "with": { "title": "With", "type": "string" }, "using": { "items": { "additionalProperties": true, "type": "object" }, "title": "Using", "type": "array" } }, "required": [ "table", "with", "using" ], "title": "Transform", "type": "object" } }, "additionalProperties": false, "required": [ "version" ] }
- Config:
extra: str = forbid
- field version: Literal['v1.0', '1.0', '1.1', '2.0'] [Required]
- update()
Submodules
dgbowl_schemas.dgpost.recipe_1_0.extract module
- pydantic model dgbowl_schemas.dgpost.recipe_1_0.extract.At
Bases:
BaseModelShow JSON schema
{ "title": "At", "type": "object", "properties": { "steps": { "default": null, "items": { "type": "string" }, "title": "Steps", "type": "array" }, "indices": { "default": null, "items": { "type": "integer" }, "title": "Indices", "type": "array" }, "timestamps": { "default": null, "items": { "type": "number" }, "title": "Timestamps", "type": "array" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- Validators:
check_one_input»all fields
- field steps: Sequence[str] = None
- Validated by:
- field indices: Sequence[int] = None
- Validated by:
- field timestamps: Sequence[float] = None
- Validated by:
- validator check_one_input » all fields
- pydantic model dgbowl_schemas.dgpost.recipe_1_0.extract.Constant
Bases:
BaseModelShow JSON schema
{ "title": "Constant", "type": "object", "properties": { "value": { "title": "Value" }, "as": { "title": "As", "type": "string" }, "units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Units" } }, "additionalProperties": false, "required": [ "value", "as" ] }
- Config:
extra: str = forbid
- field value: Any [Required]
- field as_: str [Required] (alias 'as')
- field units: str | None = None
- pydantic model dgbowl_schemas.dgpost.recipe_1_0.extract.Column
Bases:
BaseModelShow JSON schema
{ "title": "Column", "type": "object", "properties": { "key": { "title": "Key", "type": "string" }, "as": { "title": "As", "type": "string" } }, "additionalProperties": false, "required": [ "key", "as" ] }
- Config:
extra: str = forbid
- field key: str [Required]
- field as_: str [Required] (alias 'as')
- pydantic model dgbowl_schemas.dgpost.recipe_1_0.extract.Extract
Bases:
BaseModelShow JSON schema
{ "title": "Extract", "type": "object", "properties": { "into": { "title": "Into", "type": "string" }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "From" }, "at": { "anyOf": [ { "$ref": "#/$defs/At" }, { "type": "null" } ], "default": null }, "constants": { "anyOf": [ { "items": { "$ref": "#/$defs/Constant" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Constants" }, "columns": { "anyOf": [ { "items": { "$ref": "#/$defs/Column" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Columns" } }, "$defs": { "At": { "additionalProperties": false, "properties": { "steps": { "default": null, "items": { "type": "string" }, "title": "Steps", "type": "array" }, "indices": { "default": null, "items": { "type": "integer" }, "title": "Indices", "type": "array" }, "timestamps": { "default": null, "items": { "type": "number" }, "title": "Timestamps", "type": "array" } }, "title": "At", "type": "object" }, "Column": { "additionalProperties": false, "properties": { "key": { "title": "Key", "type": "string" }, "as": { "title": "As", "type": "string" } }, "required": [ "key", "as" ], "title": "Column", "type": "object" }, "Constant": { "additionalProperties": false, "properties": { "value": { "title": "Value" }, "as": { "title": "As", "type": "string" }, "units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Units" } }, "required": [ "value", "as" ], "title": "Constant", "type": "object" } }, "additionalProperties": false, "required": [ "into" ] }
- Config:
extra: str = forbid
populate_by_name: bool = True
validate_by_alias: bool = True
validate_by_name: bool = True
- Validators:
check_one_input»all fields
- field into: str [Required]
- Validated by:
- field from_: str | None = None (alias 'from')
- Validated by:
- validator check_one_input » all fields
dgbowl_schemas.dgpost.recipe_1_0.load module
- pydantic model dgbowl_schemas.dgpost.recipe_1_0.load.Load
Bases:
BaseModelShow JSON schema
{ "title": "Load", "type": "object", "properties": { "as": { "title": "As", "type": "string" }, "path": { "title": "Path", "type": "string" }, "type": { "default": "datagram", "enum": [ "datagram", "table" ], "title": "Type", "type": "string" }, "check": { "default": true, "title": "Check", "type": "boolean" } }, "additionalProperties": false, "required": [ "as", "path" ] }
- Config:
extra: str = forbid
populate_by_name: bool = True
validate_by_alias: bool = True
validate_by_name: bool = True
- field as_: str [Required] (alias 'as')
- field path: str [Required]
- field type: Literal['datagram', 'table'] = 'datagram'
- field check: bool = True
dgbowl_schemas.dgpost.recipe_1_0.plot module
- pydantic model dgbowl_schemas.dgpost.recipe_1_0.plot.SeriesIndex
Bases:
BaseModelShow JSON schema
{ "title": "SeriesIndex", "type": "object", "properties": { "from_zero": { "default": true, "title": "From Zero", "type": "boolean" }, "to_units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "To Units" } }, "additionalProperties": false }
- Config:
extra: str = forbid
- field from_zero: bool = True
- field to_units: str | None = None
- pydantic model dgbowl_schemas.dgpost.recipe_1_0.plot.Series
Bases:
BaseModelShow JSON schema
{ "title": "Series", "type": "object", "properties": { "y": { "title": "Y", "type": "string" }, "x": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "X" }, "kind": { "default": "scatter", "enum": [ "scatter", "line", "errorbar" ], "title": "Kind", "type": "string" }, "index": { "anyOf": [ { "$ref": "#/$defs/SeriesIndex" }, { "type": "null" } ], "default": { "from_zero": true, "to_units": null } } }, "$defs": { "SeriesIndex": { "additionalProperties": false, "properties": { "from_zero": { "default": true, "title": "From Zero", "type": "boolean" }, "to_units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "To Units" } }, "title": "SeriesIndex", "type": "object" } }, "additionalProperties": true, "required": [ "y" ] }
- Config:
extra: str = allow
- field y: str [Required]
- field x: str | None = None
- field kind: Literal['scatter', 'line', 'errorbar'] = 'scatter'
- field index: SeriesIndex | None = SeriesIndex(from_zero=True, to_units=None)
- pydantic model dgbowl_schemas.dgpost.recipe_1_0.plot.AxArgs
Bases:
BaseModelShow JSON schema
{ "title": "AxArgs", "type": "object", "properties": { "cols": { "anyOf": [ { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "type": "array" }, { "type": "null" } ], "default": null, "title": "Cols" }, "rows": { "anyOf": [ { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "type": "array" }, { "type": "null" } ], "default": null, "title": "Rows" }, "series": { "items": { "$ref": "#/$defs/Series" }, "title": "Series", "type": "array" }, "methods": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Methods" }, "legend": { "default": false, "title": "Legend", "type": "boolean" } }, "$defs": { "Series": { "additionalProperties": true, "properties": { "y": { "title": "Y", "type": "string" }, "x": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "X" }, "kind": { "default": "scatter", "enum": [ "scatter", "line", "errorbar" ], "title": "Kind", "type": "string" }, "index": { "anyOf": [ { "$ref": "#/$defs/SeriesIndex" }, { "type": "null" } ], "default": { "from_zero": true, "to_units": null } } }, "required": [ "y" ], "title": "Series", "type": "object" }, "SeriesIndex": { "additionalProperties": false, "properties": { "from_zero": { "default": true, "title": "From Zero", "type": "boolean" }, "to_units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "To Units" } }, "title": "SeriesIndex", "type": "object" } }, "additionalProperties": true, "required": [ "series" ] }
- Config:
extra: str = allow
- field cols: Tuple[int, int] | None = None
- field rows: Tuple[int, int] | None = None
- field methods: Dict[str, Any] | None = None
- field legend: bool = False
- pydantic model dgbowl_schemas.dgpost.recipe_1_0.plot.PlotSave
Bases:
BaseModelShow JSON schema
{ "title": "PlotSave", "type": "object", "properties": { "as": { "title": "As", "type": "string" }, "tight_layout": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Tight Layout" } }, "additionalProperties": true, "required": [ "as" ] }
- Config:
extra: str = allow
populate_by_name: bool = True
validate_by_alias: bool = True
validate_by_name: bool = True
- field as_: str [Required] (alias 'as')
- field tight_layout: Dict[str, Any] | None = None
- pydantic model dgbowl_schemas.dgpost.recipe_1_0.plot.Plot
Bases:
BaseModelShow JSON schema
{ "title": "Plot", "type": "object", "properties": { "table": { "title": "Table", "type": "string" }, "ax_args": { "items": { "$ref": "#/$defs/AxArgs" }, "title": "Ax Args", "type": "array" }, "fig_args": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Fig Args" }, "style": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Style" }, "nrows": { "default": 1, "title": "Nrows", "type": "integer" }, "ncols": { "default": 1, "title": "Ncols", "type": "integer" }, "save": { "anyOf": [ { "$ref": "#/$defs/PlotSave" }, { "type": "null" } ], "default": null } }, "$defs": { "AxArgs": { "additionalProperties": true, "properties": { "cols": { "anyOf": [ { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "type": "array" }, { "type": "null" } ], "default": null, "title": "Cols" }, "rows": { "anyOf": [ { "maxItems": 2, "minItems": 2, "prefixItems": [ { "type": "integer" }, { "type": "integer" } ], "type": "array" }, { "type": "null" } ], "default": null, "title": "Rows" }, "series": { "items": { "$ref": "#/$defs/Series" }, "title": "Series", "type": "array" }, "methods": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Methods" }, "legend": { "default": false, "title": "Legend", "type": "boolean" } }, "required": [ "series" ], "title": "AxArgs", "type": "object" }, "PlotSave": { "additionalProperties": true, "properties": { "as": { "title": "As", "type": "string" }, "tight_layout": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "default": null, "title": "Tight Layout" } }, "required": [ "as" ], "title": "PlotSave", "type": "object" }, "Series": { "additionalProperties": true, "properties": { "y": { "title": "Y", "type": "string" }, "x": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "X" }, "kind": { "default": "scatter", "enum": [ "scatter", "line", "errorbar" ], "title": "Kind", "type": "string" }, "index": { "anyOf": [ { "$ref": "#/$defs/SeriesIndex" }, { "type": "null" } ], "default": { "from_zero": true, "to_units": null } } }, "required": [ "y" ], "title": "Series", "type": "object" }, "SeriesIndex": { "additionalProperties": false, "properties": { "from_zero": { "default": true, "title": "From Zero", "type": "boolean" }, "to_units": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "To Units" } }, "title": "SeriesIndex", "type": "object" } }, "additionalProperties": false, "required": [ "table", "ax_args" ] }
- Config:
extra: str = forbid
- field table: str [Required]
- field fig_args: Dict[str, Any] | None = None
- field style: Dict[str, Any] | None = None
- field nrows: int = 1
- field ncols: int = 1
dgbowl_schemas.dgpost.recipe_1_0.save module
- pydantic model dgbowl_schemas.dgpost.recipe_1_0.save.Save
Bases:
BaseModelShow JSON schema
{ "title": "Save", "type": "object", "properties": { "table": { "title": "Table", "type": "string" }, "as": { "title": "As", "type": "string" }, "type": { "default": null, "enum": [ "pkl", "json", "xlsx", "csv" ], "title": "Type", "type": "string" }, "sigma": { "default": true, "title": "Sigma", "type": "boolean" } }, "additionalProperties": false, "required": [ "table", "as" ] }
- Config:
extra: str = forbid
populate_by_name: bool = True
validate_by_alias: bool = True
validate_by_name: bool = True
- field table: str [Required]
- field as_: str [Required] (alias 'as')
- field type: Literal['pkl', 'json', 'xlsx', 'csv'] = None
- field sigma: bool = True
dgbowl_schemas.dgpost.recipe_1_0.transform module
- pydantic model dgbowl_schemas.dgpost.recipe_1_0.transform.Transform
Bases:
BaseModelShow JSON schema
{ "title": "Transform", "type": "object", "properties": { "table": { "title": "Table", "type": "string" }, "with": { "title": "With", "type": "string" }, "using": { "items": { "additionalProperties": true, "type": "object" }, "title": "Using", "type": "array" } }, "additionalProperties": false, "required": [ "table", "with", "using" ] }
- Config:
extra: str = forbid
populate_by_name: bool = True
validate_by_alias: bool = True
validate_by_name: bool = True
- field table: str [Required]
- field with_: str [Required] (alias 'with')
- field using: Sequence[Dict[str, Any]] [Required]