Skip to content

DOC: Fix PR01 and SA01 errors in pandas.ExcelFile #57771

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

Closed
wants to merge 2 commits into from
Closed

DOC: Fix PR01 and SA01 errors in pandas.ExcelFile #57771

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
f085942
DOC: Fix PR01 and SA01 errors in pandas.ExcelFile
iridiium Mar 6, 2024
0ca1e30
DOC: Fix formatting of docstring of pandas.ExcelFile
iridiium Mar 12, 2024
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
2 changes: 0 additions & 2 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
pandas.DatetimeIndex.indexer_at_time\
pandas.DatetimeIndex.snap\
pandas.DatetimeIndex.std\
pandas.ExcelFile\
pandas.ExcelFile.parse\
pandas.HDFStore.append\
pandas.HDFStore.put\
Expand Down Expand Up @@ -966,7 +965,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
pandas.DatetimeTZDtype\
pandas.DatetimeTZDtype.tz\
pandas.DatetimeTZDtype.unit\
pandas.ExcelFile\
pandas.ExcelFile.parse\
pandas.ExcelWriter\
pandas.Flags\
Expand Down
30 changes: 27 additions & 3 deletions pandas/io/excel/_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,8 +278,17 @@
comment string and the end of the current line is ignored.
skipfooter : int, default 0
Rows at the end to skip (0-indexed).
{storage_options}

storage_options : dict, optional
Extra options that make sense for a particular storage connection,
e.g. host, port, username, password, etc.

For HTTP(S) URLs the key-value pairs are forwarded to ``urllib.request.Request`` as header options.
For other URLs (e.g. starting with “s3://”, and “gcs://”),
the key-value pairs are forwarded to ``fsspec.open``.

Please see ``fsspec`` and ``urllib`` for more details,
and for more examples on storage options,
refer `here <https://pandas.pydata.org/docs/user_guide/io.html#reading-writing-remote-files>`.
dtype_backend : {{'numpy_nullable', 'pyarrow'}}, default 'numpy_nullable'
Back-end data type applied to the resultant :class:`DataFrame`
(still experimental). Behaviour is as follows:
Expand Down Expand Up @@ -1483,16 +1492,31 @@ class ExcelFile:

Please do not report issues when using ``xlrd`` to read ``.xlsx`` files.
This is not supported, switch to using ``openpyxl`` instead.
storage_options : dict, optional
Extra options that make sense for a particular storage connection,
e.g. host, port, username, password, etc.

For HTTP(S) URLs the key-value pairs are forwarded to ``urllib.request.Request`` as header options.
For other URLs (e.g. starting with “s3://”, and “gcs://”) the key-value pairs are forwarded to ``fsspec.open``.

Please see ``fsspec`` and ``urllib`` for more details,
and for more examples on storage options refer `here <https://pandas.pydata.org/docs/user_guide/io.html#reading-writing-remote-files>`.
engine_kwargs : dict, optional
Arbitrary keyword arguments passed to excel engine.

See Also
--------
DataFrame.to_excel : Write DataFrame to an Excel file.
DataFrame.to_csv : Write DataFrame to a comma-separated values (csv) file.
read_csv : Read a comma-separated values (csv) file into DataFrame.
read_fwf : Read a table of fixed-width formatted lines into DataFrame.

Examples
--------
>>> file = pd.ExcelFile("myfile.xlsx") # doctest: +SKIP
>>> with pd.ExcelFile("myfile.xls") as xls: # doctest: +SKIP
... df1 = pd.read_excel(xls, "Sheet1") # doctest: +SKIP
"""

from pandas.io.excel._calamine import CalamineReader
from pandas.io.excel._odfreader import ODFReader
from pandas.io.excel._openpyxl import OpenpyxlReader
Expand Down
Loading