DOC: Clarify ExcelFile's available engine compatibility with file types in... #34261
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The failing checks are not related to my changes. Any feedback on how I should proceed? |
|
@miguelmarques1904 fixed in #34258. Merge master and push again. |
miguelmarques1904
force-pushed
the
add-read_excel-checks
branch
from
69b2ad6 to
6cbb84b
Compare
…rmation about engine compatibility and also the support of pyxlsb engine GH34237.
miguelmarques1904
force-pushed
the
add-read_excel-checks
branch
from
6cbb84b to
e0fc50d
Compare
miguelmarques1904
changed the title
|
@TomAugspurger could you review it? The PR only has documentation improvements, fixing #34237. |
WillAyd
approved these changes
May 27, 2020
jreback
requested changes
May 27, 2020
pandas/io/excel/_base.py
Outdated
| Acceptable values are None, "xlrd", "openpyxl" or "odf". | ||
| Acceptable values are None, "xlrd", "openpyxl", "odf", or "pyxlsb". | ||
| Engine compatibility: | ||
| "xlrd" supports most old/new Excel file formats. |
There was a problem hiding this comment.
I think you can use bullets here (e.g. -) to more doc-string clarify
There was a problem hiding this comment.
I think it's clearer now. Thank you for the suggestion. Same for the changes proposed below.
pandas/io/excel/_base.py
Outdated
| Note that ``odf`` reads tables out of OpenDocument formatted files. | ||
| Acceptable values are None, ``xlrd``, ``openpyxl``, ``odf``, or ``pyxlsb``. | ||
| Engine compatibility: | ||
| ``xlrd`` supports most old/new Excel file formats. |
| @@ -816,7 +826,8 @@ def __init__(self, io, engine=None): | |||
| raise ValueError(f"Unknown engine: {engine}") | |||
|
|
|||
| self.engine = engine | |||
| # could be a str, ExcelFile, Book, etc. | |||
|
|
|||
| # Could be a str, ExcelFile, Book, etc. | |||
| self.io = io | |||
There was a problem hiding this comment.
can we type this? (not sure its easy)
There was a problem hiding this comment.
Out of scope for this PR I think.
jreback
approved these changes
Jun 1, 2020
|
thanks @miguelmarques1904 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
information about engine compatibility and also reflect the support of the pyxlsb engine. GH34237.
DOC: I edited the available ExcelFile's docstring to add information about the recent pyxlsb engine. I also added some compatibility information between the available engines and file types.
black pandasgit diff upstream/master -u -- "*.py" | flake8 --diff