Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

""" support for providing temporary directories to test functions. """ 

from __future__ import absolute_import 

from __future__ import division 

from __future__ import print_function 

 

import os 

import re 

import tempfile 

import warnings 

 

import attr 

import py 

import six 

 

import pytest 

from .pathlib import ensure_reset_dir 

from .pathlib import LOCK_TIMEOUT 

from .pathlib import make_numbered_dir 

from .pathlib import make_numbered_dir_with_cleanup 

from .pathlib import Path 

from _pytest.monkeypatch import MonkeyPatch 

 

 

@attr.s 

class TempPathFactory(object): 

"""Factory for temporary directories under the common base temp directory. 

 

The base directory can be configured using the ``--basetemp`` option.""" 

 

_given_basetemp = attr.ib( 

# using os.path.abspath() to get absolute path instead of resolve() as it 

# does not work the same in all platforms (see #4427) 

# Path.absolute() exists, but it is not public (see https://bugs.python.org/issue25012) 

convert=attr.converters.optional( 

lambda p: Path(os.path.abspath(six.text_type(p))) 

) 

) 

_trace = attr.ib() 

_basetemp = attr.ib(default=None) 

 

@classmethod 

def from_config(cls, config): 

""" 

:param config: a pytest configuration 

""" 

return cls( 

given_basetemp=config.option.basetemp, trace=config.trace.get("tmpdir") 

) 

 

def mktemp(self, basename, numbered=True): 

"""makes a temporary directory managed by the factory""" 

if not numbered: 

p = self.getbasetemp().joinpath(basename) 

p.mkdir() 

else: 

p = make_numbered_dir(root=self.getbasetemp(), prefix=basename) 

self._trace("mktemp", p) 

return p 

 

def getbasetemp(self): 

""" return base temporary directory. """ 

if self._basetemp is None: 

if self._given_basetemp is not None: 

basetemp = self._given_basetemp 

ensure_reset_dir(basetemp) 

basetemp = basetemp.resolve() 

else: 

from_env = os.environ.get("PYTEST_DEBUG_TEMPROOT") 

temproot = Path(from_env or tempfile.gettempdir()).resolve() 

user = get_user() or "unknown" 

# use a sub-directory in the temproot to speed-up 

# make_numbered_dir() call 

rootdir = temproot.joinpath("pytest-of-{}".format(user)) 

rootdir.mkdir(exist_ok=True) 

basetemp = make_numbered_dir_with_cleanup( 

prefix="pytest-", root=rootdir, keep=3, lock_timeout=LOCK_TIMEOUT 

) 

assert basetemp is not None 

self._basetemp = t = basetemp 

self._trace("new basetemp", t) 

return t 

else: 

return self._basetemp 

 

 

@attr.s 

class TempdirFactory(object): 

""" 

backward comptibility wrapper that implements 

:class:``py.path.local`` for :class:``TempPathFactory`` 

""" 

 

_tmppath_factory = attr.ib() 

 

def ensuretemp(self, string, dir=1): 

""" (deprecated) return temporary directory path with 

the given string as the trailing part. It is usually 

better to use the 'tmpdir' function argument which 

provides an empty unique-per-test-invocation directory 

and is guaranteed to be empty. 

""" 

# py.log._apiwarn(">1.1", "use tmpdir function argument") 

from .deprecated import PYTEST_ENSURETEMP 

 

warnings.warn(PYTEST_ENSURETEMP, stacklevel=2) 

return self.getbasetemp().ensure(string, dir=dir) 

 

def mktemp(self, basename, numbered=True): 

"""Create a subdirectory of the base temporary directory and return it. 

If ``numbered``, ensure the directory is unique by adding a number 

prefix greater than any existing one. 

""" 

return py.path.local(self._tmppath_factory.mktemp(basename, numbered).resolve()) 

 

def getbasetemp(self): 

"""backward compat wrapper for ``_tmppath_factory.getbasetemp``""" 

return py.path.local(self._tmppath_factory.getbasetemp().resolve()) 

 

 

def get_user(): 

"""Return the current user name, or None if getuser() does not work 

in the current environment (see #1010). 

""" 

import getpass 

 

try: 

return getpass.getuser() 

except (ImportError, KeyError): 

return None 

 

 

def pytest_configure(config): 

"""Create a TempdirFactory and attach it to the config object. 

 

This is to comply with existing plugins which expect the handler to be 

available at pytest_configure time, but ideally should be moved entirely 

to the tmpdir_factory session fixture. 

""" 

mp = MonkeyPatch() 

tmppath_handler = TempPathFactory.from_config(config) 

t = TempdirFactory(tmppath_handler) 

config._cleanup.append(mp.undo) 

mp.setattr(config, "_tmp_path_factory", tmppath_handler, raising=False) 

mp.setattr(config, "_tmpdirhandler", t, raising=False) 

mp.setattr(pytest, "ensuretemp", t.ensuretemp, raising=False) 

 

 

@pytest.fixture(scope="session") 

def tmpdir_factory(request): 

"""Return a :class:`_pytest.tmpdir.TempdirFactory` instance for the test session. 

""" 

return request.config._tmpdirhandler 

 

 

@pytest.fixture(scope="session") 

def tmp_path_factory(request): 

"""Return a :class:`_pytest.tmpdir.TempPathFactory` instance for the test session. 

""" 

return request.config._tmp_path_factory 

 

 

def _mk_tmp(request, factory): 

name = request.node.name 

name = re.sub(r"[\W]", "_", name) 

MAXVAL = 30 

name = name[:MAXVAL] 

return factory.mktemp(name, numbered=True) 

 

 

@pytest.fixture 

def tmpdir(tmp_path): 

"""Return a temporary directory path object 

which is unique to each test function invocation, 

created as a sub directory of the base temporary 

directory. The returned object is a `py.path.local`_ 

path object. 

 

.. _`py.path.local`: https://py.readthedocs.io/en/latest/path.html 

""" 

return py.path.local(tmp_path) 

 

 

@pytest.fixture 

def tmp_path(request, tmp_path_factory): 

"""Return a temporary directory path object 

which is unique to each test function invocation, 

created as a sub directory of the base temporary 

directory. The returned object is a :class:`pathlib.Path` 

object. 

 

.. note:: 

 

in python < 3.6 this is a pathlib2.Path 

""" 

 

return _mk_tmp(request, tmp_path_factory)