python-nose/doc/plugin_cover.html at 160-jython · purepython/python-nose

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

<html>

<head>

<title>nose: builtin plugin: cover</title>

</head>

<body>

This document covers nose version 0.10.1

Last update: Fri Jan 4 10:06:23 2008

<h2>Plugins</h2><ul><li><a href="plugin_attrib.html">Builtin Plugin: attrib</a></li><li><a href="plugin_capture.html">Builtin Plugin: capture</a></li><li><a href="plugin_cover.html">Builtin Plugin: cover</a></li><li><a href="plugin_debug.html">Builtin Plugin: debug</a></li><li><a href="plugin_deprecated.html">Builtin Plugin: deprecated</a></li><li><a href="plugin_doctests.html">Builtin Plugin: doctests</a></li><li><a href="plugin_failuredetail.html">Builtin Plugin: failuredetail</a></li><li><a href="plugin_isolate.html">Builtin Plugin: isolate</a></li><li><a href="plugin_prof.html">Builtin Plugin: prof</a></li><li><a href="plugin_skip.html">Builtin Plugin: skip</a></li><li><a href="plugin_testid.html">Builtin Plugin: testid</a></li><li><a href="error_class_plugin.html">ErrorClass Plugins</a></li><li><a href="plugin_interface.html">Plugin Interface</a></li><li><a href="writing_plugins.html">Writing Plugins</a></li></ul><h2>Modules</h2><ul><li><a href="module_nose.case.html">Module: nose.case</a></li><li><a href="module_nose.commands.html">Module: nose.commands</a></li><li><a href="module_nose.config.html">Module: nose.config</a></li><li><a href="module_nose.core.html">Module: nose.core</a></li><li><a href="module_nose.exc.html">Module: nose.exc</a></li><li><a href="module_nose.importer.html">Module: nose.importer</a></li><li><a href="module_nose.inspector.html">Module: nose.inspector</a></li><li><a href="module_nose.loader.html">Module: nose.loader</a></li><li><a href="module_nose.plugins.manager.html">Module: nose.plugins.manager</a></li><li><a href="module_nose.plugins.plugintest.html">Module: nose.plugins.plugintest</a></li><li><a href="module_nose.proxy.html">Module: nose.proxy</a></li><li><a href="module_nose.result.html">Module: nose.result</a></li><li><a href="module_nose.selector.html">Module: nose.selector</a></li><li><a href="module_nose.suite.html">Module: nose.suite</a></li><li><a href="module_nose.tools.html">Module: nose.tools</a></li><li><a href="module_nose.twistedtools.html">Module: nose.twistedtools</a></li><li><a href="module_nose.util.html">Module: nose.util</a></li></ul><h2>Plugin Examples</h2><ul><li><a href="unwanted_package.html">Excluding Unwanted Packages</a></li><li><a href="empty_plugin.html">Minimal plugin</a></li><li><a href="init_plugin.html">Running Initialization Code Before the Test Run</a></li><li><a href="selector_plugin.html">Using a Custom Selector</a></li><li><a href="plugin_exceptions.html">When Plugins Fail</a></li><li><a href="plugintest_environment.html">nose.plugins.plugintest, os.environ and sys.argv</a></li></ul>

</div>

<h1>nose: builtin plugin: cover</h1>

If you have Ned Batchelder's <a class="reference" href="http://www.nedbatchelder.com/code/modules/coverage.html">coverage</a> module installed, you may activate a

coverage report with the --with-coverage switch or NOSE_WITH_COVERAGE

environment variable. The coverage report will cover any python source module

imported after the start of the test run, excluding modules that match

testMatch. If you want to include those modules too, use the --cover-tests

switch, or set the NOSE_COVER_TESTS environment variable to a true value. To

restrict the coverage report to modules from a particular package or packages,

use the --cover-packages switch or the NOSE_COVER_PACKAGES environment

variable.

<h2>Plugin Methods Implemented</h2>

This plugin implements the following plugin interface methods:

<ul><li><a href="plugin_interface.html#begin">begin</a></li><li><a href="plugin_interface.html#configure">configure</a></li><li><a href="plugin_interface.html#options">options</a></li><li><a href="plugin_interface.html#report">report</a></li><li><a href="plugin_interface.html#wantFile">wantFile</a></li></ul>

<h2>Commandline Options</h2>

This plugin adds the following commandline options:

<pre>Options:

--with-coverage Enable plugin Coverage: If you have Ned Batchelder's

coverage module installed, you may activate a coverage

report. The coverage report will cover any python

source module imported after the start of the test

run, excluding modules that match testMatch. If you

want to include those modules too, use the --cover-

tests switch, or set the NOSE_COVER_TESTS environment

variable to a true value. To restrict the coverage

report to modules from a particular package or

packages, use the --cover-packages switch or the

NOSE_COVER_PACKAGES environment variable.

[NOSE_WITH_COVERAGE]

--cover-package=COVER_PACKAGES

Restrict coverage output to selected packages

[NOSE_COVER_PACKAGE]

--cover-erase Erase previously collected coverage statistics before

run

