`arelle.ModelFormulaObject`¶

See COPYRIGHT.md for copyright information.

Module Contents¶

Classes¶

`FormulaOptions`
`Trace`
`ModelFormulaResource`
`ModelAssertionSet`
`ModelVariableSet`
`ModelFormulaRules`
`ModelFormula`
`ModelTuple`
`ModelVariableSetAssertion`
`ModelExistenceAssertion`
`ModelValueAssertion`
`ModelConsistencyAssertion`
`ModelParameter`
`ModelInstance`
`ModelVariable`
`ModelFactVariable`
`ModelGeneralVariable`
`ModelPrecondition`
`ModelFilter`
`ModelTestFilter`
`ModelPatternFilter`
`ModelAspectCover`
`ModelBooleanFilter`
`ModelAndFilter`
`ModelOrFilter`
`ModelConceptName`
`ModelConceptPeriodType`
`ModelConceptBalance`
`ModelConceptFilterWithQnameExpression`
`ModelConceptCustomAttribute`
`ModelConceptDataType`
`ModelConceptSubstitutionGroup`
`ModelConceptRelation`
`ModelEntityIdentifier`
`ModelEntitySpecificIdentifier`
`ModelEntityScheme`
`ModelEntityRegexpIdentifier`
`ModelEntityRegexpScheme`
`ModelGeneral`
`ModelMatchFilter`
`ModelPeriod`
`ModelDateTimeFilter`
`ModelPeriodStart`
`ModelPeriodEnd`
`ModelPeriodInstant`
`ModelForever`
`ModelInstantDuration`
`MemberModel`
`ModelExplicitDimension`
`ModelTypedDimension`
`ModelRelativeFilter`
`ModelSegmentFilter`
`ModelScenarioFilter`
`ModelAncestorFilter`
`ModelParentFilter`
`ModelLocationFilter`
`ModelSiblingFilter`
`ModelGeneralMeasures`
`ModelSingleMeasure`
`ModelNilFilter`
`ModelPrecisionFilter`
`ModelEqualityDefinition`
`ModelMessage`
`ModelAssertionSeverity`
`ModelCustomFunctionSignature`
`ModelCustomFunctionImplementation`

API¶

class arelle.ModelFormulaObject.FormulaOptions(savedValues: dict[str, Any] | None = None)¶

Initialization

typedParameters(prefixedNamespaces: dict[str, str] | None = None) → dict[arelle.ModelValue.QName | None, Any]¶

traceSource(traceType: int | None) → bool¶

traceEvaluation(traceType: int | None) → bool¶

class arelle.ModelFormulaObject.Trace¶

PARAMETER¶: 1

VARIABLE_SET¶: 2

MESSAGE¶: 3

FORMULA_RULES¶: 4

VARIABLE¶: 5

CUSTOM_FUNCTION¶: 6

CALL¶: 7

TEST¶: 8

class arelle.ModelFormulaObject.ModelFormulaResource¶

Bases: arelle.ModelDtsObject.ModelResource

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

property descendantArcroles: tuple[]¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens | None = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelAssertionSet¶

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

property descendantArcroles: tuple[str]¶

property propertyView: tuple[tuple[str, str | None], ...]¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens | None = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelVariableSet¶

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

property descendantArcroles: tuple[str, str, str]¶

property aspectModel: str | None¶

property implicitFiltering: str | None¶

property groupFilterRelationships: list[arelle.ModelDtsObject.ModelRelationship]¶

property xmlElementView: str¶

property propertyView: tuple[tuple[str, str | None], ...]¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens | None = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelFormulaRules¶

isSubclassOfModelVariableSet: bool¶: None

valueProg: arelle.formula.XPathParser.ExpressionStack | None¶: None

hasPrecision: bool¶: None

hasDecimals: bool¶: None

aspectValues: collections.defaultdict[int | arelle.ModelValue.QName, list[arelle.ModelValue.QName] | arelle.ModelValue.QName | arelle.ModelObject.ModelObject | str | None]¶: None

