Stacklevel argument updated #46687 #47035

Anupam-USP · 2022-05-16T19:58:59Z

closes CLN find stacklevel inside deprecate_nonkeyword_arguments #46687
Tests added and passed if fixing a bug or adding a new feature
All code checks passed.
Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.

Anupam-USP · 2022-05-16T19:59:45Z

Can you suggest me some test to write for these?

MarcoGorelli

this is just an internal refactor, so as long as the current test-suite passes, no new tests should be necessary

MarcoGorelli · 2022-05-17T09:14:41Z

pandas/util/_decorators.py

-    stacklevel: int = 2,
+    stacklevel: int = None,


if you're defining it below (L308), you don't need it as argument any more, do you?

No, I will remove it. Also should I check other files for definition of stacklevel and change them?

you should remove it from the docstring as well

MarcoGorelli · 2022-05-17T15:56:22Z

currently failing with

ImportError while loading conftest 'D:\a\pandas\pandas\pandas\conftest.py'.
pandas\__init__.py:48: in <module>
    from pandas.core.api import (
pandas\core\api.py:48: in <module>
    from pandas.core.groupby import (
pandas\core\groupby\__init__.py:1: in <module>
    from pandas.core.groupby.generic import (
pandas\core\groupby\generic.py:73: in <module>
    from pandas.core.frame import DataFrame
pandas\core\frame.py:202: in <module>
    from pandas.core.series import Series
pandas\core\series.py:5865: in <module>
    Series._add_numeric_operations()
pandas\core\generic.py:10950: in _add_numeric_operations
    @deprecate_nonkeyword_arguments(
E   TypeError: deprecate_nonkeyword_arguments() got an unexpected keyword argument 'stacklevel'

Anupam-USP · 2022-05-21T04:55:15Z

Hey @MarcoGorelli I tried changing the files and ran conftest.py to check, but getting errors like AttributeError: module 'pandas._testing' has no attribute 'make_rand_series' so not able to check the changes I have made. What can I do?

MarcoGorelli · 2022-05-21T14:43:56Z

hey @Anupam-USP - what command did you run that gave you that output?

You might need to re-compile the C extensions (python setup.py build_ext -j 4)

Anupam-USP · 2022-05-23T04:17:20Z

To overcome the aforementioned issue, I have to still declare it as I did previously.

MarcoGorelli

To overcome

E   TypeError: deprecate_nonkeyword_arguments() got an unexpected keyword argument 'stacklevel'

you should remove calls of deprecate_nonkeyword_arguments where stacklevel is passed

To address the other issue, you probably just need to recompile the C extensions (python setup.py build_ext -j 4). There should be no need to keep stacklevel as an argument to deprecate_nonkeyword_arguments

MarcoGorelli · 2022-06-04T12:51:45Z

pandas/util/_decorators.py

@@ -304,6 +305,7 @@ def decorate(func):
            f"{future_version_msg(version)} all arguments of "
            f"{name or func.__qualname__}{{arguments}} will be keyword-only."
        )
+        stacklevel = find_stack_level()


in L317, you should just set

stacklevel=find_stack_level()

rather than assigning it here

jreback · 2022-06-05T22:28:20Z

@Anupam-USP what's new entry not needed as this is not public (i removed it)

…cate_stacklevel

MarcoGorelli · 2022-06-15T08:36:58Z

couple of test failures, I'll take a look later

=================================== FAILURES ===================================
__________________ test_read_csv_posargs_deprecation[pyarrow] __________________
[gw0] linux -- Python 3.8.13 /usr/share/miniconda/envs/test/bin/python
all_parsers = <pandas.tests.io.parser.conftest.PyArrowParser object at 0x7f33cf300970>
    def test_read_csv_posargs_deprecation(all_parsers):
        # GH 41485
        f = StringIO("a,b\n1,2")
        parser = all_parsers
        msg = (
            "In a future version of pandas all arguments of read_csv "
            "except for the argument 'filepath_or_buffer' will be keyword-only"
        )
        with tm.assert_produces_warning(FutureWarning, match=msg):
>           parser.read_csv(f, " ")
pandas/tests/io/parser/common/test_common_basic.py:810: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
/usr/share/miniconda/envs/test/lib/python3.8/contextlib.py:120: in __exit__
    next(self.gen)
pandas/_testing/_warnings.py:135: in _assert_caught_expected_warning
    _assert_raised_with_correct_stacklevel(actual_warning)
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
actual_warning = <warnings.WarningMessage object at 0x7f33cd100820>
    def _assert_raised_with_correct_stacklevel(
        actual_warning: warnings.WarningMessage,
    ) -> None:
        from inspect import (
            getframeinfo,
            stack,
        )
        caller = getframeinfo(stack()[4][0])
        msg = (
            "Warning not set with correct stacklevel. "
            f"File where warning is raised: {actual_warning.filename} != "
            f"{caller.filename}. Warning message: {actual_warning.message}"
        )
>       assert actual_warning.filename == caller.filename, msg
E       AssertionError: Warning not set with correct stacklevel. File where warning is raised: /home/runner/work/pandas/pandas/pandas/tests/io/parser/conftest.py != /home/runner/work/pandas/pandas/pandas/tests/io/parser/common/test_common_basic.py. Warning message: In a future version of pandas all arguments of read_csv except for the argument 'filepath_or_buffer' will be keyword-only.
pandas/_testing/_warnings.py:221: AssertionError
_________________ test_read_table_posargs_deprecation[pyarrow] _________________
[gw0] linux -- Python 3.8.13 /usr/share/miniconda/envs/test/bin/python
all_parsers = <pandas.tests.io.parser.conftest.PyArrowParser object at 0x7f33d4eab5e0>
    def test_read_table_posargs_deprecation(all_parsers):
        # https://github.com/pandas-dev/pandas/issues/41485
        data = StringIO("a\tb\n1\t2")
        parser = all_parsers
        msg = (
            "In a future version of pandas all arguments of read_table "
            "except for the argument 'filepath_or_buffer' will be keyword-only"
        )
        with tm.assert_produces_warning(FutureWarning, match=msg):
>           parser.read_table(data, " ")
pandas/tests/io/parser/common/test_common_basic.py:925: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
/usr/share/miniconda/envs/test/lib/python3.8/contextlib.py:120: in __exit__
    next(self.gen)
pandas/_testing/_warnings.py:135: in _assert_caught_expected_warning
    _assert_raised_with_correct_stacklevel(actual_warning)
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
actual_warning = <warnings.WarningMessage object at 0x7f33d4eab[52](https://github.com/pandas-dev/pandas/runs/6895416344?check_suite_focus=true#step:8:54)0>
    def _assert_raised_with_correct_stacklevel(
        actual_warning: warnings.WarningMessage,
    ) -> None:
        from inspect import (
            getframeinfo,
            stack,
        )
        caller = getframeinfo(stack()[4][0])
        msg = (
            "Warning not set with correct stacklevel. "
            f"File where warning is raised: {actual_warning.filename} != "
            f"{caller.filename}. Warning message: {actual_warning.message}"
        )
>       assert actual_warning.filename == caller.filename, msg
E       AssertionError: Warning not set with correct stacklevel. File where warning is raised: /home/runner/work/pandas/pandas/pandas/tests/io/parser/conftest.py != /home/runner/work/pandas/pandas/pandas/tests/io/parser/common/test_common_basic.py. Warning message: In a future version of pandas all arguments of read_table except for the argument 'filepath_or_buffer' will be keyword-only.
pandas/_testing/_warnings.py:221: AssertionError
=============================== warnings summary ===============================
pandas/tests/io/parser/test_parse_dates.py::test_date_parser_resolution_if_not_ns[pyarrow]
  /home/runner/work/pandas/pandas/pandas/tests/io/parser/conftest.py:29: FutureWarning: 
          Use pd.to_datetime instead.
    return read_csv(*args, **kwargs)
-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
------ generated xml file: /home/runner/work/pandas/pandas/test-data.xml -------
---------- coverage: platform linux, python 3.8.13-final-0 -----------
Coverage XML written to file coverage.xml

MarcoGorelli · 2022-06-16T09:46:15Z

As noted here #47385 , I think the test failure might be a false-positive. Will try to address that one first

…ation test

MarcoGorelli

Have fixed this up, I think it should be fine now and that the failed job had an unrelated failure (re-running to check)

mroeschke · 2022-06-30T18:07:06Z

Thanks @Anupam-USP and @MarcoGorelli

* Stacklevel argument updated pandas-dev#46687 * argument removed * param added * fixup * remove stackevel from read_sas decorator * add read_table_check_warnings and use it in read_table posargs deprecation test Co-authored-by: Jeff Reback <[email protected]> Co-authored-by: Marco Gorelli <[email protected]>

Stacklevel argument updated pandas-dev#46687

642957e

MarcoGorelli self-requested a review May 16, 2022 22:13

MarcoGorelli suggested changes May 17, 2022

View reviewed changes

argument removed

43cd385

jreback added the Clean label May 21, 2022

param added

30d97f0

MarcoGorelli self-requested a review May 23, 2022 09:37

MarcoGorelli suggested changes Jun 4, 2022

View reviewed changes

Merge branch 'main' into deprecate_stacklevel

2b59e2b

MarcoGorelli added 4 commits June 14, 2022 17:37

Merge remote-tracking branch 'upstream/main' into pr/Anupam-USP-depre…

8ed722a

…cate_stacklevel

fixup

f491c65

Merge branch 'main' into deprecate_stacklevel

3213c78

Merge branch 'main' into deprecate_stacklevel

3f78fed

MarcoGorelli mentioned this pull request Jun 16, 2022

TST,WARN: read_csv raises warning at wrong stacklevel, but _assert_raised_with_correct_stacklevel doesn't fail #47385

Closed

3 tasks

MarcoGorelli added 3 commits June 26, 2022 21:19

Merge branch 'main' into deprecate_stacklevel

995f2e0

remove stackevel from read_sas decorator

4468340

add read_table_check_warnings and use it in read_table posargs deprec…

8467639

…ation test

MarcoGorelli approved these changes Jun 27, 2022

View reviewed changes

MarcoGorelli added this to the 1.5 milestone Jun 27, 2022

mroeschke approved these changes Jun 30, 2022

View reviewed changes

mroeschke merged commit 32cb5aa into pandas-dev:main Jun 30, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Stacklevel argument updated #46687 #47035

Stacklevel argument updated #46687 #47035

Anupam-USP commented May 16, 2022 •

edited

Loading

Anupam-USP commented May 16, 2022

MarcoGorelli left a comment

MarcoGorelli May 17, 2022

Anupam-USP May 17, 2022

MarcoGorelli May 17, 2022

MarcoGorelli commented May 17, 2022

Anupam-USP commented May 21, 2022

MarcoGorelli commented May 21, 2022

Anupam-USP commented May 23, 2022

MarcoGorelli left a comment

MarcoGorelli Jun 4, 2022

jreback commented Jun 5, 2022

MarcoGorelli commented Jun 15, 2022

MarcoGorelli commented Jun 16, 2022

MarcoGorelli left a comment

mroeschke commented Jun 30, 2022

Stacklevel argument updated #46687 #47035

Stacklevel argument updated #46687 #47035

Conversation

Anupam-USP commented May 16, 2022 • edited Loading

Anupam-USP commented May 16, 2022

MarcoGorelli left a comment

Choose a reason for hiding this comment

MarcoGorelli May 17, 2022

Choose a reason for hiding this comment

Anupam-USP May 17, 2022

Choose a reason for hiding this comment

MarcoGorelli May 17, 2022

Choose a reason for hiding this comment

MarcoGorelli commented May 17, 2022

Anupam-USP commented May 21, 2022

MarcoGorelli commented May 21, 2022

Anupam-USP commented May 23, 2022

MarcoGorelli left a comment

Choose a reason for hiding this comment

MarcoGorelli Jun 4, 2022

Choose a reason for hiding this comment

jreback commented Jun 5, 2022

MarcoGorelli commented Jun 15, 2022

MarcoGorelli commented Jun 16, 2022

MarcoGorelli left a comment

Choose a reason for hiding this comment

mroeschke commented Jun 30, 2022

Anupam-USP commented May 16, 2022 •

edited

Loading