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

API

arelle.FunctionFn.DECIMAL_5

‘Decimal(…)’

exception arelle.FunctionFn.fnFunctionNotAvailable

Bases: Exception

__repr__()
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, p, contextItem, args)
arelle.FunctionFn.nilled(xc, p, contextItem, args)
arelle.FunctionFn.string(xc, p, contextItem, args)
arelle.FunctionFn.data(xc, p, contextItem, args)
arelle.FunctionFn.base_uri(xc, p, contextItem, args)
arelle.FunctionFn.document_uri(xc, p, contextItem, args)
arelle.FunctionFn.error(xc, p, contextItem, args)
arelle.FunctionFn.trace(xc, p, contextItem, args)
arelle.FunctionFn.fn_dateTime(xc, p, contextItem, args)
arelle.FunctionFn.fn_abs(xc, p, contextItem, args)
arelle.FunctionFn.fn_ceiling(xc, p, contextItem, args)
arelle.FunctionFn.fn_floor(xc, p, contextItem, args)
arelle.FunctionFn.fn_round(xc, p, contextItem, args)
arelle.FunctionFn.fn_round_half_to_even(xc, p, contextItem, args)
arelle.FunctionFn.codepoints_to_string(xc, p, contextItem, args)
arelle.FunctionFn.string_to_codepoints(xc, p, contextItem, args)
arelle.FunctionFn.compare(xc, p, contextItem, args)
arelle.FunctionFn.codepoint_equal(xc, p, contextItem, args)
arelle.FunctionFn.concat(xc, p, contextItem, args)
arelle.FunctionFn.string_join(xc, p, contextItem, args)
arelle.FunctionFn.substring(xc, p, contextItem, args)
arelle.FunctionFn.string_length(xc, p, contextItem, args)
arelle.FunctionFn.nonSpacePattern

‘compile(…)’

arelle.FunctionFn.normalize_space(xc, p, contextItem, args)
arelle.FunctionFn.normalize_unicode(xc, p, contextItem, args)
arelle.FunctionFn.upper_case(xc, p, contextItem, args)
arelle.FunctionFn.lower_case(xc, p, contextItem, args)
arelle.FunctionFn.translate(xc, p, contextItem, args)
arelle.FunctionFn.encode_for_uri(xc, p, contextItem, args)
arelle.FunctionFn.iri_to_uri(xc, p, contextItem, args)
arelle.FunctionFn.escape_html_uri(xc, p, contextItem, args)
arelle.FunctionFn.contains(xc, p, contextItem, args)
arelle.FunctionFn.starts_with(xc, p, contextItem, args)
arelle.FunctionFn.ends_with(xc, p, contextItem, args)
arelle.FunctionFn.substring_before(xc, p, contextItem, args)
arelle.FunctionFn.substring_after(xc, p, contextItem, args)
arelle.FunctionFn.substring_functions(xc, args, contains=None, startEnd=None, beforeAfter=None)
arelle.FunctionFn.regexFlags(xc, p, args, n)
arelle.FunctionFn.matches(xc, p, contextItem, args)
arelle.FunctionFn.replace(xc, p, contextItem, args)
arelle.FunctionFn.tokenize(xc, p, contextItem, args)
arelle.FunctionFn.resolve_uri(xc, p, contextItem, args)
arelle.FunctionFn.true(xc, p, contextItem, args)
arelle.FunctionFn.false(xc, p, contextItem, args)
arelle.FunctionFn._not(xc, p, contextItem, args)
arelle.FunctionFn.years_from_duration(xc, p, contextItem, args)
arelle.FunctionFn.months_from_duration(xc, p, contextItem, args)
arelle.FunctionFn.days_from_duration(xc, p, contextItem, args)
arelle.FunctionFn.hours_from_duration(xc, p, contextItem, args)
arelle.FunctionFn.minutes_from_duration(xc, p, contextItem, args)
arelle.FunctionFn.seconds_from_duration(xc, p, contextItem, args)
arelle.FunctionFn.year_from_dateTime(xc, p, contextItem, args)
arelle.FunctionFn.month_from_dateTime(xc, p, contextItem, args)
arelle.FunctionFn.day_from_dateTime(xc, p, contextItem, args)
arelle.FunctionFn.hours_from_dateTime(xc, p, contextItem, args)
arelle.FunctionFn.minutes_from_dateTime(xc, p, contextItem, args)
arelle.FunctionFn.seconds_from_dateTime(xc, p, contextItem, args)
arelle.FunctionFn.timezone_from_dateTime(xc, p, contextItem, args)
arelle.FunctionFn.year_from_date(xc, p, contextItem, args)
arelle.FunctionFn.month_from_date(xc, p, contextItem, args)
arelle.FunctionFn.day_from_date(xc, p, contextItem, args)
arelle.FunctionFn.timezone_from_date(xc, p, contextItem, args)
arelle.FunctionFn.hours_from_time(xc, p, contextItem, args)
arelle.FunctionFn.minutes_from_time(xc, p, contextItem, args)
arelle.FunctionFn.seconds_from_time(xc, p, contextItem, args)
arelle.FunctionFn.timezone_from_time(xc, p, contextItem, args)
arelle.FunctionFn.adjust_dateTime_to_timezone(xc, p, contextItem, args)
arelle.FunctionFn.adjust_date_to_timezone(xc, p, contextItem, args)
arelle.FunctionFn.adjust_time_to_timezone(xc, p, contextItem, args)
arelle.FunctionFn.resolve_QName(xc, p, contextItem, args)
arelle.FunctionFn.QName(xc, p, contextItem, args)
arelle.FunctionFn.prefix_from_QName(xc, p, contextItem, args)
arelle.FunctionFn.local_name_from_QName(xc, p, contextItem, args)
arelle.FunctionFn.namespace_uri_from_QName(xc, p, contextItem, args)
arelle.FunctionFn.QName_functions(xc, p, args, prefix=False, localName=False, namespaceURI=False)
arelle.FunctionFn.namespace_uri_for_prefix(xc, p, contextItem, args)
arelle.FunctionFn.in_scope_prefixes(xc, p, contextItem, args)
arelle.FunctionFn.name(xc, p, contextItem, args)
arelle.FunctionFn.local_name(xc, p, contextItem, args)
arelle.FunctionFn.namespace_uri(xc, p, contextItem, args)
arelle.FunctionFn.Node_functions(xc, contextItem, args, name=None, localName=None, namespaceURI=None)
arelle.FunctionFn.NaN