aspectProgs: collections.defaultdict[int | arelle.ModelValue.QName, list[arelle.formula.XPathParser.ExpressionStack | None]]¶: None

typedDimProgAspects: set[arelle.ModelValue.QName]¶: None

modelXbrl: arelle.ModelXbrl.ModelXbrl¶: None

aspectModel: str¶: None

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

clear() → None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

evaluate(xpCtx: arelle.formula.XPathContext.XPathContext) → Any¶

evaluateRule(xpCtx: arelle.formula.XPathContext.XPathContext | None, aspect: int | arelle.ModelValue.QName) → Any¶

hasRule(aspect: int | arelle.ModelValue.QName) → bool¶

property value: str | None¶

property expression: str¶

source(aspect: int | arelle.ModelValue.QName | None = None, ruleElement: arelle.ModelObject.ModelObject | None = None, acceptFormulaSource: bool = True) → arelle.ModelValue.QName | None¶

aspectRuleElements(aspect: int | arelle.ModelValue.QName | None) → collections.abc.Sequence[arelle.ModelObject.ModelObject]¶

class arelle.ModelFormulaObject.ModelFormula¶

Bases: arelle.ModelFormulaObject.ModelFormulaRules, arelle.ModelFormulaObject.ModelVariableSet

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str | None¶

isSubclassOfModelVariableSet: bool¶: None

valueProg: arelle.formula.XPathParser.ExpressionStack | None¶: None

hasPrecision: bool¶: None

hasDecimals: bool¶: None

aspectValues: collections.defaultdict[int | arelle.ModelValue.QName, list[arelle.ModelValue.QName] | arelle.ModelValue.QName | arelle.ModelObject.ModelObject | str | None]¶: None

aspectProgs: collections.defaultdict[int | arelle.ModelValue.QName, list[arelle.formula.XPathParser.ExpressionStack | None]]¶: None

typedDimProgAspects: set[arelle.ModelValue.QName]¶: None

modelXbrl: arelle.ModelXbrl.ModelXbrl¶: None

aspectModel: str¶: None

clear() → None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

evaluate(xpCtx: arelle.formula.XPathContext.XPathContext) → Any¶

evaluateRule(xpCtx: arelle.formula.XPathContext.XPathContext | None, aspect: int | arelle.ModelValue.QName) → Any¶

hasRule(aspect: int | arelle.ModelValue.QName) → bool¶

property value: str | None¶

property expression: str¶

source(aspect: int | arelle.ModelValue.QName | None = None, ruleElement: arelle.ModelObject.ModelObject | None = None, acceptFormulaSource: bool = True) → arelle.ModelValue.QName | None¶

aspectRuleElements(aspect: int | arelle.ModelValue.QName | None) → collections.abc.Sequence[arelle.ModelObject.ModelObject]¶

property descendantArcroles: tuple[str, str, str]¶

property implicitFiltering: str | None¶

property groupFilterRelationships: list[arelle.ModelDtsObject.ModelRelationship]¶

property xmlElementView: str¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelTuple¶

Bases: arelle.ModelFormulaObject.ModelFormula

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str | None¶

isSubclassOfModelVariableSet: bool¶: None

valueProg: arelle.formula.XPathParser.ExpressionStack | None¶: None

hasPrecision: bool¶: None

hasDecimals: bool¶: None

aspectValues: collections.defaultdict[int | arelle.ModelValue.QName, list[arelle.ModelValue.QName] | arelle.ModelValue.QName | arelle.ModelObject.ModelObject | str | None]¶: None

aspectProgs: collections.defaultdict[int | arelle.ModelValue.QName, list[arelle.formula.XPathParser.ExpressionStack | None]]¶: None

typedDimProgAspects: set[arelle.ModelValue.QName]¶: None

modelXbrl: arelle.ModelXbrl.ModelXbrl¶: None

aspectModel: str¶: None

clear() → None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

evaluate(xpCtx: arelle.formula.XPathContext.XPathContext) → Any¶

evaluateRule(xpCtx: arelle.formula.XPathContext.XPathContext | None, aspect: int | arelle.ModelValue.QName) → Any¶

