Skip to content

BUG: pandas.io.formats.style.Styler.to_excel doesn't support storage_options as its documented #46381

Closed
@jcunhafonte

Description

@jcunhafonte

Pandas version checks

  • I have checked that this issue has not already been reported.

  • I have confirmed this bug exists on the latest version of pandas.

  • I have confirmed this bug exists on the main branch of pandas.

Reproducible Example

import pandas as pd
import numpy as np

bigdf = pd.DataFrame(np.random.randn(16, 100))
file = bigdf.style.set_sticky(axis="index")
file.to_excel('file.xlsx', storage_options=dict())

Issue Description

pandas.io.formats.style.Styler.to_excel method documents the support of the parameter storage_options since version 1.2.0, however when defined it raises the following error:

---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
Input In [40], in <module>
----> 1 file.to_excel('file.xlsx', storage_options=dict())

TypeError: to_excel() got an unexpected keyword argument 'storage_options'

When checking the source code of the main branch the method is documented here. However the parameter is not defined in the method.

Expected Behavior

The referred method should accept storage_options as DataFrame to_excel method supports.

Installed Versions

INSTALLED VERSIONS

commit : 06d2301
python : 3.9.10.final.0
python-bits : 64
OS : Darwin
OS-release : 21.3.0
Version : Darwin Kernel Version 21.3.0: Wed Jan 5 21:37:58 PST 2022; root:xnu-8019.80.24~20/RELEASE_ARM64_T6000
machine : arm64
processor : arm
byteorder : little
LC_ALL : None
LANG : None
LOCALE : None.UTF-8

pandas : 1.4.1
numpy : 1.22.2
pytz : 2021.3
dateutil : 2.8.2
pip : 21.3.1
setuptools : 60.5.0
Cython : None
pytest : None
hypothesis : None
sphinx : None
blosc : None
feather : None
xlsxwriter : 3.0.3
lxml.etree : None
html5lib : None
pymysql : None
psycopg2 : None
jinja2 : 3.0.3
IPython : 8.0.1
pandas_datareader: None
bs4 : None
bottleneck : None
fastparquet : None
fsspec : 2022.02.0
gcsfs : None
matplotlib : 3.5.1
numba : None
numexpr : None
odfpy : None
openpyxl : 3.0.9
pandas_gbq : None
pyarrow : None
pyreadstat : None
pyxlsb : None
s3fs : 2022.02.0
scipy : 1.8.0
sqlalchemy : None
tables : None
tabulate : 0.8.9
xarray : None
xlrd : None
xlwt : None
zstandard : None

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions