`arelle.ValidateUtr`¶

See COPYRIGHT.md for copyright information.

Module Contents¶

Classes¶

`UtrEntry`
`ValidateUtr`

Functions¶

`loadUtr`	Parses the units from modelXbrl.modelManager.disclosureStystem.utrUrl, and sets them on modelXbrl.modelManager.disclosureSystem.utrItemTypeEntries
`validateFacts`
`utrEntries`
`utrSymbol`

Data¶

`_`
`DIVISOR`

API¶

arelle.ValidateUtr._: arelle.typing.TypeGetText¶: None

arelle.ValidateUtr.DIVISOR¶: ‘DIV’

class arelle.ValidateUtr.UtrEntry¶

id: str | None¶: None

unitId: str | None¶: None

unitName: str | None¶: None

nsUnit: str | None¶: None

itemType: str | None¶: None

nsItemType: str | None¶: None

numeratorItemType: str | None¶: None

nsNumeratorItemType: str | None¶: None

denominatorItemType: str | None¶: None

nsDenominatorItemType: str | None¶: None

isSimple: bool¶: None

symbol: str | None¶: None

definition: str | None¶: None

status: str | None¶: None

__slots__¶: (‘id’, ‘unitId’, ‘unitName’, ‘nsUnit’, ‘itemType’, ‘nsItemType’, ‘isSimple’, ‘numeratorItemType’, ‘n…

qname() → arelle.ModelValue.QName | None¶

__repr__() → str¶

arelle.ValidateUtr.loadUtr(modelXbrl: arelle.ModelXbrl.ModelXbrl, statusFilters: list[str] | None = None) → None¶

Parses the units from modelXbrl.modelManager.disclosureStystem.utrUrl, and sets them on modelXbrl.modelManager.disclosureSystem.utrItemTypeEntries

Parameters:

modelXbrl – the loaded xbrl model
statusFilters – the list of statuses to keep. If unset, ‘REC’ status is the default filter

Returns:

None

arelle.ValidateUtr.validateFacts(modelXbrl: arelle.ModelXbrl.ModelXbrl) → None¶

arelle.ValidateUtr.utrEntries(modelType: arelle.ModelDtsObject.ModelType, modelUnit: arelle.ModelInstanceObject.ModelUnit) → set[arelle.ValidateUtr.UtrEntry | None]¶

arelle.ValidateUtr.utrSymbol(modelType: arelle.ModelDtsObject.ModelType, unitMeasures: tuple[list[arelle.ModelValue.QName], list[arelle.ModelValue.QName]]) → str¶

class arelle.ValidateUtr.ValidateUtr(modelXbrl: arelle.ModelXbrl.ModelXbrl, messageLevel: str = 'ERROR', messageCode: str = 'utre:error-NumericFactUtrInvalid')¶

Initialization

validateFacts() → None¶

measuresMatch(typeMatched: bool, mulMeas: tuple[arelle.ModelValue.QName, ...], divMeas: tuple[arelle.ModelValue.QName, ...], typeName: str | None = None, typeNS: str | None = None, *divArgs: Any) → tuple[bool, bool, arelle.ValidateUtr.UtrEntry | None]¶

utrEntries(modelType: arelle.ModelDtsObject.ModelType, unit: arelle.ModelInstanceObject.ModelUnit) → set[arelle.ValidateUtr.UtrEntry | None]¶

utrSymbol(multMeasures: list[arelle.ModelValue.QName] | None, divMeasures: list[arelle.ModelValue.QName] | None) → str¶

arelle.ValidateUtr¶