arelle.oim.csv.metadata.parser

See COPYRIGHT.md for copyright information.

Module Contents

Functions

parse_xbrl_csv_metadata

Build a resolved XbrlCsvEffectiveMetadata from a fully merged OIM object dict.

API

arelle.oim.csv.metadata.parser.parse_xbrl_csv_metadata(oim_object: dict[str, Any]) → arelle.oim.csv.metadata.model.XbrlCsvEffectiveMetadata

Build a resolved XbrlCsvEffectiveMetadata from a fully merged OIM object dict.

Structural validation has already been performed upstream during JSON merging. This function parses the merged dict. Raises TypeError if documentInfo is missing or not a dict, or documentType is missing or not a string. Raises ValueError if documentType is not a recognised CSV document type URI. All other type mismatched values and unknown keys are dropped, yielding a well typed partial model.