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