def cftime_end_time(date, freq):
"""Get the cftime.datetime for the end of a period.
As we are not supplying actual period objects, assumptions regarding the period are made based on
the given freq. IMPORTANT NOTE: this function cannot be used on greater-than-day freq that start at the
beginning of a month, e.g. 'MS', 'QS', 'AS' -- this mirrors pandas behavior.
Parameters
----------
date : cftime.datetime
The original datetime object as a proxy representation for period.
freq : str
String specifying the frequency/offset such as 'MS', '2D', 'H', or '3T'
Returns
-------
cftime.datetime
The ending datetime of the period inferred from date and freq.
"""
freq = to_offset(freq)
if isinstance(freq, (YearBegin, QuarterBegin, MonthBegin)):
raise ValueError("Invalid frequency: " + freq.rule_code())
if isinstance(freq, YearEnd):
mod_freq = YearBegin(n=freq.n, month=freq.month)
elif isinstance(freq, QuarterEnd):
mod_freq = QuarterBegin(n=freq.n, month=freq.month)
elif isinstance(freq, MonthEnd):
mod_freq = MonthBegin(n=freq.n)
else:
mod_freq = freq
return cftime_start_time(date + mod_freq,
freq) - pydt.timedelta(microseconds=1)
'proleptic_gregorian', 'standard'
]
def _id_func(param):
"""Called on each parameter passed to pytest.mark.parametrize"""
return str(param)
@pytest.fixture(params=_CFTIME_CALENDARS)
def calendar(request):
return request.param
@pytest.mark.parametrize(('offset', 'expected_n'), [(BaseCFTimeOffset(), 1),
(YearBegin(), 1),
(YearEnd(), 1),
(BaseCFTimeOffset(n=2), 2),
(YearBegin(n=2), 2),
(YearEnd(n=2), 2)],
ids=_id_func)
def test_cftime_offset_constructor_valid_n(offset, expected_n):
assert offset.n == expected_n
@pytest.mark.parametrize(('offset', 'invalid_n'), [(BaseCFTimeOffset, 1.5),
(YearBegin, 1.5),
(YearEnd, 1.5)],
ids=_id_func)
def test_cftime_offset_constructor_invalid_n(offset, invalid_n):
with pytest.raises(TypeError):
def _id_func(param):
"""Called on each parameter passed to pytest.mark.parametrize"""
return str(param)
@pytest.fixture(params=_CFTIME_CALENDARS)
def calendar(request):
return request.param
@pytest.mark.parametrize(
('offset', 'expected_n'),
[(BaseCFTimeOffset(), 1),
(YearBegin(), 1),
(YearEnd(), 1),
(QuarterBegin(), 1),
(QuarterEnd(), 1),
(BaseCFTimeOffset(n=2), 2),
(YearBegin(n=2), 2),
(YearEnd(n=2), 2),
(QuarterBegin(n=2), 2),
(QuarterEnd(n=2), 2)],
ids=_id_func
)
def test_cftime_offset_constructor_valid_n(offset, expected_n):
assert offset.n == expected_n
@pytest.mark.parametrize(
def _id_func(param):
"""Called on each parameter passed to pytest.mark.parametrize"""
return str(param)
@pytest.fixture(params=_CFTIME_CALENDARS)
def calendar(request):
return request.param
@pytest.mark.parametrize(
("offset", "expected_n"),
[
(BaseCFTimeOffset(), 1),
(YearBegin(), 1),
(YearEnd(), 1),
(QuarterBegin(), 1),
(QuarterEnd(), 1),
(BaseCFTimeOffset(n=2), 2),
(YearBegin(n=2), 2),
(YearEnd(n=2), 2),
(QuarterBegin(n=2), 2),
(QuarterEnd(n=2), 2),
],
ids=_id_func,
)
def test_cftime_offset_constructor_valid_n(offset, expected_n):
assert offset.n == expected_n
def _id_func(param):
"""Called on each parameter passed to pytest.mark.parametrize"""
return str(param)
@pytest.fixture(params=_CFTIME_CALENDARS)
def calendar(request):
return request.param
@pytest.mark.parametrize(
("offset", "expected_n"),
[
(BaseCFTimeOffset(), 1),
(YearBegin(), 1),
(YearEnd(), 1),
(QuarterBegin(), 1),
(QuarterEnd(), 1),
(Tick(), 1),
(Day(), 1),
(Hour(), 1),
(Minute(), 1),
(Second(), 1),
(Millisecond(), 1),
(Microsecond(), 1),
(BaseCFTimeOffset(n=2), 2),
(YearBegin(n=2), 2),
(YearEnd(n=2), 2),
(QuarterBegin(n=2), 2),
(QuarterEnd(n=2), 2),
