xbrl.taxonomy

The xbrl.taxonomy module provides a Python API for the XBRL 2.1 specification. This Python interface enables the user to navigate the DTS and its linkbases and taxonomy schemas and access information from concepts and the standard linkbases.

Classes

Enum Classes

class xbrl.taxonomy.ArcUse

The xbrl.taxonomy.ArcUse enumeration represents the value of the ‘use’ attribute on an XLink arc. See here for more details.

ArcUse.OPTIONAL

The arc may participate in the network of relationships.

ArcUse.PROHIBITED

The arc is prohibited from participation in the network of relationships.

class xbrl.taxonomy.Balance

The xbrl.taxonomy.Balance enumeration represents the value of the ‘xbrli:balance’ attribute on an XBRL concept. See here for more details.

Balance.CREDIT

Indicates that fact values for this concept should be interpreted as credit balances.

Balance.DEBIT

Indicates that fact values for this concept should be interpreted as debit balances.

class xbrl.taxonomy.CyclesAllowed

The xbrl.taxonomy.CyclesAllowed enumeration specifies the type of cycles that are allowed in a network of relationships. See here for more details.

CyclesAllowed.ANY

The network of relationships is not constrainted, it may contain both directed and undirected cyles.

CyclesAllowed.NONE

The network of relationships must not contain both directed and undirected cycles.

CyclesAllowed.UNDIRECTED

The network of relationships may contain undirected cycles.

class xbrl.taxonomy.ItemType

The xbrl.taxonomy.ItemType enumeration represents the built-in XBRL item data types. See here for more details.

ItemType.ANYURI

xbrli:anyURIItemType

ItemType.BASE64BINARY

xbrli:base64BinaryItemType

ItemType.BOOLEAN

xbrli:booleanItemType

ItemType.BYTE

xbrli:byteItemType

ItemType.DATE

xbrli:dateItemType

ItemType.DATETIME

xbrli:dateTimeItemType

ItemType.DECIMAL

xbrli:decimalItemType

ItemType.DOUBLE

xbrli:doubleItemType

ItemType.DURATION

xbrli:durationItemType

ItemType.ENUMERATION

enum:enumerationItemType

ItemType.FLOAT

xbrli:floatItemType

ItemType.FRACTION

xbrli:fractionItemType

ItemType.GDAY

xbrli:gDayItemType

ItemType.GMONTH

xbrli:gMonthItemType

ItemType.GMONTHDAY

xbrli:gMonthDayItemType

ItemType.GYEAR

xbrli:gYearItemType

ItemType.GYEARMONTH

xbrli:gYearMonthItemType

ItemType.HEXBINARY

xbrli:hexBinaryItemType

ItemType.INT

xbrli:intItemType

ItemType.INTEGER

xbrli:integerItemType

ItemType.LANGUAGE

xbrli:languageItemType

ItemType.LONG

xbrli:longItemType

ItemType.MONETARY

xbrli:monetaryItemType

ItemType.NAME

xbrli:NameItemType

ItemType.NCNAME

xbrli:NCNameItemType

ItemType.NEGATIVEINTEGER

xbrli:negativeIntegerItemType

ItemType.NONNEGATIVEINTEGER

xbrli:nonNegativeIntegerItemType

ItemType.NONPOSITIVEINTEGER

xbrli:nonPositiveIntegerItemType

ItemType.NORMALIZEDSTRING

xbrli:normalizedStringItemType

ItemType.POSITIVEINTEGER

xbrli:positiveIntegerItemType

ItemType.PURE

xbrli:pureItemType

ItemType.QNAME

xbrli:QNameItemType

ItemType.SHARES

xbrli:sharesItemType

ItemType.SHORT

xbrli:shortItemType

ItemType.STRING

xbrli:stringItemType

ItemType.TIME

xbrli:timeItemType

ItemType.TOKEN

xbrli:tokenItemType

ItemType.UNSIGNEDBYTE

xbrli:unsignedByteItemType

ItemType.UNSIGNEDINT

xbrli:unsignedIntItemType

ItemType.UNSIGNEDLONG

xbrli:unsignedLongItemType

ItemType.UNSIGNEDSHORT

xbrli:unsignedShortItemType

class xbrl.taxonomy.PeriodType

The xbrl.taxonomy.PeriodType enumeration represents the value of the ‘xbrli:periodType’ attribute on an XBRL concept. See here for more details.

PeriodType.DURATION

Facts for this concept must be reported with a duration of forever period.

PeriodType.INSTANT

Facts for this concept must be reported with an instant period.

String Constants

xbrl.taxonomy.ARCROLE_ALL

http://xbrl.org/int/dim/arcrole/all

xbrl.taxonomy.ARCROLE_CONCEPT_LABEL

http://www.xbrl.org/2003/arcrole/concept-label

xbrl.taxonomy.ARCROLE_CONCEPT_REFERENCE

http://www.xbrl.org/2003/arcrole/concept-reference

xbrl.taxonomy.ARCROLE_DIMENSION_DEFAULT

http://xbrl.org/int/dim/arcrole/dimension-default

xbrl.taxonomy.ARCROLE_DIMENSION_DOMAIN

http://xbrl.org/int/dim/arcrole/dimension-domain

xbrl.taxonomy.ARCROLE_DOMAIN_MEMBER

http://xbrl.org/int/dim/arcrole/domain-member

xbrl.taxonomy.ARCROLE_ESSENCE_ALIAS

http://www.xbrl.org/2003/arcrole/essence-alias

