Dataframes API¶

general_manager.dataframes re-exports expand_measurements, collapse_measurements, to_dataframe, from_dataframe, DataFrameMeasurementError, InvalidDataFrameMeasurementValueError, MeasurementDataFrameColumnCollisionError, MissingMeasurementDataFrameColumnError, and PandasNotInstalledError.

general_manager.dataframes.measurements ¶

Helpers for expanding row-level Measurement values into dataframe columns.

DataFrameLike ¶

Bases: Protocol

Minimal dataframe interface needed to collapse measurement columns.

to_dict ¶

to_dict(orient='dict')

Return dataframe rows as dictionaries.

DataFrameMeasurementError ¶

Bases: ValueError

Base error for dataframe measurement expansion failures.

PandasNotInstalledError ¶

Bases: ImportError

Raised when pandas-specific dataframe helpers are used without pandas.

InvalidDataFrameMeasurementValueError ¶

Bases: DataFrameMeasurementError

Raised when a configured measurement field contains an invalid value.

MeasurementDataFrameColumnCollisionError ¶

Bases: DataFrameMeasurementError

Raised when measurement expansion or collapse would overwrite row data.

MissingMeasurementDataFrameColumnError ¶

Bases: DataFrameMeasurementError

Raised when a generated measurement column is required but absent.

expand_measurements ¶

expand_measurements(rows, *, measurement_fields=None)

Expand Measurement values in mapping-like rows into value/unit columns.

collapse_measurements ¶

collapse_measurements(rows, *, measurement_fields)

Collapse value/unit dataframe columns back into Measurement values.

to_dataframe ¶

to_dataframe(
    rows, *, measurement_fields=None, **dataframe_kwargs
)

Expand measurement values and build a pandas DataFrame.

from_dataframe ¶

from_dataframe(dataframe, *, measurement_fields)

Collapse measurement value/unit columns from a dataframe-like object.