Apply review suggestions: use a simple struct for invocation params
This commit is contained in:
parent
3e669a262a
commit
6a9bf2852a
|
@ -8,7 +8,9 @@ import sys
|
||||||
import types
|
import types
|
||||||
import warnings
|
import warnings
|
||||||
from functools import lru_cache
|
from functools import lru_cache
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import attr
|
||||||
import py
|
import py
|
||||||
from packaging.version import Version
|
from packaging.version import Version
|
||||||
from pluggy import HookimplMarker
|
from pluggy import HookimplMarker
|
||||||
|
@ -70,8 +72,6 @@ def main(args=None, plugins=None):
|
||||||
tw.line(line.rstrip(), red=True)
|
tw.line(line.rstrip(), red=True)
|
||||||
return 4
|
return 4
|
||||||
else:
|
else:
|
||||||
config.invocation_args = args
|
|
||||||
config.invocation_plugins = plugins
|
|
||||||
try:
|
try:
|
||||||
return config.hook.pytest_cmdline_main(config=config)
|
return config.hook.pytest_cmdline_main(config=config)
|
||||||
finally:
|
finally:
|
||||||
|
@ -149,10 +149,15 @@ builtin_plugins = set(default_plugins)
|
||||||
builtin_plugins.add("pytester")
|
builtin_plugins.add("pytester")
|
||||||
|
|
||||||
|
|
||||||
def get_config(args=None):
|
def get_config(args=None, plugins=None):
|
||||||
# subsequent calls to main will create a fresh instance
|
# subsequent calls to main will create a fresh instance
|
||||||
pluginmanager = PytestPluginManager()
|
pluginmanager = PytestPluginManager()
|
||||||
config = Config(pluginmanager)
|
config = Config(
|
||||||
|
pluginmanager,
|
||||||
|
invocation_params=Config.InvocationParams(
|
||||||
|
args=args, plugins=plugins, dir=Path().resolve()
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
if args is not None:
|
if args is not None:
|
||||||
# Handle any "-p no:plugin" args.
|
# Handle any "-p no:plugin" args.
|
||||||
|
@ -185,7 +190,7 @@ def _prepareconfig(args=None, plugins=None):
|
||||||
msg = "`args` parameter expected to be a list or tuple of strings, got: {!r} (type: {})"
|
msg = "`args` parameter expected to be a list or tuple of strings, got: {!r} (type: {})"
|
||||||
raise TypeError(msg.format(args, type(args)))
|
raise TypeError(msg.format(args, type(args)))
|
||||||
|
|
||||||
config = get_config(args)
|
config = get_config(args, plugins)
|
||||||
pluginmanager = config.pluginmanager
|
pluginmanager = config.pluginmanager
|
||||||
try:
|
try:
|
||||||
if plugins:
|
if plugins:
|
||||||
|
@ -617,20 +622,36 @@ class Config:
|
||||||
|
|
||||||
:ivar argparse.Namespace option: access to command line option as attributes.
|
:ivar argparse.Namespace option: access to command line option as attributes.
|
||||||
|
|
||||||
:ivar invocation_args: list of command-line arguments as passed to pytest.main()
|
:ivar InvocationParams invocation_params:
|
||||||
|
|
||||||
:ivar invocation_plugins: list of extra plugins passed to pytest.main(), might be None
|
Object containing the parameters regarding the ``pytest.main``
|
||||||
|
invocation.
|
||||||
|
|
||||||
:ivar py.path.local invocation_dir: directory where pytest.main() was invoked from
|
Contains the followinig read-only attributes:
|
||||||
|
|
||||||
|
* ``args``: list of command-line arguments as passed to ``pytest.main()``.
|
||||||
|
* ``plugins``: list of extra plugins, might be None
|
||||||
|
* ``dir``: directory where ``pytest.main()`` was invoked from.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self, pluginmanager):
|
@attr.s(frozen=True)
|
||||||
|
class InvocationParams:
|
||||||
|
"""Holds parameters passed during ``pytest.main()``"""
|
||||||
|
|
||||||
|
args = attr.ib()
|
||||||
|
plugins = attr.ib()
|
||||||
|
dir = attr.ib()
|
||||||
|
|
||||||
|
def __init__(self, pluginmanager, *, invocation_params=None):
|
||||||
from .argparsing import Parser, FILE_OR_DIR
|
from .argparsing import Parser, FILE_OR_DIR
|
||||||
|
|
||||||
|
if invocation_params is None:
|
||||||
|
invocation_params = self.InvocationParams(
|
||||||
|
args=(), plugins=None, dir=Path().resolve()
|
||||||
|
)
|
||||||
|
|
||||||
self.option = argparse.Namespace()
|
self.option = argparse.Namespace()
|
||||||
self.invocation_args = None
|
self.invocation_params = invocation_params
|
||||||
self.invocation_plugins = None
|
|
||||||
self.invocation_dir = py.path.local()
|
|
||||||
|
|
||||||
_a = FILE_OR_DIR
|
_a = FILE_OR_DIR
|
||||||
self._parser = Parser(
|
self._parser = Parser(
|
||||||
|
@ -648,6 +669,11 @@ class Config:
|
||||||
self._configured = False
|
self._configured = False
|
||||||
self.hook.pytest_addoption.call_historic(kwargs=dict(parser=self._parser))
|
self.hook.pytest_addoption.call_historic(kwargs=dict(parser=self._parser))
|
||||||
|
|
||||||
|
@property
|
||||||
|
def invocation_dir(self):
|
||||||
|
"""Backward compatibility"""
|
||||||
|
return py.path.local(str(self.invocation_params.dir))
|
||||||
|
|
||||||
def add_cleanup(self, func):
|
def add_cleanup(self, func):
|
||||||
""" Add a function to be called when the config object gets out of
|
""" Add a function to be called when the config object gets out of
|
||||||
use (usually coninciding with pytest_unconfigure)."""
|
use (usually coninciding with pytest_unconfigure)."""
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
import sys
|
import sys
|
||||||
import textwrap
|
import textwrap
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
import _pytest._code
|
import _pytest._code
|
||||||
import pytest
|
import pytest
|
||||||
|
@ -1212,9 +1213,10 @@ def test_invocation_arguments(testdir):
|
||||||
call = calls[0]
|
call = calls[0]
|
||||||
config = call.item.config
|
config = call.item.config
|
||||||
|
|
||||||
assert config.invocation_args == [p, "-v"]
|
assert config.invocation_params.args == [p, "-v"]
|
||||||
|
assert config.invocation_params.dir == Path(testdir.tmpdir)
|
||||||
|
|
||||||
plugins = config.invocation_plugins
|
plugins = config.invocation_params.plugins
|
||||||
assert len(plugins) == 2
|
assert len(plugins) == 2
|
||||||
assert plugins[0] is plugin
|
assert plugins[0] is plugin
|
||||||
assert type(plugins[1]).__name__ == "Collect" # installed by testdir.inline_run()
|
assert type(plugins[1]).__name__ == "Collect" # installed by testdir.inline_run()
|
||||||
|
|
Loading…
Reference in New Issue