Skip to content

parameterized_config_class

Classes#

ParameterizedConfigClass #

Bases: BaseModel

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`."
)
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 #
classname_looks_like_a_module(v: StrictStr) -> StrictStr
Source code in tsdat/config/utils/parameterized_config_class.py 
38
39
40
41
42
@validator("classname")
def classname_looks_like_a_module(cls, v: StrictStr) -> StrictStr:
    if "." not in v or not v.replace(".", "").replace("_", "").isalnum():
        raise ValueError(f"Classname '{v}' is not a valid classname.")
    return v
instantiate #
instantiate() -> Any

Instantiates and returns the class specified by the 'classname' parameter.

Returns:

Name Type Description
Any Any

An instance of the specified class.
Source code in tsdat/config/utils/parameterized_config_class.py 
44
45
46
47
48
49
50
51
52
53
54
55
def instantiate(self) -> Any:
    """------------------------------------------------------------------------------------
    Instantiates and returns the class specified by the 'classname' parameter.

    Returns:
        Any: An instance of the specified class.

    ------------------------------------------------------------------------------------
    """
    params = {field: getattr(self, field) for field in self.__fields_set__}
    _cls = import_string(params.pop("classname"))
    return _cls(**params)