Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog/6802.bugfix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The :fixture:`testdir fixture <testdir>` works within doctests now.
17 changes: 16 additions & 1 deletion src/_pytest/nodes.py
Original file line number Diff line number Diff line change
Expand Up @@ -548,14 +548,29 @@ class Item(Node):

nextitem = None

def __init__(self, name, parent=None, config=None, session=None, nodeid=None):
def __init__(
self,
name,
parent=None,
config=None,
session=None,
nodeid=None,
*,
originalname: str = None
):
super().__init__(name, parent, config, session, nodeid=nodeid)
self._report_sections = [] # type: List[Tuple[str, str, str]]

#: user properties is a list of tuples (name, value) that holds user
#: defined properties for this test.
self.user_properties = [] # type: List[Tuple[str, Any]]

#: Original function name, without any decorations (for example
#: parametrization adds a ``"[...]"`` suffix to function names).
#:
#: .. versionadded:: 3.0
self.originalname = originalname

def runtest(self) -> None:
raise NotImplementedError("runtest must be implemented by Item subclass")

Expand Down
9 changes: 4 additions & 5 deletions src/_pytest/pytester/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -599,7 +599,7 @@ def __init__(self, request: FixtureRequest, tmpdir_factory: TempdirFactory) -> N
self._mod_collections = (
WeakKeyDictionary()
) # type: WeakKeyDictionary[Module, List[Union[Item, Collector]]]
name = request.function.__name__
name = self._name = request.node.originalname or request.node.name
self.tmpdir = tmpdir_factory.mktemp(name, numbered=True) # type: py.path.local
"""The base temporary directory.

Expand Down Expand Up @@ -675,9 +675,8 @@ def to_text(s):
return s.decode(encoding) if isinstance(s, bytes) else str(s)

if lines:
funcname = self.request.function.__name__ # type: str
lines = "\n".join(to_text(x) for x in lines)
items.insert(0, (funcname, lines))
items.insert(0, (self._name, lines))

if not items:
raise ValueError("no files to create")
Expand Down Expand Up @@ -872,7 +871,7 @@ def copy_example(self, name=None):
example_dir = example_dir.join(*extra_element.args)

if name is None:
func_name = self.request.function.__name__
func_name = self._name
maybe_dir = example_dir / func_name
maybe_file = example_dir / (func_name + ".py")

Expand Down Expand Up @@ -1256,7 +1255,7 @@ def getmodulecol(self, source, configargs=(), withinit=False):
path = self.tmpdir.join(str(source))
assert not withinit, "not supported for paths"
else:
kw = {self.request.function.__name__: Source(source).strip()}
kw = {self._name: Source(source).strip()}
path = self.makepyfile(**kw)
if withinit:
self.makepyfile(__init__="#")
Expand Down
10 changes: 3 additions & 7 deletions src/_pytest/python.py
Original file line number Diff line number Diff line change
Expand Up @@ -1411,7 +1411,9 @@ def __init__(
fixtureinfo: Optional[FuncFixtureInfo] = None,
originalname=None,
) -> None:
super().__init__(name, parent, config=config, session=session)
super().__init__(
name, parent, config=config, session=session, originalname=originalname
)
self._args = args
if callobj is not NOTSET:
self.obj = callobj
Expand Down Expand Up @@ -1450,12 +1452,6 @@ def __init__(
self.fixturenames = fixtureinfo.names_closure
self._initrequest()

#: original function name, without any decorations (for example
#: parametrization adds a ``"[...]"`` suffix to function names).
#:
#: .. versionadded:: 3.0
self.originalname = originalname

@classmethod
def from_parent(cls, parent, **kw): # todo: determine sound type limitations
"""
Expand Down
23 changes: 23 additions & 0 deletions testing/test_pytester.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,29 @@ def test_hello(testdir):
result.assert_outcomes(passed=1)


def test_testdir_with_doctest(testdir: "Testdir") -> None:
"""Check that testdir can be used within doctests.

It used to use `request.function`, which is `None` with doctests."""
testdir.makepyfile(
**{
"sub/t-doctest.py": """
'''
>>> import os
>>> testdir = getfixture("testdir")
>>> str(testdir.makepyfile("content")).replace(os.sep, '/')
'.../basetemp/sub.t-doctest0/sub.py'
'''
""",
"sub/__init__.py": "",
}
)
result = testdir.runpytest(
"-p", "pytester", "--doctest-modules", "sub/t-doctest.py"
)
assert result.ret == 0


def test_runresult_assertion_on_xfail(testdir) -> None:
testdir.makepyfile(
"""
Expand Down