Skip to content

Commit 66fcd15

Browse files
author
Joeperdefloep
committed
DOC: added docs to #42222
1 parent bc6534a commit 66fcd15

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

pandas/io/excel/_base.py

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -681,7 +681,7 @@ class ExcelWriter(metaclass=abc.ABCMeta):
681681
be parsed by ``fsspec``, e.g., starting "s3://", "gcs://".
682682
683683
.. versionadded:: 1.2.0
684-
: {'error', 'new', 'replace', 'write_to'}, default 'error'
684+
if_sheet_exists : {'error', 'new', 'replace', 'write_to'}, default 'error'
685685
How to behave when trying to write to a sheet that already
686686
exists (append mode only).
687687
@@ -763,19 +763,21 @@ class ExcelWriter(metaclass=abc.ABCMeta):
763763
... "path_to_file.xlsx",
764764
... mode="a",
765765
... engine="openpyxl",
766-
... if_sheet_exists="replace"
766+
... if_sheet_exists="replace",
767767
... ) as writer:
768-
... df.to_excel(writer, sheet_name="Sheet1")
768+
>>> df.to_excel(writer, sheet_name="Sheet1")
769769
770-
You can specify arguments to the underlying engine. For example to not
771-
calculate the result of a formula:
770+
You can also write multiple DataFrames to a single sheet. Note that the
771+
`if_sheet_exists` parameter needs to be set to `write_to` if you are in
772+
append mode:
772773
773-
>>> df = pd.DataFrame(["=1+1"])
774-
... with ExcelWriter(
775-
... "path_to_file.xlsx",
776-
... engine_kwargs={"strings_to_formulas":False}
774+
>>> with ExcelWriter("path_to_file.xlsx",
775+
... mode="a",
776+
... engine="openpyxl",
777+
... if_sheet_exists="write_to",
777778
... ) as writer:
778-
... df.to_excel(writer)
779+
>>> df.to_excel(writer, sheet_name="Sheet1")
780+
>>> df.to_excel(writer, sheet_name="Sheet1", startcol=3)
779781
780782
You can store Excel file in RAM:
781783

0 commit comments

Comments
 (0)