`arelle.FunctionUtil`¶

See COPYRIGHT.md for copyright information.

Module Contents¶

Functions¶

`anytypeArg`
`atomicArg`
`stringArg`
`numericArg`
`integerArg`
`qnameArg`
`nodeArg`
`testTypeCompatibility`

Data¶

emptyFallbackType

API¶

arelle.FunctionUtil.emptyFallbackType: TypeAlias¶: None

arelle.FunctionUtil.anytypeArg(xc: arelle.formula.XPathContext.XPathContext, args: arelle.formula.XPathContext.ResultStack, i: int, type: str, missingArgFallback: arelle.formula.XPathContext.ContextItem = None) → Any¶

arelle.FunctionUtil.atomicArg(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken, args: arelle.formula.XPathContext.ResultStack, i: int, type: str, missingArgFallback: arelle.formula.XPathContext.ContextItem = None, emptyFallback: arelle.FunctionUtil.emptyFallbackType = ()) → Any¶

arelle.FunctionUtil.stringArg(xc: arelle.formula.XPathContext.XPathContext, args: arelle.formula.XPathContext.ResultStack, i: int, type: str, missingArgFallback: arelle.formula.XPathContext.ContextItem = None, emptyFallback: arelle.FunctionUtil.emptyFallbackType = '') → Any¶

arelle.FunctionUtil.numericArg(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken, args: arelle.formula.XPathContext.ResultStack, i: int = 0, missingArgFallback: arelle.formula.XPathContext.ContextItem = None, emptyFallback: arelle.FunctionUtil.emptyFallbackType = 0, convertFallback: str | int | float | None = None) → Any¶

arelle.FunctionUtil.integerArg(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken, args: arelle.formula.XPathContext.ResultStack, i: int = 0, missingArgFallback: arelle.formula.XPathContext.ContextItem = None, emptyFallback: arelle.FunctionUtil.emptyFallbackType = 0, convertFallback: int | None = None) → arelle.FunctionUtil.emptyFallbackType¶

arelle.FunctionUtil.qnameArg(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken, args: arelle.formula.XPathContext.ResultStack, i: int, type: str, missingArgFallback: arelle.formula.XPathContext.ContextItem = None, emptyFallback: arelle.FunctionUtil.emptyFallbackType = ()) → arelle.ModelValue.QName | arelle.FunctionUtil.emptyFallbackType¶

arelle.FunctionUtil.nodeArg(xc: arelle.formula.XPathContext.XPathContext, args: arelle.formula.XPathContext.ResultStack, i: int, type: str, missingArgFallback: arelle.formula.XPathContext.ContextItem = None, emptyFallback: arelle.FunctionUtil.emptyFallbackType = None) → arelle.ModelObject.ModelObject | arelle.ModelObject.ModelAttribute | arelle.FunctionUtil.emptyFallbackType | arelle.ModelValue.QName¶

arelle.FunctionUtil.testTypeCompatibility(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken, op: str, a1: arelle.formula.XPathContext.ContextItem, a2: arelle.formula.XPathContext.ContextItem) → None¶