hasRule(aspect: int | arelle.ModelValue.QName) → bool¶

property value: str | None¶

property expression: str¶

source(aspect: int | arelle.ModelValue.QName | None = None, ruleElement: arelle.ModelObject.ModelObject | None = None, acceptFormulaSource: bool = True) → arelle.ModelValue.QName | None¶

aspectRuleElements(aspect: int | arelle.ModelValue.QName | None) → collections.abc.Sequence[arelle.ModelObject.ModelObject]¶

property descendantArcroles: tuple[str, str, str]¶

property implicitFiltering: str | None¶

property groupFilterRelationships: list[arelle.ModelDtsObject.ModelRelationship]¶

property xmlElementView: str¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelVariableSetAssertion¶

Bases: arelle.ModelFormulaObject.ModelVariableSet

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

clear() → None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

property test: str | None¶

property expression: str¶

message(satisfied: bool, preferredMessage: str = '*', lang: str | None = None) → str | arelle.ModelObject.ModelObject | list[str] | list[arelle.ModelObject.ModelObject] | None¶

unsatisfiedSeverity(xpCtx: arelle.formula.XPathContext.XPathContext, contextItem: arelle.formula.XPathContext.ContextItem = None) → str | None¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str | None¶

property descendantArcroles: tuple[str, str, str]¶

property aspectModel: str | None¶

property implicitFiltering: str | None¶

property groupFilterRelationships: list[arelle.ModelDtsObject.ModelRelationship]¶

property xmlElementView: str¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelExistenceAssertion¶

Bases: arelle.ModelFormulaObject.ModelVariableSetAssertion

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

clear() → None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

property test: str | None¶

property expression: str¶

message(satisfied: bool, preferredMessage: str = '*', lang: str | None = None) → str | arelle.ModelObject.ModelObject | list[str] | list[arelle.ModelObject.ModelObject] | None¶

unsatisfiedSeverity(xpCtx: arelle.formula.XPathContext.XPathContext, contextItem: arelle.formula.XPathContext.ContextItem = None) → str | None¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str | None¶

property descendantArcroles: tuple[str, str, str]¶

property aspectModel: str | None¶

property implicitFiltering: str | None¶

property groupFilterRelationships: list[arelle.ModelDtsObject.ModelRelationship]¶

property xmlElementView: str¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelValueAssertion¶

Bases: arelle.ModelFormulaObject.ModelVariableSetAssertion

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

evaluate(xpCtx: arelle.formula.XPathContext.XPathContext) → arelle.formula.XPathContext.ResultStack | None¶

clear() → None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

property test: str | None¶

property expression: str¶

message(satisfied: bool, preferredMessage: str = '*', lang: str | None = None) → str | arelle.ModelObject.ModelObject | list[str] | list[arelle.ModelObject.ModelObject] | None¶

unsatisfiedSeverity(xpCtx: arelle.formula.XPathContext.XPathContext, contextItem: arelle.formula.XPathContext.ContextItem = None) → str | None¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str | None¶

property descendantArcroles: tuple[str, str, str]¶

property aspectModel: str | None¶

property implicitFiltering: str | None¶

property groupFilterRelationships: list[arelle.ModelDtsObject.ModelRelationship]¶

property xmlElementView: str¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelConsistencyAssertion¶

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

clear() → None¶

compile() → None¶

evalRadius(xpCtx: arelle.formula.XPathContext.XPathContext, factValue: arelle.formula.XPathContext.ContextItem) → Any¶

property descendantArcroles: tuple[str]¶

property hasProportionalAcceptanceRadius: bool¶

property hasAbsoluteAcceptanceRadius: bool¶

property isStrict: bool¶

message(satisfied: bool, preferredMessage: str = '*', lang: str | None = None) → str | arelle.ModelObject.ModelObject | list[str] | list[arelle.ModelObject.ModelObject] | None¶

property radiusExpression: str¶

property viewExpression: str¶

property xmlElementView: str¶

