💾 Archived View for tris.fyi › pydoc › trace captured on 2023-04-26 at 13:32:42. Gemini links have been rewritten to link to archived content

-=-=-=-=-=-=-

trace

program/module to trace Python program or function execution

Sample use, command line:
  trace.py -c -f counts --ignore-dir '$prefix' spam.py eggs
  trace.py -t --ignore-dir '$prefix' spam.py eggs
  trace.py --trackcalls spam.py eggs

Sample use, programmatically
  import sys

  # create a Trace object, telling it what to ignore, and whether to
  # do tracing or line-counting or both.
  tracer = trace.Trace(ignoredirs=[sys.base_prefix, sys.base_exec_prefix,],
                       trace=0, count=1)
  # run the new command using the given tracer
  tracer.run('main()')
  # make a report, placing output in /tmp
  r = tracer.results()
  r.write_results(show_missing=True, coverdir="/tmp")

Classes

CoverageResults

is_ignored_filename(self, filename)

  Return True if the filename does not refer to a file
          we want to have reported.

update(self, other)

  Merge in the data from another CoverageResults

write_results(self, show_missing=True, summary=False, coverdir=None)


          Write the coverage results.

          :param show_missing: Show lines that had no hits.
          :param summary: Include coverage summary per module.
          :param coverdir: If None, the results of each module are placed in its
                           directory, otherwise it is included in the directory
                           specified.

write_results_file(self, path, lines, lnotab, lines_hit, encoding=None)

  Return a coverage results file in path.

Trace

file_module_function_of(self, frame)

globaltrace_countfuncs(self, frame, why, arg)

  Handler for call events.

          Adds (filename, modulename, funcname) to the self._calledfuncs dict.

globaltrace_lt(self, frame, why, arg)

  Handler for call events.

          If the code block being entered is to be ignored, returns `None',
          else returns self.localtrace.

globaltrace_trackcallers(self, frame, why, arg)

  Handler for call events.

          Adds information about who called who to the self._callers dict.

localtrace_count(self, frame, why, arg)

localtrace_trace(self, frame, why, arg)

localtrace_trace_and_count(self, frame, why, arg)

results(self)

run(self, cmd)

runctx(self, cmd, globals=None, locals=None)

runfunc(self, func, /, *args, **kw)

Functions

main

main()

Other members

PRAGMA_NOCOVER = '#pragma NO COVER'

Modules