‘float(…)’

arelle.FunctionFn.number(xc, p, contextItem, args)
arelle.FunctionFn.lang(xc, p, contextItem, args)
arelle.FunctionFn.root(xc, p, contextItem, args)
arelle.FunctionFn.boolean(xc: arelle.formula.XPathContext.XPathContext, p: arelle.formula.XPathParser.FormulaToken | None, contextItem: arelle.formula.XPathContext.ContextItem | None, args: arelle.formula.XPathContext.ResultStack) bool
arelle.FunctionFn.index_of(xc, p, contextItem, args)
arelle.FunctionFn.empty(xc, p, contextItem, args)
arelle.FunctionFn.exists(xc, p, contextItem, args)
arelle.FunctionFn.distinct_values(xc, p, contextItem, args)
arelle.FunctionFn.insert_before(xc, p, contextItem, args)
arelle.FunctionFn.remove(xc, p, contextItem, args)
arelle.FunctionFn.reverse(xc, p, contextItem, args)
arelle.FunctionFn.subsequence(xc, p, contextItem, args)
arelle.FunctionFn.unordered(xc, p, contextItem, args)
arelle.FunctionFn.zero_or_one(xc, p, contextItem, args)
arelle.FunctionFn.one_or_more(xc, p, contextItem, args)
arelle.FunctionFn.exactly_one(xc, p, contextItem, args)
arelle.FunctionFn.deep_equal(xc, p, contextItem, args)
arelle.FunctionFn.count(xc, p, contextItem, args)
arelle.FunctionFn.avg(xc, p, contextItem, args)
arelle.FunctionFn.fn_max(xc, p, contextItem, args)
arelle.FunctionFn.fn_min(xc, p, contextItem, args)
arelle.FunctionFn.fn_sum(xc, p, contextItem, args)
arelle.FunctionFn.id(xc, p, contextItem, args)
arelle.FunctionFn.idref(xc, p, contextItem, args)
arelle.FunctionFn.doc(xc, p, contextItem, args)
arelle.FunctionFn.doc_available(xc, p, contextItem, args)
arelle.FunctionFn.collection(xc, p, contextItem, args)
arelle.FunctionFn.position(xc, p, contextItem, args)
arelle.FunctionFn.last(xc, p, contextItem, args)
arelle.FunctionFn.current_dateTime(xc, p, contextItem, args)
arelle.FunctionFn.current_date(xc, p, contextItem, args)
arelle.FunctionFn.current_time(xc, p, contextItem, args)
arelle.FunctionFn.implicit_timezone(xc, p, contextItem, args)
arelle.FunctionFn.default_collation(xc, p, contextItem, args)
arelle.FunctionFn.static_base_uri(xc, p, contextItem, args)
arelle.FunctionFn.format_number(xc, p, args)
arelle.FunctionFn.fnFunctions

None