property propertyView: tuple[tuple[str, str | None] | tuple[], ...]¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens | None = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelParameter¶

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

clear() → None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

evaluate(xpCtx: arelle.formula.XPathContext.XPathContext, typeQname: arelle.ModelValue.QName | str) → Any¶

property name: str | None¶

property parameterQname: arelle.ModelValue.QName | None¶

property select: str | None¶

property isRequired: bool¶

property asType: arelle.ModelValue.QName | None¶

property propertyView: tuple[tuple[str, str | arelle.ModelValue.QName | None] | tuple[], ...]¶

property viewExpression: str | None¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelInstance¶

Bases: arelle.ModelFormulaObject.ModelParameter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

property instanceQname: arelle.ModelValue.QName | None¶

clear() → None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

evaluate(xpCtx: arelle.formula.XPathContext.XPathContext, typeQname: arelle.ModelValue.QName | str) → Any¶

property name: str | None¶

property parameterQname: arelle.ModelValue.QName | None¶

property select: str | None¶

property isRequired: bool¶

property asType: arelle.ModelValue.QName | None¶

property propertyView: tuple[tuple[str, str | arelle.ModelValue.QName | None] | tuple[], ...]¶

property viewExpression: str | None¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelVariable¶

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

compile() → None¶

property bindAsSequence: str | None¶

property descendantArcroles: tuple[]¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens | None = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelFactVariable¶

Bases: arelle.ModelFormulaObject.ModelVariable

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

clear() → None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

property descendantArcroles: tuple[str]¶

property nils: str¶

property matches: str¶

property fallbackValue: str | None¶

property filterRelationships: list[arelle.ModelDtsObject.ModelRelationship | arelle.ModelFormulaObject.ModelConceptName]¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str¶

property bindAsSequence: str | None¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelGeneralVariable¶

Bases: arelle.ModelFormulaObject.ModelVariable

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

clear() → None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

property select: str | None¶

property propertyView: tuple[tuple[str, str | None] | tuple[], ...]¶

property viewExpression: str | None¶

property bindAsSequence: str | None¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelPrecondition¶

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

clear() → None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

property test: str | None¶

evalTest(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str | None¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelFilter¶

Bases: arelle.ModelFormulaObject.ModelFormulaResource

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property descendantArcroles: tuple[]¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens | None = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelTestFilter¶

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

clear() → None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

property test: str | None¶

evalTest(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact) → bool¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str | None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelPatternFilter¶

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

property pattern: str | None¶

property rePattern: regex.Pattern[str]¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str | None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens | None = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelAspectCover¶

Bases: arelle.ModelFormulaObject.ModelFilter

isAll: bool¶: None

allDimensions: bool¶: None

includedDimQnameProgs: list[arelle.formula.XPathParser.ExpressionStack | None]¶: None

excludedDimQnameProgs: list[arelle.formula.XPathParser.ExpressionStack | None]¶: None

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

clear() → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding, xpCtx: arelle.formula.XPathContext.XPathContext = None) → set[int | arelle.ModelValue.QName]¶

dimAspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[arelle.ModelValue.QName]¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

property viewExpression: str | None¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelBooleanFilter¶

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

property descendantArcroles: tuple[str]¶

property filterRelationships: list[arelle.ModelDtsObject.ModelRelationship]¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property propertyView: tuple[tuple[str, str | None], ...]¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens | None = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelAndFilter¶

Bases: arelle.ModelFormulaObject.ModelBooleanFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

property descendantArcroles: tuple[str]¶

property filterRelationships: list[arelle.ModelDtsObject.ModelRelationship]¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property propertyView: tuple[tuple[str, str | None], ...]¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens | None = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelOrFilter¶

Bases: arelle.ModelFormulaObject.ModelBooleanFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

property descendantArcroles: tuple[str]¶

property filterRelationships: list[arelle.ModelDtsObject.ModelRelationship]¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property propertyView: tuple[tuple[str, str | None], ...]¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens | None = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelConceptName¶

Bases: arelle.ModelFormulaObject.ModelFilter

