TemplateLocation#

class rojak.core.sources.TemplateLocation(*, storage_options=<factory>, type='template', root, template, time_window, frequency='1D', on_missing='raise')[source]#

Files under root named by template formatted with each time step in time_window

Example

template="{time:%Y}/{time:%m}/{time:%Y-%m-%d}.nc" with a daily frequency over January 2024 resolves to 2024/01/2024-01-01.nc … 2024/01/2024-01-31.nc. Time steps that format to the same name (e.g. a monthly-file template with an hourly frequency) are de-duplicated.

Parameters:

storage_options (dict[str, Any])
type (Literal['template'])
root (str)
template (str)
time_window (Limits[datetime])
frequency (str)
on_missing (Literal['raise', 'skip'])

__init__(**data)[source]#

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:: data (Any)
Return type:: None

Methods

`__init__`(**data)	Create a new model by parsing and validating input data from keyword arguments.
`check_template_and_window`()	Validate that `template` uses `time`, `time_window` is increasing, and a local root exists
`construct`([_fields_set])
`copy`(*[, include, exclude, update, deep])	Returns a copy of the model.
`dict`(*[, include, exclude, by_alias, ...])
`from_orm`(obj)
`json`(*[, include, exclude, by_alias, ...])
`model_construct`([_fields_set])	Creates a new instance of the Model class with validated data.
`model_copy`(*[, update, deep])	!!! abstract "Usage Documentation"
`model_dump`(*[, mode, include, exclude, ...])	!!! abstract "Usage Documentation"
`model_dump_json`(*[, indent, ensure_ascii, ...])	!!! abstract "Usage Documentation"
`model_json_schema`([by_alias, ref_template, ...])	Generates a JSON schema for a model class.
`model_parametrized_name`(params)	Compute the class name for parametrizations of generic classes.
`model_post_init`(context, /)	Override this method to perform additional initialization after __init__ and model_construct.
`model_rebuild`(*[, force, raise_errors, ...])	Try to rebuild the pydantic-core schema for the model.
`model_validate`(obj, *[, strict, extra, ...])	Validate a pydantic model instance.
`model_validate_json`(json_data, *[, strict, ...])	!!! abstract "Usage Documentation"
`model_validate_strings`(obj, *[, strict, ...])	Validate the given object with string data against the Pydantic model.
`parse_file`(path, *[, content_type, ...])
`parse_obj`(obj)
`parse_raw`(b, *[, content_type, encoding, ...])
`schema`([by_alias, ref_template])
`schema_json`(*[, by_alias, ref_template])
`time_steps`()	Time steps in `time_window` (inclusive) at `frequency`
`update_forward_refs`(**localns)
`validate`(value)

Attributes

`model_computed_fields`
`model_config`	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
`model_extra`	Get extra fields set during validation.
`model_fields`
`model_fields_set`	Returns the set of fields that have been explicitly set on this model instance.
`type`
`root`
`template`
`time_window`
`frequency`
`on_missing`
`storage_options`