mt_metadata.common.time_period

Classes

TimePeriod

Time span of a period of time.

TimePeriodDate

Time span of a period of time.

Module Contents

class mt_metadata.common.time_period.TimePeriod(**data)

Bases: mt_metadata.base.MetadataBase

Time span of a period of time.

end: Annotated[str | float | int | numpy.datetime64 | pandas.Timestamp | mt_metadata.common.mttime.MTime, Field(default_factory=lambda: MTime(time_stamp='1980-01-01T00:00:00+00:00'), description='End date and time of collection in UTC.', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': '2020-02-04T16:23:45.453670+00:00', 'type': 'string'})]
start: Annotated[str | float | int | numpy.datetime64 | pandas.Timestamp | mt_metadata.common.mttime.MTime, Field(default_factory=lambda: MTime(), description='Start date and time of collection in UTC.', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': '2020-02-01T09:23:45.453670+00:00', 'type': 'string'})]
classmethod validate_time(value, info)

Validate that the value is a valid time.

start_is_default()

Check if the start time is the default time.

end_is_default()

Check if the end time is the default time.

class mt_metadata.common.time_period.TimePeriodDate(**data)

Bases: mt_metadata.base.MetadataBase

Time span of a period of time.

end_date: Annotated[str | float | int | numpy.datetime64 | pandas.Timestamp | mt_metadata.common.mttime.MTime | mt_metadata.common.mttime.MDate, Field(default_factory=lambda: MDate(time_stamp='1980-01-01'), description='End date and time of collection in UTC.', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': '2020-02-04', 'type': 'string'})]
start_date: Annotated[str | float | int | numpy.datetime64 | pandas.Timestamp | mt_metadata.common.mttime.MTime | mt_metadata.common.mttime.MDate, Field(default_factory=lambda: MDate(time_stamp='1980-01-01'), description='Start date and time of collection in UTC.', alias=None, json_schema_extra={'units': None, 'required': True, 'examples': '2020-02-01', 'type': 'string'})]
classmethod validate_time(value, info)

Validate that the value is a valid time.

start_is_default()

Check if the start time is the default time.

end_is_default()

Check if the end time is the default time.