qnameExpressionProgs: list[arelle.formula.XPathParser.ExpressionStack | None]¶: None

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

clear() → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

property conceptQnames: set[arelle.ModelValue.QName | None]¶

property qnameExpressions: list[str]¶

evalQnames(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact) → set[Any]¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelConceptPeriodType¶

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

property periodType: str | None¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str | None¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens | None = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelConceptBalance¶

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

property balance: str | None¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str | None¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens | None = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelConceptFilterWithQnameExpression¶

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

clear() → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

property filterQname: arelle.ModelValue.QName | None¶

property qnameExpression: str | None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

evalQname(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact) → arelle.ModelValue.QName | None¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelConceptCustomAttribute¶

Bases: arelle.ModelFormulaObject.ModelConceptFilterWithQnameExpression

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

clear() → None¶

property value: str | None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

evalValue(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact) → Any¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

property propertyView: tuple[tuple[str, str | arelle.ModelValue.QName | None] | tuple[], ...]¶

property viewExpression: str¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

property filterQname: arelle.ModelValue.QName | None¶

property qnameExpression: str | None¶

evalQname(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact) → arelle.ModelValue.QName | None¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelConceptDataType¶

Bases: arelle.ModelFormulaObject.ModelConceptFilterWithQnameExpression

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

property strict: str | None¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

property propertyView: tuple[tuple[str, str | arelle.ModelValue.QName | None] | tuple[], ...]¶

property viewExpression: str¶

clear() → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

property filterQname: arelle.ModelValue.QName | None¶

property qnameExpression: str | None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

evalQname(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact) → arelle.ModelValue.QName | None¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelConceptSubstitutionGroup¶

Bases: arelle.ModelFormulaObject.ModelConceptFilterWithQnameExpression

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

property strict: str | None¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

property propertyView: tuple[tuple[str, str | arelle.ModelValue.QName | None] | tuple[], ...]¶

property viewExpression: str¶

clear() → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

property filterQname: arelle.ModelValue.QName | None¶

property qnameExpression: str | None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

evalQname(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact) → arelle.ModelValue.QName | None¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelConceptRelation¶

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

clear() → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

property variable: arelle.ModelValue.QName | None¶

property sourceQname: arelle.ModelValue.QName | None¶

property linkrole: str | None¶

property linkQname: arelle.ModelValue.QName | None¶

property arcrole: str | None¶

property axis: str¶

property generations: int¶

property test: str | None¶

property arcQname: arelle.ModelValue.QName | None¶

property sourceQnameExpression: str | None¶

property linkroleExpression: str | None¶

property linknameExpression: str | None¶

property arcroleExpression: str | None¶

property arcnameExpression: str | None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

evalSourceQname(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact | None) → arelle.ModelValue.QName | None¶

evalLinkrole(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact | None) → str | None¶

evalLinkQname(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact | None) → arelle.ModelValue.QName | None¶

evalArcrole(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact | None) → str | None¶

evalArcQname(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact | None) → arelle.ModelValue.QName | None¶

evalTest(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact) → bool | None¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

property viewExpression: str¶

property xmlElementView: str¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelEntityIdentifier¶

Bases: arelle.ModelFormulaObject.ModelTestFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

clear() → None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

property test: str | None¶

evalTest(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact) → bool¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str | None¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelEntitySpecificIdentifier¶

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

clear() → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

property scheme: str | None¶

property value: str | None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelEntityScheme¶

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

clear() → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

property scheme: str | None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str | None¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelEntityRegexpIdentifier¶

Bases: arelle.ModelFormulaObject.ModelPatternFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

property pattern: str | None¶

property rePattern: regex.Pattern[str]¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str | None¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens | None = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelEntityRegexpScheme¶

Bases: arelle.ModelFormulaObject.ModelPatternFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

property pattern: str | None¶

property rePattern: regex.Pattern[str]¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str | None¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens | None = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelGeneral¶

Bases: arelle.ModelFormulaObject.ModelTestFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

clear() → None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

property test: str | None¶

evalTest(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact) → bool¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str | None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelMatchFilter¶

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

