arelle.formula.XPathContext
#
See COPYRIGHT.md for copyright information.
Module Contents#
Classes#
Functions#
Data#
API#
- arelle.formula.XPathContext._: arelle.typing.TypeGetText#
None
- arelle.formula.XPathContext.ContextItem#
None
- arelle.formula.XPathContext.AtomizedValue#
None
- arelle.formula.XPathContext.RecursiveContextItem#
None
- arelle.formula.XPathContext.ResultStack#
None
- arelle.formula.XPathContext.boolean: Callable[[arelle.formula.XPathContext.XPathContext, arelle.formula.XPathParser.FormulaToken | None, arelle.formula.XPathContext.ContextItem | None, arelle.formula.XPathContext.ResultStack], bool] | None#
None
- arelle.formula.XPathContext.testTypeCompatibility: Callable[[arelle.formula.XPathContext.XPathContext, arelle.formula.XPathParser.FormulaToken, str, arelle.formula.XPathContext.ContextItem, arelle.formula.XPathContext.ContextItem], None] | None#
None
- arelle.formula.XPathContext.Trace: Type[arelle.ModelFormulaObject.Trace] | None#
None
- arelle.formula.XPathContext.qnWild#
‘qname(…)’
- exception arelle.formula.XPathContext.XPathException(progStep: arelle.formula.XPathParser.FormulaToken | None, code: arelle.ModelValue.QName | str, message: str)#
Bases:
Exception
- __repr__() str #
- property sourceErrorIndication: str#
- exception arelle.formula.XPathContext.FunctionNumArgs(errCode: str = 'err:XPST0017', errText: str | None = None)#
Bases:
Exception
- __repr__() str #
- exception arelle.formula.XPathContext.FunctionArgType(argIndex: int | str, expectedType: str, foundObject: str | arelle.ModelValue.QName | Sequence[arelle.formula.XPathParser.FormulaToken] | None = '', errCode: str = 'err:XPTY0004')#
Bases:
Exception
- __repr__() str #
- exception arelle.formula.XPathContext.FunctionNotAvailable(name: str | None = None)#
Bases:
Exception
- __repr__() str #
- arelle.formula.XPathContext.create(modelXbrl: arelle.ModelXbrl.ModelXbrl, inputXbrlInstance: arelle.ModelDocument.ModelDocument | None = None, sourceElement: arelle.ModelObject.ModelObject | None = None) XPathContext #
- arelle.formula.XPathContext.VALUE_OPS#
None
- arelle.formula.XPathContext.GENERALCOMPARISON_OPS#
None
- arelle.formula.XPathContext.NODECOMPARISON_OPS#
None
- arelle.formula.XPathContext.COMBINING_OPS#
None
- arelle.formula.XPathContext.LOGICAL_OPS#
None
- arelle.formula.XPathContext.UNARY_OPS#
None
- arelle.formula.XPathContext.FORSOMEEVERY_OPS#
None
- arelle.formula.XPathContext.PATH_OPS#
None
- arelle.formula.XPathContext.SEQUENCE_TYPES#
()
- arelle.formula.XPathContext.GREGORIAN_TYPES#
()
- class arelle.formula.XPathContext.XPathContext(modelXbrl: arelle.ModelXbrl.ModelXbrl, inputXbrlInstance: arelle.ModelDocument.ModelDocument, sourceElement: arelle.ModelObject.ModelObject | None, inScopeVars: dict[arelle.ModelValue.QName, arelle.ModelXbrl.ModelXbrl | arelle.ModelObject.ModelObject | int | str] | None = None, factAspectsCache: arelle.formula.FactAspectsCache.FactAspectsCache | None = None)#
Initialization
- close() None #
- runTimeExceededCallback() None #
- property formulaOptions: arelle.ModelFormulaObject.FormulaOptions#
- evaluate(exprStack: Iterable[arelle.formula.XPathParser.FormulaToken], contextItem: arelle.formula.XPathContext.ContextItem | None = None, resultStack: arelle.formula.XPathContext.ResultStack | None = None, parentOp: str | None = None) arelle.formula.XPathContext.ResultStack #
- evaluateBooleanValue(exprStack: Sequence[arelle.formula.XPathParser.FormulaToken], contextItem: arelle.formula.XPathContext.ContextItem | None = None) bool #
- evaluateAtomicValue(exprStack: Sequence[arelle.formula.XPathParser.FormulaToken], _type: arelle.ModelValue.QName | str | None, contextItem: arelle.formula.XPathContext.ContextItem | None = None) Any #
- evaluateRangeVars(op: str, p: arelle.formula.XPathParser.FormulaToken, args: Sequence[arelle.formula.XPathParser.FormulaToken], contextItem: arelle.formula.XPathContext.ContextItem, result: Any) None #
- isNodeSequence(x: Iterable[arelle.formula.XPathContext.ContextItem]) bool #
- stepAxis(op: str | None, p: arelle.formula.XPathParser.FormulaToken, sourceSequence: Iterable[arelle.formula.XPathContext.ContextItem]) Sequence[str | arelle.ModelObject.ModelAttribute | arelle.ModelObject.ModelObject] #
- predicate(p: arelle.formula.XPathParser.OperationDef, sourceSequence: Iterable[arelle.formula.XPathContext.ContextItem]) Sequence[arelle.formula.XPathContext.ContextItem] #
- atomize(p: arelle.formula.XPathParser.FormulaToken | None, x: arelle.formula.XPathContext.RecursiveContextItem | None) Any #
- effectiveBooleanValue(p: arelle.formula.XPathParser.FormulaToken | None, x: arelle.formula.XPathContext.ResultStack | Sequence[arelle.formula.XPathContext.ContextItem] | None) bool #
- traceEffectiveVariableValue(elt: arelle.ModelObject.ModelObject, varname: str) str | None #
- flattenSequence(x: Any, sequence: list[Any] | None = None) list[Any] #
- documentOrderedNodes(x: Iterable[arelle.formula.XPathContext.ContextItem]) Sequence[arelle.formula.XPathContext.ContextItem] #
- modelItem(x: arelle.ModelObject.ModelObject) arelle.ModelInstanceObject.ModelFact | None #
- modelInstance(x: arelle.ModelXbrl.ModelXbrl | arelle.ModelObject.ModelObject | None) arelle.ModelXbrl.ModelXbrl | None #