`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.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() → Optional[arelle.ModelValue.QName]¶

__repr__()¶

arelle.ValidateUtr.loadUtr(modelXbrl, statusFilters=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) → None¶

arelle.ValidateUtr.utrEntries(modelType, modelUnit)¶

arelle.ValidateUtr.utrSymbol(modelType, unitMeasures)¶

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

Initialization

validateFacts()¶

measuresMatch(typeMatched, mulMeas, divMeas, typeName=None, typeNS=None, *divArgs)¶

utrEntries(modelType, unit)¶

utrSymbol(multMeasures, divMeasures)¶

arelle.ValidateUtr¶