GH10559: Minor improvement: Change read_excel sheet name #16442

abarber4gh · 2017-05-22T23:49:13Z

modify io/excel.py and relevant docs (io.rst) to use sheet_name for read_excel
but allow sheetname to still be used for backwards compatibility. add test_excel
to verify that sheet_name and sheetname args produce the same result.

closes Minor improvement: Change to_excel "sheet_name" to "sheetname" #10559
tests added / passed
passes git diff upstream/master --name-only -- '*.py' | flake8 --diff
whatsnew entry

modify io/excel.py and relevant docs (io.rst) to use sheet_name for read_excel but allow sheetname to still be used for backwards compatibility. add test_excel to verify that sheet_name and sheetname args produce the same result.

jreback

need to add a note in deprecation section

jreback · 2017-05-23T00:09:39Z

pandas/io/excel.py

@@ -200,8 +200,12 @@ def read_excel(io, sheetname=0, header=0, skiprows=None, skip_footer=0,
    if not isinstance(io, ExcelFile):
        io = ExcelFile(io, engine=engine)

+    # maintain backwards compatibility by converting sheetname to sheet_name
+    if 'sheetname' in kwds:
+         sheet_name = kwds.pop('sheetname')


needs a deprecation warning on the original arg. You need to also accept the original arg as a kwarg.

you can use pandas.util._decorators.deprecate_kwarg

jreback · 2017-05-23T00:10:05Z

pandas/tests/io/test_excel.py

@@ -544,6 +544,18 @@ def test_date_conversion_overflow(self):
        result = self.get_exceldf('testdateoverflow')
        tm.assert_frame_equal(result, expected)

+    # GH10559: Minor improvement: Change to_excel "sheet_name" to "sheetname"


comments go inside the function.

jreback · 2017-05-23T00:10:21Z

pandas/tests/io/test_excel.py

+    def test_sheet_name_and_sheetname(self):
+        dfref = self.get_csv_refdf('test1')
+        df1 = self.get_exceldf('test1', sheet_name='Sheet1')    # doc
+        df2 = self.get_exceldf('test1', sheetname='Sheet2')     # bkwrds compat


this should show a FutureWarning

You can assert that a warning is issued with thetm.assert_produces_warning context manager.

added @deprecate_kwarg to read_excel as arg changes from sheetname to sheet_name. moved test comments into function, add assert_produces_warning.

codecov · 2017-05-23T04:16:43Z

Codecov Report

Merging #16442 into master will decrease coverage by <.01%.
The diff coverage is 80%.

@@            Coverage Diff             @@
##           master   #16442      +/-   ##
==========================================
- Coverage   90.42%   90.42%   -0.01%     
==========================================
  Files         161      161              
  Lines       51023    51025       +2     
==========================================
  Hits        46138    46138              
- Misses       4885     4887       +2

Flag	Coverage Δ
#multiple	`88.26% <80%> (-0.01%)`	⬇️
#single	`40.17% <40%> (-0.01%)`	⬇️

Impacted Files	Coverage Δ
pandas/io/excel.py	`62.22% <80%> (-0.04%)`	⬇️
pandas/core/common.py	`91.05% <0%> (-0.34%)`	⬇️

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 49ec31b...5a59cd0. Read the comment docs.

codecov · 2017-05-23T04:16:49Z

Codecov Report

Merging #16442 into master will decrease coverage by 2.16%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #16442      +/-   ##
==========================================
- Coverage   90.42%   88.26%   -2.17%     
==========================================
  Files         161      161              
  Lines       51023    51025       +2     
==========================================
- Hits        46138    45037    -1101     
- Misses       4885     5988    +1103

Flag	Coverage Δ
#multiple	`88.26% <100%> (ø)`	⬆️
#single	`?`

Impacted Files	Coverage Δ
pandas/io/excel.py	`62.31% <100%> (+0.05%)`	⬆️
pandas/io/sql.py	`46.66% <0%> (-48.14%)`	⬇️
pandas/core/computation/pytables.py	`62.38% <0%> (-29.97%)`	⬇️
pandas/io/pytables.py	`64.24% <0%> (-28.83%)`	⬇️
pandas/io/feather_format.py	`72.72% <0%> (-15.16%)`	⬇️
pandas/core/computation/common.py	`78.57% <0%> (-7.15%)`	⬇️
pandas/core/computation/expr.py	`84.03% <0%> (-4.46%)`	⬇️
pandas/io/clipboard/clipboards.py	`22.78% <0%> (-3.8%)`	⬇️
pandas/io/formats/console.py	`66.66% <0%> (-3.04%)`	⬇️
pandas/io/formats/printing.py	`87.61% <0%> (-1.77%)`	⬇️
... and 6 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 49ec31b...4c6da13. Read the comment docs.

remove manual arg change, use @deprecate_kwarg to read_excel as arg changes from sheetname to sheet_name.

shorten lines under 79 char.

jreback

pls add a note in whatsnew (0.21.0) / Deprecations

jreback · 2017-05-23T10:38:53Z

pandas/io/excel.py

@@ -48,7 +48,7 @@
    The string could be a URL. Valid URL schemes include http, ftp, s3,
    and file. For file URLs, a host is expected. For instance, a local
    file could be file://localhost/path/to/workbook.xlsx
-sheetname : string, int, mixed list of strings/ints, or None, default 0
+sheet_name : string, int, mixed list of strings/ints, or None, default 0



can you add sheetname (DEPRECATED) as well

There's also the deprecated sphinx directive. I don't see any uses of that, but we can give it a shot here. I think it'd be like

sheetname : string, int, mixed list of strings/ints, or None, default 0 .. deprecated:: 0.21.0 Use `sheet_name` instead sheet_name : string, int, mixed list of strings/ints, or None, default 0

update whats new 0.21.0 Deprecations section noting sheetname deprecated in favor of sheet_name. add sheetname deprecation in read_excel() docstring.

fixed

TomAugspurger · 2017-05-23T19:37:39Z

@abarber4gh thanks, nice job! If you want to check the docs http://pandas-docs.github.io/pandas-docs-travis/generated/pandas.read_excel.html when this build finishes, I'm curious to see how the .. deprecated: directive looks.

* GH10559: Minor improvement: Change to_excel sheet name modify io/excel.py and relevant docs (io.rst) to use sheet_name for read_excel but allow sheetname to still be used for backwards compatibility. add test_excel to verify that sheet_name and sheetname args produce the same result. * GH10559: Minor improvement: Change to_excel sheet name added @deprecate_kwarg to read_excel as arg changes from sheetname to sheet_name. moved test comments into function, add assert_produces_warning. * GH10559: Minor improvement: Change to_excel sheet name remove manual arg change, use @deprecate_kwarg to read_excel as arg changes from sheetname to sheet_name. * GH10559: Minor improvement: Change to_excel sheet name shorten lines under 79 char. * GH10559: Minor improvement: Change to_excel sheet name update whats new 0.21.0 Deprecations section noting sheetname deprecated in favor of sheet_name. add sheetname deprecation in read_excel() docstring.

GH10559: Minor improvement: Change to_excel sheet name

23a0cec

modify io/excel.py and relevant docs (io.rst) to use sheet_name for read_excel but allow sheetname to still be used for backwards compatibility. add test_excel to verify that sheet_name and sheetname args produce the same result.

jreback requested changes May 23, 2017

View reviewed changes

jreback added Deprecate Functionality to remove in pandas IO Excel read_excel, to_excel labels May 23, 2017

GH10559: Minor improvement: Change to_excel sheet name

5a59cd0

added @deprecate_kwarg to read_excel as arg changes from sheetname to sheet_name. moved test comments into function, add assert_produces_warning.

Aaron Barber added 2 commits May 22, 2017 21:40

GH10559: Minor improvement: Change to_excel sheet name

4171dd6

remove manual arg change, use @deprecate_kwarg to read_excel as arg changes from sheetname to sheet_name.

GH10559: Minor improvement: Change to_excel sheet name

91438b8

shorten lines under 79 char.

jreback previously requested changes May 23, 2017

View reviewed changes

jsexauer mentioned this pull request May 23, 2017

DEPR: Clean up list of deprecations from prior versions #6581

Closed

1 task

GH10559: Minor improvement: Change to_excel sheet name

4c6da13

update whats new 0.21.0 Deprecations section noting sheetname deprecated in favor of sheet_name. add sheetname deprecation in read_excel() docstring.

TomAugspurger approved these changes May 23, 2017

View reviewed changes

TomAugspurger merged commit c933098 into pandas-dev:master May 23, 2017

abarber4gh deleted the issue#10559 branch May 23, 2017 20:42

jreback mentioned this pull request May 25, 2017

TST: Fix excel test discovery #16478

Merged

TomAugspurger added this to the 0.21.0 milestone May 27, 2017

rubennj mentioned this pull request Jul 28, 2017

sheet_name argument from read_excel is always giving the first sheet #17107

Closed

jreback mentioned this pull request May 24, 2019

DEPR: deprecations log for removed issues #13777

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

GH10559: Minor improvement: Change read_excel sheet name #16442

GH10559: Minor improvement: Change read_excel sheet name #16442

Uh oh!

abarber4gh commented May 22, 2017 •

edited

Loading

Uh oh!

jreback left a comment

Uh oh!

jreback May 23, 2017

Uh oh!

jreback May 23, 2017

Uh oh!

jreback May 23, 2017

Uh oh!

jreback May 23, 2017

Uh oh!

TomAugspurger May 23, 2017 •

edited

Loading

Uh oh!

codecov bot commented May 23, 2017

Uh oh!

codecov bot commented May 23, 2017 •

edited

Loading

Uh oh!

jreback left a comment

Uh oh!

jreback May 23, 2017

Uh oh!

TomAugspurger May 23, 2017

Uh oh!

TomAugspurger commented May 23, 2017

Uh oh!

Uh oh!

Uh oh!

GH10559: Minor improvement: Change read_excel sheet name #16442

GH10559: Minor improvement: Change read_excel sheet name #16442

Uh oh!

Conversation

abarber4gh commented May 22, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jreback left a comment

Choose a reason for hiding this comment

Uh oh!

jreback May 23, 2017

Choose a reason for hiding this comment

Uh oh!

jreback May 23, 2017

Choose a reason for hiding this comment

Uh oh!

jreback May 23, 2017

Choose a reason for hiding this comment

Uh oh!

jreback May 23, 2017

Choose a reason for hiding this comment

Uh oh!

TomAugspurger May 23, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented May 23, 2017

Codecov Report

Uh oh!

codecov bot commented May 23, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jreback left a comment

Choose a reason for hiding this comment

Uh oh!

jreback May 23, 2017

Choose a reason for hiding this comment

Uh oh!

TomAugspurger May 23, 2017

Choose a reason for hiding this comment

Uh oh!

TomAugspurger commented May 23, 2017

Uh oh!

Uh oh!

abarber4gh commented May 22, 2017 •

edited

Loading

TomAugspurger May 23, 2017 •

edited

Loading

codecov bot commented May 23, 2017 •

edited

Loading