# {py:mod}`arelle.oim.tc.metadata.parser`

```{py:module} arelle.oim.tc.metadata.parser
```

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

## Module Contents

### Classes

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

* - {py:obj}`TCMetadataParseError <arelle.oim.tc.metadata.parser.TCMetadataParseError>`
  - ```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCMetadataParseError
    :summary:
    ```
* - {py:obj}`TCMetadataParseTypeError <arelle.oim.tc.metadata.parser.TCMetadataParseTypeError>`
  - ```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCMetadataParseTypeError
    :summary:
    ```
* - {py:obj}`TCMetadataUnknownPropertiesError <arelle.oim.tc.metadata.parser.TCMetadataUnknownPropertiesError>`
  - ```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCMetadataUnknownPropertiesError
    :summary:
    ```
* - {py:obj}`TCMetadataMissingPropertiesError <arelle.oim.tc.metadata.parser.TCMetadataMissingPropertiesError>`
  - ```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCMetadataMissingPropertiesError
    :summary:
    ```
* - {py:obj}`TCMetadataMisplacedTCPropertiesError <arelle.oim.tc.metadata.parser.TCMetadataMisplacedTCPropertiesError>`
  - ```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCMetadataMisplacedTCPropertiesError
    :summary:
    ```
* - {py:obj}`TCParseResult <arelle.oim.tc.metadata.parser.TCParseResult>`
  - ```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCParseResult
    :summary:
    ```
````

### Functions

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

* - {py:obj}`parse_tc_metadata <arelle.oim.tc.metadata.parser.parse_tc_metadata>`
  - ```{autodoc2-docstring} arelle.oim.tc.metadata.parser.parse_tc_metadata
    :summary:
    ```
````

### Data

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

* - {py:obj}`T <arelle.oim.tc.metadata.parser.T>`
  - ```{autodoc2-docstring} arelle.oim.tc.metadata.parser.T
    :summary:
    ```
````

### API

````{py:class} TCMetadataParseError(message: str, *path: str, code: str = TCME_INVALID_JSON_STRUCTURE)
:canonical: arelle.oim.tc.metadata.parser.TCMetadataParseError

Bases: {py:obj}`arelle.oim.tc.metadata.common.TCMetadataValidationError`

```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCMetadataParseError
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCMetadataParseError.__init__
```

````

````{py:class} TCMetadataParseTypeError(expected_type: type, actual_value: typing.Any, *path: str)
:canonical: arelle.oim.tc.metadata.parser.TCMetadataParseTypeError

Bases: {py:obj}`arelle.oim.tc.metadata.parser.TCMetadataParseError`

```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCMetadataParseTypeError
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCMetadataParseTypeError.__init__
```

````

````{py:class} TCMetadataUnknownPropertiesError(property_names: list[str])
:canonical: arelle.oim.tc.metadata.parser.TCMetadataUnknownPropertiesError

Bases: {py:obj}`arelle.oim.tc.metadata.parser.TCMetadataParseError`

```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCMetadataUnknownPropertiesError
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCMetadataUnknownPropertiesError.__init__
```

````

````{py:class} TCMetadataMissingPropertiesError(property_names: list[str])
:canonical: arelle.oim.tc.metadata.parser.TCMetadataMissingPropertiesError

Bases: {py:obj}`arelle.oim.tc.metadata.parser.TCMetadataParseError`

```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCMetadataMissingPropertiesError
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCMetadataMissingPropertiesError.__init__
```

````

````{py:class} TCMetadataMisplacedTCPropertiesError(*path: str)
:canonical: arelle.oim.tc.metadata.parser.TCMetadataMisplacedTCPropertiesError

Bases: {py:obj}`arelle.oim.tc.metadata.parser.TCMetadataParseError`

```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCMetadataMisplacedTCPropertiesError
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCMetadataMisplacedTCPropertiesError.__init__
```

````

`````{py:class} TCParseResult
:canonical: arelle.oim.tc.metadata.parser.TCParseResult

```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCParseResult
```

````{py:attribute} metadata
:canonical: arelle.oim.tc.metadata.parser.TCParseResult.metadata
:type: arelle.oim.tc.metadata.model.TCMetadata | None
:value: >
   None

```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCParseResult.metadata
```

````

````{py:attribute} errors
:canonical: arelle.oim.tc.metadata.parser.TCParseResult.errors
:type: tuple[arelle.oim.tc.metadata.parser.TCMetadataParseError, ...]
:value: >
   None

```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCParseResult.errors
```

````

````{py:property} is_valid
:canonical: arelle.oim.tc.metadata.parser.TCParseResult.is_valid
:type: bool

```{autodoc2-docstring} arelle.oim.tc.metadata.parser.TCParseResult.is_valid
```

````

`````

````{py:function} parse_tc_metadata(oim_object: dict[str, typing.Any], namespaces: dict[str, str]) -> arelle.oim.tc.metadata.parser.TCParseResult
:canonical: arelle.oim.tc.metadata.parser.parse_tc_metadata

```{autodoc2-docstring} arelle.oim.tc.metadata.parser.parse_tc_metadata
```
````

````{py:data} T
:canonical: arelle.oim.tc.metadata.parser.T
:value: >
   'TypeVar(...)'

```{autodoc2-docstring} arelle.oim.tc.metadata.parser.T
```

````