`arelle.ValidateXbrlDimensions`¶

See COPYRIGHT.md for copyright information.

Module Contents¶

Functions¶

`loadDimensionDefaults`
`checkBaseSet`
`domainTargetRoles`
`xdtCycle`
`drsPriItems`
`drsPolymorphism`
`checkConcept`
`checkContext`
`checkFact`
`isFactDimensionallyValid`
`priItemElrHcRels`
`findPriItemElrHcRels`
`priItemsOfElrHc`
`checkFactElrHcs`
`dimensionMemberUsable`
`findUsableMembersInDomainELR`
`usableEnumerationMembers`
`enumerationMemberUsable`

Data¶

`NONDEFAULT`
`NOT_FOUND`
`MEMBER_USABLE`
`MEMBER_NOT_USABLE`

API¶

arelle.ValidateXbrlDimensions.NONDEFAULT¶: ‘intern(…)’

arelle.ValidateXbrlDimensions.loadDimensionDefaults(val: arelle.ModelManager.ModelManager | arelle.ModelXbrl.ModelXbrl) → None¶

arelle.ValidateXbrlDimensions.checkBaseSet(val: arelle.ValidateXbrl.ValidateXbrl | arelle.ModelXbrl.ModelXbrl, arcrole: str, ELR: str, relsSet: arelle.ModelRelationshipSet.ModelRelationshipSet) → None¶

arelle.ValidateXbrlDimensions.domainTargetRoles(val: arelle.ModelXbrl.ModelXbrl, fromELR: str, rels: list[arelle.ModelDtsObject.ModelRelationship], fromConcepts: set[arelle.ModelObject.ModelObject] | None = None, ELRs: set[str] | None = None) → set[str]¶

arelle.ValidateXbrlDimensions.xdtCycle(val: arelle.ModelXbrl.ModelXbrl, ELRs: set[str], rels: list[arelle.ModelDtsObject.ModelRelationship], fromConcepts: set[arelle.ModelObject.ModelObject]) → list[arelle.ModelDtsObject.ModelRelationship] | None¶

arelle.ValidateXbrlDimensions.drsPriItems(val: arelle.ModelXbrl.ModelXbrl, fromELR: str, fromPriItem: arelle.ModelObject.ModelObject, priItems: set[arelle.ModelObject.ModelObject] | None = None) → set[arelle.ModelObject.ModelObject]¶

arelle.ValidateXbrlDimensions.drsPolymorphism(val: arelle.ModelXbrl.ModelXbrl, fromELR: str, rels: list[arelle.ModelDtsObject.ModelRelationship], priItems: set[arelle.ModelObject.ModelObject], visitedMbrs: set[arelle.ModelObject.ModelObject] | None = None) → list[arelle.ModelDtsObject.ModelRelationship] | None¶

arelle.ValidateXbrlDimensions.checkConcept(val: arelle.ValidateXbrl.ValidateXbrl, concept: arelle.ModelDtsObject.ModelConcept) → None¶

arelle.ValidateXbrlDimensions.checkContext(val: arelle.ValidateXbrl.ValidateXbrl, cntx: arelle.ModelInstanceObject.ModelContext) → None¶

arelle.ValidateXbrlDimensions.checkFact(val: arelle.ValidateXbrl.ValidateXbrl, f: arelle.ModelInstanceObject.ModelFact, otherFacts: set[arelle.ModelInstanceObject.ModelFact] | None = None) → None¶

arelle.ValidateXbrlDimensions.isFactDimensionallyValid(val: arelle.ValidateXbrl.ValidateXbrl | arelle.ModelXbrl.ModelXbrl, f: arelle.ModelInstanceObject.ModelFact | arelle.PrototypeInstanceObject.FactPrototype, setPrototypeContextElements: bool = False, otherFacts: set[arelle.ModelInstanceObject.ModelFact] | None = None) → bool¶

arelle.ValidateXbrlDimensions.priItemElrHcRels(val: arelle.ModelXbrl.ModelXbrl | arelle.formula.XPathContext.XPathContext, priItem: arelle.ModelDtsObject.ModelConcept, ELR: str | None = None) → dict[str, list[arelle.ModelDtsObject.ModelRelationship]]¶

arelle.ValidateXbrlDimensions.findPriItemElrHcRels(val: arelle.ModelXbrl.ModelXbrl, priItem: arelle.ModelObject.ModelObject, ELR: str | None = None, elrHcRels: collections.defaultdict[str, list[arelle.ModelDtsObject.ModelRelationship]] | None = None, seenPrimaryItems: set[tuple[str | None, arelle.ModelObject.ModelObject]] | None = None) → dict[str, list[arelle.ModelDtsObject.ModelRelationship]]¶

arelle.ValidateXbrlDimensions.priItemsOfElrHc(val: arelle.ModelXbrl.ModelXbrl, priItem: arelle.ModelObject.ModelObject, hcELR: str, relELR: str, priItems: set[arelle.ModelObject.ModelObject] | None = None) → set[arelle.ModelObject.ModelObject]¶

arelle.ValidateXbrlDimensions.NOT_FOUND¶: 0

arelle.ValidateXbrlDimensions.MEMBER_USABLE¶: 1

arelle.ValidateXbrlDimensions.MEMBER_NOT_USABLE¶: 2

arelle.ValidateXbrlDimensions.checkFactElrHcs(val: arelle.ModelXbrl.ModelXbrl, f: arelle.ModelInstanceObject.ModelFact, ELR: str, hcRels: list[arelle.ModelDtsObject.ModelRelationship], setPrototypeContextElements: bool = False) → bool¶

arelle.ValidateXbrlDimensions.dimensionMemberUsable(val: arelle.ValidateXbrl.ValidateXbrl, dimConcept: arelle.ModelDtsObject.ModelConcept, memConcept: arelle.ModelObject.ModelObject, domELR: str) → bool¶

arelle.ValidateXbrlDimensions.findUsableMembersInDomainELR(val: arelle.ValidateXbrl.ValidateXbrl, rels: list[arelle.ModelDtsObject.ModelRelationship], ELR: str, usableMembers: set[arelle.ModelDtsObject.ModelConcept], unusableMembers: set[arelle.ModelDtsObject.ModelConcept], toConceptELRs: collections.defaultdict[arelle.ModelDtsObject.ModelConcept, set[str]]) → None¶

arelle.ValidateXbrlDimensions.usableEnumerationMembers(val: arelle.ValidateXbrl.ValidateXbrl, enumConcept: arelle.ModelDtsObject.ModelConcept | None) → set[arelle.ModelDtsObject.ModelConcept]¶

arelle.ValidateXbrlDimensions.enumerationMemberUsable(val: arelle.ValidateXbrl.ValidateXbrl, enumConcept: arelle.ModelDtsObject.ModelConcept | None, memConcept: arelle.ModelDtsObject.ModelConcept | None) → bool¶