TST: fixed eng_formatter doctest for #42671 #42705

KrishnaSai2020 · 2021-07-25T09:01:34Z

closes TST: Fix doctest in EngFormatter #42671
tests added / passed
Ensure all linting tests pass, see here for how to run them
fixed the doctest error in the docs for format.py

KrishnaSai2020 · 2021-07-25T10:05:24Z

I'm quite confused as to why these CI checks failed/were cancelled. can someone help me with this?

fangchenli · 2021-07-25T12:49:53Z

I'm quite confused as to why these CI checks failed/were cancelled. can someone help me with this?

The windows build timed out. It happens sometimes. And it's unrelated to this PR.

fangchenli

If this fixed all doctest errors in that file/folder, could you add it to the ci/code_checks.sh script?

KrishnaSai2020 · 2021-07-25T13:28:22Z

This fixed one doctest error in that file but I don't know about the whole directory. so I added just the file itself.

datapythonista · 2021-07-25T17:47:52Z

Thanks @KrishnaSai2020. This doctest is still failing in the file, do you want to fix it here too?

FAILED pandas/io/formats/format.py::pandas.io.formats.format.EngFormatter.__call__

KrishnaSai2020 · 2021-07-26T08:19:26Z

@datapythonista I am quite confused as this pr is fixing that particular doctest are you saying the fix doesn't work?

datapythonista · 2021-07-26T10:05:10Z

@datapythonista I am quite confused as this pr is fixing that particular doctest are you saying the fix doesn't work?

You fixed one method docstring, that's fine. And then you're validating the doctests of the file where you fixed the docstring. The problem is that the file has many other methods, and most of them pass the tests, but the one I mentioned above is failing.

So, we have two options:

You don't validate the file, since not all doctests in it are passing. There were two broken, afyer your PR there is one broken
You leave the validation of the file, but besidea the doctest that you fixed, you fix the other brokem one too

KrishnaSai2020 · 2021-07-26T10:10:36Z

I don't mind fixing the other docstrings as well but the reason I was confused is you have mentioned the same one
pandas/io/formats/format.py::pandas.io.formats.format.EngFormatter.__call__ is the same function that this pr resolves.

datapythonista · 2021-07-26T10:15:33Z

True, I assumed it was a different one. Your fix is not working, there are other problems in the docstring. You should run the doctests locally to make sure it's fixed. This is the error (the first one, of there is more than one): https://github.com/pandas-dev/pandas/pull/42705/checks?check_run_id=3154916570#step:9:102

KrishnaSai2020 · 2021-07-26T11:26:48Z

I am trying to run the doctests locally but I am getting a whole swathe of unrelated errors on pycharm such as File "/Users/krishnachivukula/Documents/pandas/pandas/_libs/__init__.py", line 13, in <module> from pandas._libs.interval import Interval ModuleNotFoundError: No module named 'pandas._libs.interval' . Anyways on a more relevant note, there was an issue fundamentally with the class itself which I have now hopefully have fixed. formatting 0 should just return 0, not 0E+00 which was overlooked.

pep8speaks · 2021-07-26T11:54:41Z

Hello @KrishnaSai2020! 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 2021-07-30 08:16:27 UTC

KrishnaSai2020

Pycharm auto formatted by accident will revert changes

… auto formatted by accident)

KrishnaSai2020 · 2021-07-26T12:19:28Z

@datapythonista sorry for the spam of commits pycharm decided to autoformat the whole file for me and I had to roll back the changes.

KrishnaSai2020 · 2021-07-26T12:40:02Z

1963 >>> format_eng(1000000) # for self.accuracy = 1, Expected: # self.use_eng_prefix = True ' 1.0M' Got: ' 1E+06'
this to me suggests an error with the eng formatter code itself unrelated to the docstring. should I open an issue?

pandas/io/formats/format.py

KrishnaSai2020 · 2021-07-27T16:33:31Z

@datapythonista no problem and thanks for your help. I will take definitely take a look at the pep8 validation scripts for the docs too at a later time.

jreback · 2021-07-28T01:10:04Z

@KrishnaSai2020 if you merge master this should now be green.

KrishnaSai2020 · 2021-07-28T06:32:48Z

@jreback thank you! I have now merged upstream master into this branch.

KrishnaSai2020 · 2021-07-29T08:20:46Z

@datapythonista Could I get an update as to what is going to happen with this pr, please? Is it going to get merged? or have I done something wrong which means it can't get merged?

datapythonista · 2021-07-29T16:07:39Z

We need to get the CI green first, otherwise we can't merge. Can you merge master again, see if that fixes the issues, and if not, have a look and see what's the problem. Mostly the CI / Checks build, the others are likely to be unrelated.

