Re: [Qemu-devel] [PATCH v3 15/18] trace: rename _read_events to read_events

["Lluís Vilanova" <vilanova@ac.upc.edu>]

Daniel P Berrange writes:

> The _read_events method is used by callers outside of
> its module, so should be a public method, not private.

> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>


Reviewed-by: Lluís Vilanova <vilanova@ac.upc.edu>


> ---
>  scripts/simpletrace.py        |  6 +++---
>  scripts/tracetool/__init__.py | 14 ++++++++++++--
>  2 files changed, 15 insertions(+), 5 deletions(-)

> diff --git a/scripts/simpletrace.py b/scripts/simpletrace.py
> index 98abb7a..5dc71d3 100755
> --- a/scripts/simpletrace.py
> +++ b/scripts/simpletrace.py
> @@ -12,7 +12,7 @@
>  import struct
>  import re
>  import inspect
> -from tracetool import _read_events, Event
> +from tracetool import read_events, Event
>  from tracetool.backend.simple import is_string
 
>  header_event_id = 0xffffffffffffffff
> @@ -128,7 +128,7 @@ class Analyzer(object):
>  def process(events, log, analyzer, read_header=True):
>      """Invoke an analyzer on each event in a log."""
>      if isinstance(events, str):
> -        events = _read_events(open(events, 'r'))
> +        events = read_events(open(events, 'r'))
>      if isinstance(log, str):
>          log = open(log, 'rb')
 
> @@ -187,7 +187,7 @@ def run(analyzer):
>                           '<trace-file>\n' % sys.argv[0])
>          sys.exit(1)
 
> -    events = _read_events(open(sys.argv[1], 'r'))
> +    events = read_events(open(sys.argv[1], 'r'))
>      process(events, sys.argv[2], analyzer, read_header=read_header)
 
>  if __name__ == '__main__':
> diff --git a/scripts/tracetool/__init__.py b/scripts/tracetool/__init__.py
> index 5191df9..1bb3886 100644
> --- a/scripts/tracetool/__init__.py
> +++ b/scripts/tracetool/__init__.py
> @@ -281,7 +281,17 @@ class Event(object):
>                       self)
 
 
> -def _read_events(fobj):
> +def read_events(fobj):
> +    """Generate the output for the given (format, backends) pair.
> +
> +    Parameters
> +    ----------
> +    fobj : file
> +        Event description file.
> +
> +    Returns a list of Event objects
> +    """
> +
>      events = []
>      for line in fobj:
>          if not line.strip():
> @@ -390,6 +400,6 @@ def generate(fevents, format, backends,
>      tracetool.backend.dtrace.BINARY = binary
>      tracetool.backend.dtrace.PROBEPREFIX = probe_prefix
 
> -    events = _read_events(fevents)
> +    events = read_events(fevents)
 
>      tracetool.format.generate(events, format, backend)
> -- 
> 2.7.4