BUG : Add Deprecation FutureWarning for parse function call in read_excel #51437
Conversation
pandas/io/excel/_base.py
Outdated
| @@ -1564,6 +1566,9 @@ def parse( | |||
| """ | |||
| Parse specified sheet(s) into a DataFrame. | |||
|
|
|||
| .. deprecated:: 2.0.0 | |||
| Arguments other than sheet_name by position may not work. | |||
There was a problem hiding this comment.
Specifying arguments other than sheet_name by position is deprecated. Specify arguments by keyword name instead.
pandas/io/excel/_base.py
Outdated
| @@ -1572,6 +1577,41 @@ def parse( | |||
| DataFrame or dict of DataFrames | |||
| DataFrame from the passed in Excel file. | |||
| """ | |||
| arguments = list(kwds.keys()) | |||
There was a problem hiding this comment.
This isn't necessary, just iterated over kwds below: for key in kwds
pandas/io/excel/_base.py
Outdated
| "convert_float", | ||
| ] | ||
| # Check for any invalid kwargs | ||
| if [argument for argument in arguments if argument not in allowed_kwargs]: |
There was a problem hiding this comment.
if any(key in allowed_kwargs for key in kwds):
pandas/io/excel/_base.py
Outdated
| if [argument for argument in arguments if argument not in allowed_kwargs]: | ||
| warnings.warn( | ||
| f"{type(self).__name__}.parse is deprecated. " | ||
| "Arguments other than sheet_name by position may not work.", |
There was a problem hiding this comment.
This method is not deprecated, right? Just passing invalid arguments and passing arguments by position.
simonjayhawkins
added
Bug
IO Excel
|
@rhshadrach @simonjayhawkins - Closed this by mistake was merging the latest main to my branch. Will resolve mentioned comments and will create a new PR. |
|
Why not just reopen? |
Okay sorry wasn't aware about it. Reopening now. |
|
This pull request is stale because it has been open for thirty days with no activity. Please update and respond to this comment if you're still interested in working on this. |
| if any(key in allowed_kwargs for key in kwds): | ||
| warnings.warn( | ||
| "Specifying arguments other than sheet_name by position is deprecated." |
There was a problem hiding this comment.
The if condition here will evaluate to true when a user passes an argument by keyword, no? We only want to warn when an argument is passed by position.
|
I'd like to make sure there isn't a better way of deprecating specifying arguments by position as recommended in #51437 (review). cc @mroeschke @phofl |
I think you can use in |
|
Thanks for the pull request, but it appears to have gone stale. If interested in continuing, please merge in the main branch, address any review comments and/or failing tests, and we can reopen. |
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.