arelle.formula.FormulaEvaluator

See COPYRIGHT.md for copyright information.

Module Contents

Classes

Functions

Data

API

arelle.formula.FormulaEvaluator.expressionVariablesPattern

‘compile(…)’

arelle.formula.FormulaEvaluator.EMPTYSET: set[Any]

‘set(…)’

arelle.formula.FormulaEvaluator.init() → None
arelle.formula.FormulaEvaluator.evaluate(xpCtx: arelle.formula.XPathContext.XPathContext, varSet: arelle.ModelFormulaObject.ModelVariableSet, variablesInScope: bool = False, uncoveredAspectFacts: arelle.formula.FormulaEvaluator.UncoveredAspectFacts | None = None) → None
arelle.formula.FormulaEvaluator.evaluateVar(xpCtx: arelle.formula.XPathContext.XPathContext, varSet: arelle.ModelFormulaObject.ModelVariableSet, varIndex: int, cachedFilteredFacts: arelle.formula.FormulaEvaluator.CachedFilteredFacts, uncoveredAspectFacts: arelle.formula.FormulaEvaluator.UncoveredAspectFacts) → None
arelle.formula.FormulaEvaluator.evaluateVariableBindings(xpCtx: arelle.formula.XPathContext.XPathContext, varSet: arelle.ModelFormulaObject.ModelVariableSet, uncoveredAspectFacts: arelle.formula.FormulaEvaluator.UncoveredAspectFacts) → None
arelle.formula.FormulaEvaluator.factVarsExistAndAllHaveFallenBack(xpCtx: arelle.formula.XPathContext.XPathContext) → bool
arelle.formula.FormulaEvaluator.evaluateVariableSetPreconditions(xpCtx: arelle.formula.XPathContext.XPathContext, varSet: arelle.ModelFormulaObject.ModelVariableSet) → bool
arelle.formula.FormulaEvaluator.bindVariables(xpCtx: arelle.formula.XPathContext.XPathContext, varSet: arelle.ModelFormulaObject.ModelVariableSet, varIndex: int, cachedFilteredFacts: arelle.formula.FormulaEvaluator.CachedFilteredFacts, uncoveredAspectFacts: arelle.formula.FormulaEvaluator.UncoveredAspectFacts) → None
arelle.formula.FormulaEvaluator.bindFactVariable(xpCtx: arelle.formula.XPathContext.XPathContext, varSet: arelle.ModelFormulaObject.ModelVariableSet, cachedFilteredFacts: arelle.formula.FormulaEvaluator.CachedFilteredFacts, uncoveredAspectFacts: arelle.formula.FormulaEvaluator.UncoveredAspectFacts, varQname: arelle.ModelValue.QName, vb: VariableBinding) → None
arelle.formula.FormulaEvaluator.filterFacts(xpCtx: arelle.formula.XPathContext.XPathContext, vb: VariableBinding, facts: set[arelle.ModelInstanceObject.ModelFact], filterRelationships: collections.abc.Iterable[arelle.ModelDtsObject.ModelRelationship], filterType: str | None) → set[arelle.ModelInstanceObject.ModelFact]
arelle.formula.FormulaEvaluator.coverAspectCoverFilterDims(xpCtx: arelle.formula.XPathContext.XPathContext, vb: VariableBinding, filterRelationships: collections.abc.Iterable[arelle.ModelDtsObject.ModelRelationship]) → None
arelle.formula.FormulaEvaluator.isVbTupleWithOnlyAnUncoveredDimension(xpCtx: arelle.formula.XPathContext.XPathContext, vb: VariableBinding, facts: collections.abc.Iterable[arelle.ModelInstanceObject.ModelFact]) → bool
arelle.formula.FormulaEvaluator.implicitFilter(xpCtx: arelle.formula.XPathContext.XPathContext, vb: VariableBinding, facts: arelle.formula.FormulaEvaluator.Facts, uncoveredAspectFacts: arelle.formula.FormulaEvaluator.UncoveredAspectFacts) → arelle.formula.FormulaEvaluator.Facts
arelle.formula.FormulaEvaluator.aspectsMatch(xpCtx: arelle.formula.XPathContext.XPathContext, fact1: arelle.ModelInstanceObject.ModelFact | None, fact2: arelle.ModelInstanceObject.ModelFact | None, aspects: collections.abc.Iterable[arelle.formula.FormulaEvaluator.AspectKey]) → bool
arelle.formula.FormulaEvaluator.aspectMatches(xpCtx: arelle.formula.XPathContext.XPathContext, fact1: arelle.ModelInstanceObject.ModelFact | None, fact2: arelle.ModelInstanceObject.ModelFact | None, aspect: arelle.formula.FormulaEvaluator.AspectKey) → bool
arelle.formula.FormulaEvaluator.aspectMatchesNoCache(xpCtx: arelle.formula.XPathContext.XPathContext, fact1: arelle.ModelInstanceObject.ModelFact | None, fact2: arelle.ModelInstanceObject.ModelFact | None, aspect: arelle.formula.FormulaEvaluator.AspectKey) → bool
arelle.formula.FormulaEvaluator.factsPartitions(xpCtx: arelle.formula.XPathContext.XPathContext, facts: collections.abc.Iterable[arelle.ModelInstanceObject.ModelFact], aspects: collections.abc.Iterable[arelle.formula.FormulaEvaluator.AspectKey]) → list[list[arelle.ModelInstanceObject.ModelFact]]
arelle.formula.FormulaEvaluator.evaluationIsUnnecessary(thisEval: arelle.formula.FormulaEvaluator.Evaluation, xpCtx: arelle.formula.XPathContext.XPathContext) → bool
arelle.formula.FormulaEvaluator.produceOutputFact(xpCtx: arelle.formula.XPathContext.XPathContext, formula: arelle.ModelFormulaObject.ModelFormula, result: Any) → arelle.ModelInstanceObject.ModelFact | None
arelle.formula.FormulaEvaluator.formulaAspectValue(xpCtx: arelle.formula.XPathContext.XPathContext, formula: arelle.ModelFormulaObject.ModelFormula, aspect: arelle.formula.FormulaEvaluator.AspectKey, srcMissingErr: str | None) → Any
arelle.formula.FormulaEvaluator.uncoveredAspectValue(xpCtx: arelle.formula.XPathContext.XPathContext, aspect: arelle.formula.FormulaEvaluator.AspectKey) → Any
arelle.formula.FormulaEvaluator.variableBindingIsFallback(xpCtx: arelle.formula.XPathContext.XPathContext, variableQname: arelle.ModelValue.QName) → bool
arelle.formula.FormulaEvaluator.uncoveredVariableSetAspects(xpCtx: arelle.formula.XPathContext.XPathContext) → set[arelle.formula.FormulaEvaluator.AspectKey]
class arelle.formula.FormulaEvaluator.VariableBindingError(err: str, msg: str | None = None)

