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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
|
"""
Tests for pathlib.types._ReadablePath
"""
import collections.abc
import io
import sys
import unittest
from .support import is_pypi
from .support.local_path import ReadableLocalPath, LocalPathGround
from .support.zip_path import ReadableZipPath, ZipPathGround
if is_pypi:
from pathlib_abc import PathInfo, _ReadablePath
from pathlib_abc._os import magic_open
else:
from pathlib.types import PathInfo, _ReadablePath
from pathlib._os import magic_open
class ReadTestBase:
def setUp(self):
self.root = self.ground.setup()
self.ground.create_hierarchy(self.root)
def tearDown(self):
self.ground.teardown(self.root)
def test_is_readable(self):
self.assertIsInstance(self.root, _ReadablePath)
def test_open_r(self):
p = self.root / 'fileA'
with magic_open(p, 'r', encoding='utf-8') as f:
self.assertIsInstance(f, io.TextIOBase)
self.assertEqual(f.read(), 'this is file A\n')
@unittest.skipIf(
not getattr(sys.flags, 'warn_default_encoding', 0),
"Requires warn_default_encoding",
)
def test_open_r_encoding_warning(self):
p = self.root / 'fileA'
with self.assertWarns(EncodingWarning) as wc:
with magic_open(p, 'r'):
pass
self.assertEqual(wc.filename, __file__)
def test_open_rb(self):
p = self.root / 'fileA'
with magic_open(p, 'rb') as f:
self.assertEqual(f.read(), b'this is file A\n')
self.assertRaises(ValueError, magic_open, p, 'rb', encoding='utf8')
self.assertRaises(ValueError, magic_open, p, 'rb', errors='strict')
self.assertRaises(ValueError, magic_open, p, 'rb', newline='')
def test_read_bytes(self):
p = self.root / 'fileA'
self.assertEqual(p.read_bytes(), b'this is file A\n')
def test_read_text(self):
p = self.root / 'fileA'
self.assertEqual(p.read_text(encoding='utf-8'), 'this is file A\n')
q = self.root / 'abc'
self.ground.create_file(q, b'\xe4bcdefg')
self.assertEqual(q.read_text(encoding='latin-1'), 'äbcdefg')
self.assertEqual(q.read_text(encoding='utf-8', errors='ignore'), 'bcdefg')
@unittest.skipIf(
not getattr(sys.flags, 'warn_default_encoding', 0),
"Requires warn_default_encoding",
)
def test_read_text_encoding_warning(self):
p = self.root / 'fileA'
with self.assertWarns(EncodingWarning) as wc:
p.read_text()
self.assertEqual(wc.filename, __file__)
def test_read_text_with_newlines(self):
p = self.root / 'abc'
self.ground.create_file(p, b'abcde\r\nfghlk\n\rmnopq')
# Check that `\n` character change nothing
self.assertEqual(p.read_text(encoding='utf-8', newline='\n'), 'abcde\r\nfghlk\n\rmnopq')
# Check that `\r` character replaces `\n`
self.assertEqual(p.read_text(encoding='utf-8', newline='\r'), 'abcde\r\nfghlk\n\rmnopq')
# Check that `\r\n` character replaces `\n`
self.assertEqual(p.read_text(encoding='utf-8', newline='\r\n'), 'abcde\r\nfghlk\n\rmnopq')
def test_iterdir(self):
expected = ['dirA', 'dirB', 'dirC', 'fileA']
if self.ground.can_symlink:
expected += ['linkA', 'linkB', 'brokenLink', 'brokenLinkLoop']
expected = {self.root.joinpath(name) for name in expected}
actual = set(self.root.iterdir())
self.assertEqual(actual, expected)
def test_iterdir_nodir(self):
p = self.root / 'fileA'
self.assertRaises(OSError, p.iterdir)
def test_iterdir_info(self):
for child in self.root.iterdir():
self.assertIsInstance(child.info, PathInfo)
self.assertTrue(child.info.exists(follow_symlinks=False))
def test_glob(self):
if not self.ground.can_symlink:
self.skipTest("requires symlinks")
p = self.root
sep = self.root.parser.sep
altsep = self.root.parser.altsep
def check(pattern, expected):
if altsep:
expected = {name.replace(altsep, sep) for name in expected}
expected = {p.joinpath(name) for name in expected}
actual = set(p.glob(pattern, recurse_symlinks=True))
self.assertEqual(actual, expected)
it = p.glob("fileA")
self.assertIsInstance(it, collections.abc.Iterator)
self.assertEqual(list(it), [p.joinpath("fileA")])
check("*A", ["dirA", "fileA", "linkA"])
check("*A", ['dirA', 'fileA', 'linkA'])
check("*B/*", ["dirB/fileB", "linkB/fileB"])
check("*B/*", ['dirB/fileB', 'linkB/fileB'])
check("brokenLink", ['brokenLink'])
check("brokenLinkLoop", ['brokenLinkLoop'])
check("**/", ["", "dirA/", "dirA/linkC/", "dirB/", "dirC/", "dirC/dirD/", "linkB/"])
check("**/*/", ["dirA/", "dirA/linkC/", "dirB/", "dirC/", "dirC/dirD/", "linkB/"])
check("*/", ["dirA/", "dirB/", "dirC/", "linkB/"])
check("*/dirD/**/", ["dirC/dirD/"])
check("*/dirD/**", ["dirC/dirD/", "dirC/dirD/fileD"])
check("dir*/**", ["dirA/", "dirA/linkC", "dirA/linkC/fileB", "dirB/", "dirB/fileB", "dirC/",
"dirC/fileC", "dirC/dirD", "dirC/dirD/fileD", "dirC/novel.txt"])
check("dir*/**/", ["dirA/", "dirA/linkC/", "dirB/", "dirC/", "dirC/dirD/"])
check("dir*/**/..", ["dirA/..", "dirA/linkC/..", "dirB/..", "dirC/..", "dirC/dirD/.."])
check("dir*/*/**", ["dirA/linkC/", "dirA/linkC/fileB", "dirC/dirD/", "dirC/dirD/fileD"])
check("dir*/*/**/", ["dirA/linkC/", "dirC/dirD/"])
check("dir*/*/**/..", ["dirA/linkC/..", "dirC/dirD/.."])
check("dir*/*/..", ["dirC/dirD/..", "dirA/linkC/.."])
check("dir*/*/../dirD/**/", ["dirC/dirD/../dirD/"])
check("dir*/**/fileC", ["dirC/fileC"])
check("dir*/file*", ["dirB/fileB", "dirC/fileC"])
check("**/*/fileA", [])
check("fileB", [])
check("**/*/fileB", ["dirB/fileB", "dirA/linkC/fileB", "linkB/fileB"])
check("**/fileB", ["dirB/fileB", "dirA/linkC/fileB", "linkB/fileB"])
check("*/fileB", ["dirB/fileB", "linkB/fileB"])
check("*/fileB", ['dirB/fileB', 'linkB/fileB'])
check("**/file*",
["fileA", "dirA/linkC/fileB", "dirB/fileB", "dirC/fileC", "dirC/dirD/fileD",
"linkB/fileB"])
with self.assertRaisesRegex(ValueError, 'Unacceptable pattern'):
list(p.glob(''))
def test_walk_top_down(self):
it = self.root.walk()
path, dirnames, filenames = next(it)
dirnames.sort()
filenames.sort()
self.assertEqual(path, self.root)
self.assertEqual(dirnames, ['dirA', 'dirB', 'dirC'])
self.assertEqual(filenames, ['brokenLink', 'brokenLinkLoop', 'fileA', 'linkA', 'linkB']
if self.ground.can_symlink else ['fileA'])
path, dirnames, filenames = next(it)
self.assertEqual(path, self.root / 'dirA')
self.assertEqual(dirnames, [])
self.assertEqual(filenames, ['linkC'] if self.ground.can_symlink else [])
path, dirnames, filenames = next(it)
self.assertEqual(path, self.root / 'dirB')
self.assertEqual(dirnames, [])
self.assertEqual(filenames, ['fileB'])
path, dirnames, filenames = next(it)
filenames.sort()
self.assertEqual(path, self.root / 'dirC')
self.assertEqual(dirnames, ['dirD'])
self.assertEqual(filenames, ['fileC', 'novel.txt'])
path, dirnames, filenames = next(it)
self.assertEqual(path, self.root / 'dirC' / 'dirD')
self.assertEqual(dirnames, [])
self.assertEqual(filenames, ['fileD'])
self.assertRaises(StopIteration, next, it)
def test_walk_prune(self):
expected = {self.root, self.root / 'dirA', self.root / 'dirC', self.root / 'dirC' / 'dirD'}
actual = set()
for path, dirnames, filenames in self.root.walk():
actual.add(path)
if path == self.root:
dirnames.remove('dirB')
self.assertEqual(actual, expected)
def test_walk_bottom_up(self):
seen_root = seen_dira = seen_dirb = seen_dirc = seen_dird = False
for path, dirnames, filenames in self.root.walk(top_down=False):
if path == self.root:
self.assertFalse(seen_root)
self.assertTrue(seen_dira)
self.assertTrue(seen_dirb)
self.assertTrue(seen_dirc)
self.assertEqual(sorted(dirnames), ['dirA', 'dirB', 'dirC'])
self.assertEqual(sorted(filenames),
['brokenLink', 'brokenLinkLoop', 'fileA', 'linkA', 'linkB']
if self.ground.can_symlink else ['fileA'])
seen_root = True
elif path == self.root / 'dirA':
self.assertFalse(seen_root)
self.assertFalse(seen_dira)
self.assertEqual(dirnames, [])
self.assertEqual(filenames, ['linkC'] if self.ground.can_symlink else [])
seen_dira = True
elif path == self.root / 'dirB':
self.assertFalse(seen_root)
self.assertFalse(seen_dirb)
self.assertEqual(dirnames, [])
self.assertEqual(filenames, ['fileB'])
seen_dirb = True
elif path == self.root / 'dirC':
self.assertFalse(seen_root)
self.assertFalse(seen_dirc)
self.assertTrue(seen_dird)
self.assertEqual(dirnames, ['dirD'])
self.assertEqual(sorted(filenames), ['fileC', 'novel.txt'])
seen_dirc = True
elif path == self.root / 'dirC' / 'dirD':
self.assertFalse(seen_root)
self.assertFalse(seen_dirc)
self.assertFalse(seen_dird)
self.assertEqual(dirnames, [])
self.assertEqual(filenames, ['fileD'])
seen_dird = True
else:
raise AssertionError(f"Unexpected path: {path}")
self.assertTrue(seen_root)
def test_info_exists(self):
p = self.root
self.assertTrue(p.info.exists())
self.assertTrue((p / 'dirA').info.exists())
self.assertTrue((p / 'dirA').info.exists(follow_symlinks=False))
self.assertTrue((p / 'fileA').info.exists())
self.assertTrue((p / 'fileA').info.exists(follow_symlinks=False))
self.assertFalse((p / 'non-existing').info.exists())
self.assertFalse((p / 'non-existing').info.exists(follow_symlinks=False))
if self.ground.can_symlink:
self.assertTrue((p / 'linkA').info.exists())
self.assertTrue((p / 'linkA').info.exists(follow_symlinks=False))
self.assertTrue((p / 'linkB').info.exists())
self.assertTrue((p / 'linkB').info.exists(follow_symlinks=True))
self.assertFalse((p / 'brokenLink').info.exists())
self.assertTrue((p / 'brokenLink').info.exists(follow_symlinks=False))
self.assertFalse((p / 'brokenLinkLoop').info.exists())
self.assertTrue((p / 'brokenLinkLoop').info.exists(follow_symlinks=False))
self.assertFalse((p / 'fileA\udfff').info.exists())
self.assertFalse((p / 'fileA\udfff').info.exists(follow_symlinks=False))
self.assertFalse((p / 'fileA\x00').info.exists())
self.assertFalse((p / 'fileA\x00').info.exists(follow_symlinks=False))
def test_info_is_dir(self):
p = self.root
self.assertTrue((p / 'dirA').info.is_dir())
self.assertTrue((p / 'dirA').info.is_dir(follow_symlinks=False))
self.assertFalse((p / 'fileA').info.is_dir())
self.assertFalse((p / 'fileA').info.is_dir(follow_symlinks=False))
self.assertFalse((p / 'non-existing').info.is_dir())
self.assertFalse((p / 'non-existing').info.is_dir(follow_symlinks=False))
if self.ground.can_symlink:
self.assertFalse((p / 'linkA').info.is_dir())
self.assertFalse((p / 'linkA').info.is_dir(follow_symlinks=False))
self.assertTrue((p / 'linkB').info.is_dir())
self.assertFalse((p / 'linkB').info.is_dir(follow_symlinks=False))
self.assertFalse((p / 'brokenLink').info.is_dir())
self.assertFalse((p / 'brokenLink').info.is_dir(follow_symlinks=False))
self.assertFalse((p / 'brokenLinkLoop').info.is_dir())
self.assertFalse((p / 'brokenLinkLoop').info.is_dir(follow_symlinks=False))
self.assertFalse((p / 'dirA\udfff').info.is_dir())
self.assertFalse((p / 'dirA\udfff').info.is_dir(follow_symlinks=False))
self.assertFalse((p / 'dirA\x00').info.is_dir())
self.assertFalse((p / 'dirA\x00').info.is_dir(follow_symlinks=False))
def test_info_is_file(self):
p = self.root
self.assertTrue((p / 'fileA').info.is_file())
self.assertTrue((p / 'fileA').info.is_file(follow_symlinks=False))
self.assertFalse((p / 'dirA').info.is_file())
self.assertFalse((p / 'dirA').info.is_file(follow_symlinks=False))
self.assertFalse((p / 'non-existing').info.is_file())
self.assertFalse((p / 'non-existing').info.is_file(follow_symlinks=False))
if self.ground.can_symlink:
self.assertTrue((p / 'linkA').info.is_file())
self.assertFalse((p / 'linkA').info.is_file(follow_symlinks=False))
self.assertFalse((p / 'linkB').info.is_file())
self.assertFalse((p / 'linkB').info.is_file(follow_symlinks=False))
self.assertFalse((p / 'brokenLink').info.is_file())
self.assertFalse((p / 'brokenLink').info.is_file(follow_symlinks=False))
self.assertFalse((p / 'brokenLinkLoop').info.is_file())
self.assertFalse((p / 'brokenLinkLoop').info.is_file(follow_symlinks=False))
self.assertFalse((p / 'fileA\udfff').info.is_file())
self.assertFalse((p / 'fileA\udfff').info.is_file(follow_symlinks=False))
self.assertFalse((p / 'fileA\x00').info.is_file())
self.assertFalse((p / 'fileA\x00').info.is_file(follow_symlinks=False))
def test_info_is_symlink(self):
p = self.root
self.assertFalse((p / 'fileA').info.is_symlink())
self.assertFalse((p / 'dirA').info.is_symlink())
self.assertFalse((p / 'non-existing').info.is_symlink())
if self.ground.can_symlink:
self.assertTrue((p / 'linkA').info.is_symlink())
self.assertTrue((p / 'linkB').info.is_symlink())
self.assertTrue((p / 'brokenLink').info.is_symlink())
self.assertFalse((p / 'linkA\udfff').info.is_symlink())
self.assertFalse((p / 'linkA\x00').info.is_symlink())
self.assertTrue((p / 'brokenLinkLoop').info.is_symlink())
self.assertFalse((p / 'fileA\udfff').info.is_symlink())
self.assertFalse((p / 'fileA\x00').info.is_symlink())
class ZipPathReadTest(ReadTestBase, unittest.TestCase):
ground = ZipPathGround(ReadableZipPath)
class LocalPathReadTest(ReadTestBase, unittest.TestCase):
ground = LocalPathGround(ReadableLocalPath)
if not is_pypi:
from pathlib import Path
class PathReadTest(ReadTestBase, unittest.TestCase):
ground = LocalPathGround(Path)
if __name__ == "__main__":
unittest.main()
|
