arelle.PrototypeDtsObject

See COPYRIGHT.md for copyright information.

Module Contents

Classes

PrototypeObject
LinkPrototype
LocPrototype
ArcPrototype
DocumentPrototype
PrototypeElementTree

API

class arelle.PrototypeDtsObject.PrototypeObject(modelDocument: arelle.ModelDocument.ModelDocument | arelle.PrototypeDtsObject.DocumentPrototype, sourceElement: arelle.ModelObject.ModelObject | None = None)

Bases: arelle.typing.PrototypeObjectBase

Initialization

property sourceline: int | None

get(key: str, default: str | None = None) → str | None

itersiblings(**kwargs: Any) → collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]

Method proxy for itersiblings() of lxml arc element

getparent() → arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject | None

(_ElementBase) – Method proxy for getparent() of lxml arc element

iterchildren() → collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]

iterdescendants() → collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]

class arelle.PrototypeDtsObject.LinkPrototype(modelDocument: arelle.ModelDocument.ModelDocument | arelle.PrototypeDtsObject.DocumentPrototype, parent: arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject | None, qname: arelle.ModelValue.QName, role: str | None, sourceElement: arelle.ModelObject.ModelObject | None = None)

Bases: arelle.PrototypeDtsObject.PrototypeObject, arelle.LinkRelationships.LinkRelationships

Initialization

clear() → None

getparent() → arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject | None

iterchildren() → collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]

property sourceline: int | None

get(key: str, default: str | None = None) → str | None

itersiblings(**kwargs: Any) → collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]

iterdescendants() → collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]

class arelle.PrototypeDtsObject.LocPrototype(modelDocument: arelle.ModelDocument.ModelDocument | arelle.PrototypeDtsObject.DocumentPrototype, parent: arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject | None, label: str, locObject: str | arelle.ModelObject.ModelObject | arelle.ModelDtsObject.ModelResource, role: str | None = None, sourceElement: arelle.ModelObject.ModelObject | None = None)

Bases: arelle.PrototypeDtsObject.PrototypeObject, arelle.typing.LocPrototypeBase

Initialization

clear() → None

property xlinkLabel: str | None

dereference() → Any

getparent() → arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject | None

get(key: str, default: str | None = None) → str | None

property sourceline: int | None

itersiblings(**kwargs: Any) → collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]

iterchildren() → collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]

iterdescendants() → collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]

class arelle.PrototypeDtsObject.ArcPrototype(modelDocument: arelle.ModelDocument.ModelDocument | arelle.PrototypeDtsObject.DocumentPrototype, parent: arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject | None, qname: arelle.ModelValue.QName, fromLabel: str, toLabel: str, linkrole: str, arcrole: str, order: str = '1', sourceElement: arelle.ModelObject.ModelObject | None = None)

Bases: arelle.PrototypeDtsObject.PrototypeObject

Initialization

property orderDecimal: decimal.Decimal

clear() → None

property arcElement: arelle.ModelObject.ModelObject | None

getparent() → arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject | None

get(key: str, default: str | None = None) → str | None

items() → ItemsView[str, str]

property sourceline: int | None

itersiblings(**kwargs: Any) → collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]

iterchildren() → collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]

iterdescendants() → collections.abc.Iterator[arelle.ModelObject.ModelObject | arelle.PrototypeDtsObject.PrototypeObject]

class arelle.PrototypeDtsObject.DocumentPrototype(modelXbrl: arelle.ModelXbrl.ModelXbrl, uri: str, base: str | None = None, referringElement: arelle.ModelObject.ModelObject | None = None, isEntry: bool = False, isDiscovered: bool = False, isIncluded: bool | None = None, namespace: str | None = None, reloadCache: bool = False, **kwargs: Any)

Initialization

clear() → None

class arelle.PrototypeDtsObject.PrototypeElementTree(rootElement: arelle.ModelObject.ModelObject)

Bases: arelle.typing.PrototypeElementTreeBase

Initialization

getroot() → arelle.ModelObject.ModelObject

iter() → collections.abc.Iterator[arelle.ModelObject.ModelObject]

ixIter(childOnly: bool = False) → collections.abc.Iterator[arelle.ModelObject.ModelObject]