U caK@sddlmZddlmZmZddlmZddlZddlZddl m Z m Z ddl mZmZmZmZmZddlmZmZmZddlmZmZdd lmZdd lmZmZmZdd l m!Z!dd l"m#Z#dd l$m%Z%m&Z&m'Z'm(Z(ddl)m*m+Z,ddl-m*m.m/Z0ddl-m1Z1ddl2m3Z3ddl4m5Z5m6Z6ddl7m8Z8ddl9m:Z:e;e0j<ZddZ?e8dddge%j@e%dde8ddge%Gd d!d!e3ZAd&d"d!d#d$d%ZBdS)') annotations)datetime timedelta)HashableN)indexlib) BaseOffsetNaTPeriod ResolutionTick)DtypeDtypeObjnpt)cache_readonlydoc)find_stack_level)is_datetime64_any_dtype is_integer pandas_dtype) PeriodDtype)is_valid_na_for_dtype) PeriodArray period_arrayraise_on_incompatiblevalidate_dtype_freq)maybe_extract_name)DatetimeIndexOpsMixin) DatetimeIndexIndex) inherit_names) Int64IndexZ target_klasszPeriodIndex or list of PeriodsklassrcKsJ|d}|jdkr:|dd}t||d}|j|f|S||f|SdS)Ndataint64freqr%)popdtyper _simple_new)clsdvaluesr%r->/tmp/pip-unpacked-wheel-g7fro6k3/pandas/core/indexes/period.py_new_PeriodIndexDs     r/strftime start_timeZend_timeT)wrapZ is_leap_yearZ_format_native_typescseZdZUdZdZded<ded<ded<eZd Ze d d d d Z e dd ddZ e ejfdddedRdddddZe ejdSdddddZe e ejjdd ddZe e ejjdd d d!Ze e ejjdd d"d#ZdTd%d&d'dd(d)d*Ze d+d d,d-Zd.d d/d0Zd1d&d2d3d4Zd5d6d+d7fd8d9 Ze ejd ejfd&d:fd;d< Ze d&d d=d>Ze dd d?d@ZfdAdBZ dUdCdDZ!dEdEdFdGdHZ"dIdJZ#e e$j%ejfddKfdLdM Z%ddNdOdPdQZ&Z'S)V PeriodIndexa Immutable ndarray holding ordinal values indicating regular periods in time. Index keys are boxed to Period objects which carries the metadata (eg, frequency information). Parameters ---------- data : array-like (1d int np.ndarray or PeriodArray), optional Optional period-like data to construct index with. copy : bool Make a copy of input ndarray. freq : str or period object, optional One of pandas period strings or corresponding objects. year : int, array, or Series, default None month : int, array, or Series, default None quarter : int, array, or Series, default None day : int, array, or Series, default None hour : int, array, or Series, default None minute : int, array, or Series, default None second : int, array, or Series, default None dtype : str or PeriodDtype, default None Attributes ---------- day dayofweek day_of_week dayofyear day_of_year days_in_month daysinmonth end_time freq freqstr hour is_leap_year minute month quarter qyear second start_time week weekday weekofyear year Methods ------- asfreq strftime to_timestamp See Also -------- Index : The base pandas Index type. Period : Represents a period of time. DatetimeIndex : Index with datetime64 data. TimedeltaIndex : Index of timedelta64 data. period_range : Create a fixed-frequency PeriodIndex. Examples -------- >>> idx = pd.PeriodIndex(year=[2000, 2002], quarter=[1, 3]) >>> idx PeriodIndex(['2000Q1', '2002Q3'], dtype='period[Q-DEC]') Z periodindexr_datarr%rr(Tztype[libindex.PeriodEngine])returncCstjSN)libindexZ PeriodEngineselfr-r-r. _engine_typeszPeriodIndex._engine_typer cCs|jjSr6)r(_resolution_objr8r-r-r.r;szPeriodIndex._resolution_objzpandas.arrays.PeriodArray)otherZ other_nameNEstr)howr5cCs"|j||}t|j||jdSNname)r4asfreqtyper)rBr9r%r?Zarrr-r-r.rCszPeriodIndex.asfreqstartrcCs|j||}tj||jdSr@)r4 to_timestamprr)rBrEr-r-r.rGszPeriodIndex.to_timestampr!cCst|jj|jdSr@)r!r4hourrBr8r-r-r.rHszPeriodIndex.hourcCst|jj|jdSr@)r!r4minuterBr8r-r-r.rIszPeriodIndex.minutecCst|jj|jdSr@)r!r4secondrBr8r-r-r.rJszPeriodIndex.secondFz Dtype | Noneboolr)r(copyrBr5c Ksdddddddh}t||sBtt||d} td | t|||}|dkr|dkr|sl|dtddd||\}} | }t||d }nft||}|rt ||r|j |kr| |}|dkr|dk rt j |t jd }t||d }n t||d }|r|}|j||d S)NyearmonthdayZquarterrHrIrJrz-__new__() got an unexpected keyword argument r&r()r#r%rA)setissubsetlist TypeErrorrZ_scalar_data_errorr_generate_ranger isinstancer%rCnpasarrayr$rrLr)) r*r#Zordinalr%r(rLrBfieldsZvalid_field_setargumentZfreq2r-r-r.__new__s8       zPeriodIndex.__new__z np.ndarraycCstj|tdS)NrP)rWrXobjectr8r-r-r.r,szPeriodIndex.valueszint | npt.NDArray[np.int64]cCsxt|ttjttjfr4t|jtrj|j|}|Sn6t|t r^|j |jj krR|j St ||n t |rj|St |ddS)a Convert timedelta-like input to an integer multiple of self.freq Parameters ---------- other : timedelta, np.timedelta64, DateOffset, int, np.ndarray Returns ------- converted : int, np.ndarray[int64] Raises ------ IncompatibleFrequency : if the input cannot be written as a multiple of self.freq. Note IncompatibleFrequency subclasses ValueError. N)rVrrWZ timedelta64r Zndarrayr%r4Z _check_timedeltalike_freq_compatrbasenrr)r9r<deltar-r-r._maybe_convert_timedeltas    z$PeriodIndex._maybe_convert_timedeltar)r(r5cCs2t|tsdS|j}|j}|j|jko0|j|jkS)zF Can we compare values of the given dtype to our own? F)rVrr%_period_dtype_coder^)r9r(r%Zown_freqr-r-r._is_comparable_dtypeCs  z PeriodIndex._is_comparable_dtyperznpt.NDArray[np.bool_])wheremaskr5cs<t|trt|j|jd}nt|ts.tdt||S)z where : array of timestamps mask : np.ndarray[bool] Array of booleans where data is not NA. r&z6asof_locs `where` must be DatetimeIndex or PeriodIndex)rVrr3Z_valuesr%rTsuper asof_locs)r9rcrd __class__r-r.rfYs   zPeriodIndex.asof_locsrLcs`t|}|tjk r&tjdttdnd}t|rPt|dd}|j |d |St j ||dS)NzThe 'how' keyword in PeriodIndex.astype is deprecated and will be removed in a future version. Use index.to_timestamp(how=how) instead.) stacklevelrFtzr?ri) rr no_defaultwarningswarn FutureWarningrrgetattrrGZ tz_localizereastype)r9r(rLr?rkrgr-r.rrfs  zPeriodIndex.astypecCsDt|dkrdS|jstd|j}|dd|dddkS)z Returns True if this PeriodIndex is range-like in that all Periods between start and end are present, in order. rTzIndex is not monotonicN)lenZis_monotonic_increasing ValueErrorZasi8all)r9r,r-r-r.is_fulls  zPeriodIndex.is_fullcCsdS)NZperiodr-r8r-r-r. inferred_typeszPeriodIndex.inferred_typecs(t||}|j|jkr$||}|Sr6)re_convert_tolerancer(r`)r9 tolerancetargetrgr-r.r{s  zPeriodIndex._convert_tolerancec Cs|}||t||jr"t}nt|trz||\}}Wn4tk rt}ztd|d|W5d}~XYnX| |rz| ||WStk r}zt||W5d}~XYnX||j kr| |}|j |||d}|S|dkrt|n | |}n8t|tr||}n t|tr2| |}nt|zt ||||WStk rz}zt||W5d}~XYnXdS)a Get integer location for requested label. Parameters ---------- key : Period, NaT, str, or datetime String or datetime key must be parsable as Period. Returns ------- loc : int or ndarray[int64] Raises ------ KeyError Key is not present in the index. TypeError If key is listlike or otherwise not hashable. zCannot interpret 'z ' as periodN)methodr|)Z_check_indexing_errorrr(r rVr>Z_parse_with_resorwKeyErrorZ_can_partial_date_sliceZ_partial_date_slicer;_cast_partial_indexing_scalarget_locr _maybe_cast_for_get_locrr) r9keyr~r|Zorig_keyparsedresoerrlocr-r-r.rs<   $         zPeriodIndex.get_locr )rr5cCs0|j}|j}|j|jkr$|j|jks,t||Sr6)r%r^rar)r9rZsfreqZkfreqr-r-r.rs  z#PeriodIndex._maybe_cast_for_get_locc CsDzt||jd}Wn,tk r>}zt||W5d}~XYnX|S)Nr&)r r%rwr)r9labelrrr-r-r.rs z)PeriodIndex._cast_partial_indexing_scalar)sidecs&t|tr||}tj|||dS)N)kind)rVrrre_maybe_cast_slice_bound)r9rrrrgr-r.rs  z#PeriodIndex._maybe_cast_slice_boundr)rrcCs.t||jd}|j|jdd|j|jddfS)Nr&rFrlend)r Z attr_abbrevrCr%)r9rrZivr-r-r._parsed_string_to_bounds sz$PeriodIndex._parsed_string_to_bounds)Nr=)NrF)NNNNFN)NN)(__name__ __module__ __qualname____doc__Z_typ__annotations__rZ _data_clsZ!_supports_partial_string_indexingpropertyr:rr;rrC_shared_doc_kwargsrGrHfgetrIrJr[r,r`rbrfrrrrrmryrzr{rrrrrr __classcell__r-r-rgr.r3Osp E   B$   Fr3z int | None)periodsr5cCsjt|||dkrtd|dkr:t|ts:t|ts:d}tj||||id\}}t||d}t||dS)a Return a fixed frequency PeriodIndex. The day (calendar) is the default frequency. Parameters ---------- start : str or period-like, default None Left bound for generating periods. end : str or period-like, default None Right bound for generating periods. periods : int, default None Number of periods to generate. freq : str or DateOffset, optional Frequency alias. By default the freq is taken from `start` or `end` if those are Period objects. Otherwise, the default is ``"D"`` for daily frequency. name : str, default None Name of the resulting PeriodIndex. Returns ------- PeriodIndex Notes ----- Of the three parameters: ``start``, ``end``, and ``periods``, exactly two must be specified. To learn more about the frequency strings, please see `this link `__. Examples -------- >>> pd.period_range(start='2017-01-01', end='2018-01-01', freq='M') PeriodIndex(['2017-01', '2017-02', '2017-03', '2017-04', '2017-05', '2017-06', '2017-07', '2017-08', '2017-09', '2017-10', '2017-11', '2017-12', '2018-01'], dtype='period[M]') If ``start`` or ``end`` are ``Period`` objects, they will be used as anchor endpoints for a ``PeriodIndex`` with frequency matching that of the ``period_range`` constructor. >>> pd.period_range(start=pd.Period('2017Q1', freq='Q'), ... end=pd.Period('2017Q2', freq='Q'), freq='M') PeriodIndex(['2017-03', '2017-04', '2017-05', '2017-06'], dtype='period[M]') ruzOOf the three parameters: start, end, and periods, exactly two must be specifiedND)rYr&rA)comZcount_not_nonerwrVr rrUr3)rFrrr%rBr#r-r-r. period_ranges4 r)NNNNN)C __future__rrrtypingrrnZnumpyrWZ pandas._libsrr7rZpandas._libs.tslibsrr r r r Zpandas._typingr rrZpandas.util._decoratorsrrZpandas.util._exceptionsrZpandas.core.dtypes.commonrrrZpandas.core.dtypes.dtypesrZpandas.core.dtypes.missingrZpandas.core.arrays.periodrrrrZpandas.core.commoncorecommonrZpandas.core.indexes.baseZindexesr]ZibaserZ pandas.core.indexes.datetimelikerZpandas.core.indexes.datetimesrrZpandas.core.indexes.extensionr Zpandas.core.indexes.numericr!dictZ_index_doc_kwargsupdaterr/Z _field_opsr3rr-r-r-r.sT            =