bpo-27902: Add compatibility note to Profile docs (GH-7295)

(cherry picked from commit f7745e1dcb)

Co-authored-by: Tobias Kunze <r@rixx.de>
This commit is contained in:
Miss Islington (bot) 2018-06-04 10:25:37 -07:00 committed by GitHub
parent d2c6ecc234
commit 7548a93274
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 5 deletions

View File

@ -317,11 +317,12 @@ Analysis of the profiler data is done using the :class:`~pstats.Stats` class.
corresponding version of :mod:`profile` or :mod:`cProfile`. To be specific,
there is *no* file compatibility guaranteed with future versions of this
profiler, and there is no compatibility with files produced by other
profilers. If several files are provided, all the statistics for identical
functions will be coalesced, so that an overall view of several processes can
be considered in a single report. If additional files need to be combined
with data in an existing :class:`~pstats.Stats` object, the
:meth:`~pstats.Stats.add` method can be used.
profilers, or the same profiler run on a different operating system. If
several files are provided, all the statistics for identical functions will
be coalesced, so that an overall view of several processes can be considered
in a single report. If additional files need to be combined with data in an
existing :class:`~pstats.Stats` object, the :meth:`~pstats.Stats.add` method
can be used.
Instead of reading the profile data from a file, a :class:`cProfile.Profile`
or :class:`profile.Profile` object can be used as the profile data source.