arelle.FunctionXs

See COPYRIGHT.md for copyright information.

Module Contents

Functions

call
isXsType
untypedAtomic
anyType
anyAtomicType
dateTime
dateTimeInstantEnd
xbrliDateUnion
date
time
duration
yearMonthDuration
dayTimeDuration
xs_float
double
decimal
integer
nonPositiveInteger
negativeInteger
long
xs_int
short
byte
nonNegativeInteger
unsignedLong
unsignedInt
unsignedShort
unsignedByte
positiveInteger
gYearMonth
gYear
gMonthDay
gDay
gMonth
xsString
normalizedString
token
language
NMTOKEN
Name
NCName
ID
IDREF
ENTITY
boolean
base64Binary
hexBinary
anyURI
QName
NOTATION

Data

objtype
tokenPattern
languagePattern
xsFunctions

API

exception arelle.FunctionXs.FORG0001(message: str | None = None)

Bases: Exception

add_note()

class args

with_traceback()

exception arelle.FunctionXs.FONS0004(message: str | None = None)

Bases: Exception

add_note()

class args

with_traceback()

exception arelle.FunctionXs.xsFunctionNotAvailable

Bases: Exception

add_note()

class args

with_traceback()

arelle.FunctionXs.call(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.ProgHeader | arelle.formula.XPathParser.OperationDef, localname: str, args: arelle.formula.XPathContext.ResultStack) → Any

arelle.FunctionXs.objtype: dict[str, Any]

None

arelle.FunctionXs.isXsType(localName: str) → bool

arelle.FunctionXs.untypedAtomic(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → NoReturn

arelle.FunctionXs.anyType(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → NoReturn

arelle.FunctionXs.anyAtomicType(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → NoReturn

arelle.FunctionXs.dateTime(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → arelle.ModelValue.DateTime | None

arelle.FunctionXs.dateTimeInstantEnd(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → arelle.ModelValue.DateTime | None

arelle.FunctionXs.xbrliDateUnion(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → datetime.date | arelle.ModelValue.DateTime | None

arelle.FunctionXs.date(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → arelle.ModelValue.DateTime | None

arelle.FunctionXs.time(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → arelle.ModelValue.Time | None

arelle.FunctionXs.duration(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → NoReturn

arelle.FunctionXs.yearMonthDuration(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → arelle.ModelValue.YearMonthDuration

arelle.FunctionXs.dayTimeDuration(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → arelle.ModelValue.DayTimeDuration

arelle.FunctionXs.xs_float(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → float

arelle.FunctionXs.double(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → float

arelle.FunctionXs.decimal(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → decimal.Decimal

arelle.FunctionXs.integer(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → int

arelle.FunctionXs.nonPositiveInteger(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → int

arelle.FunctionXs.negativeInteger(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → int

arelle.FunctionXs.long(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → int

arelle.FunctionXs.xs_int(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → int

arelle.FunctionXs.short(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → int

arelle.FunctionXs.byte(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → int

arelle.FunctionXs.nonNegativeInteger(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → int

arelle.FunctionXs.unsignedLong(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → int

arelle.FunctionXs.unsignedInt(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → int

arelle.FunctionXs.unsignedShort(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → int

arelle.FunctionXs.unsignedByte(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → int

arelle.FunctionXs.positiveInteger(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → int

arelle.FunctionXs.gYearMonth(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → arelle.ModelValue.gYearMonth

arelle.FunctionXs.gYear(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → arelle.ModelValue.gYear

arelle.FunctionXs.gMonthDay(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → arelle.ModelValue.gMonthDay

arelle.FunctionXs.gDay(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → arelle.ModelValue.gDay

arelle.FunctionXs.gMonth(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → arelle.ModelValue.gMonth

arelle.FunctionXs.xsString(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → str

arelle.FunctionXs.normalizedString(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → str

arelle.FunctionXs.tokenPattern

‘compile(…)’

arelle.FunctionXs.token(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → str

arelle.FunctionXs.languagePattern

‘compile(…)’

arelle.FunctionXs.language(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → str

arelle.FunctionXs.NMTOKEN(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → NoReturn

arelle.FunctionXs.Name(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → NoReturn

arelle.FunctionXs.NCName(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → NoReturn

arelle.FunctionXs.ID(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → NoReturn

arelle.FunctionXs.IDREF(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → NoReturn

arelle.FunctionXs.ENTITY(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → NoReturn

arelle.FunctionXs.boolean(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → bool

arelle.FunctionXs.base64Binary(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → NoReturn

arelle.FunctionXs.hexBinary(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → NoReturn

arelle.FunctionXs.anyURI(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → arelle.ModelValue.AnyURI | None

arelle.FunctionXs.QName(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → arelle.ModelValue.QName | None

arelle.FunctionXs.NOTATION(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, source: Any) → NoReturn

arelle.FunctionXs.xsFunctions: dict[str, collections.abc.Callable[[arelle.formula.XPathContext.XPathContext, arelle.formula.XPathParser.FormulaToken | None, Any], Any]]

None