Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bpo-35849 Added thousands separators to Lib/pstats.py final report #13411

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

evandrocoan
Copy link

@evandrocoan evandrocoan commented May 18, 2019

@the-knights-who-say-ni
Copy link

the-knights-who-say-ni commented May 18, 2019

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately we couldn't find an account corresponding to your GitHub username on bugs.python.org (b.p.o) to verify you have signed the CLA (this might be simply due to a missing "GitHub Name" entry in your b.p.o account settings). This is necessary for legal reasons before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for your contribution, we look forward to reviewing it!

@csabella
Copy link
Contributor

csabella commented May 18, 2019

@evandrocoan, your previous pull request for this issue was closed because the CLA wasn't signed. If your changes here are the same as that previous PR, you can close this and just re-open the original. However, you still need to sign the CLA.

@evandrocoan
Copy link
Author

evandrocoan commented May 18, 2019

I do not have authority to open the last pull request. If you have, you can close this and open the old one.

I am trying to sing the CLA. I just opened a new pull request just to run the CI Unit Tests.

@evandrocoan
Copy link
Author

evandrocoan commented May 18, 2019

How to use this blurb_it? I already installed and allowed access to my cpython fork:
image

For example, instead of doing:
      ncalls     tottime     percall     cumtime     percall filename:lineno(function)
     241,770       0.158       0.000       0.158       0.000 {method 'search' of 're.Pattern' objects}
483,543/483,541       0.176       0.000       0.692       0.000 {built-in method builtins.next}
     241,770       0.158       0.000       0.158       0.000 {method 'search' of 're.Pattern' objects}

Do:
      ncalls     tottime     percall     cumtime     percall filename:lineno(function)
     241,770       0.158       0.000       0.158       0.000 {method 'search' of 're.Pattern' objects}
483,543/483,541    0.176       0.000       0.692       0.000 {built-in method builtins.next}
     241,770       0.158       0.000       0.158       0.000 {method 'search' of 're.Pattern' objects}
@remilapeyre
Copy link
Contributor

remilapeyre commented May 20, 2019

Hi @evandrocoan, you should get a form when you go at https://blurb-it.herokuapp.com. If it does not work, you can try the blurb command line tool. You can install it by running make -C Doc venv in you repository clone.

@evandrocoan
Copy link
Author

evandrocoan commented May 21, 2019

It created the "environment":

$ make -C Doc venv
make: Entering directory '/cygdrive/c/Tests/cpython/Doc'
python3 -m venv ./venv
./venv/bin/python3 -m pip install -U Sphinx blurb python-docs-theme
Collecting Sphinx
  Downloading https://files.pythonhosted.org/packages/9a/b0/a8cf1d35237aebefd63f05543ed49ea24d302239828ca89409b0c1a35b27/Sphinx-2.0.1-py2.py3-none-any.whl (3.2MB)
    100% |████████████████████████████████| 3.2MB 2.9MB/s
Collecting blurb
  Downloading https://files.pythonhosted.org/packages/41/90/cdce96c5f5767e08a87dad88cb2da0b962c692e826d2083d983d1f6f4019/blurb-1.0.7-py3-none-any.whl (62kB)
    100% |████████████████████████████████| 71kB 5.3MB/s
Collecting python-docs-theme
  Downloading https://files.pythonhosted.org/packages/04/c0/992bcc71b70f041d1d3a5ccea2edc18925c0bae55ab6617d121c92d71767/python_docs_theme-2018.7-py2.py3-none-any.whl
Requirement already satisfied, skipping upgrade: setuptools in ./venv/lib/python3.6/site-packages (from Sphinx) (40.8.0)
Collecting snowballstemmer>=1.1 (from Sphinx)
  Using cached https://files.pythonhosted.org/packages/d4/6c/8a935e2c7b54a37714656d753e4187ee0631988184ed50c0cf6476858566/snowballstemmer-1.2.1-py2.py3-none-any.whl
Collecting alabaster<0.8,>=0.7 (from Sphinx)
  Using cached https://files.pythonhosted.org/packages/10/ad/00b090d23a222943eb0eda509720a404f531a439e803f6538f35136cae9e/alabaster-0.7.12-py2.py3-none-any.whl
Collecting sphinxcontrib-serializinghtml (from Sphinx)
  Downloading https://files.pythonhosted.org/packages/57/b3/3648e48fa5682e61e9839d62de4e23af1795ceb738d68d73bd974257a95c/sphinxcontrib_serializinghtml-1.1.3-py2.py3-none-any.whl (89kB)
    100% |████████████████████████████████| 92kB 6.2MB/s
Collecting requests>=2.5.0 (from Sphinx)
  Downloading https://files.pythonhosted.org/packages/51/bd/23c926cd341ea6b7dd0b2a00aba99ae0f828be89d72b2190f27c11d4b7fb/requests-2.22.0-py2.py3-none-any.whl (57kB)
    100% |████████████████████████████████| 61kB 5.4MB/s
Collecting babel!=2.0,>=1.3 (from Sphinx)
  Using cached https://files.pythonhosted.org/packages/b8/ad/c6f60602d3ee3d92fbed87675b6fb6a6f9a38c223343ababdb44ba201f10/Babel-2.6.0-py2.py3-none-any.whl
