Detail: IndexYear: Accessor Datetime

Overview: IndexYear: Accessor Datetime

IndexYear.via_dt.__call__(*, fill_value)
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.__call__(*, fill_value)[source]
Parameters:

fill_value – If NAT are encountered, use this value.

>>> ix = sf.IndexYear(('1620', 'NaT', '1619'))
>>> ix
<IndexYear>
1620
NaT
1619
<datetime64[Y]>
>>> ix.via_dt(fill_value=-1).year
[1620   -1 1619]
IndexYear.via_dt.year
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.year

Return the year of each element.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.year
[1517 1520 1518]
IndexYear.via_dt.year_month
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.year_month

Return the year and month of each element as string formatted YYYY-MM.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.year_month
RuntimeError('invalid dtype (datetime64[Y]) for date operation')
IndexYear.via_dt.month
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.month

Return the month of each element, between 1 and 12 inclusive.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.month
RuntimeError('invalid dtype (datetime64[Y]) for date operation')
IndexYear.via_dt.day
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.day

Return the day of each element, between 1 and the number of days in the given month of the given year.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.day
RuntimeError('invalid dtype (datetime64[Y]) for date operation')
IndexYear.via_dt.hour
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.hour

Return the hour of each element, between 0 and 24.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.hour
[0 0 0]
IndexYear.via_dt.minute
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.minute

Return the minute of each element, between 0 and 60.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.minute
[0 0 0]
IndexYear.via_dt.second
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.second

Return the second of each element, between 0 and 60.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.second
[0 0 0]
IndexYear.via_dt.weekday
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.weekday()[source]

Return the day of the week as an integer, where Monday is 0 and Sunday is 6.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.weekday()
RuntimeError('invalid dtype (datetime64[Y]) for date operation')
IndexYear.via_dt.quarter
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.quarter()[source]

Return the quarter of the year as an integer, where January through March is quarter 1.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.quarter()
[1 1 1]
IndexYear.via_dt.is_month_end
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.is_month_end()[source]

Return Boolean indicators if the day is the month end.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.is_month_end()
RuntimeError('invalid dtype (datetime64[Y]) for date operation')
IndexYear.via_dt.is_month_start
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.is_month_start()[source]

Return Boolean indicators if the day is the month start.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.is_month_start()
RuntimeError('invalid dtype (datetime64[Y]) for date operation')
IndexYear.via_dt.is_year_end
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.is_year_end()[source]

Return Boolean indicators if the day is the year end.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.is_year_end()
RuntimeError('invalid dtype (datetime64[Y]) for date operation')
IndexYear.via_dt.is_year_start
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.is_year_start()[source]

Return Boolean indicators if the day is the year start.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.is_year_start()
RuntimeError('invalid dtype (datetime64[Y]) for date operation')
IndexYear.via_dt.is_quarter_end
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.is_quarter_end()[source]

Return Boolean indicators if the day is the quarter end.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.is_quarter_end()
RuntimeError('invalid dtype (datetime64[Y]) for date operation')
IndexYear.via_dt.is_quarter_start
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.is_quarter_start()[source]

Return Boolean indicators if the day is the quarter start.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.is_quarter_start()
RuntimeError('invalid dtype (datetime64[Y]) for date operation')
IndexYear.via_dt.timetuple
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.timetuple()[source]

Return a time.struct_time such as returned by time.localtime().

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.timetuple()
RuntimeError('invalid dtype (datetime64[Y]) for date operation')
IndexYear.via_dt.isoformat(sep, timespec)
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.isoformat(sep='T', timespec='auto')[source]

Return a string representing the date in ISO 8601 format, YYYY-MM-DD.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.isoformat()
RuntimeError('invalid dtype (datetime64[Y]) for date operation')
IndexYear.via_dt.fromisoformat
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.fromisoformat()[source]

Return a datetime.date object from an ISO 8601 format.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.fromisoformat()
RuntimeError('invalid dtype (datetime64[Y]) for operation on string types')
IndexYear.via_dt.strftime(format)
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.strftime(format)[source]

Return a string representing the date, controlled by an explicit format string.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.strftime("%A | %B")
RuntimeError('invalid dtype (datetime64[Y]) for date operation')
IndexYear.via_dt.strptime(format)
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.strptime(format)[source]

Return a Python datetime object from parsing a string defined with format.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.strptime("%m/%d/%Y")
RuntimeError('invalid dtype (datetime64[Y]) for operation on string types')
IndexYear.via_dt.strpdate(format)
IndexYear.via_dt

Interface for applying datetime properties and methods to elements in this container.

InterfaceDatetime.strpdate(format)[source]

Return a Python date object from parsing a string defined with format.

>>> ix = sf.IndexYear(('1517', '1520', '1518'))
>>> ix
<IndexYear>
1517
1520
1518
<datetime64[Y]>
>>> ix.via_dt.strpdate("%m/%d/%Y")
RuntimeError('invalid dtype (datetime64[Y]) for operation on string types')

IndexYear: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary | Operator Unary | Accessor Values | Accessor Datetime | Accessor String | Accessor Regular Expression | Accessor Hashlib | Accessor Type Clinic