Skip to content

Commit 5380fcd

Browse files
ivergarajreback
authored andcommitted
Tseries fixtures docstrings (#21496)
1 parent 486bfe8 commit 5380fcd

File tree

7 files changed

+90
-83
lines changed

7 files changed

+90
-83
lines changed

pandas/conftest.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,8 @@ def nulls_fixture(request):
226226
nulls_fixture2 = nulls_fixture # Generate cartesian product of nulls_fixture
227227

228228

229-
TIMEZONES = [None, 'UTC', 'US/Eastern', 'Asia/Tokyo', 'dateutil/US/Pacific']
229+
TIMEZONES = [None, 'UTC', 'US/Eastern', 'Asia/Tokyo', 'dateutil/US/Pacific',
230+
'dateutil/Asia/Singapore']
230231

231232

232233
@td.parametrize_fixture_doc(str(TIMEZONES))

pandas/tests/indexes/datetimes/test_arithmetic.py

+54-34
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,6 @@
1919
from pandas._libs.tslibs.offsets import shift_months
2020

2121

22-
@pytest.fixture(params=[None, 'UTC', 'Asia/Tokyo',
23-
'US/Eastern', 'dateutil/Asia/Singapore',
24-
'dateutil/US/Pacific'])
25-
def tz(request):
26-
return request.param
27-
28-
2922
@pytest.fixture(params=[pd.offsets.Hour(2), timedelta(hours=2),
3023
np.timedelta64(2, 'h'), Timedelta(hours=2)],
3124
ids=str)
@@ -50,7 +43,8 @@ class TestDatetimeIndexComparisons(object):
5043
@pytest.mark.parametrize('other', [datetime(2016, 1, 1),
5144
Timestamp('2016-01-01'),
5245
np.datetime64('2016-01-01')])
53-
def test_dti_cmp_datetimelike(self, other, tz):
46+
def test_dti_cmp_datetimelike(self, other, tz_naive_fixture):
47+
tz = tz_naive_fixture
5448
dti = pd.date_range('2016-01-01', periods=2, tz=tz)
5549
if tz is not None:
5650
if isinstance(other, np.datetime64):
@@ -78,9 +72,10 @@ def test_dti_cmp_datetimelike(self, other, tz):
7872
expected = np.array([True, False])
7973
tm.assert_numpy_array_equal(result, expected)
8074

81-
def dti_cmp_non_datetime(self, tz):
75+
def dti_cmp_non_datetime(self, tz_naive_fixture):
8276
# GH#19301 by convention datetime.date is not considered comparable
8377
# to Timestamp or DatetimeIndex. This may change in the future.
78+
tz = tz_naive_fixture
8479
dti = pd.date_range('2016-01-01', periods=2, tz=tz)
8580

8681
other = datetime(2016, 1, 1).date()
@@ -96,20 +91,23 @@ def dti_cmp_non_datetime(self, tz):
9691
dti >= other
9792

9893
@pytest.mark.parametrize('other', [None, np.nan, pd.NaT])
99-
def test_dti_eq_null_scalar(self, other, tz):
94+
def test_dti_eq_null_scalar(self, other, tz_naive_fixture):
10095
# GH#19301
96+
tz = tz_naive_fixture
10197
dti = pd.date_range('2016-01-01', periods=2, tz=tz)
10298
assert not (dti == other).any()
10399

104100
@pytest.mark.parametrize('other', [None, np.nan, pd.NaT])
105-
def test_dti_ne_null_scalar(self, other, tz):
101+
def test_dti_ne_null_scalar(self, other, tz_naive_fixture):
106102
# GH#19301
103+
tz = tz_naive_fixture
107104
dti = pd.date_range('2016-01-01', periods=2, tz=tz)
108105
assert (dti != other).all()
109106

110107
@pytest.mark.parametrize('other', [None, np.nan])
111-
def test_dti_cmp_null_scalar_inequality(self, tz, other):
108+
def test_dti_cmp_null_scalar_inequality(self, tz_naive_fixture, other):
112109
# GH#19301
110+
tz = tz_naive_fixture
113111
dti = pd.date_range('2016-01-01', periods=2, tz=tz)
114112

115113
with pytest.raises(TypeError):
@@ -335,32 +333,36 @@ def test_dti_radd_timestamp_raises(self):
335333
# -------------------------------------------------------------
336334
# Binary operations DatetimeIndex and int
337335

338-
def test_dti_add_int(self, tz, one):
336+
def test_dti_add_int(self, tz_naive_fixture, one):
339337
# Variants of `one` for #19012
338+
tz = tz_naive_fixture
340339
rng = pd.date_range('2000-01-01 09:00', freq='H',
341340
periods=10, tz=tz)
342341
result = rng + one
343342
expected = pd.date_range('2000-01-01 10:00', freq='H',
344343
periods=10, tz=tz)
345344
tm.assert_index_equal(result, expected)
346345

347-
def test_dti_iadd_int(self, tz, one):
346+
def test_dti_iadd_int(self, tz_naive_fixture, one):
347+
tz = tz_naive_fixture
348348
rng = pd.date_range('2000-01-01 09:00', freq='H',
349349
periods=10, tz=tz)
350350
expected = pd.date_range('2000-01-01 10:00', freq='H',
351351
periods=10, tz=tz)
352352
rng += one
353353
tm.assert_index_equal(rng, expected)
354354

355-
def test_dti_sub_int(self, tz, one):
355+
def test_dti_sub_int(self, tz_naive_fixture, one):
356+
tz = tz_naive_fixture
356357
rng = pd.date_range('2000-01-01 09:00', freq='H',
357358
periods=10, tz=tz)
358359
result = rng - one
359360
expected = pd.date_range('2000-01-01 08:00', freq='H',
360361
periods=10, tz=tz)
361362
tm.assert_index_equal(result, expected)
362363

363-
def test_dti_isub_int(self, tz, one):
364+
def test_dti_isub_int(self, tz_naive_fixture, one):
365+
tz = tz_naive_fixture
364366
rng = pd.date_range('2000-01-01 09:00', freq='H',
365367
periods=10, tz=tz)
366368
expected = pd.date_range('2000-01-01 08:00', freq='H',
@@ -414,8 +416,9 @@ def test_dti_add_intarray_no_freq(self, box):
414416
# -------------------------------------------------------------
415417
# DatetimeIndex.shift is used in integer addition
416418

417-
def test_dti_shift_tzaware(self, tz):
419+
def test_dti_shift_tzaware(self, tz_naive_fixture):
418420
# GH#9903
421+
tz = tz_naive_fixture
419422
idx = pd.DatetimeIndex([], name='xxx', tz=tz)
420423
tm.assert_index_equal(idx.shift(0, freq='H'), idx)
421424
tm.assert_index_equal(idx.shift(3, freq='H'), idx)
@@ -502,28 +505,32 @@ def test_dti_shift_near_midnight(self, shift, result_time):
502505
# -------------------------------------------------------------
503506
# Binary operations DatetimeIndex and timedelta-like
504507

505-
def test_dti_add_timedeltalike(self, tz, delta):
508+
def test_dti_add_timedeltalike(self, tz_naive_fixture, delta):
509+
tz = tz_naive_fixture
506510
rng = pd.date_range('2000-01-01', '2000-02-01', tz=tz)
507511
result = rng + delta
508512
expected = pd.date_range('2000-01-01 02:00',
509513
'2000-02-01 02:00', tz=tz)
510514
tm.assert_index_equal(result, expected)
511515

512-
def test_dti_iadd_timedeltalike(self, tz, delta):
516+
def test_dti_iadd_timedeltalike(self, tz_naive_fixture, delta):
517+
tz = tz_naive_fixture
513518
rng = pd.date_range('2000-01-01', '2000-02-01', tz=tz)
514519
expected = pd.date_range('2000-01-01 02:00',
515520
'2000-02-01 02:00', tz=tz)
516521
rng += delta
517522
tm.assert_index_equal(rng, expected)
518523

519-
def test_dti_sub_timedeltalike(self, tz, delta):
524+
def test_dti_sub_timedeltalike(self, tz_naive_fixture, delta):
525+
tz = tz_naive_fixture
520526
rng = pd.date_range('2000-01-01', '2000-02-01', tz=tz)
521527
expected = pd.date_range('1999-12-31 22:00',
522528
'2000-01-31 22:00', tz=tz)
523529
result = rng - delta
524530
tm.assert_index_equal(result, expected)
525531

526-
def test_dti_isub_timedeltalike(self, tz, delta):
532+
def test_dti_isub_timedeltalike(self, tz_naive_fixture, delta):
533+
tz = tz_naive_fixture
527534
rng = pd.date_range('2000-01-01', '2000-02-01', tz=tz)
528535
expected = pd.date_range('1999-12-31 22:00',
529536
'2000-01-31 22:00', tz=tz)
@@ -532,8 +539,9 @@ def test_dti_isub_timedeltalike(self, tz, delta):
532539

533540
# -------------------------------------------------------------
534541
# Binary operations DatetimeIndex and TimedeltaIndex/array
535-
def test_dti_add_tdi(self, tz):
542+
def test_dti_add_tdi(self, tz_naive_fixture):
536543
# GH 17558
544+
tz = tz_naive_fixture
537545
dti = DatetimeIndex([Timestamp('2017-01-01', tz=tz)] * 10)
538546
tdi = pd.timedelta_range('0 days', periods=10)
539547
expected = pd.date_range('2017-01-01', periods=10, tz=tz)
@@ -552,8 +560,9 @@ def test_dti_add_tdi(self, tz):
552560
result = tdi.values + dti
553561
tm.assert_index_equal(result, expected)
554562

555-
def test_dti_iadd_tdi(self, tz):
563+
def test_dti_iadd_tdi(self, tz_naive_fixture):
556564
# GH 17558
565+
tz = tz_naive_fixture
557566
dti = DatetimeIndex([Timestamp('2017-01-01', tz=tz)] * 10)
558567
tdi = pd.timedelta_range('0 days', periods=10)
559568
expected = pd.date_range('2017-01-01', periods=10, tz=tz)
@@ -576,8 +585,9 @@ def test_dti_iadd_tdi(self, tz):
576585
result += dti
577586
tm.assert_index_equal(result, expected)
578587

579-
def test_dti_sub_tdi(self, tz):
588+
def test_dti_sub_tdi(self, tz_naive_fixture):
580589
# GH 17558
590+
tz = tz_naive_fixture
581591
dti = DatetimeIndex([Timestamp('2017-01-01', tz=tz)] * 10)
582592
tdi = pd.timedelta_range('0 days', periods=10)
583593
expected = pd.date_range('2017-01-01', periods=10, tz=tz, freq='-1D')
@@ -598,8 +608,9 @@ def test_dti_sub_tdi(self, tz):
598608
with tm.assert_raises_regex(TypeError, msg):
599609
tdi.values - dti
600610

601-
def test_dti_isub_tdi(self, tz):
611+
def test_dti_isub_tdi(self, tz_naive_fixture):
602612
# GH 17558
613+
tz = tz_naive_fixture
603614
dti = DatetimeIndex([Timestamp('2017-01-01', tz=tz)] * 10)
604615
tdi = pd.timedelta_range('0 days', periods=10)
605616
expected = pd.date_range('2017-01-01', periods=10, tz=tz, freq='-1D')
@@ -653,7 +664,8 @@ def test_add_datetimelike_and_dti_tz(self, addend):
653664
# -------------------------------------------------------------
654665
# __add__/__sub__ with ndarray[datetime64] and ndarray[timedelta64]
655666

656-
def test_dti_add_dt64_array_raises(self, tz):
667+
def test_dti_add_dt64_array_raises(self, tz_naive_fixture):
668+
tz = tz_naive_fixture
657669
dti = pd.date_range('2016-01-01', periods=3, tz=tz)
658670
dtarr = dti.values
659671

@@ -672,7 +684,8 @@ def test_dti_sub_dt64_array_naive(self):
672684
result = dtarr - dti
673685
tm.assert_index_equal(result, expected)
674686

675-
def test_dti_sub_dt64_array_aware_raises(self, tz):
687+
def test_dti_sub_dt64_array_aware_raises(self, tz_naive_fixture):
688+
tz = tz_naive_fixture
676689
if tz is None:
677690
return
678691
dti = pd.date_range('2016-01-01', periods=3, tz=tz)
@@ -683,7 +696,8 @@ def test_dti_sub_dt64_array_aware_raises(self, tz):
683696
with pytest.raises(TypeError):
684697
dtarr - dti
685698

686-
def test_dti_add_td64_array(self, tz):
699+
def test_dti_add_td64_array(self, tz_naive_fixture):
700+
tz = tz_naive_fixture
687701
dti = pd.date_range('2016-01-01', periods=3, tz=tz)
688702
tdi = dti - dti.shift(1)
689703
tdarr = tdi.values
@@ -694,7 +708,8 @@ def test_dti_add_td64_array(self, tz):
694708
result = tdarr + dti
695709
tm.assert_index_equal(result, expected)
696710

697-
def test_dti_sub_td64_array(self, tz):
711+
def test_dti_sub_td64_array(self, tz_naive_fixture):
712+
tz = tz_naive_fixture
698713
dti = pd.date_range('2016-01-01', periods=3, tz=tz)
699714
tdi = dti - dti.shift(1)
700715
tdarr = tdi.values
@@ -867,8 +882,9 @@ def test_dti_add_series(self, tz, names):
867882
result4 = index + ser.values
868883
tm.assert_index_equal(result4, expected)
869884

870-
def test_dti_add_offset_array(self, tz):
885+
def test_dti_add_offset_array(self, tz_naive_fixture):
871886
# GH#18849
887+
tz = tz_naive_fixture
872888
dti = pd.date_range('2017-01-01', periods=2, tz=tz)
873889
other = np.array([pd.offsets.MonthEnd(), pd.offsets.Day(n=2)])
874890

@@ -885,8 +901,9 @@ def test_dti_add_offset_array(self, tz):
885901
@pytest.mark.parametrize('names', [(None, None, None),
886902
('foo', 'bar', None),
887903
('foo', 'foo', 'foo')])
888-
def test_dti_add_offset_index(self, tz, names):
904+
def test_dti_add_offset_index(self, tz_naive_fixture, names):
889905
# GH#18849, GH#19744
906+
tz = tz_naive_fixture
890907
dti = pd.date_range('2017-01-01', periods=2, tz=tz, name=names[0])
891908
other = pd.Index([pd.offsets.MonthEnd(), pd.offsets.Day(n=2)],
892909
name=names[1])
@@ -901,8 +918,9 @@ def test_dti_add_offset_index(self, tz, names):
901918
res2 = other + dti
902919
tm.assert_index_equal(res2, expected)
903920

904-
def test_dti_sub_offset_array(self, tz):
921+
def test_dti_sub_offset_array(self, tz_naive_fixture):
905922
# GH#18824
923+
tz = tz_naive_fixture
906924
dti = pd.date_range('2017-01-01', periods=2, tz=tz)
907925
other = np.array([pd.offsets.MonthEnd(), pd.offsets.Day(n=2)])
908926

@@ -915,8 +933,9 @@ def test_dti_sub_offset_array(self, tz):
915933
@pytest.mark.parametrize('names', [(None, None, None),
916934
('foo', 'bar', None),
917935
('foo', 'foo', 'foo')])
918-
def test_dti_sub_offset_index(self, tz, names):
936+
def test_dti_sub_offset_index(self, tz_naive_fixture, names):
919937
# GH#18824, GH#19744
938+
tz = tz_naive_fixture
920939
dti = pd.date_range('2017-01-01', periods=2, tz=tz, name=names[0])
921940
other = pd.Index([pd.offsets.MonthEnd(), pd.offsets.Day(n=2)],
922941
name=names[1])
@@ -930,8 +949,9 @@ def test_dti_sub_offset_index(self, tz, names):
930949
@pytest.mark.parametrize('names', [(None, None, None),
931950
('foo', 'bar', None),
932951
('foo', 'foo', 'foo')])
933-
def test_dti_with_offset_series(self, tz, names):
952+
def test_dti_with_offset_series(self, tz_naive_fixture, names):
934953
# GH#18849
954+
tz = tz_naive_fixture
935955
dti = pd.date_range('2017-01-01', periods=2, tz=tz, name=names[0])
936956
other = Series([pd.offsets.MonthEnd(), pd.offsets.Day(n=2)],
937957
name=names[1])

0 commit comments

Comments
 (0)