[ENH] Add to_markdown method #30350

MarcoGorelli · 2019-12-19T16:41:57Z

closes DataFrame could have a to_markdown method. #11052
tests added / passed
passes black pandas
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

pep8speaks · 2019-12-19T16:46:36Z

Hello @MarcoGorelli! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2019-12-27 16:16:15 UTC

environment.yml

pandas/core/frame.py

pandas/tests/io/formats/test_to_markdown.py

jbrockmendel · 2019-12-19T20:12:28Z

should Series support this too? does tabulate have something that could be used for a read_markdown to round-trip?

TomAugspurger

You'll need to add tabulate to at least one of the ci/deps/ files

pandas/core/frame.py

doc/source/whatsnew/v1.0.0.rst

pandas/core/series.py

ci/deps/travis-38.yaml

MarcoGorelli · 2019-12-20T13:15:05Z

should Series support this too? does tabulate have something that could be used for a read_markdown to round-trip?

Sure, I've added it to Series.

I haven't found anything in the tabulate source code that can be easily used for read_markdown, but it would be a nice enhancement to work on.

Thank you @TomAugspurger and @jbrockmendel for your reviews!

darkdragon-001 · 2019-12-20T13:25:07Z

I haven't found anything in the tabulate source code that can be easily used for read_markdown, but it would be a nice enhancement to work on.

Maybe CSV code with | separator could work. One just has to ignore the header separation line. Maybe empty columns will be added because of the outer border separators and should be removed in post-processing automatically.

pandas/core/frame.py

pandas/tests/io/formats/test_to_markdown.py

jreback

can you add to install.rst and pandas/compat/_optional.py

ci/deps/travis-38.yaml

pandas/core/frame.py

TomAugspurger · 2019-12-20T15:38:24Z

pandas/core/frame.py

+        Print a DataFrame in markdown-friendly format.
+
+        .. versionadded:: 1.0
+


Add a Parameters section here.

Sure, done. Wasn't sure what to write for mode, as the docstring for pandas/io/common.py::get_filepath_or_buffer just says

mode : str, optional

and, as far as I can tell, the parameter is only used in the following conditions:

if is_s3_url(filepath_or_buffer): if is_gcs_url(filepath_or_buffer):

pandas/core/frame.py

pandas/core/series.py

pandas/tests/io/formats/test_to_markdown.py

… whole class

… introduced in to 1.0.0

MarcoGorelli · 2019-12-27T16:52:14Z

@jreback I've mentioned tabulate and added a link to its docs in install.rst, then rebased

@datapythonista Thanks! I've read through the thread you linked to. There seems to still be some disagreement among the core team about the issue though, so I'm not sure what to do and am in no position to pick sides

jreback · 2019-12-27T16:56:36Z

Thanks @MarcoGorelli, this is quite useful.

