cpython/Lib/test/test_pathlib/test_pathlib.py at a614f7b0fc1a12d917c0f811fcc2345a1859b917 · encukou/cpython

Repository navigation

History

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

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

import io

import os

import sys

import errno

import ntpath

import pathlib

import pickle

import posixpath

import socket

import stat

import tempfile

import unittest

from unittest import mock

from urllib.request import pathname2url

from test.support import import_helper

from test.support import is_emscripten, is_wasi

from test.support import infinite_recursion

from test.support import os_helper

from test.support.os_helper import TESTFN, FakePath

from test.test_pathlib import test_pathlib_abc

from test.test_pathlib.test_pathlib_abc import needs_posix, needs_windows, needs_symlinks

try:

import grp, pwd

except ImportError:

grp = pwd = None

root_in_posix = False

if hasattr(os, 'geteuid'):

root_in_posix = (os.geteuid() == 0)

# Tests for the pure classes.

class PurePathTest(test_pathlib_abc.DummyPurePathTest):

cls = pathlib.PurePath

# Make sure any symbolic links in the base test path are resolved.

base = os.path.realpath(TESTFN)

# Keys are canonical paths, values are list of tuples of arguments

# supposed to produce equal paths.

equivalences = {

'a/b': [

('a', 'b'), ('a/', 'b'), ('a', 'b/'), ('a/', 'b/'),

('a/b/',), ('a//b',), ('a//b//',),

# Empty components get removed.

('', 'a', 'b'), ('a', '', 'b'), ('a', 'b', ''),

'/b/c/d': [

('a', '/b/c', 'd'), ('/a', '/b/c', 'd'),

# Empty components get removed.

('/', 'b', '', 'c/d'), ('/', '', 'b/c/d'), ('', '/b/c/d'),

}

def test_concrete_class(self):

if self.cls is pathlib.PurePath:

expected = pathlib.PureWindowsPath if os.name == 'nt' else pathlib.PurePosixPath

else:

expected = self.cls

p = self.cls('a')

self.assertIs(type(p), expected)

def test_concrete_parser(self):

if self.cls is pathlib.PurePosixPath:

expected = posixpath

elif self.cls is pathlib.PureWindowsPath:

expected = ntpath

else:

expected = os.path

p = self.cls('a')

self.assertIs(p.parser, expected)

def test_different_parsers_unequal(self):

p = self.cls('a')

if p.parser is posixpath:

q = pathlib.PureWindowsPath('a')

else:

q = pathlib.PurePosixPath('a')

self.assertNotEqual(p, q)

def test_different_parsers_unordered(self):

p = self.cls('a')

if p.parser is posixpath:

q = pathlib.PureWindowsPath('a')

else:

q = pathlib.PurePosixPath('a')

with self.assertRaises(TypeError):

p < q

with self.assertRaises(TypeError):

p <= q

with self.assertRaises(TypeError):

p > q

with self.assertRaises(TypeError):

p >= q

def test_constructor_nested(self):

P = self.cls

P(FakePath("a/b/c"))

self.assertEqual(P(P('a')), P('a'))

self.assertEqual(P(P('a'), 'b'), P('a/b'))

self.assertEqual(P(P('a'), P('b')), P('a/b'))

self.assertEqual(P(P('a'), P('b'), P('c')), P(FakePath("a/b/c")))

self.assertEqual(P(P('./a:b')), P('./a:b'))

def _check_parse_path(self, raw_path, *expected):

sep = self.parser.sep

actual = self.cls._parse_path(raw_path.replace('/', sep))

self.assertEqual(actual, expected)

if altsep := self.parser.altsep:

actual = self.cls._parse_path(raw_path.replace('/', altsep))

self.assertEqual(actual, expected)

def test_parse_path_common(self):

check = self._check_parse_path

sep = self.parser.sep

check('', '', '', [])

check('a', '', '', ['a'])

check('a/', '', '', ['a'])

check('a/b', '', '', ['a', 'b'])

check('a/b/', '', '', ['a', 'b'])

check('a/b/c/d', '', '', ['a', 'b', 'c', 'd'])

check('a/b//c/d', '', '', ['a', 'b', 'c', 'd'])

check('a/b/c/d', '', '', ['a', 'b', 'c', 'd'])

check('.', '', '', [])

check('././b', '', '', ['b'])

check('a/./b', '', '', ['a', 'b'])

check('a/./.', '', '', ['a'])

check('/a/b', '', sep, ['a', 'b'])

def test_empty_path(self):

# The empty path points to '.'

p = self.cls('')

self.assertEqual(str(p), '.')

# Special case for the empty path.

self._check_str('.', ('',))

def test_parts_interning(self):

P = self.cls

p = P('/usr/bin/foo')

q = P('/usr/local/bin')

# 'usr'

self.assertIs(p.parts[1], q.parts[1])

# 'bin'

self.assertIs(p.parts[2], q.parts[3])

def test_join_nested(self):

P = self.cls

p = P('a/b').joinpath(P('c'))

self.assertEqual(p, P('a/b/c'))

def test_div_nested(self):

P = self.cls

p = P('a/b') / P('c')

self.assertEqual(p, P('a/b/c'))

def test_pickling_common(self):

P = self.cls

for pathstr in ('a', 'a/', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c', 'a/b/c/'):

with self.subTest(pathstr=pathstr):

p = P(pathstr)

for proto in range(0, pickle.HIGHEST_PROTOCOL + 1):

dumped = pickle.dumps(p, proto)

pp = pickle.loads(dumped)

self.assertIs(pp.__class__, p.__class__)

self.assertEqual(pp, p)

self.assertEqual(hash(pp), hash(p))

self.assertEqual(str(pp), str(p))

def test_repr_common(self):

for pathstr in ('a', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c'):

with self.subTest(pathstr=pathstr):

p = self.cls(pathstr)

clsname = p.__class__.__name__

r = repr(p)

# The repr() is in the form ClassName("forward-slashes path").

self.assertTrue(r.startswith(clsname + '('), r)

self.assertTrue(r.endswith(')'), r)

inner = r[len(clsname) + 1 : -1]

self.assertEqual(eval(inner), p.as_posix())

def test_fspath_common(self):

P = self.cls

p = P('a/b')

self._check_str(p.__fspath__(), ('a/b',))

self._check_str(os.fspath(p), ('a/b',))

def test_bytes_exc_message(self):

P = self.cls

message = (r"argument should be a str or an os\.PathLike object "

r"where __fspath__ returns a str, not 'bytes'")

with self.assertRaisesRegex(TypeError, message):

P(b'a')

with self.assertRaisesRegex(TypeError, message):

P(b'a', 'b')

with self.assertRaisesRegex(TypeError, message):

P('a', b'b')

def test_as_bytes_common(self):

sep = os.fsencode(self.sep)

P = self.cls

self.assertEqual(bytes(P('a/b')), b'a' + sep + b'b')

def test_eq_common(self):

P = self.cls

self.assertEqual(P('a/b'), P('a/b'))

self.assertEqual(P('a/b'), P('a', 'b'))

self.assertNotEqual(P('a/b'), P('a'))

self.assertNotEqual(P('a/b'), P('/a/b'))

self.assertNotEqual(P('a/b'), P())

self.assertNotEqual(P('/a/b'), P('/'))

self.assertNotEqual(P(), P('/'))

self.assertNotEqual(P(), "")

self.assertNotEqual(P(), {})

self.assertNotEqual(P(), int)

def test_equivalences(self, equivalences=None):

if equivalences is None:

equivalences = self.equivalences

for k, tuples in equivalences.items():

canon = k.replace('/', self.sep)

posix = k.replace(self.sep, '/')

if canon != posix:

tuples = tuples + [

tuple(part.replace('/', self.sep) for part in t)

for t in tuples

]

tuples.append((posix, ))

pcanon = self.cls(canon)

for t in tuples:

p = self.cls(*t)

self.assertEqual(p, pcanon, "failed with args {}".format(t))

self.assertEqual(hash(p), hash(pcanon))

self.assertEqual(str(p), canon)

self.assertEqual(p.as_posix(), posix)

def test_ordering_common(self):

# Ordering is tuple-alike.

def assertLess(a, b):

self.assertLess(a, b)

self.assertGreater(b, a)

P = self.cls

a = P('a')

b = P('a/b')

c = P('abc')

d = P('b')

assertLess(a, b)

assertLess(a, c)

assertLess(a, d)

assertLess(b, c)

assertLess(c, d)

P = self.cls

a = P('/a')

b = P('/a/b')

c = P('/abc')

d = P('/b')

assertLess(a, b)

assertLess(a, c)

assertLess(a, d)

assertLess(b, c)

assertLess(c, d)

with self.assertRaises(TypeError):

P() < {}

def test_as_uri_common(self):

P = self.cls

with self.assertRaises(ValueError):

P('a').as_uri()

with self.assertRaises(ValueError):

P().as_uri()

def test_repr_roundtrips(self):

for pathstr in ('a', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c'):

with self.subTest(pathstr=pathstr):

p = self.cls(pathstr)

r = repr(p)

# The repr() roundtrips.

q = eval(r, pathlib.__dict__)

self.assertIs(q.__class__, p.__class__)

self.assertEqual(q, p)

self.assertEqual(repr(q), r)

def test_name_empty(self):

P = self.cls

self.assertEqual(P('').name, '')

self.assertEqual(P('.').name, '')

self.assertEqual(P('/a/b/.').name, 'b')

def test_stem_empty(self):

P = self.cls

self.assertEqual(P('').stem, '')

self.assertEqual(P('.').stem, '')

def test_with_name_empty(self):

P = self.cls

self.assertRaises(ValueError, P('').with_name, 'd.xml')

self.assertRaises(ValueError, P('.').with_name, 'd.xml')

self.assertRaises(ValueError, P('/').with_name, 'd.xml')

self.assertRaises(ValueError, P('a/b').with_name, '')

self.assertRaises(ValueError, P('a/b').with_name, '.')

def test_with_stem_empty(self):

P = self.cls

self.assertRaises(ValueError, P('').with_stem, 'd')

self.assertRaises(ValueError, P('.').with_stem, 'd')

self.assertRaises(ValueError, P('/').with_stem, 'd')

self.assertRaises(ValueError, P('a/b').with_stem, '')

self.assertRaises(ValueError, P('a/b').with_stem, '.')

def test_is_reserved_deprecated(self):

P = self.cls

p = P('a/b')

with self.assertWarns(DeprecationWarning):

p.is_reserved()

def test_match_empty(self):

P = self.cls

self.assertRaises(ValueError, P('a').match, '')

self.assertRaises(ValueError, P('a').match, '.')

@needs_posix

def test_parse_path_posix(self):

check = self._check_parse_path

# Collapsing of excess leading slashes, except for the double-slash

# special case.

check('//a/b', '', '//', ['a', 'b'])

check('///a/b', '', '/', ['a', 'b'])

check('////a/b', '', '/', ['a', 'b'])

# Paths which look like NT paths aren't treated specially.

check('c:a', '', '', ['c:a',])

check('c:\\a', '', '', ['c:\\a',])

check('\\a', '', '', ['\\a',])

@needs_posix

def test_eq_posix(self):

P = self.cls

self.assertNotEqual(P('a/b'), P('A/b'))

self.assertEqual(P('/a'), P('///a'))

self.assertNotEqual(P('/a'), P('//a'))

@needs_posix

def test_as_uri_posix(self):

P = self.cls

self.assertEqual(P('/').as_uri(), 'file:///')

self.assertEqual(P('/a/b.c').as_uri(), 'file:///a/b.c')

self.assertEqual(P('/a/b%#c').as_uri(), 'file:///a/b%25%23c')

@needs_posix

def test_as_uri_non_ascii(self):

from urllib.parse import quote_from_bytes

P = self.cls

try:

os.fsencode('\xe9')

except UnicodeEncodeError:

self.skipTest("\\xe9 cannot be encoded to the filesystem encoding")

self.assertEqual(P('/a/b\xe9').as_uri(),

'file:///a/b' + quote_from_bytes(os.fsencode('\xe9')))

@needs_posix

def test_parse_windows_path(self):

P = self.cls

p = P('c:', 'a', 'b')

pp = P(pathlib.PureWindowsPath('c:\\a\\b'))

self.assertEqual(p, pp)

windows_equivalences = {

'./a:b': [ ('./a:b',) ],

'c:a': [ ('c:', 'a'), ('c:', 'a/'), ('.', 'c:', 'a') ],

'c:/a': [

('c:/', 'a'), ('c:', '/', 'a'), ('c:', '/a'),

('/z', 'c:/', 'a'), ('//x/y', 'c:/', 'a'),

'//a/b/': [ ('//a/b',) ],

'//a/b/c': [

('//a/b', 'c'), ('//a/b/', 'c'),

}

@needs_windows

def test_equivalences_windows(self):

self.test_equivalences(self.windows_equivalences)

@needs_windows

def test_parse_path_windows(self):

check = self._check_parse_path

# First part is anchored.

check('c:', 'c:', '', [])

check('c:/', 'c:', '\\', [])

check('/', '', '\\', [])

check('c:a', 'c:', '', ['a'])

check('c:/a', 'c:', '\\', ['a'])

check('/a', '', '\\', ['a'])

# UNC paths.

check('//', '\\\\', '', [])

check('//a', '\\\\a', '', [])

check('//a/', '\\\\a\\', '', [])

check('//a/b', '\\\\a\\b', '\\', [])

check('//a/b/', '\\\\a\\b', '\\', [])

check('//a/b/c', '\\\\a\\b', '\\', ['c'])

# Collapsing and stripping excess slashes.

check('Z://b//c/d/', 'Z:', '\\', ['b', 'c', 'd'])

# UNC paths.

check('//b/c//d', '\\\\b\\c', '\\', ['d'])

# Extended paths.

check('//./c:', '\\\\.\\c:', '', [])

check('//?/c:/', '\\\\?\\c:', '\\', [])

check('//?/c:/a', '\\\\?\\c:', '\\', ['a'])

# Extended UNC paths (format is "\\?\UNC\server\share").

check('//?', '\\\\?', '', [])

check('//?/', '\\\\?\\', '', [])

check('//?/UNC', '\\\\?\\UNC', '', [])

check('//?/UNC/', '\\\\?\\UNC\\', '', [])

check('//?/UNC/b', '\\\\?\\UNC\\b', '', [])

check('//?/UNC/b/', '\\\\?\\UNC\\b\\', '', [])

check('//?/UNC/b/c', '\\\\?\\UNC\\b\\c', '\\', [])

check('//?/UNC/b/c/', '\\\\?\\UNC\\b\\c', '\\', [])

check('//?/UNC/b/c/d', '\\\\?\\UNC\\b\\c', '\\', ['d'])

# UNC device paths

check('//./BootPartition/', '\\\\.\\BootPartition', '\\', [])

check('//?/BootPartition/', '\\\\?\\BootPartition', '\\', [])

check('//./PhysicalDrive0', '\\\\.\\PhysicalDrive0', '', [])

check('//?/Volume{}/', '\\\\?\\Volume{}', '\\', [])

check('//./nul', '\\\\.\\nul', '', [])

# Paths to files with NTFS alternate data streams

check('./c:s', '', '', ['c:s'])

check('cc:s', '', '', ['cc:s'])

check('C:c:s', 'C:', '', ['c:s'])

check('C:/c:s', 'C:', '\\', ['c:s'])

check('D:a/c:b', 'D:', '', ['a', 'c:b'])

check('D:/a/c:b', 'D:', '\\', ['a', 'c:b'])

@needs_windows

def test_eq_windows(self):

P = self.cls

self.assertEqual(P('c:a/b'), P('c:a/b'))

self.assertEqual(P('c:a/b'), P('c:', 'a', 'b'))

self.assertNotEqual(P('c:a/b'), P('d:a/b'))

self.assertNotEqual(P('c:a/b'), P('c:/a/b'))

self.assertNotEqual(P('/a/b'), P('c:/a/b'))

# Case-insensitivity.

self.assertEqual(P('a/B'), P('A/b'))

self.assertEqual(P('C:a/B'), P('c:A/b'))

self.assertEqual(P('//Some/SHARE/a/B'), P('//somE/share/A/b'))

self.assertEqual(P('\u0130'), P('i\u0307'))

@needs_windows

def test_as_uri_windows(self):

P = self.cls

with self.assertRaises(ValueError):

P('/a/b').as_uri()

with self.assertRaises(ValueError):

P('c:a/b').as_uri()

self.assertEqual(P('c:/').as_uri(), 'file:///c:/')

self.assertEqual(P('c:/a/b.c').as_uri(), 'file:///c:/a/b.c')

self.assertEqual(P('c:/a/b%#c').as_uri(), 'file:///c:/a/b%25%23c')

self.assertEqual(P('c:/a/b\xe9').as_uri(), 'file:///c:/a/b%C3%A9')

self.assertEqual(P('//some/share/').as_uri(), 'file://some/share/')

self.assertEqual(P('//some/share/a/b.c').as_uri(),

'file://some/share/a/b.c')

self.assertEqual(P('//some/share/a/b%#c\xe9').as_uri(),

'file://some/share/a/b%25%23c%C3%A9')

@needs_windows

def test_ordering_windows(self):

# Case-insensitivity.

def assertOrderedEqual(a, b):

self.assertLessEqual(a, b)

self.assertGreaterEqual(b, a)

P = self.cls

p = P('c:A/b')

q = P('C:a/B')

assertOrderedEqual(p, q)

self.assertFalse(p < q)

self.assertFalse(p > q)

p = P('//some/Share/A/b')

q = P('//Some/SHARE/a/B')

assertOrderedEqual(p, q)

self.assertFalse(p < q)

self.assertFalse(p > q)

class PurePosixPathTest(PurePathTest):

cls = pathlib.PurePosixPath

class PureWindowsPathTest(PurePathTest):

cls = pathlib.PureWindowsPath

class PurePathSubclassTest(PurePathTest):

class cls(pathlib.PurePath):

pass

# repr() roundtripping is not supported in custom subclass.

test_repr_roundtrips = None

# Tests for the concrete classes.

class PathTest(test_pathlib_abc.DummyPathTest, PurePathTest):

"""Tests for the FS-accessing functionalities of the Path classes."""

cls = pathlib.Path

can_symlink = os_helper.can_symlink()

def setUp(self):

super().setUp()

os.chmod(self.parser.join(self.base, 'dirE'), 0)

def tearDown(self):

os.chmod(self.parser.join(self.base, 'dirE'), 0o777)

os_helper.rmtree(self.base)

def tempdir(self):

d = os_helper._longpath(tempfile.mkdtemp(suffix='-dirD',

dir=os.getcwd()))

self.addCleanup(os_helper.rmtree, d)

return d

def test_matches_pathbase_api(self):

our_names = {name for name in dir(self.cls) if name[0] != '_'}

our_names.remove('is_reserved') # only present in PurePath

path_names = {name for name in dir(pathlib._abc.PathBase) if name[0] != '_'}

self.assertEqual(our_names, path_names)

for attr_name in our_names:

if attr_name == 'parser':

# On Windows, Path.parser is ntpath, but PathBase.parser is

# posixpath, and so their docstrings differ.

continue

our_attr = getattr(self.cls, attr_name)

path_attr = getattr(pathlib._abc.PathBase, attr_name)

self.assertEqual(our_attr.__doc__, path_attr.__doc__)

def test_concrete_class(self):

if self.cls is pathlib.Path:

expected = pathlib.WindowsPath if os.name == 'nt' else pathlib.PosixPath

else:

expected = self.cls

p = self.cls('a')

self.assertIs(type(p), expected)

def test_unsupported_parser(self):

if self.cls.parser is os.path:

self.skipTest("path parser is supported")

else:

self.assertRaises(pathlib.UnsupportedOperation, self.cls)

def _test_cwd(self, p):

q = self.cls(os.getcwd())

self.assertEqual(p, q)

self.assertEqualNormCase(str(p), str(q))

self.assertIs(type(p), type(q))

self.assertTrue(p.is_absolute())

def test_cwd(self):

p = self.cls.cwd()

self._test_cwd(p)

def test_absolute_common(self):

P = self.cls

with mock.patch("os.getcwd") as getcwd:

getcwd.return_value = self.base

# Simple relative paths.

self.assertEqual(str(P().absolute()), self.base)

self.assertEqual(str(P('.').absolute()), self.base)

self.assertEqual(str(P('a').absolute()), os.path.join(self.base, 'a'))

self.assertEqual(str(P('a', 'b', 'c').absolute()), os.path.join(self.base, 'a', 'b', 'c'))

# Symlinks should not be resolved.

self.assertEqual(str(P('linkB', 'fileB').absolute()), os.path.join(self.base, 'linkB', 'fileB'))

self.assertEqual(str(P('brokenLink').absolute()), os.path.join(self.base, 'brokenLink'))

self.assertEqual(str(P('brokenLinkLoop').absolute()), os.path.join(self.base, 'brokenLinkLoop'))

# '..' entries should be preserved and not normalised.

self.assertEqual(str(P('..').absolute()), os.path.join(self.base, '..'))

self.assertEqual(str(P('a', '..').absolute()), os.path.join(self.base, 'a', '..'))

self.assertEqual(str(P('..', 'b').absolute()), os.path.join(self.base, '..', 'b'))

def _test_home(self, p):

q = self.cls(os.path.expanduser('~'))

self.assertEqual(p, q)

self.assertEqualNormCase(str(p), str(q))

self.assertIs(type(p), type(q))

self.assertTrue(p.is_absolute())

@unittest.skipIf(

pwd is None, reason="Test requires pwd module to get homedir."

)

def test_home(self):

with os_helper.EnvironmentVarGuard() as env:

self._test_home(self.cls.home())

env.clear()

env['USERPROFILE'] = os.path.join(self.base, 'userprofile')

self._test_home(self.cls.home())

# bpo-38883: ignore `HOME` when set on windows

env['HOME'] = os.path.join(self.base, 'home')

self._test_home(self.cls.home())

@unittest.skipIf(is_wasi, "WASI has no user accounts.")

def test_expanduser_common(self):

P = self.cls

p = P('~')

self.assertEqual(p.expanduser(), P(os.path.expanduser('~')))

p = P('foo')

self.assertEqual(p.expanduser(), p)

p = P('/~')

self.assertEqual(p.expanduser(), p)

p = P('../~')

self.assertEqual(p.expanduser(), p)

p = P(P('').absolute().anchor) / '~'

self.assertEqual(p.expanduser(), p)

p = P('~/a:b')

self.assertEqual(p.expanduser(), P(os.path.expanduser('~'), './a:b'))

def test_with_segments(self):

class P(self.cls):

def __init__(self, *pathsegments, session_id):

super().__init__(*pathsegments)

self.session_id = session_id

def with_segments(self, *pathsegments):

return type(self)(*pathsegments, session_id=self.session_id)

p = P(self.base, session_id=42)

self.assertEqual(42, p.absolute().session_id)

self.assertEqual(42, p.resolve().session_id)

if not is_wasi: # WASI has no user accounts.

self.assertEqual(42, p.with_segments('~').expanduser().session_id)

self.assertEqual(42, (p / 'fileA').rename(p / 'fileB').session_id)

self.assertEqual(42, (p / 'fileB').replace(p / 'fileA').session_id)

if self.can_symlink:

self.assertEqual(42, (p / 'linkA').readlink().session_id)

for path in p.iterdir():

self.assertEqual(42, path.session_id)

for path in p.glob('*'):

self.assertEqual(42, path.session_id)

for path in p.rglob('*'):

self.assertEqual(42, path.session_id)

for dirpath, dirnames, filenames in p.walk():

self.assertEqual(42, dirpath.session_id)

def test_open_unbuffered(self):

p = self.cls(self.base)

with (p / 'fileA').open('rb', buffering=0) as f:

self.assertIsInstance(f, io.RawIOBase)

self.assertEqual(f.read().strip(), b"this is file A")

@unittest.skipIf(sys.platform == "win32" or sys.platform == "wasi", "directories are always readable on Windows and WASI")

@unittest.skipIf(root_in_posix, "test fails with root privilege")

def test_copytree_no_read_permission(self):

base = self.cls(self.base)

source = base / 'dirE'

target = base / 'copyE'

self.assertRaises(PermissionError, source.copytree, target)

self.assertFalse(target.exists())

errors = []

source.copytree(target, on_error=errors.append)

self.assertEqual(len(errors), 1)

self.assertIsInstance(errors[0], PermissionError)

self.assertFalse(target.exists())

def test_resolve_nonexist_relative_issue38671(self):

p = self.cls('non', 'exist')

old_cwd = os.getcwd()

os.chdir(self.base)

try:

self.assertEqual(p.resolve(), self.cls(self.base, p))

finally:

os.chdir(old_cwd)

@os_helper.skip_unless_working_chmod

def test_chmod(self):

p = self.cls(self.base) / 'fileA'

mode = p.stat().st_mode

# Clear writable bit.

new_mode = mode & ~0o222

p.chmod(new_mode)

self.assertEqual(p.stat().st_mode, new_mode)

# Set writable bit.

new_mode = mode | 0o222

p.chmod(new_mode)

self.assertEqual(p.stat().st_mode, new_mode)

# On Windows, os.chmod does not follow symlinks (issue #15411)

@needs_posix

@os_helper.skip_unless_working_chmod

def test_chmod_follow_symlinks_true(self):

p = self.cls(self.base) / 'linkA'

q = p.resolve()

mode = q.stat().st_mode

# Clear writable bit.

new_mode = mode & ~0o222

p.chmod(new_mode, follow_symlinks=True)

self.assertEqual(q.stat().st_mode, new_mode)

# Set writable bit

new_mode = mode | 0o222

p.chmod(new_mode, follow_symlinks=True)

self.assertEqual(q.stat().st_mode, new_mode)

# XXX also need a test for lchmod.

def _get_pw_name_or_skip_test(self, uid):

try:

return pwd.getpwuid(uid).pw_name

except KeyError:

self.skipTest(

"user %d doesn't have an entry in the system database" % uid)

@unittest.skipUnless(pwd, "the pwd module is needed for this test")

def test_owner(self):

p = self.cls(self.base) / 'fileA'

expected_uid = p.stat().st_uid

expected_name = self._get_pw_name_or_skip_test(expected_uid)

self.assertEqual(expected_name, p.owner())

@unittest.skipUnless(pwd, "the pwd module is needed for this test")

@unittest.skipUnless(root_in_posix, "test needs root privilege")

def test_owner_no_follow_symlinks(self):

all_users = [u.pw_uid for u in pwd.getpwall()]

if len(all_users) < 2:

self.skipTest("test needs more than one user")

target = self.cls(self.base) / 'fileA'

link = self.cls(self.base) / 'linkA'

uid_1, uid_2 = all_users[:2]

os.chown(target, uid_1, -1)

os.chown(link, uid_2, -1, follow_symlinks=False)

expected_uid = link.stat(follow_symlinks=False).st_uid

expected_name = self._get_pw_name_or_skip_test(expected_uid)

self.assertEqual(expected_uid, uid_2)

self.assertEqual(expected_name, link.owner(follow_symlinks=False))

def _get_gr_name_or_skip_test(self, gid):

try:

return grp.getgrgid(gid).gr_name

except KeyError:

self.skipTest(

"group %d doesn't have an entry in the system database" % gid)

@unittest.skipUnless(grp, "the grp module is needed for this test")

def test_group(self):

p = self.cls(self.base) / 'fileA'

expected_gid = p.stat().st_gid

expected_name = self._get_gr_name_or_skip_test(expected_gid)

self.assertEqual(expected_name, p.group())

@unittest.skipUnless(grp, "the grp module is needed for this test")

@unittest.skipUnless(root_in_posix, "test needs root privilege")

def test_group_no_follow_symlinks(self):

all_groups = [g.gr_gid for g in grp.getgrall()]

if len(all_groups) < 2:

self.skipTest("test needs more than one group")

target = self.cls(self.base) / 'fileA'

link = self.cls(self.base) / 'linkA'

gid_1, gid_2 = all_groups[:2]

os.chown(target, -1, gid_1)

os.chown(link, -1, gid_2, follow_symlinks=False)

expected_gid = link.stat(follow_symlinks=False).st_gid

expected_name = self._get_pw_name_or_skip_test(expected_gid)

self.assertEqual(expected_gid, gid_2)

self.assertEqual(expected_name, link.group(follow_symlinks=False))

@os_helper.skip_unless_hardlink

def test_hardlink_to(self):

P = self.cls(self.base)

target = P / 'fileA'

size = target.stat().st_size

# linking to another path.

link = P / 'dirA' / 'fileAA'

link.hardlink_to(target)

self.assertEqual(link.stat().st_size, size)

self.assertTrue(os.path.samefile(target, link))

self.assertTrue(target.exists())

# Linking to a str of a relative path.

link2 = P / 'dirA' / 'fileAAA'

target2 = self.parser.join(TESTFN, 'fileA')

link2.hardlink_to(target2)

self.assertEqual(os.stat(target2).st_size, size)

self.assertTrue(link2.exists())

@unittest.skipIf(hasattr(os, "link"), "os.link() is present")

def test_hardlink_to_unsupported(self):

P = self.cls(self.base)

p = P / 'fileA'

# linking to another path.

q = P / 'dirA' / 'fileAA'

with self.assertRaises(pathlib.UnsupportedOperation):

q.hardlink_to(p)

def test_rename(self):

P = self.cls(self.base)

p = P / 'fileA'

size = p.stat().st_size

# Renaming to another path.

q = P / 'dirA' / 'fileAA'

renamed_p = p.rename(q)

self.assertEqual(renamed_p, q)

self.assertEqual(q.stat().st_size, size)

self.assertFileNotFound(p.stat)

# Renaming to a str of a relative path.

r = self.parser.join(TESTFN, 'fileAAA')

renamed_q = q.rename(r)

self.assertEqual(renamed_q, self.cls(r))

self.assertEqual(os.stat(r).st_size, size)

self.assertFileNotFound(q.stat)

def test_replace(self):

P = self.cls(self.base)

p = P / 'fileA'

size = p.stat().st_size

# Replacing a non-existing path.

q = P / 'dirA' / 'fileAA'

replaced_p = p.replace(q)

self.assertEqual(replaced_p, q)

self.assertEqual(q.stat().st_size, size)

self.assertFileNotFound(p.stat)

# Replacing another (existing) path.

r = self.parser.join(TESTFN, 'dirB', 'fileB')

replaced_q = q.replace(r)

self.assertEqual(replaced_q, self.cls(r))

self.assertEqual(os.stat(r).st_size, size)

self.assertFileNotFound(q.stat)

def test_touch_common(self):

P = self.cls(self.base)

p = P / 'newfileA'

self.assertFalse(p.exists())

p.touch()

self.assertTrue(p.exists())

st = p.stat()

old_mtime = st.st_mtime

old_mtime_ns = st.st_mtime_ns

# Rewind the mtime sufficiently far in the past to work around

# filesystem-specific timestamp granularity.

os.utime(str(p), (old_mtime - 10, old_mtime - 10))

# The file mtime should be refreshed by calling touch() again.

p.touch()

st = p.stat()

self.assertGreaterEqual(st.st_mtime_ns, old_mtime_ns)

self.assertGreaterEqual(st.st_mtime, old_mtime)

# Now with exist_ok=False.

p = P / 'newfileB'

self.assertFalse(p.exists())

p.touch(mode=0o700, exist_ok=False)

self.assertTrue(p.exists())

self.assertRaises(OSError, p.touch, exist_ok=False)

def test_touch_nochange(self):

P = self.cls(self.base)

p = P / 'fileA'

p.touch()

with p.open('rb') as f:

self.assertEqual(f.read().strip(), b"this is file A")

def test_mkdir(self):

P = self.cls(self.base)

p = P / 'newdirA'

self.assertFalse(p.exists())

p.mkdir()

self.assertTrue(p.exists())

self.assertTrue(p.is_dir())

with self.assertRaises(OSError) as cm:

p.mkdir()

self.assertEqual(cm.exception.errno, errno.EEXIST)

def test_mkdir_parents(self):

# Creating a chain of directories.

p = self.cls(self.base, 'newdirB', 'newdirC')

self.assertFalse(p.exists())

with self.assertRaises(OSError) as cm:

p.mkdir()

self.assertEqual(cm.exception.errno, errno.ENOENT)

p.mkdir(parents=True)

self.assertTrue(p.exists())

self.assertTrue(p.is_dir())

with self.assertRaises(OSError) as cm:

p.mkdir(parents=True)

self.assertEqual(cm.exception.errno, errno.EEXIST)

# Test `mode` arg.

mode = stat.S_IMODE(p.stat().st_mode) # Default mode.

p = self.cls(self.base, 'newdirD', 'newdirE')

p.mkdir(0o555, parents=True)

self.assertTrue(p.exists())

self.assertTrue(p.is_dir())

if os.name != 'nt':

# The directory's permissions follow the mode argument.

self.assertEqual(stat.S_IMODE(p.stat().st_mode), 0o7555 & mode)

# The parent's permissions follow the default process settings.

self.assertEqual(stat.S_IMODE(p.parent.stat().st_mode), mode)

def test_mkdir_exist_ok(self):

p = self.cls(self.base, 'dirB')

st_ctime_first = p.stat().st_ctime

self.assertTrue(p.exists())

self.assertTrue(p.is_dir())

with self.assertRaises(FileExistsError) as cm:

p.mkdir()

self.assertEqual(cm.exception.errno, errno.EEXIST)

p.mkdir(exist_ok=True)

self.assertTrue(p.exists())

self.assertEqual(p.stat().st_ctime, st_ctime_first)

def test_mkdir_exist_ok_with_parent(self):

p = self.cls(self.base, 'dirC')

self.assertTrue(p.exists())

with self.assertRaises(FileExistsError) as cm:

p.mkdir()

self.assertEqual(cm.exception.errno, errno.EEXIST)

p = p / 'newdirC'

p.mkdir(parents=True)

st_ctime_first = p.stat().st_ctime

self.assertTrue(p.exists())

with self.assertRaises(FileExistsError) as cm:

p.mkdir(parents=True)

self.assertEqual(cm.exception.errno, errno.EEXIST)

p.mkdir(parents=True, exist_ok=True)

self.assertTrue(p.exists())

self.assertEqual(p.stat().st_ctime, st_ctime_first)

@unittest.skipIf(is_emscripten, "FS root cannot be modified on Emscripten.")

def test_mkdir_exist_ok_root(self):

# Issue #25803: A drive root could raise PermissionError on Windows.

self.cls('/').resolve().mkdir(exist_ok=True)

self.cls('/').resolve().mkdir(parents=True, exist_ok=True)

@needs_windows # XXX: not sure how to test this on POSIX.

def test_mkdir_with_unknown_drive(self):

for d in 'ZYXWVUTSRQPONMLKJIHGFEDCBA':

p = self.cls(d + ':\\')

if not p.is_dir():

break

else:

self.skipTest("cannot find a drive that doesn't exist")

with self.assertRaises(OSError):

(p / 'child' / 'path').mkdir(parents=True)

def test_mkdir_with_child_file(self):

p = self.cls(self.base, 'dirB', 'fileB')

self.assertTrue(p.exists())

# An exception is raised when the last path component is an existing

# regular file, regardless of whether exist_ok is true or not.

with self.assertRaises(FileExistsError) as cm:

p.mkdir(parents=True)

self.assertEqual(cm.exception.errno, errno.EEXIST)

with self.assertRaises(FileExistsError) as cm:

p.mkdir(parents=True, exist_ok=True)

self.assertEqual(cm.exception.errno, errno.EEXIST)

def test_mkdir_no_parents_file(self):

p = self.cls(self.base, 'fileA')

self.assertTrue(p.exists())

# An exception is raised when the last path component is an existing

# regular file, regardless of whether exist_ok is true or not.

with self.assertRaises(FileExistsError) as cm:

p.mkdir()

self.assertEqual(cm.exception.errno, errno.EEXIST)

with self.assertRaises(FileExistsError) as cm:

p.mkdir(exist_ok=True)

self.assertEqual(cm.exception.errno, errno.EEXIST)

def test_mkdir_concurrent_parent_creation(self):

for pattern_num in range(32):

p = self.cls(self.base, 'dirCPC%d' % pattern_num)

self.assertFalse(p.exists())

real_mkdir = os.mkdir

def my_mkdir(path, mode=0o777):

path = str(path)

# Emulate another process that would create the directory

# just before we try to create it ourselves. We do it

# in all possible pattern combinations, assuming that this

# function is called at most 5 times (dirCPC/dir1/dir2,

# dirCPC/dir1, dirCPC, dirCPC/dir1, dirCPC/dir1/dir2).

if pattern.pop():

real_mkdir(path, mode) # From another process.

concurrently_created.add(path)

real_mkdir(path, mode) # Our real call.

pattern = [bool(pattern_num & (1 << n)) for n in range(5)]

concurrently_created = set()

p12 = p / 'dir1' / 'dir2'

try:

View remainder of file in raw view

FilesExpand file tree

test_pathlib.py

Latest commit

History

test_pathlib.py

File metadata and controls