`xbrl.Period`¶

A Period class represents the period part of an XBRL context in the instance document.

INSTANT Denotes that the period contains an instant child XML information item. DURATION Denotes that the period contains startDate and endDate child XML information items. FOREVER Denotes that the period contains a forever child XML information item.

class xbrl.Period¶

Attributes¶

xbrl.Period.aspect_value¶: Returns an xbrl.PeriodAspectValue object representing the value of the period aspect.

xbrl.Period.effective_end_date¶: Returns a datetime.datetime object with effective date and time calculated from the value of the endDate child XML element information item. If the period doesn’t have an endDate child XML element information item, the attribute is None.

xbrl.Period.effective_instant¶: Returns a datetime.datetime object with effective date and time calculated from the value of the instant child XML element information item. If the period doesn’t have an instant child XML element information item, the attribute is None.

xbrl.Period.effective_start_date¶: Returns a datetime.datetime object with effective date and time calculated from the value of the startDate child XML element information item. If the period doesn’t have a startDate child XML element information item, the attribute is None.

xbrl.Period.element¶: Returns an xml.Element object which represents the period child XML element information item of the XBRL context.

xbrl.Period.end_date¶: Returns a string with the text value of the endDate child XML element information item. If the period doesn’t have an endDate child XML element information item, the attribute is None.

xbrl.Period.instant¶: Returns a string with the text value of the instant child XML element information item. If the period doesn’t have an instant child XML element information item, the attribute is None.

xbrl.Period.period_type¶: Returns INSTANT, DURATION or FOREVER depending on the period’s child XML element information items.

xbrl.Period.start_date¶: Returns a string with the text value of the startDate child XML element information item. If the period doesn’t have an startDate child XML element information item, the attribute is None.

Special methods¶

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