But personally I think this is a great opportunity to implement this as a third party module, and start to work on making it easier to extend pandas with I/O adapters like this (see #26804)

@datapythonista that's orthogonal, and to be honest this IS almost entirely a third-party module.

It is much much easier to simply refactor later than to re-factor while adding something new.

jreback · 2019-12-27T16:58:10Z

thanks @MarcoGorelli very nice!

…ndexing-1row-df * upstream/master: (333 commits) CI: troubleshoot Web_and_Docs failing (pandas-dev#30534) WARN: Ignore NumbaPerformanceWarning in test suite (pandas-dev#30525) DEPR: camelCase in offsets, get_offset (pandas-dev#30340) PERF: implement scalar ops blockwise (pandas-dev#29853) DEPR: Remove Series.compress (pandas-dev#30514) ENH: Add numba engine for rolling apply (pandas-dev#30151) [ENH] Add to_markdown method (pandas-dev#30350) DEPR: Deprecate pandas.np module (pandas-dev#30386) ENH: Add ignore_index for df.drop_duplicates (pandas-dev#30405) BUG: The setting xrot=0 in DataFrame.hist() doesn't work with by and subplots pandas-dev#30288 (pandas-dev#30491) CI: Fix GBQ Tests (pandas-dev#30478) Bug groupby quantile listlike q and int columns (pandas-dev#30485) ENH: Add ignore_index for df.sort_values and series.sort_values (pandas-dev#30402) TYP: Typing hints in pandas/io/formats/{css,csvs}.py (pandas-dev#30398) BUG: raise on non-hashable Index name, closes pandas-dev#29069 (pandas-dev#30335) Replace "foo!r" to "repr(foo)" syntax pandas-dev#29886 (pandas-dev#30502) BUG: preserve EA dtype in transpose (pandas-dev#30091) BLD: add check to prevent tempita name error, clsoes pandas-dev#28836 (pandas-dev#30498) REF/TST: method-specific files for test_append (pandas-dev#30503) marked unused parameters (pandas-dev#30504) ...

MarcoGorelli force-pushed the add-to-markdown branch 4 times, most recently from 1a1ddee to 8282511 Compare December 19, 2019 18:13

jbrockmendel reviewed Dec 19, 2019

View reviewed changes

environment.yml Outdated Show resolved Hide resolved

jbrockmendel reviewed Dec 19, 2019

View reviewed changes

pandas/core/frame.py Outdated Show resolved Hide resolved

jbrockmendel reviewed Dec 19, 2019

View reviewed changes

pandas/tests/io/formats/test_to_markdown.py Outdated Show resolved Hide resolved

TomAugspurger reviewed Dec 19, 2019

View reviewed changes

pandas/core/frame.py Outdated Show resolved Hide resolved

pandas/core/frame.py Outdated Show resolved Hide resolved

doc/source/whatsnew/v1.0.0.rst Outdated Show resolved Hide resolved

TomAugspurger added the IO Data IO issues that don't fit into a more specific label label Dec 19, 2019

jbrockmendel mentioned this pull request Dec 19, 2019

DISC/REF: split frame.py and generic.py into smaller files #30360

Closed

MarcoGorelli changed the title ~~✨ Add to_markdown method~~ [ENH] Add to_markdown method Dec 20, 2019

MarcoGorelli force-pushed the add-to-markdown branch from 8282511 to 8e98324 Compare December 20, 2019 13:06

MarcoGorelli commented Dec 20, 2019

View reviewed changes

pandas/core/series.py Outdated Show resolved Hide resolved

MarcoGorelli changed the title ~~[ENH] Add to_markdown method~~ [wip] [ENH] Add to_markdown method Dec 20, 2019

MarcoGorelli commented Dec 20, 2019

View reviewed changes

ci/deps/travis-38.yaml Outdated Show resolved Hide resolved

MarcoGorelli changed the title ~~[wip] [ENH] Add to_markdown method~~ [ENH] Add to_markdown method Dec 20, 2019

TomAugspurger reviewed Dec 20, 2019

View reviewed changes

pandas/core/frame.py Outdated Show resolved Hide resolved

pandas/core/frame.py Outdated Show resolved Hide resolved

pandas/tests/io/formats/test_to_markdown.py Outdated Show resolved Hide resolved

jreback requested changes Dec 20, 2019

View reviewed changes

TomAugspurger reviewed Dec 20, 2019

View reviewed changes

MarcoGorelli changed the title ~~[ENH] Add to_markdown method~~ wip [ENH] Add to_markdown method Dec 20, 2019

MarcoGorelli force-pushed the add-to-markdown branch 6 times, most recently from 48289b5 to a572e29 Compare December 21, 2019 17:54

Marco Gorelli and others added 22 commits December 27, 2019 16:16

♻️ remove call to DataFrame.pipe in DataFrame.to_markdown

00fd8a4

📌 add tabulate to travis-38.yaml

65e9f1b

📝 add DataFrame.to_markdown to API reference file

a273560

✨ add **kwargs to DataFrame.to_markdown

14e36e8

✅ update tests so they work with **kwargs, set skip_if_no_tabulate to…

ee07c68

… whole class

✨ add to_markdown to Series

d99a54f

📝 document to_markdown in Series API reference

57dfb7b

✅ update tests so they test Series.to_markdown as well

ccb132b

⬇️ Set tabulate dependency at 0.8, before which tests fail

bac632e

📝 update failing docstring

557e6dd

📌 set tabulate dependency at 0.8.0, not 0.8

01260f2

✨ add buf and mode arguments to to_markdown

b32d54d

✅ update tests so they use buf

68e84d6

🔥 remove skip_if_no_tabulate, due to module-level fixture

882768b

📝 add tabulate to install.rst and _optional, capitalise Markdown

f46edb1

:push_pin: add tabulate unpinned to travis-37.yaml

32d8762

🐛 dont all get_filepath_or_buffer with buf equal to sys.stdout

c5c3768

👌 return string if buf is set to None, use shared doc, change version…

df7880c

… introduced in to 1.0.0

📌 pin tabulate at 0.8.3

039e6a9

📝 add kwargs to parameters

093d63a

📝 link to tabulate docs in install.rst

ec77816

📝 fix merge conflict in whatsnew

32650f7

jreback approved these changes Dec 27, 2019

View reviewed changes

jreback merged commit 7ab73a9 into pandas-dev:master Dec 27, 2019

AlexKirko pushed a commit to AlexKirko/pandas that referenced this pull request Dec 29, 2019

[ENH] Add to_markdown method (pandas-dev#30350)

8853bbc

MarcoGorelli deleted the add-to-markdown branch January 24, 2020 13:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ENH] Add to_markdown method #30350

[ENH] Add to_markdown method #30350

MarcoGorelli commented Dec 19, 2019

pep8speaks commented Dec 19, 2019 •

edited

Loading

jbrockmendel commented Dec 19, 2019

TomAugspurger left a comment

MarcoGorelli commented Dec 20, 2019 •

edited

Loading

darkdragon-001 commented Dec 20, 2019

jreback left a comment

TomAugspurger Dec 20, 2019

MarcoGorelli Dec 21, 2019

MarcoGorelli commented Dec 27, 2019

jreback commented Dec 27, 2019

jreback commented Dec 27, 2019

		Print a DataFrame in markdown-friendly format.

		.. versionadded:: 1.0

[ENH] Add to_markdown method #30350

[ENH] Add to_markdown method #30350

Conversation

MarcoGorelli commented Dec 19, 2019

pep8speaks commented Dec 19, 2019 • edited Loading

Comment last updated at 2019-12-27 16:16:15 UTC

jbrockmendel commented Dec 19, 2019

TomAugspurger left a comment

Choose a reason for hiding this comment

MarcoGorelli commented Dec 20, 2019 • edited Loading

darkdragon-001 commented Dec 20, 2019

jreback left a comment

Choose a reason for hiding this comment

TomAugspurger Dec 20, 2019

Choose a reason for hiding this comment

MarcoGorelli Dec 21, 2019

Choose a reason for hiding this comment

MarcoGorelli commented Dec 27, 2019

jreback commented Dec 27, 2019

jreback commented Dec 27, 2019

pep8speaks commented Dec 19, 2019 •

edited

Loading

MarcoGorelli commented Dec 20, 2019 •

edited

Loading