chore: add typing hints to pytest components

CHANGES.rst

@@ -17,6 +17,7 @@ more performant and the import times are shorter.
 New Features in 24.1
 ~~~~~~~~~~~~~~~~~~~~
 - All components can be installed into the same virtualenv again.
+- The ``pytest`` specific parts of the labgrid framework now have typing hints.
 
 Bug fixes in 24.1
 ~~~~~~~~~~~~~~~~~

labgrid/config.py

@@ -5,6 +5,7 @@
 """
 import os
 import warnings
+from typing import Dict
 from yaml import YAMLError
 import attr
 
@@ -262,7 +263,7 @@ def get_imports(self):
 
         return imports
 
-    def get_paths(self):
+    def get_paths(self) -> Dict[str, str]:
         """Helper function that returns the subdict of all paths
 
         Returns:
@@ -275,7 +276,7 @@ def get_paths(self):
 
         return paths
 
-    def get_images(self):
+    def get_images(self) -> Dict[str, str]:
         """Helper function that returns the subdict of all images
 
         Returns:

labgrid/environment.py

@@ -1,5 +1,5 @@
 import os
-from typing import Optional
+from typing import Callable, Optional
 import attr
 
 from .target import Target
@@ -9,10 +9,10 @@
 @attr.s(eq=False)
 class Environment:
     """An environment encapsulates targets."""
-    config_file = attr.ib(
+    config_file: str = attr.ib(
         default="config.yaml", validator=attr.validators.instance_of(str)
     )
-    interact = attr.ib(default=input, repr=False)
+    interact: Callable[[str], str] = attr.ib(default=input, repr=False)
 
     def __attrs_post_init__(self):
         self.targets = {}

labgrid/logging.py

@@ -17,12 +17,12 @@ def basicConfig(**kwargs):
     root.handlers[0].setFormatter(StepFormatter(indent=indent, parent=parent))
 
 
-logging.CONSOLE = logging.INFO - 5
-assert(logging.CONSOLE > logging.DEBUG)
-logging.addLevelName(logging.CONSOLE, "CONSOLE")
+CONSOLE = logging.INFO - 5
+assert(CONSOLE > logging.DEBUG)
+logging.addLevelName(CONSOLE, "CONSOLE")
 
 # Use composition instead of inheritance
-class StepFormatter:
+class StepFormatter(logging.Formatter):
     def __init__(self, *args, indent=True, color=None, parent=None, **kwargs):
         self.formatter = parent or logging.Formatter(*args, **kwargs)
         self.indent = indent
@@ -106,11 +106,11 @@ def notify(self, event):
 
                 for part in parts:
                     data = self.vt100_replace_cr_nl(part)
-                    logger.log(logging.CONSOLE, self._create_message(event, data), extra=extra)
+                    logger.log(CONSOLE, self._create_message(event, data), extra=extra)
 
             elif state == "start" and step.args and "data" in step.args:
                 data = self.vt100_replace_cr_nl(step.args["data"])
-                logger.log(logging.CONSOLE, self._create_message(event, data), extra=extra)
+                logger.log(CONSOLE, self._create_message(event, data), extra=extra)
 
     def flush(self):
         if self.lastevent is None:
@@ -122,7 +122,7 @@ def flush(self):
         for source, logger in self.loggers.items():
             data = self.vt100_replace_cr_nl(self.bufs[source])
             if data:
-                logger.log(logging.CONSOLE, self._create_message(self.lastevent, data), extra=extra)
+                logger.log(CONSOLE, self._create_message(self.lastevent, data), extra=extra)
             self.bufs[source] = b""
 
 

labgrid/py.typed

@@ -0,0 +1 @@
+partial

labgrid/pytestplugin/__init__.py

@@ -1,2 +1,12 @@
 from .fixtures import pytest_addoption, env, target, strategy
 from .hooks import pytest_configure, pytest_collection_modifyitems, pytest_cmdline_main
+
+__all__ = [
+    "pytest_addoption",
+    "env",
+    "target",
+    "strategy",
+    "pytest_configure",
+    "pytest_collection_modifyitems",
+    "pytest_cmdline_main",
+]

labgrid/pytestplugin/fixtures.py

@@ -1,8 +1,12 @@
 import os
 import subprocess
+from typing import Iterator
+
 import pytest
 
+from .. import Environment, Target
 from ..exceptions import NoResourceFoundError, NoDriverFoundError
+from ..strategy import Strategy
 from ..remote.client import UserError
 from ..resource.remote import RemotePlace
 from ..util.ssh import sshmanager
@@ -12,7 +16,9 @@
 # pylint: disable=redefined-outer-name
 
 
-def pytest_addoption(parser):
+def pytest_addoption(parser: pytest.Parser, pluginmanager: pytest.PytestPluginManager) -> None:
+    del pluginmanager  # unused
+
     group = parser.getgroup('labgrid')
     group.addoption(
         '--env-config',
@@ -57,7 +63,7 @@ def pytest_addoption(parser):
 
 
 @pytest.fixture(scope="session")
-def env(request, record_testsuite_property):
+def env(request: pytest.FixtureRequest, record_testsuite_property) -> Iterator[Environment]:
     """Return the environment configured in the supplied configuration file.
     It contains the targets contained in the configuration file.
     """
@@ -74,7 +80,8 @@ def env(request, record_testsuite_property):
         try:
             target = env.get_target(target_name)
         except UserError as e:
-            pytest.exit(e)
+            pytest.exit(str(e))
+        assert target, "could not get target from environment"
         try:
             remote_place = target.get_resource(RemotePlace, wait_avail=False)
             remote_name = remote_place.name
@@ -117,7 +124,7 @@ def env(request, record_testsuite_property):
 
 
 @pytest.fixture(scope="session")
-def target(env):
+def target(env: Environment) -> Target:
     """Return the default target `main` configured in the supplied
     configuration file."""
     target = env.get_target()
@@ -128,13 +135,13 @@ def target(env):
 
 
 @pytest.fixture(scope="session")
-def strategy(request, target):
+def strategy(request: pytest.FixtureRequest, target: Target) -> Strategy:
     """Return the Strategy of the default target `main` configured in the
     supplied configuration file."""
     try:
-        strategy = target.get_driver("Strategy")
+        strategy: Strategy = target.get_driver("Strategy")
     except NoDriverFoundError as e:
-        pytest.exit(e)
+        pytest.exit(str(e))
 
     state = request.config.option.lg_initial_state
     if state is not None:

labgrid/pytestplugin/hooks.py

@@ -1,19 +1,22 @@
 import os
 import warnings
 import logging
+from typing import List, Optional
+
 import pytest
+from _pytest.logging import ColoredLevelFormatter, LoggingPlugin
 
 from .. import Environment
 from ..consoleloggingreporter import ConsoleLoggingReporter
 from ..util.helper import processwrapper
-from ..logging import StepFormatter, StepLogger
+from ..logging import CONSOLE, StepFormatter, StepLogger
 
-LABGRID_ENV_KEY = pytest.StashKey[Environment]()
+LABGRID_ENV_KEY = pytest.StashKey[Optional[Environment]]()
 
 
 @pytest.hookimpl(tryfirst=True)
-def pytest_cmdline_main(config):
-    def set_cli_log_level(level):
+def pytest_cmdline_main(config: pytest.Config):
+    def set_cli_log_level(level: int):
         nonlocal config
 
         try:
@@ -27,23 +30,26 @@ def set_cli_log_level(level):
                 current_level = int(logging.getLevelName(current_level))
             except ValueError:
                 current_level = None
+        assert current_level is None or isinstance(current_level, int), "unexpected type of current log level"
 
         # If no level was set previously (via ini or cli) or current_level is
         # less verbose than level, set to new level.
         if current_level is None or level < current_level:
             config.option.log_cli_level = str(level)
 
     verbosity = config.getoption("verbose")
+    assert isinstance(verbosity, int), "unexpected verbosity option type"
     if verbosity > 3: # enable with -vvvv
         set_cli_log_level(logging.DEBUG)
     elif verbosity > 2: # enable with -vvv
-        set_cli_log_level(logging.CONSOLE)
+        set_cli_log_level(CONSOLE)
     elif verbosity > 1: # enable with -vv
         set_cli_log_level(logging.INFO)
 
 
-def configure_pytest_logging(config, plugin):
-    plugin.log_cli_handler.formatter.add_color_level(logging.CONSOLE, "blue")
+def configure_pytest_logging(config: pytest.Config, plugin: LoggingPlugin):
+    assert isinstance(plugin.log_cli_handler.formatter, ColoredLevelFormatter), "unexpected type of log_cli_handler.formatter"
+    plugin.log_cli_handler.formatter.add_color_level(CONSOLE, "blue")
     plugin.log_cli_handler.setFormatter(StepFormatter(
         color=config.option.lg_colored_steps,
         parent=plugin.log_cli_handler.formatter,
@@ -61,12 +67,13 @@ def configure_pytest_logging(config, plugin):
     plugin.report_handler.setFormatter(StepFormatter(parent=caplog_formatter))
 
 @pytest.hookimpl(trylast=True)
-def pytest_configure(config):
+def pytest_configure(config: pytest.Config):
     StepLogger.start()
     config.add_cleanup(StepLogger.stop)
 
     logging_plugin = config.pluginmanager.getplugin('logging-plugin')
     if logging_plugin:
+        assert isinstance(logging_plugin, LoggingPlugin), "unexpected type of logging-plugin"
         configure_pytest_logging(config, logging_plugin)
 
     config.addinivalue_line("markers",
@@ -97,9 +104,11 @@ def pytest_configure(config):
     processwrapper.enable_logging()
 
 @pytest.hookimpl()
-def pytest_collection_modifyitems(config, items):
+def pytest_collection_modifyitems(session: pytest.Session, config: pytest.Config, items: List[pytest.Item]):
     """This function matches function feature flags with those found in the
     environment and disables the item if no match is found"""
+    del session  # unused
+
     env = config.stash[LABGRID_ENV_KEY]
 
     if not env:

labgrid/remote/client.py

@@ -46,7 +46,7 @@
 from ..util.proxy import proxymanager
 from ..util.helper import processwrapper
 from ..driver import Mode, ExecutionError
-from ..logging import basicConfig, StepLogger
+from ..logging import basicConfig, CONSOLE, StepLogger
 
 
 class Error(Exception):
@@ -2041,7 +2041,7 @@ def main():
     if args.verbose:
         logging.getLogger().setLevel(logging.INFO)
     if args.verbose > 1:
-        logging.getLogger().setLevel(logging.CONSOLE)
+        logging.getLogger().setLevel(CONSOLE)
     if args.debug or args.verbose > 2:
         logging.getLogger().setLevel(logging.DEBUG)
 

tests/conftest.py

@@ -13,6 +13,8 @@
 
 psutil = pytest.importorskip("psutil")
 
+pytest_plugins = ["pytester"]
+
 @pytest.fixture(scope="session")
 def curses_init():
     """ curses only reads the terminfo DB once on the first import, so make