Add nrows parameter to pandas.read_excel()

[alysivji]

• closes Pandas read_excel: only read first few lines #16645
• tests added / passed
• passes git diff upstream/master -u -- "*.py" | flake8 --diff
• whatsnew entry

I was working on this a few months back, but got busy. Apologies. I'm free until January so thought I'd pick this back up.

Changes

• Added code for nrows parameter (with tests)
• Changed order of parameters to match pandas.read_csv() signature (across entire pandas/io/excel.py file)
• Increased readability by having one parameter per line
• Updated docstring to match new order (+ new entry for nrows param)

I think that covered all the outstanding issues from the previous (closed) PR. Please let me know if you need anything changed or modified.

[foresmac]

LGTM; Travis build issues appear to be related to quote issues and not test failures.

[foresmac]

LGTM

[alysivji]

Hi @jreback @gfyoung
Could you please take a look at this when you have some time?

Thanks!

[gfyoung]

@alysivji : Thanks for the ping. A couple of points:

1. We do need the Travis builds to pass before we can merge this. I'll double-check to see if you need to do anything to fix that.

2. Your PR is for adding nrows to read_excel, but you also changed up the signature. IMO that's a little too much API changing in one PR for us to review. Let's break up this PR into two by separating out your read_excel signature changes into a separate PR.

I'm totally onboard for adding nrows but need to review your signature changes separately.

[codecov]

Codecov Report

Merging #18507 into master will decrease coverage by 0.04%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #18507      +/-   ##
==========================================
- Coverage    91.6%   91.56%   -0.05%     
==========================================
  Files         153      153              
  Lines       51272    51273       +1     
==========================================
- Hits        46969    46947      -22     
- Misses       4303     4326      +23

Flag	Coverage Δ
#multiple	89.42% <100%> (-0.03%)	⬇️
#single	40.68% <62.5%> (-0.11%)	⬇️

Impacted Files	Coverage Δ
pandas/io/excel.py	90.13% <100%> (ø)	⬆️
pandas/io/parsers.py	95.55% <100%> (ø)	⬆️
pandas/io/gbq.py	25% <0%> (-58.34%)	⬇️
pandas/plotting/_converter.py	64.78% <0%> (-1.74%)	⬇️
pandas/util/testing.py	81.82% <0%> (-0.2%)	⬇️
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 27a64b2...c52315f. Read the comment docs.

[jreback]

I think you need a blank line before the deprecated

[alysivji]

This has been fixed, also added a blank line in the sheetname section. Thanks.

[jreback]

I am ok with the re-aranging of parameters in this PR. pls rebase.

[alysivji]

@jreback How does this look? Any changes needed?

[jreback]

thanks!

[Sabr3tooth]

Hi folks,

Reading the Whats New for Pandas 0.22.0 as well as checking the pandas.read_excel page I note that nrows param is not yet available for read_excel(..). Is there any indication as to when as well as what version of Pandas it will be added? Thanks in advance to the people involved in adding this functionality, keep up the great work!

[alysivji]

@Sabr3tooth Pandas 0.22 had a single API breaking change.

This enhancement will be in 0.23 based on the whatsnew in master

[Sabr3tooth]

Thanks, looking forward to seeing it in Pandas!