`arelle.FunctionFn`¶

See COPYRIGHT.md for copyright information.

Module Contents¶

Functions¶

`call`
`node_name`
`nilled`
`string`
`data`
`base_uri`
`document_uri`
`error`
`trace`
`fn_dateTime`
`fn_abs`
`fn_ceiling`
`fn_floor`
`fn_round`
`fn_round_half_to_even`
`codepoints_to_string`
`string_to_codepoints`
`compare`
`codepoint_equal`
`concat`
`string_join`
`substring`
`string_length`
`normalize_space`
`normalize_unicode`
`upper_case`
`lower_case`
`translate`
`encode_for_uri`
`iri_to_uri`
`escape_html_uri`
`contains`
`starts_with`
`ends_with`
`substring_before`
`substring_after`
`substring_functions`
`regexFlags`
`matches`
`replace`
`tokenize`
`resolve_uri`
`true`
`false`
`_not`
`years_from_duration`
`months_from_duration`
`days_from_duration`
`hours_from_duration`
`minutes_from_duration`
`seconds_from_duration`
`year_from_dateTime`
`month_from_dateTime`
`day_from_dateTime`
`hours_from_dateTime`
`minutes_from_dateTime`
`seconds_from_dateTime`
`timezone_from_dateTime`
`year_from_date`
`month_from_date`
`day_from_date`
`timezone_from_date`
`hours_from_time`
`minutes_from_time`
`seconds_from_time`
`timezone_from_time`
`adjust_dateTime_to_timezone`
`adjust_date_to_timezone`
`adjust_time_to_timezone`
`resolve_QName`
`QName`
`prefix_from_QName`
`local_name_from_QName`
`namespace_uri_from_QName`
`QName_functions`
`namespace_uri_for_prefix`
`in_scope_prefixes`
`name`
`local_name`
`namespace_uri`
`Node_functions`
`number`
`lang`
`root`
`boolean`
`index_of`
`empty`
`exists`
`distinct_values`
`insert_before`
`remove`
`reverse`
`subsequence`
`unordered`
`zero_or_one`
`one_or_more`
`exactly_one`
`deep_equal`
`count`
`avg`
`fn_max`
`fn_min`
`fn_sum`
`id`
`idref`
`doc`
`doc_available`
`collection`
`position`
`last`
`current_dateTime`
`current_date`
`current_time`
`implicit_timezone`
`default_collation`
`static_base_uri`
`format_number`

Data¶

`_`
`DECIMAL_5`
`NaN`
`fnFunctions`

API¶

arelle.FunctionFn._: arelle.typing.TypeGetText¶: None

arelle.FunctionFn.DECIMAL_5¶: ‘Decimal(…)’

exception arelle.FunctionFn.fnFunctionNotAvailable¶

Bases: Exception

__repr__() → str¶

arelle.FunctionFn.call(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, localname: str, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → arelle.formula.XPathContext.RecursiveContextItem¶

arelle.FunctionFn.node_name(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → tuple[] | arelle.ModelValue.QName¶

arelle.FunctionFn.nilled(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → bool | tuple[]¶

arelle.FunctionFn.string(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → str¶

arelle.FunctionFn.data(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → Any¶

arelle.FunctionFn.base_uri(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → str¶

arelle.FunctionFn.document_uri(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → Any¶

arelle.FunctionFn.error(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → NoReturn¶

arelle.FunctionFn.trace(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → NoReturn¶

arelle.FunctionFn.fn_dateTime(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → tuple[] | arelle.ModelValue.DateTime | datetime.timedelta¶

arelle.FunctionFn.fn_abs(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → Any¶

arelle.FunctionFn.fn_ceiling(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → int¶

arelle.FunctionFn.fn_floor(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → int¶

arelle.FunctionFn.fn_round(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → Any¶

arelle.FunctionFn.fn_round_half_to_even(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → Any¶

arelle.FunctionFn.codepoints_to_string(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → str | None¶

arelle.FunctionFn.string_to_codepoints(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → tuple[int, ...] | tuple[]¶

arelle.FunctionFn.compare(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → int | tuple[]¶

arelle.FunctionFn.codepoint_equal(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → NoReturn¶

arelle.FunctionFn.concat(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → str¶

arelle.FunctionFn.string_join(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → str¶

arelle.FunctionFn.substring(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → str¶

arelle.FunctionFn.string_length(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → int¶

arelle.FunctionFn.normalize_space(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → str¶

arelle.FunctionFn.normalize_unicode(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → NoReturn¶

arelle.FunctionFn.upper_case(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → str¶

arelle.FunctionFn.lower_case(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → str¶

arelle.FunctionFn.translate(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → str | tuple[]¶

arelle.FunctionFn.encode_for_uri(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → str¶

arelle.FunctionFn.iri_to_uri(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → str¶

arelle.FunctionFn.escape_html_uri(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → str¶

arelle.FunctionFn.contains(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → bool | str¶

arelle.FunctionFn.starts_with(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → bool | str¶

arelle.FunctionFn.ends_with(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → bool | str¶

arelle.FunctionFn.substring_before(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → bool | str¶

arelle.FunctionFn.substring_after(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.OperationDef, contextItem: arelle.formula.XPathContext.ContextItem, args: arelle.formula.XPathContext.ResultStack) → bool | str¶

arelle.FunctionFn.substring_functions(xc: arelle.formula.XPathContext.XPathContext, args: arelle.formula.XPathContext.ResultStack, contains: bool | None = None, startEnd: bool | None = None, beforeAfter: bool | None = None) → bool | str¶