Skip to content

bpo-29235: Update document for Profiler's context manager #7331

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Jun 7, 2018
Merged

bpo-29235: Update document for Profiler's context manager #7331

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e134846
bpo-29235: Add versionadded note to cProfile docs.
Jun 1, 2018
9abe26d
DOC: Remove extra paragraph from NEWS entry.
Jun 1, 2018
8fb0157
DOC: Add whatsnew entry for bpo-29235.
Jun 1, 2018
4b8b743
Add missing word.
Jun 2, 2018
84bed55
DOC: Switch from versionadded to versionchanged.
ssanderson Jun 3, 2018
7f32b19
DOC: Remove extra whitespace.
Jun 3, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Doc/library/profile.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,8 @@ functions:

pr.print_stats()

.. versionadded:: 3.8
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this applies to the class definition this isn't accurate since the class isn't new 😉 . I would change this to:

.. versionchanged:: 3.8
   Added context manager support.


.. method:: enable()

Start collecting profiling data.
Expand Down
2 changes: 2 additions & 0 deletions Doc/whatsnew/3.8.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,8 @@ Changes in the Python API
``type.__new__``. A :exc:`DeprecationWarning` was emitted in Python
3.6--3.7. (Contributed by Serhiy Storchaka in :issue:`23722`.)

* The :class:`cProfile.Profile` class can now be used as a context
manager. (Contributed by Scott Sanderson in :issue:`29235`.)

CPython bytecode changes
------------------------
Expand Down
10 changes: 2 additions & 8 deletions Misc/NEWS.d/next/Library/2018-05-14-15-01-55.bpo-29235.47Fzwt.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,2 @@
The :class:`cProfile.Profile` class can now be used as a context manager.
You can profile a block of code by running::

import cProfile
with cProfile.Profile() as profiler:
# ... code to be profiled ...

Patch by Scott Sanderson.
The :class:`cProfile.Profile` class can now be used as a context manager. Patch
by Scott Sanderson.