xbrl.Context.Period

An xbrl.Context.Period class represents a <xbrli:period> element with an XBRL context in the XBRL instance.

Nested classes: xbrl.Context.Period.EndDate, xbrl.Context.Period.Forever, xbrl.Context.Period.Instant, xbrl.Context.Period.StartDate

class xbrl.Context.Period

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

Attributes

xbrl.Context.Period.aspect_value

Returns an xbrl.PeriodAspectValue object representing the period aspect value specified in the XBRL context.

xbrl.Context.Period.element

Returns an xml.ElementInformationItem object which represents the <xbrli:period> element information item.

xbrl.Context.Period.end_date

Returns an xbrl.Context.Period.EndDate object which represents the <xbrli:endDate> element of the XBRL context, or None if period is not a duration period.

xbrl.Context.Period.forever

Returns an xbrl.Context.Period.Forever object which represents the <xbrli:forever> element of the XBRL context, or None if period is not a forever period.

xbrl.Context.Period.instant

Returns an xbrl.Context.Period.Instant object which represents the <xbrli:instant> element of the XBRL context, or None if period is not an instant period.

xbrl.Context.Period.start_date

Returns an xbrl.Context.Period.StartDate object which represents the <xbrli:startDate> element of the XBRL context, or None if period is not a duration period.

xbrl.Context.Period.type

Returns the period type as xbrl.PeriodType enumeration.

Methods

xbrl.Context.Period.is_duration()

Returns true if the period has <xbrli:startDate>, <xbrli:endDate> or <xbrli:forever> child element information items.

xbrl.Context.Period.is_forever()

Returns True if the period has a <xbrli:forever> child element information item.

xbrl.Context.Period.is_instant()

Returns True if the period has an <xbrli:instant> child element information item.

xbrl.Context.Period.is_start_end()

Returns True if the period has a <xbrli:startDate> and <xbrli:endDate> child element information items.

Special methods

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