`arelle.oim.tc.periods`¶

See COPYRIGHT.md for copyright information.

The xBRL-CSV period representations accepted by table constraints.

Module Contents¶

Functions¶

`period_time_zone_matches`
`parse_period`	Returns the start and end instants of a valid xBRL-CSV period, or None.

Data¶

`PERIOD_TYPE_PARSERS`
`PERIOD_TYPES`

API¶

arelle.oim.tc.periods.period_time_zone_matches(value: str, time_zone: bool) → bool¶

arelle.oim.tc.periods.PERIOD_TYPE_PARSERS: collections.abc.Mapping[str, arelle.oim.tc.periods._PeriodParser]¶: ‘MappingProxyType(…)’

arelle.oim.tc.periods.PERIOD_TYPES¶: ‘frozenset(…)’

arelle.oim.tc.periods.parse_period(value: str) → arelle.oim.tc.periods._PeriodBounds | None¶

Returns the start and end instants of a valid xBRL-CSV period, or None.

An instant period has the same start and end. Abbreviated periods and inclusive date ranges end at the start of the following day, so 2024-01-01..2024-01-31 ends at 2024-02-01T00:00:00.