# {py:mod}`arelle.DisclosureSystem` ```{py:module} arelle.DisclosureSystem ``` ```{autodoc2-docstring} arelle.DisclosureSystem :allowtitles: ``` ## Module Contents ### Classes ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`ErxlLoc ` - ```{autodoc2-docstring} arelle.DisclosureSystem.ErxlLoc :summary: ``` * - {py:obj}`DisclosureSystem ` - ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem :summary: ``` ```` ### Functions ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`compileAttrPattern ` - ```{autodoc2-docstring} arelle.DisclosureSystem.compileAttrPattern :summary: ``` ```` ### API ````{py:function} compileAttrPattern(elt: lxml.etree._Element, attrName: str, flags: int | None = None, patternIfNoAttr: str | None = '') -> regex.Pattern[str] | None :canonical: arelle.DisclosureSystem.compileAttrPattern ```{autodoc2-docstring} arelle.DisclosureSystem.compileAttrPattern ``` ```` ````{py:class} ErxlLoc(family: str | None, version: str | None, href: str, attType: str | None, elements: str | None, namespace: str | None) :canonical: arelle.DisclosureSystem.ErxlLoc ```{autodoc2-docstring} arelle.DisclosureSystem.ErxlLoc ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} arelle.DisclosureSystem.ErxlLoc.__init__ ``` ```` `````{py:class} DisclosureSystem(modelManager: arelle.ModelManager.ModelManager) :canonical: arelle.DisclosureSystem.DisclosureSystem ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.__init__ ``` ````{py:attribute} name :canonical: arelle.DisclosureSystem.DisclosureSystem.name :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.name ``` ```` ````{py:attribute} selection :canonical: arelle.DisclosureSystem.DisclosureSystem.selection :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.selection ``` ```` ````{py:attribute} standardTaxonomiesDict :canonical: arelle.DisclosureSystem.DisclosureSystem.standardTaxonomiesDict :type: dict[str, set[str] | str] :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.standardTaxonomiesDict ``` ```` ````{py:attribute} familyHrefs :canonical: arelle.DisclosureSystem.DisclosureSystem.familyHrefs :type: dict[str, set[arelle.DisclosureSystem.ErxlLoc]] :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.familyHrefs ``` ```` ````{py:attribute} standardLocalHrefs :canonical: arelle.DisclosureSystem.DisclosureSystem.standardLocalHrefs :type: dict[str, set[str]] :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.standardLocalHrefs ``` ```` ````{py:attribute} standardAuthorities :canonical: arelle.DisclosureSystem.DisclosureSystem.standardAuthorities :type: set[str] :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.standardAuthorities ``` ```` ````{py:attribute} baseTaxonomyNamespaces :canonical: arelle.DisclosureSystem.DisclosureSystem.baseTaxonomyNamespaces :type: set[str] :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.baseTaxonomyNamespaces ``` ```` ````{py:attribute} standardPrefixes :canonical: arelle.DisclosureSystem.DisclosureSystem.standardPrefixes :type: dict[str, str] :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.standardPrefixes ``` ```` ````{py:attribute} names :canonical: arelle.DisclosureSystem.DisclosureSystem.names :type: list[str] :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.names ``` ```` ````{py:attribute} validationType :canonical: arelle.DisclosureSystem.DisclosureSystem.validationType :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.validationType ``` ```` ````{py:attribute} exclusiveTypesPattern :canonical: arelle.DisclosureSystem.DisclosureSystem.exclusiveTypesPattern :type: regex.Pattern[str] | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.exclusiveTypesPattern ``` ```` ````{py:attribute} EFM :canonical: arelle.DisclosureSystem.DisclosureSystem.EFM :type: bool :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.EFM ``` ```` ````{py:attribute} GFM :canonical: arelle.DisclosureSystem.DisclosureSystem.GFM :type: bool :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.GFM ``` ```` ````{py:attribute} EFMorGFM :canonical: arelle.DisclosureSystem.DisclosureSystem.EFMorGFM :type: bool :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.EFMorGFM ``` ```` ````{py:attribute} HMRC :canonical: arelle.DisclosureSystem.DisclosureSystem.HMRC :type: bool :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.HMRC ``` ```` ````{py:attribute} SBRNL :canonical: arelle.DisclosureSystem.DisclosureSystem.SBRNL :type: bool :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.SBRNL ``` ```` ````{py:attribute} pluginTypes :canonical: arelle.DisclosureSystem.DisclosureSystem.pluginTypes :type: set[str] :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.pluginTypes ``` ```` ````{py:attribute} validateFileText :canonical: arelle.DisclosureSystem.DisclosureSystem.validateFileText :type: bool :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.validateFileText ``` ```` ````{py:attribute} validateEntryText :canonical: arelle.DisclosureSystem.DisclosureSystem.validateEntryText :type: bool :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.validateEntryText ``` ```` ````{py:attribute} allowedExternalHrefPattern :canonical: arelle.DisclosureSystem.DisclosureSystem.allowedExternalHrefPattern :type: regex.Pattern[str] | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.allowedExternalHrefPattern ``` ```` ````{py:attribute} allowedImageTypes :canonical: arelle.DisclosureSystem.DisclosureSystem.allowedImageTypes :type: dict[str, typing.Iterable[str]] | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.allowedImageTypes ``` ```` ````{py:attribute} arcroleCyclesAllowed :canonical: arelle.DisclosureSystem.DisclosureSystem.arcroleCyclesAllowed :type: dict[str, tuple[str, str | None]] :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.arcroleCyclesAllowed ``` ```` ````{py:attribute} schemaValidateSchema :canonical: arelle.DisclosureSystem.DisclosureSystem.schemaValidateSchema :type: typing.Any :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.schemaValidateSchema ``` ```` ````{py:attribute} blockDisallowedReferences :canonical: arelle.DisclosureSystem.DisclosureSystem.blockDisallowedReferences :type: bool :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.blockDisallowedReferences ``` ```` ````{py:attribute} maxSubmissionSubdirectoryEntryNesting :canonical: arelle.DisclosureSystem.DisclosureSystem.maxSubmissionSubdirectoryEntryNesting :type: int :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.maxSubmissionSubdirectoryEntryNesting ``` ```` ````{py:attribute} defaultXmlLang :canonical: arelle.DisclosureSystem.DisclosureSystem.defaultXmlLang :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.defaultXmlLang ``` ```` ````{py:attribute} defaultXmlEncoding :canonical: arelle.DisclosureSystem.DisclosureSystem.defaultXmlEncoding :type: str :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.defaultXmlEncoding ``` ```` ````{py:attribute} xmlLangPattern :canonical: arelle.DisclosureSystem.DisclosureSystem.xmlLangPattern :type: regex.Pattern[str] | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.xmlLangPattern ``` ```` ````{py:attribute} xmlLangIsInheritable :canonical: arelle.DisclosureSystem.DisclosureSystem.xmlLangIsInheritable :type: bool :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.xmlLangIsInheritable ``` ```` ````{py:attribute} defaultLanguage :canonical: arelle.DisclosureSystem.DisclosureSystem.defaultLanguage :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.defaultLanguage ``` ```` ````{py:attribute} language :canonical: arelle.DisclosureSystem.DisclosureSystem.language :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.language ``` ```` ````{py:attribute} validTaxonomiesUrl :canonical: arelle.DisclosureSystem.DisclosureSystem.validTaxonomiesUrl :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.validTaxonomiesUrl ``` ```` ````{py:attribute} standardTaxonomiesUrl :canonical: arelle.DisclosureSystem.DisclosureSystem.standardTaxonomiesUrl :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.standardTaxonomiesUrl ``` ```` ````{py:attribute} mappingsUrl :canonical: arelle.DisclosureSystem.DisclosureSystem.mappingsUrl :type: str :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.mappingsUrl ``` ```` ````{py:attribute} mappedFiles :canonical: arelle.DisclosureSystem.DisclosureSystem.mappedFiles :type: dict[str, str] :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.mappedFiles ``` ```` ````{py:attribute} mappedPaths :canonical: arelle.DisclosureSystem.DisclosureSystem.mappedPaths :type: list[tuple[str, str]] :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.mappedPaths ``` ```` ````{py:attribute} utrUrl :canonical: arelle.DisclosureSystem.DisclosureSystem.utrUrl :type: list[str] :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.utrUrl ``` ```` ````{py:attribute} utrStatusFilters :canonical: arelle.DisclosureSystem.DisclosureSystem.utrStatusFilters :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.utrStatusFilters ``` ```` ````{py:attribute} utrTypeEntries :canonical: arelle.DisclosureSystem.DisclosureSystem.utrTypeEntries :type: typing.Any :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.utrTypeEntries ``` ```` ````{py:attribute} keepOpen :canonical: arelle.DisclosureSystem.DisclosureSystem.keepOpen :type: bool :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.keepOpen ``` ```` ````{py:attribute} identifierSchemePattern :canonical: arelle.DisclosureSystem.DisclosureSystem.identifierSchemePattern :type: regex.Pattern[str] | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.identifierSchemePattern ``` ```` ````{py:attribute} identifierValuePattern :canonical: arelle.DisclosureSystem.DisclosureSystem.identifierValuePattern :type: regex.Pattern[str] | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.identifierValuePattern ``` ```` ````{py:attribute} identifierValueName :canonical: arelle.DisclosureSystem.DisclosureSystem.identifierValueName :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.identifierValueName ``` ```` ````{py:attribute} contextElement :canonical: arelle.DisclosureSystem.DisclosureSystem.contextElement :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.contextElement ``` ```` ````{py:attribute} roleDefinitionPattern :canonical: arelle.DisclosureSystem.DisclosureSystem.roleDefinitionPattern :type: regex.Pattern[str] | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.roleDefinitionPattern ``` ```` ````{py:attribute} labelCheckPattern :canonical: arelle.DisclosureSystem.DisclosureSystem.labelCheckPattern :type: regex.Pattern[str] | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.labelCheckPattern ``` ```` ````{py:attribute} labelTrimPattern :canonical: arelle.DisclosureSystem.DisclosureSystem.labelTrimPattern :type: regex.Pattern[str] | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.labelTrimPattern ``` ```` ````{py:attribute} deiNamespacePattern :canonical: arelle.DisclosureSystem.DisclosureSystem.deiNamespacePattern :type: regex.Pattern[str] | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.deiNamespacePattern ``` ```` ````{py:attribute} deiAmendmentFlagElement :canonical: arelle.DisclosureSystem.DisclosureSystem.deiAmendmentFlagElement :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.deiAmendmentFlagElement ``` ```` ````{py:attribute} deiCurrentFiscalYearEndDateElement :canonical: arelle.DisclosureSystem.DisclosureSystem.deiCurrentFiscalYearEndDateElement :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.deiCurrentFiscalYearEndDateElement ``` ```` ````{py:attribute} deiDocumentFiscalYearFocusElement :canonical: arelle.DisclosureSystem.DisclosureSystem.deiDocumentFiscalYearFocusElement :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.deiDocumentFiscalYearFocusElement ``` ```` ````{py:attribute} deiDocumentPeriodEndDateElement :canonical: arelle.DisclosureSystem.DisclosureSystem.deiDocumentPeriodEndDateElement :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.deiDocumentPeriodEndDateElement ``` ```` ````{py:attribute} deiFilerIdentifierElement :canonical: arelle.DisclosureSystem.DisclosureSystem.deiFilerIdentifierElement :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.deiFilerIdentifierElement ``` ```` ````{py:attribute} deiFilerNameElement :canonical: arelle.DisclosureSystem.DisclosureSystem.deiFilerNameElement :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.deiFilerNameElement ``` ```` ````{py:attribute} logLevelFilter :canonical: arelle.DisclosureSystem.DisclosureSystem.logLevelFilter :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.logLevelFilter ``` ```` ````{py:attribute} logCodeFilter :canonical: arelle.DisclosureSystem.DisclosureSystem.logCodeFilter :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.logCodeFilter ``` ```` ````{py:attribute} standardTaxonomyDatabase :canonical: arelle.DisclosureSystem.DisclosureSystem.standardTaxonomyDatabase :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.standardTaxonomyDatabase ``` ```` ````{py:attribute} standardTaxonomyUrlPattern :canonical: arelle.DisclosureSystem.DisclosureSystem.standardTaxonomyUrlPattern :type: regex.Pattern[str] | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.standardTaxonomyUrlPattern ``` ```` ````{py:attribute} options :canonical: arelle.DisclosureSystem.DisclosureSystem.options :type: str | None :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.options ``` ```` ````{py:attribute} version :canonical: arelle.DisclosureSystem.DisclosureSystem.version :type: tuple[int, ...] :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.version ``` ```` ````{py:attribute} validTaxonomiesDict :canonical: arelle.DisclosureSystem.DisclosureSystem.validTaxonomiesDict :type: dict[str, set[str] | str] :value: > None ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.validTaxonomiesDict ``` ```` ````{py:method} clear() -> None :canonical: arelle.DisclosureSystem.DisclosureSystem.clear ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.clear ``` ```` ````{py:property} dir :canonical: arelle.DisclosureSystem.DisclosureSystem.dir :type: list[tuple[str, str | None]] ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.dir ``` ```` ````{py:property} urls :canonical: arelle.DisclosureSystem.DisclosureSystem.urls :type: list[str] ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.urls ``` ```` ````{py:property} url :canonical: arelle.DisclosureSystem.DisclosureSystem.url :type: str ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.url ``` ```` ````{py:method} dirlist(listFormat: str) -> list[str | tuple[str, str | None]] :canonical: arelle.DisclosureSystem.DisclosureSystem.dirlist ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.dirlist ``` ```` ````{py:method} select(name: str | None) -> bool :canonical: arelle.DisclosureSystem.DisclosureSystem.select ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.select ``` ```` ````{py:method} loadStandardTaxonomiesDict() -> None :canonical: arelle.DisclosureSystem.DisclosureSystem.loadStandardTaxonomiesDict ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.loadStandardTaxonomiesDict ``` ```` ````{py:method} loadValidTaxonomiesDict() -> None :canonical: arelle.DisclosureSystem.DisclosureSystem.loadValidTaxonomiesDict ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.loadValidTaxonomiesDict ``` ```` ````{py:method} loadMappings() -> None :canonical: arelle.DisclosureSystem.DisclosureSystem.loadMappings ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.loadMappings ``` ```` ````{py:method} mappedUrl(url: str) -> str :canonical: arelle.DisclosureSystem.DisclosureSystem.mappedUrl ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.mappedUrl ``` ```` ````{py:method} isMappedUrl(url: str) -> bool :canonical: arelle.DisclosureSystem.DisclosureSystem.isMappedUrl ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.isMappedUrl ``` ```` ````{py:method} uriAuthorityValid(uri: str) -> bool :canonical: arelle.DisclosureSystem.DisclosureSystem.uriAuthorityValid ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.uriAuthorityValid ``` ```` ````{py:method} disallowedHrefOfNamespace(href: str, namespaceUri: str) -> bool :canonical: arelle.DisclosureSystem.DisclosureSystem.disallowedHrefOfNamespace ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.disallowedHrefOfNamespace ``` ```` ````{py:method} hrefValid(href: str) -> bool :canonical: arelle.DisclosureSystem.DisclosureSystem.hrefValid ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.hrefValid ``` ```` ````{py:method} hrefValidForDisclosureSystem(href: str) -> bool :canonical: arelle.DisclosureSystem.DisclosureSystem.hrefValidForDisclosureSystem ```{autodoc2-docstring} arelle.DisclosureSystem.DisclosureSystem.hrefValidForDisclosureSystem ``` ```` `````