Collecting packaging (from Sphinx)
  Downloading https://files.pythonhosted.org/packages/91/32/58bc30e646e55eab8b21abf89e353f59c0cc02c417e42929f4a9546e1b1d/packaging-19.0-py2.py3-none-any.whl
Collecting Jinja2>=2.3 (from Sphinx)
  Downloading https://files.pythonhosted.org/packages/1d/e7/fd8b501e7a6dfe492a433deb7b9d833d39ca74916fa8bc63dd1a4947a671/Jinja2-2.10.1-py2.py3-none-any.whl (124kB)
    100% |████████████████████████████████| 133kB 5.6MB/s
Collecting sphinxcontrib-applehelp (from Sphinx)
  Downloading https://files.pythonhosted.org/packages/13/9a/4428b3114d654cb1cd34d90d5e6fab938d5436f94a571155187ea1dd78b4/sphinxcontrib_applehelp-1.0.1-py2.py3-none-any.whl (121kB)
    100% |████████████████████████████████| 122kB 2.8MB/s
Collecting imagesize (from Sphinx)
  Using cached https://files.pythonhosted.org/packages/fc/b6/aef66b4c52a6ad6ac18cf6ebc5731ed06d8c9ae4d3b2d9951f261150be67/imagesize-1.1.0-py2.py3-none-any.whl
Collecting sphinxcontrib-devhelp (from Sphinx)
  Downloading https://files.pythonhosted.org/packages/b0/a3/fea98741f0b2f2902fbf6c35c8e91b22cd0dd13387291e81d457f9a93066/sphinxcontrib_devhelp-1.0.1-py2.py3-none-any.whl (84kB)
    100% |████████████████████████████████| 92kB 6.9MB/s
Collecting sphinxcontrib-jsmath (from Sphinx)
  Downloading https://files.pythonhosted.org/packages/c2/42/4c8646762ee83602e3fb3fbe774c2fac12f317deb0b5dbeeedd2d3ba4b77/sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl
Collecting docutils>=0.12 (from Sphinx)
  Using cached https://files.pythonhosted.org/packages/36/fa/08e9e6e0e3cbd1d362c3bbee8d01d0aedb2155c4ac112b19ef3cae8eed8d/docutils-0.14-py3-none-any.whl
Collecting Pygments>=2.0 (from Sphinx)
  Downloading https://files.pythonhosted.org/packages/6e/00/c5cb5fc7c047da4af049005d0146b3a961b1a25d9cefbbe24bf0882a11ad/Pygments-2.4.0-py2.py3-none-any.whl (882kB)
    100% |████████████████████████████████| 890kB 3.9MB/s
Collecting sphinxcontrib-qthelp (from Sphinx)
  Downloading https://files.pythonhosted.org/packages/ce/5b/4747c3ba98b3a3e21a66faa183d8f79b9ded70e74212a7988d236a6eb78a/sphinxcontrib_qthelp-1.0.2-py2.py3-none-any.whl (90kB)
    100% |████████████████████████████████| 92kB 5.5MB/s
Collecting sphinxcontrib-htmlhelp (from Sphinx)
  Downloading https://files.pythonhosted.org/packages/e4/35/80a67cc493f4a8a9634ab203a77aaa1b84d79ccb1c02eca72cb084d2c7f7/sphinxcontrib_htmlhelp-1.0.2-py2.py3-none-any.whl (96kB)
    100% |████████████████████████████████| 102kB 5.0MB/s
Collecting chardet<3.1.0,>=3.0.2 (from requests>=2.5.0->Sphinx)
  Using cached https://files.pythonhosted.org/packages/bc/a9/01ffebfb562e4274b6487b4bb1ddec7ca55ec7510b22e4c51f14098443b8/chardet-3.0.4-py2.py3-none-any.whl
Collecting certifi>=2017.4.17 (from requests>=2.5.0->Sphinx)
  Downloading https://files.pythonhosted.org/packages/60/75/f692a584e85b7eaba0e03827b3d51f45f571c2e793dd731e598828d380aa/certifi-2019.3.9-py2.py3-none-any.whl (158kB)
    100% |████████████████████████████████| 163kB 5.1MB/s
Collecting idna<2.9,>=2.5 (from requests>=2.5.0->Sphinx)
  Using cached https://files.pythonhosted.org/packages/14/2c/cd551d81dbe15200be1cf41cd03869a46fe7226e7450af7a6545bfc474c9/idna-2.8-py2.py3-none-any.whl
Collecting urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 (from requests>=2.5.0->Sphinx)
  Downloading https://files.pythonhosted.org/packages/39/ec/d93dfc69617a028915df914339ef66936ea976ef24fa62940fd86ba0326e/urllib3-1.25.2-py2.py3-none-any.whl (150kB)
    100% |████████████████████████████████| 153kB 6.0MB/s
