Skip to content

DOC: clarify that ExcelFile is not deprecated but only moved (#5435) #6133

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 1 commit into from
Jan 28, 2014
Merged

DOC: clarify that ExcelFile is not deprecated but only moved (#5435) #6133

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 15 additions & 11 deletions doc/source/io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1802,28 +1802,32 @@ Not escaped:
Excel files
-----------

The ``read_excel`` method can read Excel 2003 (``.xls``) and
The :func:`~pandas.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

.. note::
Besides ``read_excel`` you can also read Excel files using the ``ExcelFile``
class. The following two command are equivalent:

The prior method of accessing Excel is now deprecated as of 0.12.0,
this will work but will be removed in a future version.
.. code-block:: python

.. code-block:: python
# using the ExcelFile class
xls = pd.ExcelFile('path_to_file.xls')
xls.parse('Sheet1', index_col=None, na_values=['NA'])

from pandas.io.parsers import ExcelFile
xls = ExcelFile('path_to_file.xls')
xls.parse('Sheet1', index_col=None, na_values=['NA'])
# using the read_excel function
read_excel('path_to_file.xls', 'Sheet1', index_col=None, na_values=['NA'])

Replaced by
The class based approach can be used to read multiple sheets or to introspect
the sheet names using the ``sheet_names`` attribute.

.. code-block:: python
.. note::

read_excel('path_to_file.xls', 'Sheet1', index_col=None, na_values=['NA'])
The prior method of accessing ``ExcelFile`` has been moved from
``pandas.io.parsers`` to the top level namespace starting from pandas
0.12.0.

.. versionadded:: 0.13

Expand Down