'365_day', '360_day', 'julian', 'all_leap', '366_day', 'gregorian',
'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):
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
'366_day', 'gregorian', '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),
(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 generate_range(
start: cftime.datetime,
end: cftime.datetime,
offset: cftime_offsets.BaseCFTimeOffset,
) -> Iterable[cftime.datetime]:
"""
Generate a range of datetime objects between start and end, using offset to
determine the steps.
The range will extend both ends of the span to the next valid timestep, see
examples.
Parameters
----------
start: :class:`cftime.datetime`
Starting datetime from which to generate the range (noting roll backward
mentioned above and illustrated in the examples).
end: :class:`cftime.datetime`
Last datetime from which to generate the range (noting roll forward mentioned
above and illustrated in the examples).
offset:
Offset object for determining the timesteps.
Yields
------
:class:`cftime.datetime`
Next datetime in the range
Raises
------
ValueError
Offset does not result in increasing :class:`cftime.datetime`'s
Examples
--------
The range is extended at either end to the nearest timestep. In the example below,
the first timestep is rolled back to 1st Jan 2001 whilst the last is extended to 1st
Jan 2006.
>>> import datetime as dt
>>> from pprint import pprint
>>> from scmdata.offsets import to_offset, generate_range
>>> g = generate_range(
... dt.datetime(2001, 4, 1),
... dt.datetime(2005, 6, 3),
... to_offset("AS"),
... )
>>> pprint([d for d in g])
[cftime.datetime(2001, 1, 1, 0, 0),
cftime.datetime(2002, 1, 1, 0, 0),
cftime.datetime(2003, 1, 1, 0, 0),
cftime.datetime(2004, 1, 1, 0, 0),
cftime.datetime(2005, 1, 1, 0, 0),
cftime.datetime(2006, 1, 1, 0, 0)]
In this example the first timestep is rolled back to 31st Dec 2000 whilst the last
is extended to 31st Dec 2005.
>>> g = generate_range(
... dt.datetime(2001, 4, 1),
... dt.datetime(2005, 6, 3),
... to_offset("A"),
... )
>>> pprint([d for d in g])
[cftime.datetime(2000, 12, 31, 0, 0),
cftime.datetime(2001, 12, 31, 0, 0),
cftime.datetime(2002, 12, 31, 0, 0),
cftime.datetime(2003, 12, 31, 0, 0),
cftime.datetime(2004, 12, 31, 0, 0),
cftime.datetime(2005, 12, 31, 0, 0)]
In this example the first timestep is already on the offset so stays there, the last
timestep is to 1st Sep 2005.
>>> g = generate_range(
... dt.datetime(2001, 4, 1),
... dt.datetime(2005, 6, 3),
... to_offset("QS"),
... )
>>> pprint([d for d in g])
[cftime.datetime(2001, 4, 1, 0, 0),
cftime.datetime(2001, 7, 1, 0, 0),
cftime.datetime(2001, 10, 1, 0, 0),
cftime.datetime(2002, 1, 1, 0, 0),
cftime.datetime(2002, 4, 1, 0, 0),
cftime.datetime(2002, 7, 1, 0, 0),
cftime.datetime(2002, 10, 1, 0, 0),
cftime.datetime(2003, 1, 1, 0, 0),
cftime.datetime(2003, 4, 1, 0, 0),
cftime.datetime(2003, 7, 1, 0, 0),
cftime.datetime(2003, 10, 1, 0, 0),
cftime.datetime(2004, 1, 1, 0, 0),
cftime.datetime(2004, 4, 1, 0, 0),
cftime.datetime(2004, 7, 1, 0, 0),
cftime.datetime(2004, 10, 1, 0, 0),
cftime.datetime(2005, 1, 1, 0, 0),
cftime.datetime(2005, 4, 1, 0, 0),
cftime.datetime(2005, 7, 1, 0, 0)]
"""
# Uses the Gregorian calendar - allows for adding/subtracting datetime.timedelta in range calc
start_cf = cftime.DatetimeGregorian(*start.timetuple()[:6])
end_cf = cftime.DatetimeGregorian(*end.timetuple()[:6])
res = cftime_offsets.cftime_range(offset.rollback(start_cf),
offset.rollforward(end_cf),
freq=offset)
return [cftime.datetime(*dt.timetuple()[:6]) for dt in res]
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),
