retrieved_variable

Classes:

Name	Description
RetrievedVariable	Tracks the name of the input variable and the converters to apply.

Attributes

Classes

RetrievedVariable

Bases: BaseModel

Tracks the name of the input variable and the converters to apply.

Methods:

Name	Description
add_units_converter

Attributes:

Name	Type	Description
data_converters	List[DataConverter]
name	Union[str, List[str]]
source	InputKey

Attributes

data_converters class-attribute instance-attribute

data_converters: List[DataConverter] = Field(
    default_factory=list
)

name instance-attribute

name: Union[str, List[str]]

source class-attribute instance-attribute

source: InputKey = ''

Functions

add_units_converter

add_units_converter(
    data_converters: list[DataConverter],
) -> list[DataConverter]

Source code in tsdat/io/base/retrieved_variable.py

@validator("data_converters", always=True)
def add_units_converter(
    cls, data_converters: list[DataConverter]
) -> list[DataConverter]:
    from ..converters.units_converter import UnitsConverter

    if not any(isinstance(dc, UnitsConverter) for dc in data_converters):
        data_converters.append(UnitsConverter())
    return data_converters