pandas.DataFrame.to_markdown

DataFrame.to_markdown(buf=None, *, mode='wt', index=True, storage_options=None, **kwargs)[source]

Вывод DataFrame в формате, подходящем для Markdown.

Параметры:

buf:str, Путь или объект типа StringIO, необязательно, по умолчанию None

Буфер для записи. Если None, результат возвращается как строка.

mode:str, необязательно

Режим открытия файла, по умолчанию “wt”.

index:bool, необязательно, по умолчанию True

Добавить метки индексов (строк).

storage_options:dict, необязательно

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

**kwargs

Эти параметры будут переданы в tabulate.

Возвращаемое значение:

str

DataFrame в формате, подходящем для Markdown.

Примечания

Требуется пакет tabulate.

Примеры

>>> df = pd.DataFrame(
...     data={"animal_1": ["elk", "pig"], "animal_2": ["dog", "quetzal"]}
... )
>>> print(df.to_markdown())
|    | animal_1   | animal_2   |
|---:|:-----------|:-----------|
|  0 | elk        | dog        |
|  1 | pig        | quetzal    |

Вывод Markdown с параметрами tabulate.

>>> print(df.to_markdown(tablefmt="grid"))
+----+------------+------------+
|    | animal_1   | animal_2   |
+====+============+============+
|  0 | elk        | dog        |
+----+------------+------------+
|  1 | pig        | quetzal    |
+----+------------+------------+