Skip to content

ENH: Allow passing read_only, data_only and keep_links arguments to openpyxl using engine_kwargs #55807

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.

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 4 commits into from
Nov 9, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
1 change: 1 addition & 0 deletions doc/source/whatsnew/v2.2.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ Other enhancements
- :func:`tseries.api.guess_datetime_format` is now part of the public API (:issue:`54727`)
- :meth:`ExtensionArray._explode` interface method added to allow extension type implementations of the ``explode`` method (:issue:`54833`)
- :meth:`ExtensionArray.duplicated` added to allow extension type implementations of the ``duplicated`` method (:issue:`55255`)
- Allow passing ``read_only``, ``data_only`` and ``keep_links`` arguments to openpyxl using ``engine_kwargs`` of :func:`read_excel` (:issue:`55027`)
- DataFrame.apply now allows the usage of numba (via ``engine="numba"``) to JIT compile the passed function, allowing for potential speedups (:issue:`54666`)
- Implement masked algorithms for :meth:`Series.value_counts` (:issue:`54984`)

Expand Down
10 changes: 7 additions & 3 deletions pandas/io/excel/_openpyxl.py
Original file line number Diff line number Diff line change
Expand Up @@ -567,11 +567,15 @@ def load_workbook(
) -> Workbook:
from openpyxl import load_workbook

if engine_kwargs is None:
engine_kwargs = {}

engine_kwargs.setdefault("read_only", True)
engine_kwargs.setdefault("data_only", True)
engine_kwargs.setdefault("keep_links", False)

return load_workbook(
filepath_or_buffer,
read_only=True,
data_only=True,
keep_links=False,
**engine_kwargs,
)

Expand Down
14 changes: 14 additions & 0 deletions pandas/tests/io/excel/test_openpyxl.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
ExcelWriter,
_OpenpyxlWriter,
)
from pandas.io.excel._openpyxl import OpenpyxlReader

openpyxl = pytest.importorskip("openpyxl")

Expand Down Expand Up @@ -130,6 +131,19 @@ def test_engine_kwargs_append_data_only(ext, data_only, expected):
DataFrame().to_excel(writer, sheet_name="Sheet2")


@pytest.mark.parametrize("kwarg_name", ["read_only", "data_only"])
@pytest.mark.parametrize("kwarg_value", [True, False])
def test_engine_kwargs_append_reader(datapath, ext, kwarg_name, kwarg_value):
# GH 55027
# test that `read_only` and `data_only` can be passed to
# `openpyxl.reader.excel.load_workbook` via `engine_kwargs`
filename = datapath("io", "data", "excel", "test1" + ext)
with contextlib.closing(
OpenpyxlReader(filename, engine_kwargs={kwarg_name: kwarg_value})
) as reader:
assert getattr(reader.book, kwarg_name) == kwarg_value


@pytest.mark.parametrize(
"mode,expected", [("w", ["baz"]), ("a", ["foo", "bar", "baz"])]
)
Expand Down