--cover-tests Include test modules in coverage report

[NOSE_COVER_TESTS]

--cover-inclusive Include all python files under working directory in

coverage report. Useful for discovering holes in test

coverage if not all files are imported by the test

suite. [NOSE_COVER_INCLUSIVE]

</pre>

<h2>Source</h2>

<div class="highlight"><pre>"""If you have Ned Batchelder's coverage_ module installed, you may activate a

coverage report with the --with-coverage switch or NOSE_WITH_COVERAGE

environment variable. The coverage report will cover any python source module

imported after the start of the test run, excluding modules that match

testMatch. If you want to include those modules too, use the --cover-tests

switch, or set the NOSE_COVER_TESTS environment variable to a true value. To

restrict the coverage report to modules from a particular package or packages,

use the --cover-packages switch or the NOSE_COVER_PACKAGES environment

variable.

.. _coverage: http://www.nedbatchelder.com/code/modules/coverage.html

"""

import logging

import os

import sys

from nose.plugins.base import Plugin

from nose.util import tolist

log = logging.getLogger(__name__)

class Coverage(Plugin):

"""

If you have Ned Batchelder's coverage module installed, you may

activate a coverage report. The coverage report will cover any

python source module imported after the start of the test run, excluding

modules that match testMatch. If you want to include those modules too,

use the --cover-tests switch, or set the NOSE_COVER_TESTS environment

variable to a true value. To restrict the coverage report to modules from

a particular package or packages, use the --cover-packages switch or the

NOSE_COVER_PACKAGES environment variable.

"""

coverTests = False

coverPackages = None

def options(self, parser, env=os.environ):

Plugin.options(self, parser, env)

parser.add_option("--cover-package", action="append",

default=env.get('NOSE_COVER_PACKAGE'),

dest="cover_packages",

help="Restrict coverage output to selected packages "

"[NOSE_COVER_PACKAGE]")

parser.add_option("--cover-erase", action="store_true",

dest="cover_erase",

help="Erase previously collected coverage "

"statistics before run")

parser.add_option("--cover-tests", action="store_true",

dest="cover_tests",

help="Include test modules in coverage report "

"[NOSE_COVER_TESTS]")

parser.add_option("--cover-inclusive", action="store_true",

dest="cover_inclusive",

help="Include all python files under working "

"directory in coverage report. Useful for "

"discovering holes in test coverage if not all "

"files are imported by the test suite. "

"[NOSE_COVER_INCLUSIVE]")

def configure(self, options, config):

Plugin.configure(self, options, config)

if self.enabled:

try:

import coverage

except ImportError:

log.error("Coverage not available: "

"unable to import coverage module")

self.enabled = False

return

self.conf = config

self.coverErase = options.cover_erase

self.coverTests = options.cover_tests

self.coverPackages = []

if options.cover_packages:

for pkgs in [tolist(x) for x in options.cover_packages]:

self.coverPackages.extend(pkgs)

self.coverInclusive = options.cover_inclusive

if self.coverPackages:

log.info("Coverage report will include only packages: %s",

self.coverPackages)

def begin(self):

log.debug("Coverage begin")

import coverage

self.skipModules = sys.modules.keys()[:]

if self.coverErase:

log.debug("Clearing previously collected coverage statistics")

coverage.erase()

coverage.exclude('#pragma[: ]+[nN][oO] [cC][oO][vV][eE][rR]')

coverage.start()

def report(self, stream):

log.debug("Coverage report")

import coverage

coverage.stop()

modules = [ module

for name, module in sys.modules.items()

if self.wantModuleCoverage(name, module) ]

log.debug("Coverage report will cover modules: %s", modules)

coverage.report(modules, file=stream)

def wantModuleCoverage(self, name, module):

if not hasattr(module, '__file__'):

log.debug("no coverage of %s: no __file__", name)

return False

root, ext = os.path.splitext(module.__file__)

if not ext in ('.py', '.pyc', '.pyo'):

log.debug("no coverage of %s: not a python file", name)

return False

if self.coverPackages:

for package in self.coverPackages:

if (name.startswith(package)

and (self.coverTests

or not self.conf.testMatch.search(name))):

log.debug("coverage for %s", name)

return True

if name in self.skipModules:

log.debug("no coverage for %s: loaded before coverage start",

name)

return False

if self.conf.testMatch.search(name) and not self.coverTests:

log.debug("no coverage for %s: is a test", name)

return False

# accept any package that passed the previous tests, unless

# coverPackages is on -- in that case, if we wanted this

# module, we would have already returned True

return not self.coverPackages

def wantFile(self, file, package=None):

"""If inclusive coverage enabled, return true for all source files

in wanted packages.

"""

if self.coverInclusive:

if file.endswith(".py"):

if package and self.coverPackages:

for want in self.coverPackages:

if package.startswith(want):

return True

else:

return True

return None

</pre></div>

</div>

type="text/javascript">

</script>

_uacct = "UA-2236166-1";

urchinTracker();

</script>

</body>

</html>

FilesExpand file tree

plugin_cover.html

Latest commit

History

plugin_cover.html

File metadata and controls