xbrl

The xbrl module provides a Python API for the XBRL 2.1 specification. This Python interface enables the user to navigate the XBRL instance document and access information from any fact item or tuple.

Enum Classes

class xbrl.Aspect

The xbrl.Aspect enumeration represents the various aspects defined in the Variables 1.0 specification. See here for more details. Please note that the dimension aspects are represented as instances of the xbrl.xdt.Dimension.

Aspect.COMPLETE_SCENARIO

The complete scenario aspect

Aspect.COMPLETE_SEGMENT

The complete segment aspect

Aspect.CONCEPT

The concept aspect

Aspect.ENTITY_IDENTIFIER

The entity identifier aspect

Aspect.LOCATION

The location aspect

Aspect.NON_XDT_SCENARIO

The Non-XDT scenario aspect

Aspect.NON_XDT_SEGMENT

The Non-XDT segment aspect

Aspect.PERIOD

The period aspect

Aspect.UNIT

The unit aspect

class xbrl.DuplicateClass

The xbrl.DuplicateClass enumeration represents the various classes of duplicates defined in the Handling Duplicate Facts in XBRL and Inline XBRL 1.0 working group note. See here for more details.

DuplicateClass.ALL

A bit flag including all types of duplicates

DuplicateClass.COMPLETE

The facts are complete duplicates

DuplicateClass.CONSISTENT

The facts are consistent duplicates (only for numeric facts)

DuplicateClass.INCONSISTENT

TA bit flag including inconsistent numeric and non-numeric duplicates

DuplicateClass.MULTI_LANGUAGE

The facts are multi-language duplicates (only for string facts)

DuplicateClass.NONE

The facts are not duplicates

DuplicateClass.NON_NUMERIC_INCONSISTENT

The facts are inconsistent non-numeric duplicates

DuplicateClass.NUMERIC_INCONSISTENT

The facts are inconsistent numeric duplicates

class xbrl.PeriodType

The xbrl.PeriodType enumeration represents the various possible choices how date intervals can be represented in an XBRL instance. See here for more details.

PeriodType.FOREVER

The period contains a forever child element.

PeriodType.INSTANT

The period contains an instant child element.

PeriodType.START_END

The period contains startDate and endDate child elements.

String Constants

xbrl.NAMESPACE_ISO4217

http://www.xbrl.org/2003/iso4217

http://www.xbrl.org/2003/linkbase

xbrl.NAMESPACE_XBRLDI

http://xbrl.org/2006/xbrldi

xbrl.NAMESPACE_XBRLDIE

http://xbrl.org/2005/xbrldi/errors

xbrl.NAMESPACE_XBRLDT

http://xbrl.org/2005/xbrldt

xbrl.NAMESPACE_XBRLDTE

http://xbrl.org/2005/xbrldt/errors

xbrl.NAMESPACE_XBRLI

http://www.xbrl.org/2003/instance

xbrl.NAMESPACE_XL

http://www.xbrl.org/2003/XLink

http://www.w3.org/1999/xlink