~dkuhlman/python-training-materials/Materials

.. class:: Trace([count=1[, trace=1[, countfuncs=0[, countcallers=0[, ignoremods=()[, ignoredirs=()[, infile=None[, outfile=None[, timing=False]]]]]]]]])

134

135

Create an object to trace execution of a single statement or expression. All

136

parameters are optional. *count* enables counting of line numbers. *trace*

137

enables line execution tracing. *countfuncs* enables listing of the

138

functions called during the run. *countcallers* enables call relationship

139

tracking. *ignoremods* is a list of modules or packages to ignore.

140

*ignoredirs* is a list of directories whose modules or packages should be

141

ignored. *infile* is the name of the file from which to read stored count

142

information. *outfile* is the name of the file in which to write updated

143

count information. *timing* enables a timestamp relative to when tracing was

144

started to be displayed.

145

146

.. method:: run(cmd)

147

148

Execute the command and gather statistics from the execution with

149

the current tracing parameters. *cmd* must be a string or code object,

150

suitable for passing into :func:`exec`.

151

152

.. method:: runctx(cmd, globals=None, locals=None)

153

154

Execute the command and gather statistics from the execution with the

155

current tracing parameters, in the defined global and local

156

environments. If not defined, *globals* and *locals* default to empty

157

dictionaries.

158

159

.. method:: runfunc(func, *args, **kwds)

160

161

Call *func* with the given arguments under control of the :class:`Trace`

162

object with the current tracing parameters.

163

164

.. method:: results()

165

166

Return a :class:`CoverageResults` object that contains the cumulative

167

results of all previous calls to ``run``, ``runctx`` and ``runfunc``

168

for the given :class:`Trace` instance. Does not reset the accumulated

169

trace results.

170

171

.. class:: CoverageResults

172

173

A container for coverage results, created by :meth:`Trace.results`. Should

174

not be created directly by the user.

175

176

.. method:: update(other)

177

178

Merge in data from another :class:`CoverageResults` object.

179

180

.. method:: write_results([show_missing=True[, summary=False[, coverdir=None]]])

181

182

Write coverage results. Set *show_missing* to show lines that had no

183

hits. Set *summary* to include in the output the coverage summary per

184

module. *coverdir* specifies the directory into which the coverage

185

result files will be output. If ``None``, the results for each source

186

file are placed in its directory.

187

188

A simple example demonstrating the use of the programmatic interface::

189

190

import sys

191

import trace

192

193

# create a Trace object, telling it what to ignore, and whether to

194

# do tracing or line-counting or both.

195

tracer = trace.Trace(

196

ignoredirs=[sys.prefix, sys.exec_prefix],

197

trace=0,

198

count=1)

199

200

# run the new command using the given tracer

201

tracer.run('main()')

202

203

# make a report, placing output in the current directory

204

r = tracer.results()

205

r.write_results(show_missing=True, coverdir=".")

206

Older »