parameterized_config_class
Classes:
Name | Description |
---|---|
ParameterizedConfigClass |
|
Classes#
ParameterizedConfigClass #
Bases: BaseModel
Methods:
Name | Description |
---|---|
classname_looks_like_a_module |
|
instantiate |
|
Attributes:
Name | Type | Description |
---|---|---|
classname |
StrictStr
|
The dotted module path to the pipeline that the specified configurations should |
parameters |
Dict[str, Any]
|
|
Attributes#
classname
class-attribute
instance-attribute
#
classname: StrictStr = Field(
description="The import path to the Python class that should be used, e.g., if your import statement looks like `from foo.bar import Baz`, then your classname would be `foo.bar.Baz`."
)
The dotted module path to the pipeline that the specified configurations should apply to. To use the built-in IngestPipeline, for example, you would set 'tsdat.pipeline.pipelines.IngestPipeline' as the classname.
parameters
class-attribute
instance-attribute
#
parameters: Dict[str, Any] = Field(
{},
description="Optional dictionary that will be passed to the Python class specified by 'classname' when it is instantiated. If the object is a tsdat class, then the parameters will typically be made accessible under the `params` property on an instance of the class. See the documentation for individual classes for more information.",
)
Functions#
classname_looks_like_a_module #
Source code in tsdat/config/utils/parameterized_config_class.py
instantiate #
Instantiates and returns the class specified by the 'classname' parameter.
Returns:
Name | Type | Description |
---|---|---|
Any |
Any
|
An instance of the specified class. |