property aspectName: str¶

property dimension: arelle.ModelValue.QName | None¶

property matchAny: bool¶

property aspect: int | arelle.ModelValue.QName | None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int | arelle.ModelValue.QName | None]¶

property variable: arelle.ModelValue.QName | None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

property propertyView: tuple[tuple[str, str | arelle.ModelValue.QName | None] | tuple[], ...]¶

property viewExpression: arelle.ModelValue.QName | None¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

compile() → None¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelPeriod¶

Bases: arelle.ModelFormulaObject.ModelTestFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

clear() → None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

property test: str | None¶

evalTest(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact) → bool¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property viewExpression: str | None¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelDateTimeFilter¶

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

clear() → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

property date: str | None¶

property time: str | None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

evalDatetime(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact, addOneDay: bool = False) → Any¶

property propertyView: tuple[tuple[str, str | None] | tuple[], ...]¶

property viewExpression: str¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelPeriodStart¶

Bases: arelle.ModelFormulaObject.ModelDateTimeFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

clear() → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

property date: str | None¶

property time: str | None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

evalDatetime(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact, addOneDay: bool = False) → Any¶

property propertyView: tuple[tuple[str, str | None] | tuple[], ...]¶

property viewExpression: str¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelPeriodEnd¶

Bases: arelle.ModelFormulaObject.ModelDateTimeFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

clear() → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

property date: str | None¶

property time: str | None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

evalDatetime(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact, addOneDay: bool = False) → Any¶

property propertyView: tuple[tuple[str, str | None] | tuple[], ...]¶

property viewExpression: str¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelPeriodInstant¶

Bases: arelle.ModelFormulaObject.ModelDateTimeFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

clear() → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

property date: str | None¶

property time: str | None¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

evalDatetime(xpCtx: arelle.formula.XPathContext.XPathContext, fact: arelle.ModelInstanceObject.ModelFact, addOneDay: bool = False) → Any¶

property propertyView: tuple[tuple[str, str | None] | tuple[], ...]¶

property viewExpression: str¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelForever¶

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property propertyView: tuple[tuple[str, str | None], ...]¶

property descendantArcroles: tuple[]¶

compile() → None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens | None = [], varRefSet: set[arelle.ModelValue.QName] | None = None) → set[arelle.ModelValue.QName]¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.ModelInstantDuration¶

Bases: arelle.ModelFormulaObject.ModelFilter

init(modelDocument: arelle.ModelDocument.ModelDocument) → None¶

aspectsCovered(varBinding: arelle.formula.FormulaEvaluator.VariableBinding) → set[int]¶

property variable: arelle.ModelValue.QName | None¶

variableRefs(progs: arelle.formula.XPathParser.RecursiveFormulaTokens = [], varRefSet: set[arelle.ModelValue.QName | None] | None = None) → set[arelle.ModelValue.QName]¶

property boundary: str | None¶

filter(xpCtx: arelle.formula.XPathContext.XPathContext, varBinding: arelle.formula.FormulaEvaluator.VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], cmplmt: bool) → set[arelle.ModelInstanceObject.ModelFact]¶

property propertyView: tuple[tuple[str, str | arelle.ModelValue.QName | None], ...]¶

property viewExpression: str¶

hasNoFilterVariableDependencies(xpCtx: arelle.formula.XPathContext.XPathContext) → bool¶

property isFilterShared: bool¶

property descendantArcroles: tuple[]¶

compile() → None¶

logLabel(preferredRole: str = '*', lang: str | None = None) → str¶

property role: str | None¶

property xlinkLabel: str | None¶

property xmlLang: str | None¶

viewText(labelrole: str | None = None, lang: str | None = None) → str¶

roleRefPartSortKey() → str¶

dereference() → Self¶

class arelle.ModelFormulaObject.MemberModel(qname: arelle.ModelValue.QName, qnameExprProg: arelle.formula.XPathParser.ExpressionStack | None, variable: arelle.ModelValue.QName, linkrole: str, arcrole: str, axis: str)¶: Initialization