PEP 454: rename Snapshot.apply_filters() to Snapshot.filter_traces()

This commit is contained in:
Victor Stinner 2013-11-12 13:38:36 +01:00
parent c29cc79166
commit 4f669af9ab
1 changed files with 12 additions and 12 deletions

View File

@ -284,18 +284,6 @@ Snapshot
The ``take_snapshot()`` function creates a snapshot instance.
``apply_filters(filters)`` method:
Create a new ``Snapshot`` instance with a filtered ``traces``
sequence, *filters* is a list of ``Filter`` instances. If *filters*
is an empty list, return a new ``Snapshot`` instance with a copy of
the traces.
All inclusive filters are applied at once, a trace is ignored if no
inclusive filters match it. A trace is ignored if at least one
exclusive filter matchs it.
``compare_to(old_snapshot: Snapshot, group_by: str, cumulative: bool=False)`` method:
Compute the differences with an old snapshot. Get statistics as a
@ -317,6 +305,18 @@ Snapshot
Use ``load()`` to reload the snapshot.
``filter_traces(filters)`` method:
Create a new ``Snapshot`` instance with a filtered ``traces``
sequence, *filters* is a list of ``Filter`` instances. If *filters*
is an empty list, return a new ``Snapshot`` instance with a copy of
the traces.
All inclusive filters are applied at once, a trace is ignored if no
inclusive filters match it. A trace is ignored if at least one
exclusive filter matchs it.
``load(filename)`` classmethod:
Load a snapshot from a file.