Fix order parameters and add decimal to to_string #23614

thoo · 2018-11-10T16:44:20Z

closes CLN: Consistency of arguments in to_html and to_string #23612
tests added / passed
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry
Add an extra argument:decimal to pandas.DataFrame.to_string.

pep8speaks · 2018-11-10T16:44:23Z

Hello @thoo! Thanks for updating the PR.

There are no PEP8 issues in the file pandas/core/frame.py !
There are no PEP8 issues in the file pandas/io/formats/format.py !
There are no PEP8 issues in the file pandas/tests/io/formats/test_format.py !

Comment last updated on November 11, 2018 at 23:37 Hours UTC

codecov · 2018-11-10T18:44:03Z

Codecov Report

Merging #23614 into master will decrease coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #23614      +/-   ##
==========================================
- Coverage   92.25%   92.25%   -0.01%     
==========================================
  Files         161      161              
  Lines       51384    51383       -1     
==========================================
- Hits        47405    47404       -1     
  Misses       3979     3979

Flag	Coverage Δ
#multiple	`90.64% <100%> (-0.01%)`	⬇️
#single	`42.31% <100%> (-0.01%)`	⬇️

Impacted Files	Coverage Δ
pandas/io/formats/format.py	`97.87% <ø> (-0.01%)`	⬇️
pandas/core/frame.py	`97.02% <100%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8af7637...ddf42c7. Read the comment docs.

datapythonista · 2018-11-10T21:57:22Z

Looks quite nice.

I think it good be good to have one test to see that decimal is working in to_string, and then we need to add to the whatsnew two entries, one for the addition of decimal, and another one for the argument resorting.

thoo · 2018-11-11T06:31:36Z

@datapythonista Please let me know the two entries are not in the right place in whatnews file.

jreback · 2018-11-11T14:45:42Z

doc/source/whatsnew/v0.24.0.txt

@@ -945,6 +946,7 @@ Other API Changes
 - :class:`DateOffset` attribute `_cacheable` and method `_should_cache` have been removed (:issue:`23118`)
 - Comparing :class:`Timedelta` to be less or greater than unknown types now raises a ``TypeError`` instead of returning ``False`` (:issue:`20829`)
 - :meth:`Index.hasnans` and :meth:`Series.hasnans` now always return a python boolean. Previously, a python or a numpy boolean could be returned, depending on circumstances (:issue:`23294`).
+- The order of the arguments of `DataFrame.to_html` and `DataFrame.to_string` is rearranged. (:issue:`23614`)


can you use a :func: ref here

say to be consistent with each other

jreback · 2018-11-11T14:46:50Z

pandas/tests/io/formats/test_format.py

@@ -1451,6 +1451,11 @@ def test_to_string_format_na(self):
                    '4  4.0     bar')
        assert result == expected

+    def test_to_string_decimal(self):
+        df = DataFrame({'A': [6.0, 3.1, 2.2]})


can you add the issue number

Small thing, but I think we consistently use the format GH 23614.

@gfyoung I think you changed some in a recent PR, can you confirm?

* upstream/master: BUG: Casting tz-aware DatetimeIndex to object-dtype ndarray/Index (pandas-dev#23524) BUG: Delegate more of Excel parsing to CSV (pandas-dev#23544) API: DataFrame.__getitem__ returns Series for sparse column (pandas-dev#23561) CLN: use float64_t consistently instead of double, double_t (pandas-dev#23583) DOC: Fix Order of parameters in docstrings (pandas-dev#23611) TST: Unskip some Categorical Tests (pandas-dev#23613) TST: Fix integer ops comparison test (pandas-dev#23619) DOC: Fixes to docstring to add validation to CI (pandas-dev#23560) DOC: Remove incorrect periods at the end of parameter types (pandas-dev#23600) MAINT: tm.assert_raises_regex --> pytest.raises (pandas-dev#23592) DOC: Updating Series.resample and DataFrame.resample docstrings (pandas-dev#23197)

* upstream/master: BUILD: Simplifying contributor dependencies (pandas-dev#23522) BUG/REF: TimedeltaIndex.__new__ (pandas-dev#23539)

thoo · 2018-11-12T05:11:45Z

@jreback All checks are passed. Could you re-review this ? Thanks.

datapythonista

looks good, just two minor things

datapythonista · 2018-11-12T13:08:53Z

doc/source/whatsnew/v0.24.0.txt

@@ -20,7 +20,8 @@ New features
 the user to override the engine's default behavior to include or omit the
 dataframe's indexes from the resulting Parquet file. (:issue:`20768`)
 - :meth:`DataFrame.corr` and :meth:`Series.corr` now accept a callable for generic calculation methods of correlation, e.g. histogram intersection (:issue:`22684`)
-
+- :func:`DataFrame.to_string` now accepts ``decimal`` as an argument, allowing
+the user to use a decimal separator. (:issue:`23614`)


more than to use as decimal separator, if I understood correctly, it'll allow the user to specify which decimal separator should be used in the output. Isn't it?

datapythonista · 2018-11-12T13:12:13Z

pandas/tests/io/formats/test_format.py

@@ -1451,6 +1451,11 @@ def test_to_string_format_na(self):
                    '4  4.0     bar')
        assert result == expected

+    def test_to_string_decimal(self):
+        df = DataFrame({'A': [6.0, 3.1, 2.2]})


Small thing, but I think we consistently use the format GH 23614.

@gfyoung I think you changed some in a recent PR, can you confirm?

jreback · 2018-11-12T13:14:39Z

lgtm. @datapythonista merge when you are satisfied.

* upstream/master: BUG: Don't over-optimize memory with jagged CSV (pandas-dev#23527) DEPR: Deprecate usecols as int in read_excel (pandas-dev#23635) More helpful Stata string length error. (pandas-dev#23629) BUG: astype fill_value for SparseArray.astype (pandas-dev#23547) CLN: datetimelike arrays: isort, small reorg (pandas-dev#23587) CI: Check in the CI that assert_raises_regex is not being used (pandas-dev#23627) CLN:Remove unused **kwargs from user facing methods (pandas-dev#23249) DOC: Enhancing pivot / reshape docs (pandas-dev#21038) TST: Fix xfailing DataFrame arithmetic tests by transposing (pandas-dev#23620)

* upstream/master: (25 commits) DOC: Delete trailing blank lines in docstrings. (pandas-dev#23651) DOC: Change release and whatsnew (pandas-dev#21599) DOC: Fix format of the See Also descriptions (pandas-dev#23654) DOC: update pandas.core.groupby.DataFrameGroupBy.resample docstring. (pandas-dev#20374) ENH: Allow export of mixed columns to Stata strl (pandas-dev#23692) CLN: Remove unnecessary code (pandas-dev#23696) Pin flake8-rst version (pandas-dev#23699) Implement _most_ of the EA interface for DTA/TDA (pandas-dev#23643) CI: raise clone depth limit on CI BUG: Fix Series/DataFrame.rank(pct=True) with more than 2**24 rows (pandas-dev#23688) REF: Move Excel names parameter handling to CSV (pandas-dev#23690) DOC: Accessing files from a S3 bucket. (pandas-dev#23639) Fix errorbar visualization (pandas-dev#23674) DOC: Surface / doc mangle_dupe_cols in read_excel (pandas-dev#23678) DOC: Update is_sparse docstring (pandas-dev#19983) BUG: Fix read_excel w/parse_cols & empty dataset (pandas-dev#23661) Add to_flat_index method to MultiIndex (pandas-dev#22866) CLN: Move to_excel to generic.py (pandas-dev#23656) TST: IntervalTree.get_loc_interval should return platform int (pandas-dev#23660) CI: Allow to compile docs with ipython 7.11 pandas-dev#22990 (pandas-dev#23655) ...

jreback · 2018-11-15T13:53:58Z

doc/source/whatsnew/v0.24.0.rst

@@ -961,6 +962,7 @@ Other API Changes
 - :class:`DateOffset` attribute `_cacheable` and method `_should_cache` have been removed (:issue:`23118`)
 - Comparing :class:`Timedelta` to be less or greater than unknown types now raises a ``TypeError`` instead of returning ``False`` (:issue:`20829`)
 - :meth:`Index.hasnans` and :meth:`Series.hasnans` now always return a python boolean. Previously, a python or a numpy boolean could be returned, depending on circumstances (:issue:`23294`).
+- :func:The order of the arguments of `DataFrame.to_html` and `DataFrame.to_string` is rearranged to be consistent with each other. (:issue:`23614`)


this is malformed here, you need the :func: to go with the DataFrame.to_html and .to_string (separate ones)

Got it. Done.

* upstream/master: BUG: to_html misses truncation indicators (...) when index=False (pandas-dev#22786) API/DEPR: replace "raise_conflict" with "errors" for df.update (pandas-dev#23657) BUG: Append DataFrame to Series with dateutil timezone (pandas-dev#23685) CLN/CI: Catch that stderr-warning! (pandas-dev#23706) ENH: Allow for join between two multi-index dataframe instances (pandas-dev#20356) Ensure Index._data is an ndarray (pandas-dev#23628) DOC: flake8-per-pr for windows users (pandas-dev#23707) DOC: Handle exceptions when computing contributors. (pandas-dev#23714) DOC: Validate space before colon docstring parameters pandas-dev#23483 (pandas-dev#23506) BUG-22984 Fix truncation of DataFrame representations (pandas-dev#22987)

jreback · 2018-11-15T16:08:36Z

thanks

Fix docstrings

13b3fcd

Retrigger Travis CI

c41c1ea

datapythonista added Docs IO HTML read_html, to_html, Styler.apply, Styler.applymap Clean labels Nov 10, 2018

Add whatnews and to_string decimal test

910cfea

Add issue no.

831aa90

jreback requested changes Nov 11, 2018

View reviewed changes

jreback added this to the 0.24.0 milestone Nov 11, 2018

datapythonista mentioned this pull request Nov 11, 2018

DOC: Fix Order of parameters in docstrings #23611

Merged

3 tasks

thoo added 5 commits November 11, 2018 13:57

Add issue no. in test_format.py and add func ref

b87dc8c

Retrigger circleci

ef872e9

Fix flake8 E265

87297cd

Merge remote-tracking branch 'upstream/master' into to_html-to_string

895f8cd

* upstream/master: BUILD: Simplifying contributor dependencies (pandas-dev#23522) BUG/REF: TimedeltaIndex.__new__ (pandas-dev#23539)

datapythonista reviewed Nov 12, 2018

View reviewed changes

jreback approved these changes Nov 12, 2018

View reviewed changes

thoo added 3 commits November 12, 2018 10:22

Change as recommended

7186aaf

jreback requested changes Nov 15, 2018

View reviewed changes

thoo added 2 commits November 15, 2018 09:55

Fix at whatsnew

2bb90d4

jreback approved these changes Nov 15, 2018

View reviewed changes

jreback merged commit a23f901 into pandas-dev:master Nov 15, 2018

tm9k1 pushed a commit to tm9k1/pandas that referenced this pull request Nov 19, 2018

Fix order parameters and add decimal to to_string (pandas-dev#23614)

a4233e9

thoo deleted the to_html-to_string branch January 2, 2019 20:26

Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019

Fix order parameters and add decimal to to_string (pandas-dev#23614)

abcf882

Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019

Fix order parameters and add decimal to to_string (pandas-dev#23614)

8de306f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix order parameters and add decimal to to_string #23614

Fix order parameters and add decimal to to_string #23614

thoo commented Nov 10, 2018 •

edited

Loading

pep8speaks commented Nov 10, 2018 •

edited

Loading

codecov bot commented Nov 10, 2018 •

edited

Loading

datapythonista commented Nov 10, 2018

thoo commented Nov 11, 2018

jreback Nov 11, 2018

jreback Nov 11, 2018

jreback Nov 11, 2018

datapythonista Nov 12, 2018

thoo commented Nov 12, 2018

datapythonista left a comment

datapythonista Nov 12, 2018

datapythonista Nov 12, 2018

jreback commented Nov 12, 2018

jreback Nov 15, 2018

thoo Nov 15, 2018

jreback commented Nov 15, 2018

Fix order parameters and add decimal to to_string #23614

Fix order parameters and add decimal to to_string #23614

Conversation

thoo commented Nov 10, 2018 • edited Loading

pep8speaks commented Nov 10, 2018 • edited Loading

Comment last updated on November 11, 2018 at 23:37 Hours UTC

codecov bot commented Nov 10, 2018 • edited Loading

Codecov Report

datapythonista commented Nov 10, 2018

thoo commented Nov 11, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thoo commented Nov 12, 2018

datapythonista left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Nov 12, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jreback commented Nov 15, 2018

thoo commented Nov 10, 2018 •

edited

Loading

pep8speaks commented Nov 10, 2018 •

edited

Loading

codecov bot commented Nov 10, 2018 •

edited

Loading