Skip to content

DOC: update wording about when xlrd engine can be used #38456

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 8 commits into from
Dec 23, 2020
Merged

DOC: update wording about when xlrd engine can be used #38456

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e107c1e
adjust docs about xlrd changes to match my intentions
cjw296 Dec 13, 2020
a70795d
undo edits under discussion
jorisvandenbossche Dec 22, 2020
d7d8fd3
fixup
jorisvandenbossche Dec 22, 2020
51706b2
Add warnings that using xlrd to open xlsx files is no longer supported.
cjw296 Dec 22, 2020
f77ca98
add warning to io.rst as well
jorisvandenbossche Dec 23, 2020
41c14cf
edits
jorisvandenbossche Dec 23, 2020
4bc6a08
edit
jorisvandenbossche Dec 23, 2020
47e26b5
fix sphinx warning
jorisvandenbossche Dec 23, 2020
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
4 changes: 2 additions & 2 deletions doc/source/user_guide/io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2837,15 +2837,15 @@ See the :ref:`cookbook<cookbook.excel>` for some advanced strategies.
old-style ``.xls`` files.

Previously, the default argument ``engine=None`` to :func:`~pandas.read_excel`
would result in using the ``xlrd`` engine in many cases, also for new
would result in using the ``xlrd`` engine in many cases, including for new
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry to be pedantic, but the change I suggested was "also for" -> "including", not "also" -> "including".

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops, sorry, read to quickly

Excel 2007+ (``.xlsx``) files.
If `openpyxl <https://openpyxl.readthedocs.io/en/stable/>`_ is installed,
many of these cases will now default to using the ``openpyxl`` engine.
See the :func:`read_excel` documentation for more details.

Thus, it is strongly encouraged to install ``openpyxl`` to read Excel 2007+
(``.xlsx``) files.
Please do not report issues when using ``xlrd`` to read ``.xlsx`` files.
**Please do not report issues when using ``xlrd`` to read ``.xlsx`` files.**
This is no longer supported, switch to using ``openpyxl`` instead.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer these two lines to be further up, around 2938, and in their own paragraph. I mean, I'd prefer them to be bright red and bold, maybe flashing too, but I doubt you'd agree to that ;-)


Attempting to use the the ``xlwt`` engine will raise a ``FutureWarning``
Expand Down
4 changes: 2 additions & 2 deletions doc/source/whatsnew/v1.2.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ including other versions of pandas.
old-style ``.xls`` files.

Previously, the default argument ``engine=None`` to :func:`~pandas.read_excel`
would result in using the ``xlrd`` engine in many cases, also for new
would result in using the ``xlrd`` engine in many cases, including for new
Excel 2007+ (``.xlsx``) files.
If `openpyxl <https://openpyxl.readthedocs.io/en/stable/>`_ is installed,
many of these cases will now default to using the ``openpyxl`` engine.
See the :func:`read_excel` documentation for more details.

Thus, it is strongly encouraged to install ``openpyxl`` to read Excel 2007+
(``.xlsx``) files.
Please do not report issues when using ``xlrd`` to read ``.xlsx`` files.
**Please do not report issues when using ``xlrd`` to read ``.xlsx`` files.**
This is no longer supported, switch to using ``openpyxl`` instead.

Attempting to use the the ``xlwt`` engine will raise a ``FutureWarning``
Expand Down