# {py:mod}`arelle.oim.tc.periods`

```{py:module} arelle.oim.tc.periods
```

```{autodoc2-docstring} arelle.oim.tc.periods
:allowtitles:
```

## Module Contents

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`period_time_zone_matches <arelle.oim.tc.periods.period_time_zone_matches>`
  - ```{autodoc2-docstring} arelle.oim.tc.periods.period_time_zone_matches
    :summary:
    ```
* - {py:obj}`parse_period <arelle.oim.tc.periods.parse_period>`
  - ```{autodoc2-docstring} arelle.oim.tc.periods.parse_period
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`PERIOD_TYPE_PARSERS <arelle.oim.tc.periods.PERIOD_TYPE_PARSERS>`
  - ```{autodoc2-docstring} arelle.oim.tc.periods.PERIOD_TYPE_PARSERS
    :summary:
    ```
* - {py:obj}`PERIOD_TYPES <arelle.oim.tc.periods.PERIOD_TYPES>`
  - ```{autodoc2-docstring} arelle.oim.tc.periods.PERIOD_TYPES
    :summary:
    ```
````

### API

````{py:function} period_time_zone_matches(value: str, time_zone: bool) -> bool
:canonical: arelle.oim.tc.periods.period_time_zone_matches

```{autodoc2-docstring} arelle.oim.tc.periods.period_time_zone_matches
```
````

````{py:data} PERIOD_TYPE_PARSERS
:canonical: arelle.oim.tc.periods.PERIOD_TYPE_PARSERS
:type: collections.abc.Mapping[str, arelle.oim.tc.periods._PeriodParser]
:value: >
   'MappingProxyType(...)'

```{autodoc2-docstring} arelle.oim.tc.periods.PERIOD_TYPE_PARSERS
```

````

````{py:data} PERIOD_TYPES
:canonical: arelle.oim.tc.periods.PERIOD_TYPES
:value: >
   'frozenset(...)'

```{autodoc2-docstring} arelle.oim.tc.periods.PERIOD_TYPES
```

````

````{py:function} parse_period(value: str) -> arelle.oim.tc.periods._PeriodBounds | None
:canonical: arelle.oim.tc.periods.parse_period

```{autodoc2-docstring} arelle.oim.tc.periods.parse_period
```
````