xbrl.taxonomy.ARCROLE_FACT_FOOTNOTE

http://www.xbrl.org/2003/arcrole/fact-footnote

xbrl.taxonomy.ARCROLE_GENERAL_SPECIAL

http://www.xbrl.org/2003/arcrole/general-special

xbrl.taxonomy.ARCROLE_HYPERCUBE_DIMENSION

http://xbrl.org/int/dim/arcrole/hypercube-dimension

xbrl.taxonomy.ARCROLE_NOT_ALL

http://xbrl.org/int/dim/arcrole/notAll

xbrl.taxonomy.ARCROLE_PARENT_CHILD

http://www.xbrl.org/2003/arcrole/parent-child

xbrl.taxonomy.ARCROLE_REQUIRES_ELEMENT

http://www.xbrl.org/2003/arcrole/requires-element

xbrl.taxonomy.ARCROLE_SIMILAR_TUPLES

http://www.xbrl.org/2003/arcrole/similar-tuples

xbrl.taxonomy.ARCROLE_SUMMATION_ITEM

http://www.xbrl.org/2003/arcrole/summation-item

xbrl.taxonomy.ROLE_COMMENTARYGUIDANCE

http://www.xbrl.org/2003/role/commentaryGuidance

xbrl.taxonomy.ROLE_COMMENTARYREF

http://www.xbrl.org/2003/role/commentaryRef

xbrl.taxonomy.ROLE_DEFINITIONGUIDANCE

http://www.xbrl.org/2003/role/definitionGuidance

xbrl.taxonomy.ROLE_DEFINITIONREF

http://www.xbrl.org/2003/role/definitionRef

xbrl.taxonomy.ROLE_DISCLOSUREGUIDANCE

http://www.xbrl.org/2003/role/disclosureGuidance

xbrl.taxonomy.ROLE_DISCLOSUREREF

http://www.xbrl.org/2003/role/disclosureRef

xbrl.taxonomy.ROLE_DOCUMENTATION

http://www.xbrl.org/2003/role/documentation

xbrl.taxonomy.ROLE_EXAMPLEGUIDANCE

http://www.xbrl.org/2003/role/exampleGuidance

xbrl.taxonomy.ROLE_EXAMPLEREF

http://www.xbrl.org/2003/role/exampleRef

xbrl.taxonomy.ROLE_FOOTNOTE

http://www.xbrl.org/2003/role/footnote

xbrl.taxonomy.ROLE_LABEL

http://www.xbrl.org/2003/role/label

http://www.xbrl.org/2003/role/link

xbrl.taxonomy.ROLE_MANDATORYDISCLOSUREREF

http://www.xbrl.org/2003/role/mandatoryDisclosureRef

xbrl.taxonomy.ROLE_MEASUREMENTGUIDANCE

http://www.xbrl.org/2003/role/measurementGuidance

xbrl.taxonomy.ROLE_MEASUREMENTREF

http://www.xbrl.org/2003/role/measurementRef

xbrl.taxonomy.ROLE_NEGATIVELABEL

http://www.xbrl.org/2003/role/negativeLabel

xbrl.taxonomy.ROLE_NEGATIVETERSELABEL

http://www.xbrl.org/2003/role/negativeTerseLabel

xbrl.taxonomy.ROLE_NEGATIVEVERBOSELABEL

http://www.xbrl.org/2003/role/negativeVerboseLabel

xbrl.taxonomy.ROLE_PERIODENDLABEL

http://www.xbrl.org/2003/role/periodEndLabel

xbrl.taxonomy.ROLE_PERIODSTARTLABEL

http://www.xbrl.org/2003/role/periodStartLabel

xbrl.taxonomy.ROLE_POSITIVELABEL

http://www.xbrl.org/2003/role/positiveLabel

xbrl.taxonomy.ROLE_POSITIVETERSELABEL

http://www.xbrl.org/2003/role/positiveTerseLabel

xbrl.taxonomy.ROLE_POSITIVEVERBOSELABEL

http://www.xbrl.org/2003/role/positiveVerboseLabel

xbrl.taxonomy.ROLE_PRESENTATIONGUIDANCE

http://www.xbrl.org/2003/role/presentationGuidance

xbrl.taxonomy.ROLE_PRESENTATIONREF

http://www.xbrl.org/2003/role/presentationRef

xbrl.taxonomy.ROLE_RECOMMENDEDDISCLOSUREREF

http://www.xbrl.org/2003/role/recommendedDisclosureRef

xbrl.taxonomy.ROLE_REFERENCE

http://www.xbrl.org/2003/role/reference

xbrl.taxonomy.ROLE_TERSELABEL

http://www.xbrl.org/2003/role/terseLabel

xbrl.taxonomy.ROLE_TOTALLABEL

http://www.xbrl.org/2003/role/totalLabel

xbrl.taxonomy.ROLE_UNSPECIFIEDDISCLOSUREREF

http://www.xbrl.org/2003/role/unspecifiedDisclosureRef

xbrl.taxonomy.ROLE_VERBOSELABEL

http://www.xbrl.org/2003/role/verboseLabel

xbrl.taxonomy.ROLE_ZEROLABEL

http://www.xbrl.org/2003/role/zeroLabel

xbrl.taxonomy.ROLE_ZEROTERSELABEL

http://www.xbrl.org/2003/role/zeroTerseLabel

xbrl.taxonomy.ROLE_ZEROVERBOSELABEL

http://www.xbrl.org/2003/role/zeroVerboseLabel