a İaD@sVdZddlZddlmZddlmZddlmZmZddl Z ddl m Z dd l mZmZdd lmZz ddlZWneydZYn0d d ZGd ddZddZddZddZddZdgddZdhddZddZGdd d eZGd!d"d"eZd#d$d%d&d'd(d)d*d+d,d-d.d/ ZGd0d1d1eZ Gd2d3d3e Z!Gd4d5d5e Z"Gd6d7d7eZ#Gd8d9d9e#Z$Gd:d;d;e#Z%Gdd?d?eZ'Gd@dAdAeZ(GdBdCdCeZ)GdDdEdEeZ*GdFdGdGeZ+e%e$e%e$ee"dHdIee!ddIeee&e'e(e(e)e*e*e+e+ee$ddIee$ddIee$ddIee$dJdIee$dKdIee$dLdIee$dMdIee$dNdIee$dOdIee$dPdIee$dQdIee$dHdIee%ddIee%ddIee%ddIee%dJdIee%dKdIee%dLdIee%dMdIee%dNdIee%dOdIee%dPdIee%dQdIee%dHdIee!ddIee!ddIee!ddIee!dJdIee!dKdIee!dLdIee!dMdIee!dNdIee!dOdIee!dPdIee!dQdIee!dHdIee"ddIee"ddIee"ddIee"dJdIee"dKdIee"dLdIee"dMdIee"dNdIee"dOdIee"dPdIee"dQdIee"dHdIdRAZ,dS-e,.Z/dTe/dUZ0e&e'e(e)fZ1dVdWZ2didXdYZ3dZd[Z4d\d]Z5d^d_Z6d`daZ7djdedfZ8dS)kz8Time offset classes for use with cftime.datetime objectsN) timedelta)partial)ClassVarOptional)count_not_none) CFTimeIndex_parse_iso8601_with_reso)format_cftime_datetimec CsHtdurtdn2tjtjtjtjtjtjtjtjtjd }||SdS)z6Return the cftime date type for a given calendar name.Nz8cftime is required for dates with non-standard calendars) ZnoleapZ360_dayZ365_dayZ366_dayZ gregorianZproleptic_gregorianZjulianZall_leapstandard)cftime ImportErrorZDatetimeNoLeapZDatetime360DayZDatetimeAllLeapZDatetimeGregorianZDatetimeProlepticGregorianZDatetimeJulian)calendarZ calendarsr;lib/python3.9/site-packages/xarray/coding/cftime_offsets.py get_date_type<s  rc@seZdZUdZeeeed<dZeeeed<d)ddZ ddZ d d Z d d Z d dZ ddZddZddZddZddZddZddZddZdd Zd!d"Zd#d$Zd%d&Zd'd(ZdS)*BaseCFTimeOffsetN_freq _day_optionrcCs&t|tstdt|||_dS)NzXThe provided multiple 'n' must be an integer. Instead a value of type {!r} was provided.) isinstanceint TypeErrorformattypen)selfrrrr__init__Ss zBaseCFTimeOffset.__init__cCs|jSN)rrrrr rule_code[szBaseCFTimeOffset.rule_codecCs|j|jko||kSr)rr rotherrrr__eq__^szBaseCFTimeOffset.__eq__cCs ||k Srrr!rrr__ne__aszBaseCFTimeOffset.__ne__cCs ||Sr) __apply__r!rrr__add__dszBaseCFTimeOffset.__add__cCsRtdurtdt|tjr&tdn(t|t|krJt||j|jStSdS)NNo module named 'cftime'z5Cannot subtract a cftime.datetime from a time offset.)r ModuleNotFoundErrorrdatetimerrrNotImplementedr!rrr__sub__gs  zBaseCFTimeOffset.__sub__cCst|||jdS)Nr)rrr!rrr__mul__rszBaseCFTimeOffset.__mul__cCs|dS)Nrrrrr__neg__uszBaseCFTimeOffset.__neg__cCs ||Sr)r-r!rrr__rmul__xszBaseCFTimeOffset.__rmul__cCs ||Sr)r&r!rrr__radd__{szBaseCFTimeOffset.__radd__cCs,t|tr"t|t|kr"td| |S)Nz1Cannot subtract cftime offsets of differing types)rrrrr!rrr__rsub__~szBaseCFTimeOffset.__rsub__cCstSr)r*rrrrr%szBaseCFTimeOffset.__apply__cCs|||}||kSxCheck if the given date is in the set of possible dates created using a length-one version of this offset class.r)rdateZ test_daterrronOffsets zBaseCFTimeOffset.onOffsetcCs ||r|S|t|SdSrr6rrr5rrr rollforwards zBaseCFTimeOffset.rollforwardcCs ||r|S|t|SdSrr7r8rrrrollbacks zBaseCFTimeOffset.rollbackcCsdt|j|jS)Nz <{}: n={}>)rr__name__rrrrr__str__szBaseCFTimeOffset.__str__cCst|Sr)strrrrr__repr__szBaseCFTimeOffset.__repr__cCs t||jSr)_get_day_of_monthrr!rrr_get_offset_daysz BaseCFTimeOffset._get_offset_day)r)r; __module__ __qualname__rrrr=__annotations__rrr r#r$r&r+r-r/r0r1r2r%r6r9r:r<r>r@rrrrrOs(   rcCs8|dkr dS|dkrt|S|dur,tnt|dS)a\Find the day in `other`'s month that satisfies a BaseCFTimeOffset's onOffset policy, as described by the `day_option` argument. Parameters ---------- other : cftime.datetime day_option : 'start', 'end' 'start': returns 1 'end': returns last day of the month Returns ------- day_of_month : int startrendN)_days_in_monthNotImplementedError ValueError)r" day_optionrrrr?sr?cCsJ|jdkr"t||jddd}nt||j|jdd}|tddjS)z1The number of days in the month of the given date rZdays)monthryearrday)r5 referencerrrrFs rFcCs6|dkr||kr|d}n|dkr2||kr2|d}|S)zAdjust the number of times a monthly offset is applied based on the day of a given date, and the reference day provided. rrr)Z other_dayr reference_dayrrr_adjust_n_monthss  rQcCsZ|dkr0|j|ks&|j|krV|j|krV|d8}n&|j|ksN|j|krV|j|krV|d7}|S)zpAdjust the number of times an annual offset is applied based on another date, and the reference day providedrr)rLrN)r"rrLrPrrr_adjust_n_yearss  rRrDcCstdurtd|j|d}|j|d}|dkr@d}|d}|j|}|dkrXd}n*|dkrzt|||d}t|}nt||j|||dS) zEShift the date to a month start or end a given number of months away.Nr'rJrrrDrE)rMrLrN)r r(rLrMrrFrHreplace)r5monthsrIZ delta_yearrLrMrNrOrrr _shift_months  rUcCsp|j|||}|dkrD|dks:|dkrl|jt||krl|d8}n(|dksd|dkrl|jt||krl|d7}|S)aPossibly increment or decrement the number of periods to shift based on rollforward/rollbackward conventions. Parameters ---------- other : cftime.datetime n : number of periods to increment, before adjusting for rolling month : int reference month giving the first month of the year day_option : 'start', 'end' The convention to use in finding the day in a given month against which to compare for rollforward/rollbackward decisions. modby : int 3 for quarters, 12 for years Returns ------- n : int number of periods to increment See Also -------- _get_day_of_month : Find the day in a month provided an offset. rr)rLrNr?)r"rrLrImodby months_sincerrr roll_qtrdays rYcCsR|dur |n|}t|ts*td|n$d|kr>dksNntd||S)Nz_'self.month' must be an integer value between 1 and 12. Instead, it was set to a value of {!r}rrJ)rrrrrH)rLZ default_monthZ result_monthrrr_validate_month!s rZc@s eZdZdZddZddZdS) MonthBeginMScCst|j|jd}t||dS)NrrD)rQrNrrUrr"rrrrr%5szMonthBegin.__apply__cCs |jdkSr4r)rNr8rrrr69szMonthBegin.onOffsetNr;rArBrr%r6rrrrr[2sr[c@s eZdZdZddZddZdS)MonthEndMcCs t|j|jt|}t||dS)NrE)rQrNrrFrUr]rrrr%BszMonthEnd.__apply__cCs|jt|kSr3)rNrFr8rrrr6FszMonthEnd.onOffsetNr_rrrrr`?sr`ZJANZFEBZMARZAPRZMAYZJUNZJULZAUGZSEPZOCTZNOVZDEC) rrrV rJc@sdeZdZUdZeeed<eeed<dddZdd Z d d Z d d Z ddZ ddZ ddZdS) QuarterOffsetz>Quarter representation copied off of pandas/tseries/offsets.pyr_default_monthrNcCst||t||j|_dSrrrrZrkrLrrrLrrrrbs zQuarterOffset.__init__cCsF|jd|jd}t||j|j|jdd}|d|}t|||jS)NrV)rIrW)rLrYrrrU)rr"rXZqtrsrTrrrr%fs  zQuarterOffset.__apply__cCs(|j|jd}|dko&|j||kS)r4rVr)rLrNr@)rr5Z mod_monthrrrr6sszQuarterOffset.onOffsetcCsdtdurtdt|tjr&tdn:t|t|kr\|j|jkr\t||j|j|jdStSdSNr'z,Cannot subtract cftime.datetime from offset.rL r r(rr)rrrLrr*r!rrrr+ys  zQuarterOffset.__sub__cCst|||j|jdSN)rrLrrrLr!rrrr-szQuarterOffset.__mul__cCsd|jt|jSNz{}-{}rr_MONTH_ABBREVIATIONSrLrrrrr szQuarterOffset.rule_codecCsdt|j|j|jSNz<{}: n={}, month={}>rrr;rrLrrrrr<szQuarterOffset.__str__)rN)r;rArB__doc__rr=rCrrr%r6r+r-r r<rrrrrj\s      rjc@s(eZdZdZdZdZddZddZdS) QuarterBeginrVQSrDcCs"||r|S|t|jdSdS)z-Roll date forward to nearest start of quarterroNr6ryrLr8rrrr9s zQuarterBegin.rollforwardcCs"||r|S|t|jdSdS)z.Roll date backward to nearest start of quarterroNr{r8rrrr:s zQuarterBegin.rollbackNr;rArBrkrrr9r:rrrrrys ryc@s(eZdZdZdZdZddZddZdS) QuarterEndrVQrEcCs"||r|S|t|jdSdS)z+Roll date forward to nearest end of quarterroNr6r}rLr8rrrr9s zQuarterEnd.rollforwardcCs"||r|S|t|jdSdS)z,Roll date backward to nearest end of quarterroNrr8rrrr:s zQuarterEnd.rollbackNr|rrrrr}s r}c@sdeZdZUeeed<eeed<eeed<dddZdd Zd d Z d d Z ddZ ddZ dS) YearOffsetrrrkrNcCst||t||j|_dSrrlrmrrrrs zYearOffset.__init__cCs@t||j}t||j|j|}|d|j|j}t|||jS)NrJ)r?rrRrrLrU)rr"rPZyearsrTrrrr%s zYearOffset.__apply__cCsdtdurtdt|tjr&tdn:t|t|kr\|j|jkr\t||j|j|jdStSdSrnrpr!rrrr+s  zYearOffset.__sub__cCst|||j|jdSrqrrr!rrrr-szYearOffset.__mul__cCsd|jt|jSrsrtrrrrr szYearOffset.rule_codecCsdt|j|j|jSrvrwrrrrr<szYearOffset.__str__)rN) r;rArBrr=rCrrr%r+r-r r<rrrrrs      rc@s0eZdZdZdZdZddZddZdd Zd S) YearBeginASrDrcCs|jdko|j|jkSr^)rNrLr8rrrr6szYearBegin.onOffsetcCs"||r|S|t|jdSdS)z*Roll date forward to nearest start of yearroNr6rrLr8rrrr9s zYearBegin.rollforwardcCs"||r|S|t|jdSdS)z+Roll date backward to nearest start of yearroNrr8rrrr:s zYearBegin.rollbackN r;rArBrrrkr6r9r:rrrrrs rc@s0eZdZdZdZdZddZddZdd Zd S) YearEndArErJcCs|jt|ko|j|jkSr3)rNrFrLr8rrrr6szYearEnd.onOffsetcCs"||r|S|t|jdSdS)z(Roll date forward to nearest end of yearroNr6rrLr8rrrr9s zYearEnd.rollforwardcCs"||r|S|t|jdSdS)z)Roll date backward to nearest end of yearroNrr8rrrr:s zYearEnd.rollbackNrrrrrrs rc@s eZdZdZddZddZdS)DayDcCs t|jdS)NrKrrrrrr as_timedeltaszDay.as_timedeltacCs ||Srrr!rrrr%sz Day.__apply__Nr;rArBrrr%rrrrrsrc@s eZdZdZddZddZdS)HourHcCs t|jdS)N)Zhoursrrrrrr#szHour.as_timedeltacCs ||Srrr!rrrr%&szHour.__apply__Nrrrrrr src@s eZdZdZddZddZdS)MinuteTcCs t|jdS)N)Zminutesrrrrrr-szMinute.as_timedeltacCs ||Srrr!rrrr%0szMinute.__apply__Nrrrrrr*src@s eZdZdZddZddZdS)SecondScCs t|jdS)N)Zsecondsrrrrrr7szSecond.as_timedeltacCs ||Srrr!rrrr%:szSecond.__apply__Nrrrrrr4src@s eZdZdZddZddZdS) MillisecondLcCs t|jdS)N)Z millisecondsrrrrrrAszMillisecond.as_timedeltacCs ||Srrr!rrrr%DszMillisecond.__apply__Nrrrrrr>src@s eZdZdZddZddZdS) MicrosecondUcCs t|jdS)N)Z microsecondsrrrrrrKszMicrosecond.as_timedeltacCs ||Srrr!rrrr%NszMicrosecond.__apply__NrrrrrrHsrrJrorbrcrdrerfrgrhri)ArrYZYSr~rzrar\rrrminrrmsruszAS-JANzAS-FEBzAS-MARzAS-APRzAS-MAYzAS-JUNzAS-JULzAS-AUGzAS-SEPzAS-OCTzAS-NOVzAS-DECzA-JANzA-FEBzA-MARzA-APRzA-MAYzA-JUNzA-JULzA-AUGzA-SEPzA-OCTzA-NOVzA-DECzQS-JANzQS-FEBzQS-MARzQS-APRzQS-MAYzQS-JUNzQS-JULzQS-AUGzQS-SEPzQS-OCTzQS-NOVzQS-DECzQ-JANzQ-FEBzQ-MARzQ-APRzQ-MAYzQ-JUNzQ-JULzQ-AUGzQ-SEPzQ-OCTzQ-NOVzQ-DEC|z!^((?P\d+)|())(?P(z))$cCspt|tr|Sztt|}Wnty<tdYn0|d}|d}|durZdnt|}t ||dS)zOConvert a frequency string to the appropriate subclass of BaseCFTimeOffset.z!Invalid frequency string providedfreqZmultipleNrr,) rrrematch_PATTERN groupdictAttributeErrorrHr _FREQUENCIES)rZ freq_dataZ multiplesrrr to_offsets  rcCsbtdurtdt|tr@|dur*tdtt||\}}|St|tjrP|Std |dS)Nr'zTIf converting a string to a cftime.datetime object, a calendar type must be providedzUdate_str_or_date must be a string or a subclass of cftime.datetime. Instead got {!r}.) r r(rr=rHr rr)rr)Zdate_str_or_daterr5_rrrto_cftime_datetimes   rcCs|jdddddS)z Round datetime down to midnight.r)ZhourZminutesecondZ microsecond)rS)r5rrrnormalize_datesrcCs|r t|S|SdS)z5Round datetime down to midnight if normalize is True.N)r)r5 normalizerrr_maybe_normalize_datesrcCsTtdurtd||}tjd||dd}dt|}|j}tj|||ddS)zGenerate an equally-spaced sequence of cftime.datetime objects between and including two dates (whose length equals the number of periods).Nr'gT)Zendpointzseconds since {})unitsrZonly_use_cftime_datetimes) r r( total_secondsnpZlinspacerr rZnum2date)rDrEperiodsrvaluesrrrrr_generate_linear_ranges rccs|r||}|r||}|dur4||kr4d}d}|durL||d|}|durd||d|}|}|jdkr||kr|V||}||krtd|d|}qrn4||kr|V||}||krtd|d|}qdS)aGenerate a regular range of cftime.datetime objects with a given time offset. Adapted from pandas.tseries.offsets.generate_range. Parameters ---------- start : cftime.datetime, or None Start of range end : cftime.datetime, or None End of range periods : int, or None Number of elements in the sequence offset : BaseCFTimeOffset An offset class designed for working with cftime.datetime objects Returns ------- A generator object NrrzOffset z did not increment datez did not decrement date)r9r:rrH)rDrEroffsetcurrentZ next_daterrr_generate_ranges2   rrFr c Cs2t||||dkrtd|dur6t||}t||}|durRt||}t||}|durht|||}n t|} ttt |||| }d} d} |durd} d} n$|dkrd} n|dkrd} ntd| st |r|dur|d |kr|d d}| s&t |r&|dur&|d |kr&|dd }t ||d S) a%Return a fixed frequency CFTimeIndex. Parameters ---------- start : str or cftime.datetime, optional Left bound for generating dates. end : str or cftime.datetime, optional Right bound for generating dates. periods : int, optional Number of periods to generate. freq : str or None, default: "D" Frequency strings can have multiples, e.g. "5H". normalize : bool, default: False Normalize start/end dates to midnight before generating date range. name : str, default: None Name of the resulting index closed : {"left", "right"} or None, default: None Make the interval closed with respect to the given frequency to the "left", "right", or both sides (None). calendar : str, default: "standard" Calendar type for the datetimes. Returns ------- CFTimeIndex Notes ----- This function is an analog of ``pandas.date_range`` for use in generating sequences of ``cftime.datetime`` objects. It supports most of the features of ``pandas.date_range`` (e.g. specifying how the index is ``closed`` on either side, or whether or not to ``normalize`` the start and end bounds); however, there are some notable exceptions: - You cannot specify a ``tz`` (time zone) argument. - Start or end dates specified as partial-datetime strings must use the `ISO-8601 format `_. - It supports many, but not all, frequencies supported by ``pandas.date_range``. For example it does not currently support any of the business-related or semi-monthly frequencies. - Compound sub-monthly frequencies are not supported, e.g. '1H1min', as these can easily be written in terms of the finest common resolution, e.g. '61min'. Valid simple frequency strings for use with ``cftime``-calendars include any multiples of the following. +--------+--------------------------+ | Alias | Description | +========+==========================+ | A, Y | Year-end frequency | +--------+--------------------------+ | AS, YS | Year-start frequency | +--------+--------------------------+ | Q | Quarter-end frequency | +--------+--------------------------+ | QS | Quarter-start frequency | +--------+--------------------------+ | M | Month-end frequency | +--------+--------------------------+ | MS | Month-start frequency | +--------+--------------------------+ | D | Day frequency | +--------+--------------------------+ | H | Hour frequency | +--------+--------------------------+ | T, min | Minute frequency | +--------+--------------------------+ | S | Second frequency | +--------+--------------------------+ | L, ms | Millisecond frequency | +--------+--------------------------+ | U, us | Microsecond frequency | +--------+--------------------------+ Any multiples of the following anchored offsets are also supported. +----------+--------------------------------------------------------------------+ | Alias | Description | +==========+====================================================================+ | A(S)-JAN | Annual frequency, anchored at the end (or beginning) of January | +----------+--------------------------------------------------------------------+ | A(S)-FEB | Annual frequency, anchored at the end (or beginning) of February | +----------+--------------------------------------------------------------------+ | A(S)-MAR | Annual frequency, anchored at the end (or beginning) of March | +----------+--------------------------------------------------------------------+ | A(S)-APR | Annual frequency, anchored at the end (or beginning) of April | +----------+--------------------------------------------------------------------+ | A(S)-MAY | Annual frequency, anchored at the end (or beginning) of May | +----------+--------------------------------------------------------------------+ | A(S)-JUN | Annual frequency, anchored at the end (or beginning) of June | +----------+--------------------------------------------------------------------+ | A(S)-JUL | Annual frequency, anchored at the end (or beginning) of July | +----------+--------------------------------------------------------------------+ | A(S)-AUG | Annual frequency, anchored at the end (or beginning) of August | +----------+--------------------------------------------------------------------+ | A(S)-SEP | Annual frequency, anchored at the end (or beginning) of September | +----------+--------------------------------------------------------------------+ | A(S)-OCT | Annual frequency, anchored at the end (or beginning) of October | +----------+--------------------------------------------------------------------+ | A(S)-NOV | Annual frequency, anchored at the end (or beginning) of November | +----------+--------------------------------------------------------------------+ | A(S)-DEC | Annual frequency, anchored at the end (or beginning) of December | +----------+--------------------------------------------------------------------+ | Q(S)-JAN | Quarter frequency, anchored at the end (or beginning) of January | +----------+--------------------------------------------------------------------+ | Q(S)-FEB | Quarter frequency, anchored at the end (or beginning) of February | +----------+--------------------------------------------------------------------+ | Q(S)-MAR | Quarter frequency, anchored at the end (or beginning) of March | +----------+--------------------------------------------------------------------+ | Q(S)-APR | Quarter frequency, anchored at the end (or beginning) of April | +----------+--------------------------------------------------------------------+ | Q(S)-MAY | Quarter frequency, anchored at the end (or beginning) of May | +----------+--------------------------------------------------------------------+ | Q(S)-JUN | Quarter frequency, anchored at the end (or beginning) of June | +----------+--------------------------------------------------------------------+ | Q(S)-JUL | Quarter frequency, anchored at the end (or beginning) of July | +----------+--------------------------------------------------------------------+ | Q(S)-AUG | Quarter frequency, anchored at the end (or beginning) of August | +----------+--------------------------------------------------------------------+ | Q(S)-SEP | Quarter frequency, anchored at the end (or beginning) of September | +----------+--------------------------------------------------------------------+ | Q(S)-OCT | Quarter frequency, anchored at the end (or beginning) of October | +----------+--------------------------------------------------------------------+ | Q(S)-NOV | Quarter frequency, anchored at the end (or beginning) of November | +----------+--------------------------------------------------------------------+ | Q(S)-DEC | Quarter frequency, anchored at the end (or beginning) of December | +----------+--------------------------------------------------------------------+ Finally, the following calendar aliases are supported. +--------------------------------+---------------------------------------+ | Alias | Date type | +================================+=======================================+ | standard, gregorian | ``cftime.DatetimeGregorian`` | +--------------------------------+---------------------------------------+ | proleptic_gregorian | ``cftime.DatetimeProlepticGregorian`` | +--------------------------------+---------------------------------------+ | noleap, 365_day | ``cftime.DatetimeNoLeap`` | +--------------------------------+---------------------------------------+ | all_leap, 366_day | ``cftime.DatetimeAllLeap`` | +--------------------------------+---------------------------------------+ | 360_day | ``cftime.Datetime360Day`` | +--------------------------------+---------------------------------------+ | julian | ``cftime.DatetimeJulian`` | +--------------------------------+---------------------------------------+ Examples -------- This function returns a ``CFTimeIndex``, populated with ``cftime.datetime`` objects associated with the specified calendar type, e.g. >>> xr.cftime_range(start="2000", periods=6, freq="2MS", calendar="noleap") CFTimeIndex([2000-01-01 00:00:00, 2000-03-01 00:00:00, 2000-05-01 00:00:00, 2000-07-01 00:00:00, 2000-09-01 00:00:00, 2000-11-01 00:00:00], dtype='object', length=6, calendar='noleap', freq='2MS') As in the standard pandas function, three of the ``start``, ``end``, ``periods``, or ``freq`` arguments must be specified at a given time, with the other set to ``None``. See the `pandas documentation `_ for more examples of the behavior of ``date_range`` with each of the parameters. See Also -------- pandas.date_range rVzZOf the arguments 'start', 'end', 'periods', and 'freq', three must be specified at a time.NFTleftrightz-Closed must be either 'left', 'right' or Nonerrr.)name) rrHrrrrrZarraylistrlenr ) rDrErrrrclosedrZdatesrZ left_closedZ right_closedrrr cftime_ranges<4      ( r)rD)rV)N)NNNrFNNr )9rxrr)r functoolsrtypingrrZnumpyrZ core.pdcompatrZ cftimeindexr r timesr r rrrr?rFrQrRrUrYrZr[r`rurjryr}rrrrrrrrrrjoinkeysZ_FREQUENCY_CONDITIONrZ CFTIME_TICKSrrrrrrrrrrrs*       U    ) 2$                                                        E   9