`xbrl.Context`¶

An xbrl.Context class represents an XBRL context in the XBRL instance.

Nested classes: xbrl.Context.Entity, xbrl.Context.Period, xbrl.Context.Scenario

class xbrl.Context¶: Proper instances of this class will be created within RaptorXML only, instantiation from script code will throw a NotImplementedError exception.

Attributes¶

xbrl.Context.aspect_values¶: Returns an xbrl.ConstraintSet object representing the aspect values specified in the XBRL context.

xbrl.Context.dimension_aspect_values¶: Returns an iterator of xbrl.ExplicitDimensionAspectValue and xbrl.TypedDimensionAspectValue objects representing the dimension aspect values specified in the XBRL context.

xbrl.Context.element¶: Returns an xml.ElementInformationItem object which represents the <xbrli:context> element information item.

xbrl.Context.entity¶: Returns an xbrl.Context.Entity object which represents the <xbrli:entity> element of the XBRL context.

xbrl.Context.entity_identifier_aspect_value¶: Returns an xbrl.EntityIdentifierAspectValue object representing the entity identifier aspect value specified in the XBRL context.

xbrl.Context.explicit_dimension_aspect_values¶: Returns an iterator of xbrl.ExplicitDimensionAspectValue objects representing the explicit dimension aspect values specified in the XBRL context.

xbrl.Context.id¶: Returns the value of the ‘id’ attribute as a string, or None if the XML element information item doesn’t have an ‘id’ attribute.

xbrl.Context.non_xdt_scenario_aspect_value¶: Returns an xbrl.ScenarioAspectValue object representing the non-XDT scenario aspect value specified in the XBRL context.

xbrl.Context.non_xdt_segment_aspect_value¶: Returns an xbrl.SegmentAspectValue object representing the non-XDT segment aspect value specified in the XBRL context.

xbrl.Context.period¶: Returns an xbrl.Context.Period object which represents the <xbrli:period> element of the XBRL context.

xbrl.Context.period_aspect_value¶: Returns an xbrl.PeriodAspectValue object representing the period aspect value specified in the XBRL context.

xbrl.Context.scenario¶: Returns an xbrl.Context.Scenario object which represents the <xbrli:scenario> element of the XBRL context, or None if the XBRL context doesn’t have a scenario element.

xbrl.Context.typed_dimension_aspect_values¶: Returns an iterator of xbrl.TypedDimensionAspectValue objects representing the typed dimension aspect values specified in the XBRL context.

Methods¶

xbrl.Context.dimension_aspect_value(Dimension dimension)¶: Returns an xbrl.ExplicitDimensionAspectValue or xbrl.TypedDimensionAspectValue object which represents the dimension aspect value specified in the XBRL context, or None if the XBRL context doesn’t have a dimension aspect for the given dimension.

xbrl.Context.xpointer(bForceElementScheme=False)¶: Returns an URI with XPointer fragment that points to this XML element as a string. If the XML element information item has an id attribute, a shorthand pointer with the id attribute value will be generated, otherwise the XPointer element scheme will be used. Set force_element_scheme to True to prevent generation of shorthand pointers.

Special methods¶

__bool__, __eq__, __ge__, __gt__, __le__, __lt__, __ne__