parq_tools.utils.profile_utils.ColumnMetadata

class parq_tools.utils.profile_utils.ColumnMetadata(title=None, description=None, units=None, source=None)[source]

Structured metadata used to render profile column descriptions.

__init__(title=None, description=None, units=None, source=None)

Methods

__init__([title, description, units, source])

from_dict(data)

Create ColumnMetadata from supported metadata keys.

from_value(value)

Normalize a supported column metadata payload into ColumnMetadata.

to_description_string([default_title])

Render metadata into a single profile description string.

Attributes

description

source

title

units

classmethod from_dict(data)[source]

Create ColumnMetadata from supported metadata keys.

Return type:

ColumnMetadata

classmethod from_value(value)[source]

Normalize a supported column metadata payload into ColumnMetadata.

Return type:

ColumnMetadata

to_description_string(default_title=None)[source]

Render metadata into a single profile description string.

Return type:

str