Skip to content

DOC: Improve excel docs #4154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 10, 2013
Merged

DOC: Improve excel docs #4154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5146329
DOC: Update excel read dependency on ``xlrd``
davidshinn Jul 7, 2013
1c6440e
DOC: Update docstrings to reflect benefit from resolving #4131
davidshinn Jul 7, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions doc/source/io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1494,7 +1494,8 @@ any pickled pandas object (or any other pickled object) from file:
Excel files
-----------

The ``read_excel`` method can read an Excel 2003 file using the ``xlrd`` Python
The ``read_excel`` method can read Excel 2003 (``.xls``) and
Excel 2007 (``.xlsx``) files using the ``xlrd`` Python
module and use the same parsing code as the above to convert tabular data into
a DataFrame. See the :ref:`cookbook<cookbook.excel>` for some
advanced strategies
Expand All @@ -1516,9 +1517,6 @@ advanced strategies
read_excel('path_to_file.xls', 'Sheet1', index_col=None, na_values=['NA'])
To read sheets from an Excel 2007 file, you can pass a filename with a ``.xlsx``
extension, in which case the ``openpyxl`` module will be used to read the file.

It is often the case that users will insert columns to do temporary computations
in Excel and you may not want to read in those columns. `read_excel` takes
a `parse_cols` keyword to allow you to specify a subset of columns to parse.
Expand Down
10 changes: 10 additions & 0 deletions pandas/io/excel.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ def read_excel(path_or_buf, sheetname, kind=None, **kwds):
column ranges (e.g. "A:E" or "A,C,E:F")
na_values : list-like, default None
List of additional strings to recognize as NA/NaN
keep_default_na : bool, default True
If na_values are specified and keep_default_na is False the default NaN
values are overridden, otherwise they're appended to
verbose : boolean, default False
Indicate number of NA values placed in non-numeric columns

Returns
-------
Expand Down Expand Up @@ -101,6 +106,11 @@ def parse(self, sheetname, header=0, skiprows=None, skip_footer=0,
column ranges (e.g. "A:E" or "A,C,E:F")
na_values : list-like, default None
List of additional strings to recognize as NA/NaN
keep_default_na : bool, default True
If na_values are specified and keep_default_na is False the default NaN
values are overridden, otherwise they're appended to
verbose : boolean, default False
Indicate number of NA values placed in non-numeric columns

Returns
-------
Expand Down