`arelle.XbrlUtil`#

See COPYRIGHT.md for copyright information.

Module Contents#

Functions#

`nodesCorrespond`
`equalityHash`
`sEqual`
`attributeDict`
`attributes`
`childElements`
`xEqual`
`vEqual`
`typedValue`

Data#

`S_EQUAL`
`S_EQUAL2`
`XPATH_EQ`
`VALIDATE_BY_STRING_VALUE`
`NO_IDs_EXCLUDED`
`ALL_IDs_EXCLUDED`
`TOP_IDs_EXCLUDED`

API#

arelle.XbrlUtil.S_EQUAL: int#: 0

arelle.XbrlUtil.S_EQUAL2: int#: 1

arelle.XbrlUtil.XPATH_EQ: int#: 2

arelle.XbrlUtil.VALIDATE_BY_STRING_VALUE: int#: 3

arelle.XbrlUtil.NO_IDs_EXCLUDED: int#: 0

arelle.XbrlUtil.ALL_IDs_EXCLUDED: int#: 1

arelle.XbrlUtil.TOP_IDs_EXCLUDED: int#: 2

arelle.XbrlUtil.nodesCorrespond(dts1: arelle.ModelXbrl.ModelXbrl, elt1: arelle.ModelObject.ModelObject | arelle.ModelObject.ModelAttribute | None, elt2: arelle.ModelObject.ModelObject | arelle.ModelObject.ModelAttribute | None, dts2: arelle.ModelXbrl.ModelXbrl | None = None, equalMode: int = XPATH_EQ, excludeIDs: int = ALL_IDs_EXCLUDED) → bool#

arelle.XbrlUtil.equalityHash(elt: arelle.ModelObject.ModelObject | Sequence[arelle.ModelObject.ModelObject], equalMode: int = S_EQUAL, excludeIDs: int = NO_IDs_EXCLUDED) → int#

arelle.XbrlUtil.sEqual(dts1: arelle.ModelXbrl.ModelXbrl, elt1: arelle.ModelObject.ModelObject, elt2: arelle.ModelObject.ModelObject, equalMode: int = S_EQUAL, excludeIDs: int = NO_IDs_EXCLUDED, dts2: arelle.ModelXbrl.ModelXbrl | None = None, ns2ns1Tbl: dict[str, str] | None = None) → bool#

arelle.XbrlUtil.attributeDict(modelXbrl: arelle.ModelXbrl.ModelXbrl, elt: arelle.ModelObject.ModelObject, exclusions: set[str] = set(), equalMode: int = S_EQUAL, excludeIDs: int = NO_IDs_EXCLUDED, ns2ns1Tbl: dict[str, str] | None = None, keyByTag: bool = False, distinguishNaNs: bool = False) → dict[arelle.ModelValue.QName, Any]#

arelle.XbrlUtil.attributes(modelXbrl: arelle.ModelXbrl.ModelXbrl, elt: arelle.ModelObject.ModelObject, exclusions: set[str] = set(), ns2ns1Tbl: dict[str, str] | None = None, keyByTag: bool = False) → tuple[tuple[arelle.ModelValue.QName, Any], ...]#

arelle.XbrlUtil.childElements(elt: arelle.ModelObject.ModelObject) → list[arelle.ModelObject.ModelObject]#

arelle.XbrlUtil.xEqual(elt1: arelle.ModelObject.ModelObject, elt2: arelle.ModelObject.ModelObject, equalMode: int = S_EQUAL) → bool#

arelle.XbrlUtil.vEqual(elt1: arelle.ModelObject.ModelObject, elt2: arelle.ModelObject.ModelObject) → bool#

arelle.XbrlUtil.typedValue(dts: arelle.ModelXbrl.ModelXbrl | None, element: arelle.ModelObject.ModelObject, attrQname: arelle.ModelValue.QName | None = None) → Any#