pandas.ExcelWriter#

класс pandas.ExcelWriter(путь, движок=None, date_format=None, datetime_format=None, mode='w', storage_options=None, if_sheet_exists=None, engine_kwargs=None)[источник]#

Класс для записи объектов DataFrame в листы Excel.

По умолчанию используется:

xlsxwriter для файлов xlsx, если установлен xlsxwriter, иначе openpyxl
odswriter для файлов ods

См. DataFrame.to_excel для типичного использования.

Писатель должен использоваться как контекстный менеджер. В противном случае вызовите close() чтобы сохранить и закрыть любые открытые файловые дескрипторы.

Параметры:

путьstr или typing.BinaryIO

Путь к файлу xls, xlsx или ods.

движокstr (опционально)

Движок для записи. Если None, по умолчанию используется io.excel..writer. ПРИМЕЧАНИЕ: может быть передано только как именованный аргумент.

date_formatstr, по умолчанию None

Строка формата для дат, записываемых в файлы Excel (например, 'ГГГГ-ММ-ДД').

datetime_formatstr, по умолчанию None

Строка формата для объектов datetime, записываемых в файлы Excel. (например, 'ГГГГ-ММ-ДД ЧЧ:ММ:СС').

mode{‘w’, ‘a’}, по умолчанию ‘w’

Режим файла для использования (запись или добавление). Добавление не работает с URL-адресами fsspec.

storage_optionsdict, optional

Дополнительные параметры, которые имеют смысл для конкретного соединения с хранилищем, например, хост, порт, имя пользователя, пароль и т.д. Для HTTP(S) URL пары ключ-значение передаются в urllib.request.Request в качестве параметров заголовка. Для других URL-адресов (например, начинающихся с "s3://" и "gcs://") пары ключ-значение передаются fsspec.open. Пожалуйста, смотрите fsspec и urllib для получения дополнительной информации, а для дополнительных примеров по опциям хранения см. здесь.

if_sheet_exists{‘error’, ‘new’, ‘replace’, ‘overlay’}, по умолчанию ‘error’

Как вести себя при попытке записи на лист, который уже существует (только режим добавления).

ошибка: вызывает ValueError.
new: Создать новый лист с именем, определяемым движком.
replace: Удалить содержимое листа перед записью в него.
overlay: Запись содержимого в существующий лист без предварительного удаления, но возможно поверх существующего содержимого.

Добавлено в версии 1.3.0.

Изменено в версии 1.4.0: Добавлен overlay опция

engine_kwargsdict, optional

Ключевые аргументы для передачи в движок. Они будут переданы в следующие функции соответствующих движков:

xlsxwriter: xlsxwriter.Workbook(file, **engine_kwargs)
openpyxl (режим записи): openpyxl.Workbook(**engine_kwargs)
openpyxl (режим добавления): openpyxl.load_workbook(file, **engine_kwargs)
odswriter: odf.opendocument.OpenDocumentSpreadsheet(**engine_kwargs)

Добавлено в версии 1.3.0.

Примечания

Для совместимости с CSV-писателями, ExcelWriter сериализует списки и словари в строки перед записью.

Примеры

Использование по умолчанию:

>>> df = pd.DataFrame([["ABC", "XYZ"]], columns=["Foo", "Bar"])  
>>> with pd.ExcelWriter("path_to_file.xlsx") as writer:
...     df.to_excel(writer)  

Для записи на отдельные листы в одном файле:

>>> df1 = pd.DataFrame([["AAA", "BBB"]], columns=["Spam", "Egg"])  
>>> df2 = pd.DataFrame([["ABC", "XYZ"]], columns=["Foo", "Bar"])  
>>> with pd.ExcelWriter("path_to_file.xlsx") as writer:
...     df1.to_excel(writer, sheet_name="Sheet1")  
...     df2.to_excel(writer, sheet_name="Sheet2")  

Вы можете установить формат даты или формат даты и времени:

>>> from datetime import date, datetime  
>>> df = pd.DataFrame(
...     [
...         [date(2014, 1, 31), date(1999, 9, 24)],
...         [datetime(1998, 5, 26, 23, 33, 4), datetime(2014, 2, 28, 13, 5, 13)],
...     ],
...     index=["Date", "Datetime"],
...     columns=["X", "Y"],
... )  
>>> with pd.ExcelWriter(
...     "path_to_file.xlsx",
...     date_format="YYYY-MM-DD",
...     datetime_format="YYYY-MM-DD HH:MM:SS"
... ) as writer:
...     df.to_excel(writer)  

Вы также можете добавлять данные в существующий файл Excel:

>>> with pd.ExcelWriter("path_to_file.xlsx", mode="a", engine="openpyxl") as writer:
...     df.to_excel(writer, sheet_name="Sheet3")  

Здесь if_sheet_exists параметр может быть установлен для замены листа, если он уже существует:

>>> with ExcelWriter(
...     "path_to_file.xlsx",
...     mode="a",
...     engine="openpyxl",
...     if_sheet_exists="replace",
... ) as writer:
...     df.to_excel(writer, sheet_name="Sheet1")  

Вы также можете записать несколько DataFrame на один лист. Обратите внимание, что if_sheet_exists параметр должен быть установлен в overlay:

>>> with ExcelWriter("path_to_file.xlsx",
...     mode="a",
...     engine="openpyxl",
...     if_sheet_exists="overlay",
... ) as writer:
...     df1.to_excel(writer, sheet_name="Sheet1")
...     df2.to_excel(writer, sheet_name="Sheet1", startcol=3)  

Вы можете хранить файл Excel в оперативной памяти:

>>> import io
>>> df = pd.DataFrame([["ABC", "XYZ"]], columns=["Foo", "Bar"])
>>> buffer = io.BytesIO()
>>> with pd.ExcelWriter(buffer) as writer:
...     df.to_excel(writer)

Вы можете упаковать файл Excel в архив zip:

>>> import zipfile  
>>> df = pd.DataFrame([["ABC", "XYZ"]], columns=["Foo", "Bar"])  
>>> with zipfile.ZipFile("path_to_file.zip", "w") as zf:
...     with zf.open("filename.xlsx", "w") as buffer:
...         with pd.ExcelWriter(buffer) as writer:
...             df.to_excel(writer)  

Вы можете указать дополнительные аргументы для базового движка:

>>> with pd.ExcelWriter(
...     "path_to_file.xlsx",
...     engine="xlsxwriter",
...     engine_kwargs={"options": {"nan_inf_to_errors": True}}
... ) as writer:
...     df.to_excel(writer)  

В режиме добавления, engine_kwargs передаются в openpyxl load_workbook:

>>> with pd.ExcelWriter(
...     "path_to_file.xlsx",
...     engine="openpyxl",
...     mode="a",
...     engine_kwargs={"keep_vba": True}
... ) as writer:
...     df.to_excel(writer, sheet_name="Sheet2")  

Атрибуты

`book`	экземпляр Book.
`date_format`	Строка формата для дат, записываемых в файлы Excel (например, 'YYYY-MM-DD').
`datetime_format`	Строка формата для дат, записываемых в файлы Excel (например, 'YYYY-MM-DD').
`engine`	Название движка.
`if_sheet_exists`	Как вести себя при записи на лист, который уже существует в режиме добавления.
`sheets`	Сопоставление имен листов с объектами листов.
`supported_extensions`	Расширения, которые поддерживает движок записи.

Методы

`check_extension`(ext)	проверяет расширение пути на соответствие поддерживаемым расширениям Writer.
`close`()	синоним для save, чтобы сделать его более похожим на файл