Collecting pytz>=0a (from babel!=2.0,>=1.3->Sphinx)
  Downloading https://files.pythonhosted.org/packages/3d/73/fe30c2daaaa0713420d0382b16fbb761409f532c56bdcc514bf7b6262bb6/pytz-2019.1-py2.py3-none-any.whl (510kB)
    100% |████████████████████████████████| 512kB 3.9MB/s
Collecting pyparsing>=2.0.2 (from packaging->Sphinx)
  Downloading https://files.pythonhosted.org/packages/dd/d9/3ec19e966301a6e25769976999bd7bbe552016f0d32b577dc9d63d2e0c49/pyparsing-2.4.0-py2.py3-none-any.whl (62kB)
    100% |████████████████████████████████| 71kB 4.4MB/s
Collecting six (from packaging->Sphinx)
  Using cached https://files.pythonhosted.org/packages/73/fb/00a976f728d0d1fecfe898238ce23f502a721c0ac0ecfedb80e0d88c64e9/six-1.12.0-py2.py3-none-any.whl
Collecting MarkupSafe>=0.23 (from Jinja2>=2.3->Sphinx)
  Downloading https://files.pythonhosted.org/packages/b9/2e/64db92e53b86efccfaea71321f597fa2e1b2bd3853d8ce658568f7a13094/MarkupSafe-1.1.1.tar.gz
Installing collected packages: snowballstemmer, alabaster, sphinxcontrib-serializinghtml, chardet, certifi, idna, urllib3, requests, pytz, babel, pyparsing, six, packaging, MarkupSafe, Jinja2, sphinxcontrib-applehelp, imagesize, sphinxcontrib-devhelp, sphinxcontrib-jsmath, docutils, Pygments, sphinxcontrib-qthelp, sphinxcontrib-htmlhelp, Sphinx, blurb, python-docs-theme
  Running setup.py install for MarkupSafe ... done
Successfully installed Jinja2-2.10.1 MarkupSafe-1.1.1 Pygments-2.4.0 Sphinx-2.0.1 alabaster-0.7.12 babel-2.6.0 blurb-1.0.7 certifi-2019.3.9 chardet-3.0.4 docutils-0.14 idna-2.8 imagesize-1.1.0 packaging-19.0 pyparsing-2.4.0 python-docs-theme-2018.7 pytz-2019.1 requests-2.22.0 six-1.12.0 snowballstemmer-1.2.1 sphinxcontrib-applehelp-1.0.1 sphinxcontrib-devhelp-1.0.1 sphinxcontrib-htmlhelp-1.0.2 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.2 sphinxcontrib-serializinghtml-1.1.3 urllib3-1.25.2
You are using pip version 19.0.3, however version 19.1.1 is available.
You should consider upgrading via the 'pip install --upgrade pip' command.
The venv has been created in the ./venv directory
make: Leaving directory '/cygdrive/c/Tests/cpython/Doc'


But how I run blurb now?

When I do blurb add it says bash: blurb: command not found.

I tried installing blurb directly, but it does not work.

When I run blurb add and correctly create the file, it says:

Error: Error in C:\Users\PROFES~1\AppData\Local\Temp\tmpsjnu9cr2.rst:30:
No 'section' specified.  You must provide one!

[Hit return to retry (or Ctrl-C to abort)>

But I have the section specified:

#
# Please enter the relevant bugs.python.org issue number here:
#
.. bpo:
35849

#
# Uncomment one of these "section:" lines to specify which section
# this entry should go in in Misc/NEWS.
#
#.. section: Security
#.. section: Core and Builtins
#.. section: Library
#.. section: Documentation
.. section: Tests
#.. section: Build
#.. section: Windows
#.. section: macOS
#.. section: IDLE
#.. section: Tools/Demos
#.. section: C API

# Write your Misc/NEWS entry below.  It should be a simple ReST paragraph.
# Don't start with "- Issue #<n>: " or "- bpo-<n>: " or that sort of stuff.
###########################################################################
Added thousands separators to pstats results and increased the column width

Also allowed to reduce automatically subsequent pstats rows size

For example, instead of doing:
      ncalls     tottime     percall     cumtime     percall filename:lineno(function)
     241,770       0.158       0.000       0.158       0.000 {method 'search' of 're.Pattern' objects}
483,543/483,541       0.176       0.000       0.692       0.000 {built-in method builtins.next}
     241,770       0.158       0.000       0.158       0.000 {method 'search' of 're.Pattern' objects}

Do:
      ncalls     tottime     percall     cumtime     percall filename:lineno(function)
     241,770       0.158       0.000       0.158       0.000 {method 'search' of 're.Pattern' objects}
483,543/483,541    0.176       0.000       0.692       0.000 {built-in method builtins.next}
     241,770       0.158       0.000       0.158       0.000 {method 'search' of 're.Pattern' objects}


@remilapeyre
Copy link
Contributor

remilapeyre commented May 21, 2019

I think

.. bpo:
35849

needs to be on one line, like so: .. bpo: 35849

I think the message should be short and not contain example, for example:

Added thousands separators to ``pstats`` results, increased the column width and allowed to reduce automatically subsequent ``pstats`` rows size. Patch contributed by ...

@evandrocoan
Copy link
Author

evandrocoan commented May 22, 2019

Thanks @remilapeyre, it worked!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants