DEPR: camelCase in offsets, get_offset #30340

jbrockmendel · 2019-12-19T02:11:31Z

closes API: deprecate get_offset, Offset for time rules like '30s' #4205
tests added / passed
passes black pandas
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

…pr-get_offset

jbrockmendel · 2019-12-20T01:43:57Z

@datapythonista the good news is im able to reproduce this locally with make doc like you suggested, the bad is that I have no idea why I'm getting a bunch of these complaints:

/home/vsts/work/1/s/doc/source/reference/api/pandas.tseries.offsets.BQuarterBegin.isAnchored.rst: WARNING: document isn't included in any toctree

ideas?

datapythonista · 2019-12-20T04:29:09Z

We fixed a lot of these in the past, but I'm not sure if we ever understood the problem. At least I don't think I did.

I think what we do is to add the docs being reported to a hidden autosummary. See: https://github.com/pandas-dev/pandas/blame/master/doc/source/reference/index.rst#L44

@jorisvandenbossche probably knows more

jorisvandenbossche · 2019-12-20T07:35:42Z

BQuarterBegin.isAnchored.rst: WARNING: document isn't included in any toctree

It's because you removed those from the api doc pages, while they are still generated automatically from the class docstring. But so they also need to be included somewhere in another autosummary that adds them into the toctree. So like Marc said, we use hidden autosummaries to solve this. There should be some other examples in the api docs of that (look at the bottom of those pages).

jorisvandenbossche · 2019-12-20T08:47:48Z

See the "hidden" text in doc/source/reference/index.rst (https://github.com/pandas-dev/pandas/blob/master/doc/source/reference/index.rst)

jbrockmendel · 2019-12-20T16:40:17Z

thank you both

jbrockmendel · 2019-12-20T18:51:00Z

@jorisvandenbossche my attempts at mimicing the examples in offset_frequency.rst haven't worked. in this commit i used "api.offsets.Foo.onOffset" but itt also didn't work with "Foo.onOffset", "api/Foo.onOffset", "pandas.tseries.offsets.Foo.onOffset"

jorisvandenbossche · 2019-12-21T09:17:46Z

The toctree needs the path (which becomes the url, eg https://dev.pandas.io/docs/reference/api/pandas.tseries.offsets.DateOffset.isAnchored.html), so you need something like api/pandas.tseries.offsets.DateOffset.isAnchored. However, if you do it on this page, it might need to be ../api/pandas... since it is one level down in the hierarchy.

jbrockmendel · 2019-12-21T19:16:39Z

@jorisvandenbossche see newest commit where i tried just about every variant I could think of, including putting them in a different file where we already use this pattern.

jorisvandenbossche · 2019-12-21T20:14:31Z

doc/source/reference/index.rst

@@ -61,6 +61,546 @@ public functions related to data types in pandas.
        api/pandas.Series.from_array
        api/pandas.Series.imag
        api/pandas.Series.real
+        ..api/pandas.tseries.offsets.DateOffset.isAnchored


if you put it here it doesn't need the '..', see the lines above

OK, didn't see what you did below :)

doc/source/reference/offset_frequency.rst

…pr-get_offset

jorisvandenbossche

On the actual PR, is there any difference between get_offset and to_offset that the user should be aware of? (the implementation is not exactly the same)

jorisvandenbossche · 2019-12-23T09:01:31Z

pandas/tseries/offsets.py

        return self.n == 1

+    def onOffset(self, dt):
+        warnings.warn(


Can you add a docstring with a ..deprecated:: directive?

jorisvandenbossche · 2019-12-23T09:01:50Z

pandas/tseries/frequencies.py

@@ -185,10 +186,29 @@ def get_offset(name: str) -> DateOffset:
    """
    Return DateOffset object associated with rule name.

+    .. deprecated:: 1.0.0
+


Can you add here that to_offset should be used instead?

jbrockmendel · 2019-12-23T16:29:16Z

is there any difference between get_offset and to_offset that the user should be aware of?

I dont think get_offset is supported in a meaningful enough way for this to make sense. e.g. i just found the example in the docstring was wrong

jreback · 2019-12-27T20:42:56Z

pandas/tseries/frequencies.py

+        FutureWarning,
+        stacklevel=2,
+    )
+    return _get_offset(name)


can this call to_offset instead?

No, we still need _get_offset internally, just officially telling users to stay away

ok, would rename maybe if you can (followon ok)

jreback

comment

jreback

did you add a deprecation note in whatsnew?

jbrockmendel · 2019-12-27T20:49:35Z

did you add a deprecation note in whatsnew?

yes

jreback · 2019-12-27T20:53:32Z

great thanks.

…ndexing-1row-df * upstream/master: (333 commits) CI: troubleshoot Web_and_Docs failing (pandas-dev#30534) WARN: Ignore NumbaPerformanceWarning in test suite (pandas-dev#30525) DEPR: camelCase in offsets, get_offset (pandas-dev#30340) PERF: implement scalar ops blockwise (pandas-dev#29853) DEPR: Remove Series.compress (pandas-dev#30514) ENH: Add numba engine for rolling apply (pandas-dev#30151) [ENH] Add to_markdown method (pandas-dev#30350) DEPR: Deprecate pandas.np module (pandas-dev#30386) ENH: Add ignore_index for df.drop_duplicates (pandas-dev#30405) BUG: The setting xrot=0 in DataFrame.hist() doesn't work with by and subplots pandas-dev#30288 (pandas-dev#30491) CI: Fix GBQ Tests (pandas-dev#30478) Bug groupby quantile listlike q and int columns (pandas-dev#30485) ENH: Add ignore_index for df.sort_values and series.sort_values (pandas-dev#30402) TYP: Typing hints in pandas/io/formats/{css,csvs}.py (pandas-dev#30398) BUG: raise on non-hashable Index name, closes pandas-dev#29069 (pandas-dev#30335) Replace "foo!r" to "repr(foo)" syntax pandas-dev#29886 (pandas-dev#30502) BUG: preserve EA dtype in transpose (pandas-dev#30091) BLD: add check to prevent tempita name error, clsoes pandas-dev#28836 (pandas-dev#30498) REF/TST: method-specific files for test_append (pandas-dev#30503) marked unused parameters (pandas-dev#30504) ...

jbrockmendel added 5 commits December 18, 2019 18:08

DEPR: camelCase in offsets

afe3050

GH ref

fcd58e9

Merge branch 'master' of https://github.com/pandas-dev/pandas into de…

20e60bb

…pr-get_offset

troubleshoot ci

a39d50e

update usage

e30d272

jbrockmendel added Deprecate Functionality to remove in pandas Frequency DateOffsets labels Dec 20, 2019

keeep trying

ae19cf3

throw everything at the wall

df3ff50

jorisvandenbossche reviewed Dec 21, 2019

View reviewed changes

doc/source/reference/offset_frequency.rst Show resolved Hide resolved

jbrockmendel added 2 commits December 21, 2019 12:21

Merge branch 'master' of https://github.com/pandas-dev/pandas into de…

4bfd4ef

…pr-get_offset

just keep em both

eaf3b6d

jorisvandenbossche reviewed Dec 23, 2019

View reviewed changes

jreback reviewed Dec 27, 2019

View reviewed changes

jreback requested changes Dec 27, 2019

View reviewed changes

jreback reviewed Dec 27, 2019

View reviewed changes

jreback approved these changes Dec 27, 2019

View reviewed changes

jreback added this to the 1.0 milestone Dec 27, 2019

jreback merged commit 1d36851 into pandas-dev:master Dec 27, 2019

jorisvandenbossche mentioned this pull request Dec 27, 2019

DEPR: log of deprecations in 1.x (to be removed in 2.0) #30228

Closed

jbrockmendel deleted the depr-get_offset branch December 27, 2019 20:58

AlexKirko pushed a commit to AlexKirko/pandas that referenced this pull request Dec 29, 2019

DEPR: camelCase in offsets, get_offset (pandas-dev#30340)

5481f51

mroeschke mentioned this pull request Oct 25, 2022

DEPR: Remove get_offset, infer_freq warn param #49314

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DEPR: camelCase in offsets, get_offset #30340

DEPR: camelCase in offsets, get_offset #30340

jbrockmendel commented Dec 19, 2019

jbrockmendel commented Dec 20, 2019

datapythonista commented Dec 20, 2019

jorisvandenbossche commented Dec 20, 2019

jorisvandenbossche commented Dec 20, 2019

jbrockmendel commented Dec 20, 2019

jbrockmendel commented Dec 20, 2019

jorisvandenbossche commented Dec 21, 2019

jbrockmendel commented Dec 21, 2019

jorisvandenbossche Dec 21, 2019

jorisvandenbossche Dec 21, 2019

jorisvandenbossche left a comment

jorisvandenbossche Dec 23, 2019

jorisvandenbossche Dec 23, 2019

jbrockmendel commented Dec 23, 2019

jreback Dec 27, 2019

jbrockmendel Dec 27, 2019

jreback Dec 27, 2019

jreback left a comment

jreback left a comment

jbrockmendel commented Dec 27, 2019

jreback commented Dec 27, 2019

DEPR: camelCase in offsets, get_offset #30340

DEPR: camelCase in offsets, get_offset #30340

Conversation

jbrockmendel commented Dec 19, 2019

jbrockmendel commented Dec 20, 2019

datapythonista commented Dec 20, 2019

jorisvandenbossche commented Dec 20, 2019

jorisvandenbossche commented Dec 20, 2019

jbrockmendel commented Dec 20, 2019

jbrockmendel commented Dec 20, 2019

jorisvandenbossche commented Dec 21, 2019

jbrockmendel commented Dec 21, 2019

jorisvandenbossche Dec 21, 2019

Choose a reason for hiding this comment

jorisvandenbossche Dec 21, 2019

Choose a reason for hiding this comment

jorisvandenbossche left a comment

Choose a reason for hiding this comment

jorisvandenbossche Dec 23, 2019

Choose a reason for hiding this comment

jorisvandenbossche Dec 23, 2019

Choose a reason for hiding this comment

jbrockmendel commented Dec 23, 2019

jreback Dec 27, 2019

Choose a reason for hiding this comment

jbrockmendel Dec 27, 2019

Choose a reason for hiding this comment

jreback Dec 27, 2019

Choose a reason for hiding this comment

jreback left a comment

Choose a reason for hiding this comment

jreback left a comment

Choose a reason for hiding this comment

jbrockmendel commented Dec 27, 2019

jreback commented Dec 27, 2019