ENH: Raise error for 'sheet' arg in read_excel

[lucianoviola]

• closes read_excel does not raise error with wrong keyword arg #17994

I was also thinking about the possibility of raising a warning instead, and do something like:

if sheet in kwds:
    sheet_name = sheet

[pep8speaks]

Hello @lucianoviola! Thanks for updating the PR.

Cheers ! There are no PEP8 issues in this Pull Request. 🍻

Comment last updated on July 07, 2018 at 16:23 Hours UTC

[codecov]

Codecov Report

Merging #18604 into master will decrease coverage by 0.01%.
The diff coverage is 50%.

@@            Coverage Diff             @@
##           master   #18604      +/-   ##
==========================================
- Coverage   91.46%   91.45%   -0.02%     
==========================================
  Files         157      157              
  Lines       51439    51441       +2     
==========================================
- Hits        47051    47043       -8     
- Misses       4388     4398      +10

Flag	Coverage Δ
#multiple	89.32% <50%> (-0.01%)	⬇️
#single	40.6% <0%> (-0.11%)	⬇️

Impacted Files	Coverage Δ
pandas/io/excel.py	80.3% <50%> (-0.09%)	⬇️
pandas/io/gbq.py	25% <0%> (-58.34%)	⬇️
pandas/core/frame.py	97.81% <0%> (-0.1%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0e16818...1e6b21a. Read the comment docs.

[codecov]

Codecov Report

Merging #18604 into master will decrease coverage by 0.5%.
The diff coverage is 50%.

@@            Coverage Diff             @@
##           master   #18604      +/-   ##
==========================================
- Coverage   91.95%   91.45%   -0.51%     
==========================================
  Files         160      157       -3     
  Lines       49837    51441    +1604     
==========================================
+ Hits        45830    47043    +1213     
- Misses       4007     4398     +391

Flag	Coverage Δ
#multiple	89.32% <50%> (-1.02%)	⬇️
#single	40.6% <0%> (-1.48%)	⬇️

Impacted Files	Coverage Δ
pandas/io/excel.py	80.3% <50%> (ø)
pandas/tseries/converter.py	0% <0%> (-100%)	⬇️
pandas/tseries/plotting.py	0% <0%> (-100%)	⬇️
pandas/plotting/_compat.py	62% <0%> (-28.91%)	⬇️
pandas/core/missing.py	84.3% <0%> (-7.35%)	⬇️
pandas/io/parquet.py	65.38% <0%> (-6.42%)	⬇️
pandas/core/accessor.py	93.75% <0%> (-4.97%)	⬇️
pandas/core/ops.py	91.77% <0%> (-4.7%)	⬇️
pandas/plotting/_timeseries.py	60.73% <0%> (-4.58%)	⬇️
pandas/io/formats/terminal.py	16.43% <0%> (-4.55%)	⬇️
... and 116 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e84cf2a...7e38b46. Read the comment docs.

[gfyoung]

This is not generalizable. What happens if I were to pass in an argument called "Sheet" ? Your check wouldn't catch that. You should develop a more general checker that checks for any keywords that don't correspond to ones that we accept.

[gfyoung]

I was also thinking about the possibility of raising a warning instead, and do something like:

Potentially. I personally don't feel too against just raising for incorrect arguments that we don't explicitly document. However, let's see what others have to say? @jreback @jorisvandenbossche ?

[jreback]

the way to do this is to stop passing thru **kwds, rather explicity name any other args (which I don't think there are any), if there are they should be explicity named and in the doc-strings.

[jorisvandenbossche]

the way to do this is to stop passing thru **kwds, rather explicity name any other args (which I don't think there are any), if there are they should be explicity named and in the doc-strings.

That is indeed the way to go, but currently kwds are passed to TextParser, so we should investigate if there are possible other keyword arguments that could be used in read_excel that are supported by TextParser.

[lucianoviola]

Ok. I'll have a look at TextParser!

[jreback]

can you rebase and respond to comments.

[lucianoviola]

I apologize @jreback. I will get back on it.

[jreback]

this is all fixed up.