Description
Describe the bug
When using dynamic_context=test_function, the context is not set if the test function is a @staticmethod or @classmethod.
I believe this is due to the logic of context.qualname_from_frame, which explicitly tests for the presence of a first argument named "self" to detect whether a test function is scoped to a class. Since static and class methods do not tend to have such an argument, they are treated as functions, but because they are not found in f_globals, None is returned by qualname_from_frame and in turn returned by should_start_context_test_function, as if the method was not a test at all.
To Reproduce
Here is a minimal example that demonstrates the problem.
- place the files below alongside each other in some directory
- run
toxin that directory - note that this warning is emitted
CoverageWarning: No contexts were measured self.coverage._warn("No contexts were measured") - observe that the context for the lines of
foo_module.pyare labeled(empty)in the htmlcov report
foo_module.py
def foo_fn():
print('foo')test_foo.py
import foo_module
class TestFoo:
@staticmethod
def test_foo_static():
foo_module.foo_fn()
@classmethod
def test_foo_class(cls):
foo_module.foo_fn().coveragerc
[run]
dynamic_context = test_function
tox.ini
[testenv]
deps =
coverage
pytest
commands =
coverage run -m pytest
coverage html --show-contextsExpected behavior
I would expect to see the contexts TestFoo.test_foo_static and TestFoo.test_foo_class in the htmlcov report, and no warning.
Additional context
Class methods can be covered by adding an explicit test for a first argument named "cls" similar to the existing logic.
Static methods are a little trickier. Python 3.11 adds the co_qualname attribute to frame.f_code, which is exactly what's needed, and solves the problem for me. For older Python versions, the status quo could be improved by simply returning something like staticmethod(test_foo_static).
For example, changing these lines as follows might work. The only caveat is that perhaps there's some other reason you could reach the func is None case.
if method is None:
func = frame.f_globals.get(fname)
if func is None:
try:
return frame.f_code.co_qualname
except AttributeError:
return f"staticmethod({fname})"
return cast(str, func.__module__ + "." + fname)- What version of Python are you using? I've reproduced this on versions 3.8 - 3.13
- What version of coverage.py shows the problem? Coverage.py, version 7.6.10 with C extension. I believe this issue is present in main.
- What versions of what packages do you have installed? See minimal example.
- What code shows the problem? See minimal example.
- What commands should we run to reproduce the problem? See minimal example.