arelle.oim.tc.metadata.parser

See COPYRIGHT.md for copyright information.

Module Contents

Classes

TCMetadataParseError
TCMetadataParseTypeError
TCMetadataUnknownPropertiesError
TCMetadataMissingPropertiesError
TCMetadataMisplacedTCPropertiesError
TCParseResult

Functions

parse_tc_metadata

Parse Table Constraints (TC) metadata from an OIM report.

Data

T

API

class arelle.oim.tc.metadata.parser.TCMetadataParseError(message: str, *path: str, code: str = TCME_INVALID_JSON_STRUCTURE)

Bases: arelle.oim.tc.metadata.common.TCMetadataValidationError

Initialization

class arelle.oim.tc.metadata.parser.TCMetadataParseTypeError(expected_type: type, actual_value: Any, *path: str)

Bases: arelle.oim.tc.metadata.parser.TCMetadataParseError

Initialization

class arelle.oim.tc.metadata.parser.TCMetadataUnknownPropertiesError(property_names: list[str])

Bases: arelle.oim.tc.metadata.parser.TCMetadataParseError

Initialization

class arelle.oim.tc.metadata.parser.TCMetadataMissingPropertiesError(property_names: list[str])

Bases: arelle.oim.tc.metadata.parser.TCMetadataParseError

Initialization

class arelle.oim.tc.metadata.parser.TCMetadataMisplacedTCPropertiesError(*path: str)

Bases: arelle.oim.tc.metadata.parser.TCMetadataParseError

Initialization

class arelle.oim.tc.metadata.parser.TCParseResult

metadata: arelle.oim.tc.metadata.model.TCMetadata | None

None

errors: tuple[arelle.oim.tc.metadata.parser.TCMetadataParseError, ...]

None

property is_valid: bool

arelle.oim.tc.metadata.parser.parse_tc_metadata(oim_object: dict[str, Any], namespaces: dict[str, str]) → arelle.oim.tc.metadata.parser.TCParseResult

Parse Table Constraints (TC) metadata from an OIM report.

On success or failure, returns a TCParseResult. Errors may include:

• tcme:invalidJSONStructure for type/structure violations

• tcme:misplacedOrUnknownProperty for tc: properties in wrong locations

• xbrlce:invalidIdentifier for invalid parameter or key names Full semantic validation of the parsed metadata is not performed here.

arelle.oim.tc.metadata.parser.T

‘TypeVar(…)’