Initialization

arelle.formula.FormulaEvaluator.orderAspects(aspects: collections.abc.Iterable[arelle.formula.FormulaEvaluator.AspectKey]) → list[arelle.formula.FormulaEvaluator.AspectKey]
arelle.formula.FormulaEvaluator.xbrlfe_undefinedSAV

‘VariableBindingError(…)’

class arelle.formula.FormulaEvaluator.VariableBinding(xpCtx: arelle.formula.XPathContext.XPathContext, varRel: arelle.ModelDtsObject.ModelRelationship | None = None, boundFact: arelle.ModelInstanceObject.ModelFact | None = None)

Initialization

qname: arelle.ModelValue.QName | None

None

var: Any

None

aspectsDefined: set[arelle.formula.FormulaEvaluator.AspectKey]

None

aspectsCovered: set[arelle.formula.FormulaEvaluator.AspectKey]

None

facts: arelle.formula.FormulaEvaluator.Facts

None

values: Any

None

parameterValue: Any

None

yieldedFact: arelle.ModelInstanceObject.ModelFact | None

None

yieldedFactContext: arelle.ModelInstanceObject.ModelContext | None

None

yieldedEvaluation: Any

None

close() → None
property resourceElementName: str | None
matchesSubPartitions(partition: list[arelle.ModelInstanceObject.ModelFact], aspects: collections.abc.Iterable[arelle.formula.FormulaEvaluator.AspectKey]) → collections.abc.Generator[list[arelle.ModelInstanceObject.ModelFact] | tuple[arelle.ModelInstanceObject.ModelFact, ...], None, None]
property evaluationResults: collections.abc.Generator[Any, None, None]
matchableBoundFact(fbVars: set[arelle.ModelValue.QName]) → Any
hasDimension(dimension: arelle.ModelValue.QName) → bool
hasDimensionValueDefined(dimension: arelle.ModelValue.QName) → bool
definedDimensions(dimension: arelle.ModelValue.QName) → set[arelle.ModelValue.QName]
isDimensionalValid(dimension: arelle.ModelValue.QName) → bool
hasAspectValueUncovered(aspect: arelle.formula.FormulaEvaluator.AspectKey) → bool
hasAspectValueCovered(aspect: arelle.formula.FormulaEvaluator.AspectKey) → bool
aspectsNotCovered(aspects: collections.abc.Iterable[arelle.formula.FormulaEvaluator.AspectKey]) → set[arelle.formula.FormulaEvaluator.AspectKey]
hasAspectValueDefined(aspect: arelle.formula.FormulaEvaluator.AspectKey) → bool
aspectValue(aspect: arelle.formula.FormulaEvaluator.AspectKey) → Any