arelle.utils.validate.Document

Module Contents

Functions

checkDocumentEncoding

Checks the encoding of documents on the ModelXbrl against a list of allowed encodings. If documentType is not specified, all documents except INLINEXBRLDOCUMENTSET are checked. If documentType is specified, only documents of that type are checked.

API

arelle.utils.validate.Document.checkDocumentEncoding(val: arelle.ValidateXbrl.ValidateXbrl, encodings: list[str], taxonomyUrlPrefixes: frozenset[str], documentType: Optional[arelle.ModelDocumentType.ModelDocumentType] = None) → list[arelle.ModelDocument.ModelDocument]

Checks the encoding of documents on the ModelXbrl against a list of allowed encodings. If documentType is not specified, all documents except INLINEXBRLDOCUMENTSET are checked. If documentType is specified, only documents of that type are checked.

Parameters:

  • val – validateXbrl object containing the modelXbrl with the documents to check.

  • encodings – lower case list of allowed encodings (e.g., [‘utf-8’, ‘iso-8859-1’, ‘utf-8-sig’])

  • taxonomyUrlPrefixes – frozenset of URL prefixes that identify taxonomy documents (e.g., {‘http://www.xbrl.org/2003/linkbase’, ‘http://www.xbrl.org/2003/instance’})

  • documentType – optional ModelDocumentType to filter documents by type (e.g., ModelDocumentType.INSTANCE). If None, all non-INLINEXBRLDOCUMENTSET document types are checked.

Returns:

list of ModelDocument objects that have a disallowed encoding.