Detail: IndexYearMonth: Accessor Datetime

Overview: IndexYearMonth: Accessor Datetime

IndexYearMonth.via_dt.__call__(*, fill_value)

IndexYearMonth.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.IndexYearMonth(('1620-09', 'NaT', '1620-11'))
>>> ix
<IndexYearMonth>
1620-09
NaT
1620-11
<datetime64[M]>
>>> ix.via_dt(fill_value=-1).year
[1620   -1 1620]

IndexYearMonth.via_dt.year

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

InterfaceDatetime.year: Return the year of each element.

>>> ix = sf.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.year
[1517 1517 1517]

IndexYearMonth.via_dt.year_month

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.year_month
['1517-04' '1517-12' '1517-06']

IndexYearMonth.via_dt.month

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.month
[ 4 12  6]

IndexYearMonth.via_dt.day

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.day
RuntimeError('invalid dtype (datetime64[M]) for date operation')

IndexYearMonth.via_dt.hour

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.hour
[0 0 0]

IndexYearMonth.via_dt.minute

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.minute
[0 0 0]

IndexYearMonth.via_dt.second

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.second
[0 0 0]

IndexYearMonth.via_dt.weekday

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.weekday()
RuntimeError('invalid dtype (datetime64[M]) for date operation')

IndexYearMonth.via_dt.quarter

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.quarter()
[2 4 2]

IndexYearMonth.via_dt.is_month_end

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.is_month_end()
RuntimeError('invalid dtype (datetime64[M]) for date operation')

IndexYearMonth.via_dt.is_month_start

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.is_month_start()
RuntimeError('invalid dtype (datetime64[M]) for date operation')

IndexYearMonth.via_dt.is_year_end

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.is_year_end()
RuntimeError('invalid dtype (datetime64[M]) for date operation')

IndexYearMonth.via_dt.is_year_start

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.is_year_start()
RuntimeError('invalid dtype (datetime64[M]) for date operation')

IndexYearMonth.via_dt.is_quarter_end

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.is_quarter_end()
RuntimeError('invalid dtype (datetime64[M]) for date operation')

IndexYearMonth.via_dt.is_quarter_start

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.is_quarter_start()
RuntimeError('invalid dtype (datetime64[M]) for date operation')

IndexYearMonth.via_dt.timetuple

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.timetuple()
RuntimeError('invalid dtype (datetime64[M]) for date operation')

IndexYearMonth.via_dt.isoformat(sep, timespec)

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.isoformat()
RuntimeError('invalid dtype (datetime64[M]) for date operation')

IndexYearMonth.via_dt.fromisoformat

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.fromisoformat()
RuntimeError('invalid dtype (datetime64[M]) for operation on string types')

IndexYearMonth.via_dt.strftime(format)

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.strftime("%A | %B")
RuntimeError('invalid dtype (datetime64[M]) for date operation')

IndexYearMonth.via_dt.strptime(format)

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.strptime("%m/%d/%Y")
RuntimeError('invalid dtype (datetime64[M]) for operation on string types')

IndexYearMonth.via_dt.strpdate(format)

IndexYearMonth.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.IndexYearMonth(('1517-04', '1517-12', '1517-06'))
>>> ix
<IndexYearMonth>
1517-04
1517-12
1517-06
<datetime64[M]>
>>> ix.via_dt.strpdate("%m/%d/%Y")
RuntimeError('invalid dtype (datetime64[M]) for operation on string types')