129 lines
4.5 KiB
Python
129 lines
4.5 KiB
Python
""" version info, help messages, tracing configuration. """
|
|
import py
|
|
import pytest
|
|
import os, sys
|
|
|
|
def pytest_addoption(parser):
|
|
group = parser.getgroup('debugconfig')
|
|
group.addoption('--version', action="store_true",
|
|
help="display pytest lib version and import information.")
|
|
group._addoption("-h", "--help", action="store_true", dest="help",
|
|
help="show help message and configuration info")
|
|
group._addoption('-p', action="append", dest="plugins", default = [],
|
|
metavar="name",
|
|
help="early-load given plugin (multi-allowed). "
|
|
"To avoid loading of plugins, use the `no:` prefix, e.g. "
|
|
"`no:doctest`.")
|
|
group.addoption('--traceconfig', '--trace-config',
|
|
action="store_true", default=False,
|
|
help="trace considerations of conftest.py files."),
|
|
group.addoption('--debug',
|
|
action="store_true", dest="debug", default=False,
|
|
help="store internal tracing debug information in 'pytestdebug.log'.")
|
|
|
|
|
|
def pytest_cmdline_parse(__multicall__):
|
|
config = __multicall__.execute()
|
|
if config.option.debug:
|
|
path = os.path.abspath("pytestdebug.log")
|
|
f = open(path, 'w')
|
|
config._debugfile = f
|
|
f.write("versions pytest-%s, py-%s, python-%s\ncwd=%s\nargs=%s\n\n" %(
|
|
pytest.__version__, py.__version__, ".".join(map(str, sys.version_info)),
|
|
os.getcwd(), config._origargs))
|
|
config.pluginmanager.set_tracing(f.write)
|
|
sys.stderr.write("writing pytestdebug information to %s\n" % path)
|
|
return config
|
|
|
|
@pytest.mark.trylast
|
|
def pytest_unconfigure(config):
|
|
if hasattr(config, '_debugfile'):
|
|
config._debugfile.close()
|
|
sys.stderr.write("wrote pytestdebug information to %s\n" %
|
|
config._debugfile.name)
|
|
config.trace.root.setwriter(None)
|
|
|
|
|
|
def pytest_cmdline_main(config):
|
|
if config.option.version:
|
|
p = py.path.local(pytest.__file__)
|
|
sys.stderr.write("This is pytest version %s, imported from %s\n" %
|
|
(pytest.__version__, p))
|
|
plugininfo = getpluginversioninfo(config)
|
|
if plugininfo:
|
|
for line in plugininfo:
|
|
sys.stderr.write(line + "\n")
|
|
return 0
|
|
elif config.option.help:
|
|
config.do_configure()
|
|
showhelp(config)
|
|
config.do_unconfigure()
|
|
return 0
|
|
|
|
def showhelp(config):
|
|
tw = py.io.TerminalWriter()
|
|
tw.write(config._parser.optparser.format_help())
|
|
tw.line()
|
|
tw.line()
|
|
#tw.sep( "=", "config file settings")
|
|
tw.line("[pytest] ini-options in the next "
|
|
"pytest.ini|tox.ini|setup.cfg file:")
|
|
tw.line()
|
|
|
|
for name in config._parser._ininames:
|
|
help, type, default = config._parser._inidict[name]
|
|
if type is None:
|
|
type = "string"
|
|
spec = "%s (%s)" % (name, type)
|
|
line = " %-24s %s" %(spec, help)
|
|
tw.line(line[:tw.fullwidth])
|
|
|
|
tw.line() ; tw.line()
|
|
#tw.sep("=")
|
|
tw.line("to see available markers type: py.test --markers")
|
|
tw.line("to see available fixtures type: py.test --fixtures")
|
|
tw.line("(shown according to specified file_or_dir or current dir "
|
|
"if not specified)")
|
|
for warning in config.pluginmanager._warnings:
|
|
tw.line("warning: %s" % (warning,), red=True)
|
|
return
|
|
|
|
|
|
conftest_options = [
|
|
('pytest_plugins', 'list of plugin names to load'),
|
|
]
|
|
|
|
def getpluginversioninfo(config):
|
|
lines = []
|
|
plugininfo = config.pluginmanager._plugin_distinfo
|
|
if plugininfo:
|
|
lines.append("setuptools registered plugins:")
|
|
for dist, plugin in plugininfo:
|
|
loc = getattr(plugin, '__file__', repr(plugin))
|
|
content = "%s-%s at %s" % (dist.project_name, dist.version, loc)
|
|
lines.append(" " + content)
|
|
return lines
|
|
|
|
def pytest_report_header(config):
|
|
lines = []
|
|
if config.option.debug or config.option.traceconfig:
|
|
lines.append("using: pytest-%s pylib-%s" %
|
|
(pytest.__version__,py.__version__))
|
|
|
|
verinfo = getpluginversioninfo(config)
|
|
if verinfo:
|
|
lines.extend(verinfo)
|
|
|
|
if config.option.traceconfig:
|
|
lines.append("active plugins:")
|
|
items = config.pluginmanager._name2plugin.items()
|
|
for name, plugin in items:
|
|
if hasattr(plugin, '__file__'):
|
|
r = plugin.__file__
|
|
else:
|
|
r = repr(plugin)
|
|
lines.append(" %-20s: %s" %(name, r))
|
|
return lines
|
|
|
|
|