Skip to content

DEPR #16747: deprecate pd.TimeGrouper #16942

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

DEPR #16747: deprecate pd.TimeGrouper #16942

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
397d547
Add deprecation warning to TimeGrouper
stevenvandenberghe Jul 15, 2017
7d8797b
Add TimeGrouper to deprecated_classes_in_future
stevenvandenberghe Jul 15, 2017
c82089f
Add test class TimeGrouper_deprecation
stevenvandenberghe Jul 15, 2017
cc3cec7
Add TimeGrouper to deprecated_classes
stevenvandenberghe Jul 15, 2017
5f044e9
Change ref to github issue
stevenvandenberghe Jul 15, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pandas/core/resample.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1020,6 +1020,10 @@ def __init__(self, freq='Min', closed=None, label=None, how='mean',
nperiods=None, axis=0,
fill_method=None, limit=None, loffset=None, kind=None,
convention=None, base=0, **kwargs):
# deprecation TimeGrouper, #16747
warnings.warn("TimeGrouper is deprecated. Please use "
"Grouper", FutureWarning, stacklevel=2)

freq = to_offset(freq)

end_types = set(['M', 'A', 'Q', 'BM', 'BA', 'BQ', 'W'])
Expand Down
5 changes: 3 additions & 2 deletions pandas/tests/api/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,13 @@ class TestPDApi(Base):
'Grouper', 'HDFStore', 'Index', 'Int64Index', 'MultiIndex',
'Period', 'PeriodIndex', 'RangeIndex', 'UInt64Index',
'Series', 'SparseArray', 'SparseDataFrame',
'SparseSeries', 'TimeGrouper', 'Timedelta',
'SparseSeries', 'Timedelta',
'TimedeltaIndex', 'Timestamp', 'Interval', 'IntervalIndex']

# these are already deprecated; awaiting removal
deprecated_classes = ['WidePanel', 'Panel4D',
'SparseList', 'Expr', 'Term']
'SparseList', 'Expr', 'Term',
'TimeGrouper']

# these should be deprecated in the future
deprecated_classes_in_future = ['Panel']
Expand Down
5 changes: 5 additions & 0 deletions pandas/tests/test_resample.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3030,6 +3030,11 @@ def setup_method(self, method):
self.ts = Series(np.random.randn(1000),
index=date_range('1/1/2000', periods=1000))

def test_TimeGrouper_deprecation(self):
# GH 16747
with tm.assert_produces_warning(FutureWarning):
TimeGrouper('A', label='right', closed='right')

def test_apply(self):
grouper = TimeGrouper('A', label='right', closed='right')

Expand Down