KrishnaSai2020 · 2021-07-29T16:16:17Z

I think the issue is with stylerender.py doctests. I've removed them now and let's see what happens.

KrishnaSai2020 · 2021-07-29T16:50:01Z

I've merged master again and some completely unrelated doctests are still failing.

datapythonista · 2021-07-29T17:46:42Z

I created #42798 for it, we'll have to wait for that issue to be fixed, and then merge master again.

KrishnaSai2020 · 2021-07-30T08:37:27Z

@datapythonista all CI/checks have now passed

datapythonista

Thanks @KrishnaSai2020, really nice.

@fangchenli do you want to have another look?

jreback · 2021-07-30T15:51:36Z

thanks @KrishnaSai2020

* TST: Fix doctests for pandas.io.formats.style * Modified: pandas/io/formats/style.py * Added some expected results * Skipped some tests * TST: Add link to redirect to Table Visualization user guide * Modified style.py * Updated the doctest of the apply() * Updated the doctest of the applymap() * Updated the doctest of the set_table_styles() * Updated the doctest of the set_properties() * TST: Add image to pipe function result * Modified style.py * Updated the doctest of the pipe() * TST: Remove unnecessary outputs * Modified pandas/io/formats/style.py * Updated the doctests of the set_tooltips() * Updated the doctests of the to_latex() * Updated the doctests of the set_td_classes() * Updated the doctests of the set_table_attributes() * TST: Add the output to the Styler.format doctest in to_latex() * REG: DataFrame.agg where func returns lists and axis=1 (#42762) * Fix typing issues for CI (#42770) * BUG: groupby.shift returns different columns when fill_value is specified (#41858) * PERF: extract_array earlier in DataFrame construction (#42774) * ENH: `sparse_columns` and `sparse_index` added to `Styler.to_html` (#41946) * TYP: Fix typing for searchsorted (#42788) * DOC GH42756 Update documentation for pandas.DataFrame.drop to clarify tuples. (#42789) * CI: Fix doctests (#42790) * REGR: nanosecond timestamp comparisons to OOB datetimes (#42796) * COMPAT: MPL 3.4.0 (#42803) * Delete duplicates and unused code from reshape tests (#42802) * REGR: ValueError raised when both prefix and names are set to None (#42690) * REGR: ValueError raised when both prefix and names are set to None * Update readers.py * whitespace * Update v1.3.1.rst * Update v1.3.2.rst * Update readers.py * Update readers.py Co-authored-by: Jeff Reback <[email protected]> * TST: Add style.py to the doctest check * TST: fixed eng_formatter doctest for #42671 (#42705) * TST: Revert x and y position in some doctests * Updated the doctest of the hide_columns() Co-authored-by: Richard Shadrach <[email protected]> Co-authored-by: Irv Lustig <[email protected]> Co-authored-by: Thomas Smith <[email protected]> Co-authored-by: jbrockmendel <[email protected]> Co-authored-by: attack68 <[email protected]> Co-authored-by: Mike Phung <[email protected]> Co-authored-by: Matthew Zeitlin <[email protected]> Co-authored-by: Thomas Li <[email protected]> Co-authored-by: Patrick Hoefler <[email protected]> Co-authored-by: Jeff Reback <[email protected]> Co-authored-by: Krishna Chivukula <[email protected]>

* TST: Fix doctests for pandas.io.formats.style * Modified: pandas/io/formats/style.py * Added some expected results * Skipped some tests * TST: Add link to redirect to Table Visualization user guide * Modified style.py * Updated the doctest of the apply() * Updated the doctest of the applymap() * Updated the doctest of the set_table_styles() * Updated the doctest of the set_properties() * TST: Add image to pipe function result * Modified style.py * Updated the doctest of the pipe() * TST: Remove unnecessary outputs * Modified pandas/io/formats/style.py * Updated the doctests of the set_tooltips() * Updated the doctests of the to_latex() * Updated the doctests of the set_td_classes() * Updated the doctests of the set_table_attributes() * TST: Add the output to the Styler.format doctest in to_latex() * REG: DataFrame.agg where func returns lists and axis=1 (pandas-dev#42762) * Fix typing issues for CI (pandas-dev#42770) * BUG: groupby.shift returns different columns when fill_value is specified (pandas-dev#41858) * PERF: extract_array earlier in DataFrame construction (pandas-dev#42774) * ENH: `sparse_columns` and `sparse_index` added to `Styler.to_html` (pandas-dev#41946) * TYP: Fix typing for searchsorted (pandas-dev#42788) * DOC GH42756 Update documentation for pandas.DataFrame.drop to clarify tuples. (pandas-dev#42789) * CI: Fix doctests (pandas-dev#42790) * REGR: nanosecond timestamp comparisons to OOB datetimes (pandas-dev#42796) * COMPAT: MPL 3.4.0 (pandas-dev#42803) * Delete duplicates and unused code from reshape tests (pandas-dev#42802) * REGR: ValueError raised when both prefix and names are set to None (pandas-dev#42690) * REGR: ValueError raised when both prefix and names are set to None * Update readers.py * whitespace * Update v1.3.1.rst * Update v1.3.2.rst * Update readers.py * Update readers.py Co-authored-by: Jeff Reback <[email protected]> * TST: Add style.py to the doctest check * TST: fixed eng_formatter doctest for pandas-dev#42671 (pandas-dev#42705) * TST: Revert x and y position in some doctests * Updated the doctest of the hide_columns() Co-authored-by: Richard Shadrach <[email protected]> Co-authored-by: Irv Lustig <[email protected]> Co-authored-by: Thomas Smith <[email protected]> Co-authored-by: jbrockmendel <[email protected]> Co-authored-by: attack68 <[email protected]> Co-authored-by: Mike Phung <[email protected]> Co-authored-by: Matthew Zeitlin <[email protected]> Co-authored-by: Thomas Li <[email protected]> Co-authored-by: Patrick Hoefler <[email protected]> Co-authored-by: Jeff Reback <[email protected]> Co-authored-by: Krishna Chivukula <[email protected]>

doctest fix for pandas-dev#42671

7bef135

KrishnaSai2020 changed the title ~~fixed eng_formatter doctest for #42671~~ tst: fixed eng_formatter doctest for #42671 Jul 25, 2021

KrishnaSai2020 changed the title ~~tst: fixed eng_formatter doctest for #42671~~ TST: fixed eng_formatter doctest for #42671 Jul 25, 2021

KrishnaSai2020 marked this pull request as draft July 25, 2021 12:13

KrishnaSai2020 marked this pull request as ready for review July 25, 2021 12:13

fangchenli requested changes Jul 25, 2021

View reviewed changes

doctest fix for pandas-dev#42671(added format.py to doctest scripts)

cc55377

KrishnaSai2020 requested a review from fangchenli July 25, 2021 13:57

doctest fix for pandas-dev#42670

e7a5a91

KrishnaSai2020 added 2 commits July 26, 2021 12:49

doctest fix for pandas-dev#42670 (whitespace removal)

170cc45

doctest fix for pandas-dev#42670

fad0bab

KrishnaSai2020 commented Jul 26, 2021

View reviewed changes

KrishnaSai2020 force-pushed the doctest-fix-2 branch from b4abd67 to fad0bab Compare July 26, 2021 12:16

doctest fix for pandas-dev#42670 (reverted formatting changes pycharm…

a340b16

… auto formatted by accident)

datapythonista reviewed Jul 26, 2021

View reviewed changes

pandas/io/formats/format.py Outdated Show resolved Hide resolved

KrishnaSai2020 and others added 3 commits July 27, 2021 09:20

doctest fix for pandas-dev#42670

93d5565

Merge branch 'master' into doctest-fix-2

314aee5

doctest fix for pandas-dev#42670

3074c66

jreback added this to the 1.4 milestone Jul 28, 2021

jreback added Docs Testing pandas testing functions or related to the test suite labels Jul 28, 2021

jreback mentioned this pull request Jul 28, 2021

TST: doctest fix for pandas.io.formats.style_render._parse_latex_tabl… #42752

Merged

1 task

Merge https://github.com/pandas-dev/pandas into doctest-fix-2

96b447d

KrishnaSai2020 mentioned this pull request Jul 28, 2021

TST: Fix doctest in EngFormatter #42671

Closed

Merge branch 'master' into doctest-fix-2

8ec062d

Update code_checks.sh

e898934

Merge branch 'pandas-dev:master' into doctest-fix-2

d4b326b

hrishikeshnikam2000 mentioned this pull request Jul 29, 2021

CI: Doctests failing on master #42798

Closed

Merge branch 'pandas-dev:master' into doctest-fix-2

4899867

KrishnaSai2020 mentioned this pull request Jul 30, 2021

BUG: Posix / pytest (actions-39-numpydev.yaml, ...) checks failing on master #42814

Closed

3 tasks

datapythonista approved these changes Jul 30, 2021

View reviewed changes

fangchenli approved these changes Jul 30, 2021

View reviewed changes

jreback merged commit 1e88d66 into pandas-dev:master Jul 30, 2021

KrishnaSai2020 deleted the doctest-fix-2 branch July 30, 2021 15:57

Leonardofreua pushed a commit to Leonardofreua/pandas that referenced this pull request Jul 30, 2021

TST: fixed eng_formatter doctest for pandas-dev#42671 (pandas-dev#42705)

adc540f

feefladder pushed a commit to feefladder/pandas that referenced this pull request Sep 7, 2021

TST: fixed eng_formatter doctest for pandas-dev#42671 (pandas-dev#42705)

cb2a0e4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TST: fixed eng_formatter doctest for #42671 #42705

TST: fixed eng_formatter doctest for #42671 #42705

KrishnaSai2020 commented Jul 25, 2021 •

edited

Loading

KrishnaSai2020 commented Jul 25, 2021

fangchenli commented Jul 25, 2021 •

edited

Loading

fangchenli left a comment

KrishnaSai2020 commented Jul 25, 2021

datapythonista commented Jul 25, 2021

KrishnaSai2020 commented Jul 26, 2021

datapythonista commented Jul 26, 2021

KrishnaSai2020 commented Jul 26, 2021 •

edited

Loading

datapythonista commented Jul 26, 2021

KrishnaSai2020 commented Jul 26, 2021 •

edited

Loading

pep8speaks commented Jul 26, 2021 •

edited

Loading

KrishnaSai2020 left a comment

KrishnaSai2020 commented Jul 26, 2021

KrishnaSai2020 commented Jul 26, 2021

KrishnaSai2020 commented Jul 27, 2021 •

edited

Loading

jreback commented Jul 28, 2021

KrishnaSai2020 commented Jul 28, 2021 •

edited

Loading

KrishnaSai2020 commented Jul 29, 2021

datapythonista commented Jul 29, 2021

KrishnaSai2020 commented Jul 29, 2021 •

edited

Loading

KrishnaSai2020 commented Jul 29, 2021 •

edited

Loading

datapythonista commented Jul 29, 2021

KrishnaSai2020 commented Jul 30, 2021 •

edited

Loading

datapythonista left a comment

jreback commented Jul 30, 2021

TST: fixed eng_formatter doctest for #42671 #42705

TST: fixed eng_formatter doctest for #42671 #42705

Conversation

KrishnaSai2020 commented Jul 25, 2021 • edited Loading

KrishnaSai2020 commented Jul 25, 2021

fangchenli commented Jul 25, 2021 • edited Loading

fangchenli left a comment

Choose a reason for hiding this comment

KrishnaSai2020 commented Jul 25, 2021

datapythonista commented Jul 25, 2021

KrishnaSai2020 commented Jul 26, 2021

datapythonista commented Jul 26, 2021

KrishnaSai2020 commented Jul 26, 2021 • edited Loading

datapythonista commented Jul 26, 2021

KrishnaSai2020 commented Jul 26, 2021 • edited Loading

pep8speaks commented Jul 26, 2021 • edited Loading

Comment last updated at 2021-07-30 08:16:27 UTC

KrishnaSai2020 left a comment

Choose a reason for hiding this comment

KrishnaSai2020 commented Jul 26, 2021

KrishnaSai2020 commented Jul 26, 2021

KrishnaSai2020 commented Jul 27, 2021 • edited Loading

jreback commented Jul 28, 2021

KrishnaSai2020 commented Jul 28, 2021 • edited Loading

KrishnaSai2020 commented Jul 29, 2021

datapythonista commented Jul 29, 2021

KrishnaSai2020 commented Jul 29, 2021 • edited Loading

KrishnaSai2020 commented Jul 29, 2021 • edited Loading

datapythonista commented Jul 29, 2021

KrishnaSai2020 commented Jul 30, 2021 • edited Loading

datapythonista left a comment

Choose a reason for hiding this comment

jreback commented Jul 30, 2021

KrishnaSai2020 commented Jul 25, 2021 •

edited

Loading

fangchenli commented Jul 25, 2021 •

edited

Loading

KrishnaSai2020 commented Jul 26, 2021 •

edited

Loading

KrishnaSai2020 commented Jul 26, 2021 •

edited

Loading

pep8speaks commented Jul 26, 2021 •

edited

Loading

KrishnaSai2020 commented Jul 27, 2021 •

edited

Loading

KrishnaSai2020 commented Jul 28, 2021 •

edited

Loading

KrishnaSai2020 commented Jul 29, 2021 •

edited

Loading

KrishnaSai2020 commented Jul 29, 2021 •

edited

Loading

KrishnaSai2020 commented Jul 30, 2021 •

edited

Loading