cpython/Lib/pathlib.py at 3.5 · python/cpython · GitHub

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 fnmatch

import functools

import io

import ntpath

import os

import posixpath

import re

import sys

from collections import Sequence

from contextlib import contextmanager

from errno import EINVAL, ENOENT, ENOTDIR

from operator import attrgetter

from stat import S_ISDIR, S_ISLNK, S_ISREG, S_ISSOCK, S_ISBLK, S_ISCHR, S_ISFIFO

from urllib.parse import quote_from_bytes as urlquote_from_bytes

supports_symlinks = True

if os.name == 'nt':

import nt

if sys.getwindowsversion()[:2] >= (6, 0):

from nt import _getfinalpathname

else:

supports_symlinks = False

_getfinalpathname = None

else:

nt = None

__all__ = [

"PurePath", "PurePosixPath", "PureWindowsPath",

"Path", "PosixPath", "WindowsPath",

]

# Internals

def _is_wildcard_pattern(pat):

# Whether this pattern needs actual matching using fnmatch, or can

# be looked up directly as a file.

return "*" in pat or "?" in pat or "[" in pat

class _Flavour(object):

"""A flavour implements a particular (platform-specific) set of path

semantics."""

def __init__(self):

self.join = self.sep.join

def parse_parts(self, parts):

parsed = []

sep = self.sep

altsep = self.altsep

drv = root = ''

it = reversed(parts)

for part in it:

if not part:

continue

if altsep:

part = part.replace(altsep, sep)

drv, root, rel = self.splitroot(part)

if sep in rel:

for x in reversed(rel.split(sep)):

if x and x != '.':

parsed.append(sys.intern(x))

else:

if rel and rel != '.':

parsed.append(sys.intern(rel))

if drv or root:

if not drv:

# If no drive is present, try to find one in the previous

# parts. This makes the result of parsing e.g.

# ("C:", "/", "a") reasonably intuitive.

for part in it:

if not part:

continue

if altsep:

part = part.replace(altsep, sep)

drv = self.splitroot(part)[0]

if drv:

break

if drv or root:

parsed.append(drv + root)

parsed.reverse()

return drv, root, parsed

def join_parsed_parts(self, drv, root, parts, drv2, root2, parts2):

"""

Join the two paths represented by the respective

(drive, root, parts) tuples. Return a new (drive, root, parts) tuple.

"""

if root2:

if not drv2 and drv:

return drv, root2, [drv + root2] + parts2[1:]

elif drv2:

if drv2 == drv or self.casefold(drv2) == self.casefold(drv):

# Same drive => second path is relative to the first

return drv, root, parts + parts2[1:]

else:

# Second path is non-anchored (common case)

return drv, root, parts + parts2

return drv2, root2, parts2

class _WindowsFlavour(_Flavour):

# Reference for Windows paths can be found at

# http://msdn.microsoft.com/en-us/library/aa365247%28v=vs.85%29.aspx

sep = '\\'

altsep = '/'

has_drv = True

pathmod = ntpath

is_supported = (os.name == 'nt')

drive_letters = (

set(chr(x) for x in range(ord('a'), ord('z') + 1)) |

set(chr(x) for x in range(ord('A'), ord('Z') + 1))

)

ext_namespace_prefix = '\\\\?\\'

reserved_names = (

{'CON', 'PRN', 'AUX', 'NUL'} |

{'COM%d' % i for i in range(1, 10)} |

{'LPT%d' % i for i in range(1, 10)}

)

# Interesting findings about extended paths:

# - '\\?\c:\a', '//?/c:\a' and '//?/c:/a' are all supported

# but '\\?\c:/a' is not

# - extended paths are always absolute; "relative" extended paths will

# fail.

def splitroot(self, part, sep=sep):

first = part[0:1]

second = part[1:2]

if (second == sep and first == sep):

# XXX extended paths should also disable the collapsing of "."

# components (according to MSDN docs).

prefix, part = self._split_extended_path(part)

first = part[0:1]

second = part[1:2]

else:

prefix = ''

third = part[2:3]

if (second == sep and first == sep and third != sep):

# is a UNC path:

# vvvvvvvvvvvvvvvvvvvvv root

# \\machine\mountpoint\directory\etc\...

# directory ^^^^^^^^^^^^^^

index = part.find(sep, 2)

if index != -1:

index2 = part.find(sep, index + 1)

# a UNC path can't have two slashes in a row

# (after the initial two)

if index2 != index + 1:

if index2 == -1:

index2 = len(part)

if prefix:

return prefix + part[1:index2], sep, part[index2+1:]

else:

return part[:index2], sep, part[index2+1:]

drv = root = ''

if second == ':' and first in self.drive_letters:

drv = part[:2]

part = part[2:]

first = third

if first == sep:

root = first

part = part.lstrip(sep)

return prefix + drv, root, part

def casefold(self, s):

return s.lower()

def casefold_parts(self, parts):

return [p.lower() for p in parts]

def resolve(self, path):

s = str(path)

if not s:

return os.getcwd()

if _getfinalpathname is not None:

return self._ext_to_normal(_getfinalpathname(s))

# Means fallback on absolute

return None

def _split_extended_path(self, s, ext_prefix=ext_namespace_prefix):

prefix = ''

if s.startswith(ext_prefix):

prefix = s[:4]

s = s[4:]

if s.startswith('UNC\\'):

prefix += s[:3]

s = '\\' + s[3:]

return prefix, s

def _ext_to_normal(self, s):

# Turn back an extended path into a normal DOS-like path

return self._split_extended_path(s)[1]

def is_reserved(self, parts):

# NOTE: the rules for reserved names seem somewhat complicated

# (e.g. r"..\NUL" is reserved but not r"foo\NUL").

# We err on the side of caution and return True for paths which are

# not considered reserved by Windows.

if not parts:

return False

if parts[0].startswith('\\\\'):

# UNC paths are never reserved

return False

return parts[-1].partition('.')[0].upper() in self.reserved_names

def make_uri(self, path):

# Under Windows, file URIs use the UTF-8 encoding.

drive = path.drive

if len(drive) == 2 and drive[1] == ':':

# It's a path on a local drive => 'file:///c:/a/b'

rest = path.as_posix()[2:].lstrip('/')

return 'file:///%s/%s' % (

drive, urlquote_from_bytes(rest.encode('utf-8')))

else:

# It's a path on a network drive => 'file://host/share/a/b'

return 'file:' + urlquote_from_bytes(path.as_posix().encode('utf-8'))

def gethomedir(self, username):

if 'HOME' in os.environ:

userhome = os.environ['HOME']

elif 'USERPROFILE' in os.environ:

userhome = os.environ['USERPROFILE']

elif 'HOMEPATH' in os.environ:

try:

drv = os.environ['HOMEDRIVE']

except KeyError:

drv = ''

userhome = drv + os.environ['HOMEPATH']

else:

raise RuntimeError("Can't determine home directory")

if username:

# Try to guess user home directory. By default all users

# directories are located in the same place and are named by

# corresponding usernames. If current user home directory points

# to nonstandard place, this guess is likely wrong.

if os.environ['USERNAME'] != username:

drv, root, parts = self.parse_parts((userhome,))

if parts[-1] != os.environ['USERNAME']:

raise RuntimeError("Can't determine home directory "

"for %r" % username)

parts[-1] = username

if drv or root:

userhome = drv + root + self.join(parts[1:])

else:

userhome = self.join(parts)

return userhome

class _PosixFlavour(_Flavour):

sep = '/'

altsep = ''

has_drv = False

pathmod = posixpath

is_supported = (os.name != 'nt')

def splitroot(self, part, sep=sep):

if part and part[0] == sep:

stripped_part = part.lstrip(sep)

# According to POSIX path resolution:

# http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap04.html#tag_04_11

# "A pathname that begins with two successive slashes may be

# interpreted in an implementation-defined manner, although more

# than two leading slashes shall be treated as a single slash".

if len(part) - len(stripped_part) == 2:

return '', sep * 2, stripped_part

else:

return '', sep, stripped_part

else:

return '', '', part

def casefold(self, s):

return s

def casefold_parts(self, parts):

return parts

def resolve(self, path):

sep = self.sep

accessor = path._accessor

seen = {}

def _resolve(path, rest):

if rest.startswith(sep):

path = ''

for name in rest.split(sep):

if not name or name == '.':

# current dir

continue

if name == '..':

# parent dir

path, _, _ = path.rpartition(sep)

continue

newpath = path + sep + name

if newpath in seen:

# Already seen this path

path = seen[newpath]

if path is not None:

# use cached value

continue

# The symlink is not resolved, so we must have a symlink loop.

raise RuntimeError("Symlink loop from %r" % newpath)

# Resolve the symbolic link

try:

target = accessor.readlink(newpath)

except OSError as e:

if e.errno != EINVAL:

raise

# Not a symlink

path = newpath

else:

seen[newpath] = None # not resolved symlink

path = _resolve(path, target)

seen[newpath] = path # resolved symlink

return path

# NOTE: according to POSIX, getcwd() cannot contain path components

# which are symlinks.

base = '' if path.is_absolute() else os.getcwd()

return _resolve(base, str(path)) or sep

def is_reserved(self, parts):

return False

def make_uri(self, path):

# We represent the path using the local filesystem encoding,

# for portability to other applications.

bpath = bytes(path)

return 'file://' + urlquote_from_bytes(bpath)

def gethomedir(self, username):

if not username:

try:

return os.environ['HOME']

except KeyError:

import pwd

return pwd.getpwuid(os.getuid()).pw_dir

else:

import pwd

try:

return pwd.getpwnam(username).pw_dir

except KeyError:

raise RuntimeError("Can't determine home directory "

"for %r" % username)

_windows_flavour = _WindowsFlavour()

_posix_flavour = _PosixFlavour()

class _Accessor:

"""An accessor implements a particular (system-specific or not) way of

accessing paths on the filesystem."""

class _NormalAccessor(_Accessor):

def _wrap_strfunc(strfunc):

@functools.wraps(strfunc)

def wrapped(pathobj, *args):

return strfunc(str(pathobj), *args)

return staticmethod(wrapped)

def _wrap_binary_strfunc(strfunc):

@functools.wraps(strfunc)

def wrapped(pathobjA, pathobjB, *args):

return strfunc(str(pathobjA), str(pathobjB), *args)

return staticmethod(wrapped)

stat = _wrap_strfunc(os.stat)

lstat = _wrap_strfunc(os.lstat)

open = _wrap_strfunc(os.open)

listdir = _wrap_strfunc(os.listdir)

chmod = _wrap_strfunc(os.chmod)

if hasattr(os, "lchmod"):

lchmod = _wrap_strfunc(os.lchmod)

else:

def lchmod(self, pathobj, mode):

raise NotImplementedError("lchmod() not available on this system")

mkdir = _wrap_strfunc(os.mkdir)

unlink = _wrap_strfunc(os.unlink)

rmdir = _wrap_strfunc(os.rmdir)

rename = _wrap_binary_strfunc(os.rename)

replace = _wrap_binary_strfunc(os.replace)

if nt:

if supports_symlinks:

symlink = _wrap_binary_strfunc(os.symlink)

else:

def symlink(a, b, target_is_directory):

raise NotImplementedError("symlink() not available on this system")

else:

# Under POSIX, os.symlink() takes two args

@staticmethod

def symlink(a, b, target_is_directory):

return os.symlink(str(a), str(b))

utime = _wrap_strfunc(os.utime)

# Helper for resolve()

def readlink(self, path):

return os.readlink(path)

_normal_accessor = _NormalAccessor()

# Globbing helpers

@contextmanager

def _cached(func):

try:

func.__cached__

yield func

except AttributeError:

cache = {}

def wrapper(*args):

try:

return cache[args]

except KeyError:

value = cache[args] = func(*args)

return value

wrapper.__cached__ = True

try:

yield wrapper

finally:

cache.clear()

def _make_selector(pattern_parts):

pat = pattern_parts[0]

child_parts = pattern_parts[1:]

if pat == '**':

cls = _RecursiveWildcardSelector

elif '**' in pat:

raise ValueError("Invalid pattern: '**' can only be an entire path component")

elif _is_wildcard_pattern(pat):

cls = _WildcardSelector

else:

cls = _PreciseSelector

return cls(pat, child_parts)

if hasattr(functools, "lru_cache"):

_make_selector = functools.lru_cache()(_make_selector)

class _Selector:

"""A selector matches a specific glob pattern part against the children

of a given path."""

def __init__(self, child_parts):

self.child_parts = child_parts

if child_parts:

self.successor = _make_selector(child_parts)

else:

self.successor = _TerminatingSelector()

def select_from(self, parent_path):

"""Iterate over all child paths of `parent_path` matched by this

selector. This can contain parent_path itself."""

path_cls = type(parent_path)

is_dir = path_cls.is_dir

exists = path_cls.exists

listdir = parent_path._accessor.listdir

return self._select_from(parent_path, is_dir, exists, listdir)

class _TerminatingSelector:

def _select_from(self, parent_path, is_dir, exists, listdir):

yield parent_path

class _PreciseSelector(_Selector):

def __init__(self, name, child_parts):

self.name = name

_Selector.__init__(self, child_parts)

def _select_from(self, parent_path, is_dir, exists, listdir):

try:

if not is_dir(parent_path):

return

path = parent_path._make_child_relpath(self.name)

if exists(path):

for p in self.successor._select_from(path, is_dir, exists, listdir):

yield p

except PermissionError:

return

class _WildcardSelector(_Selector):

def __init__(self, pat, child_parts):

self.pat = re.compile(fnmatch.translate(pat))

_Selector.__init__(self, child_parts)

def _select_from(self, parent_path, is_dir, exists, listdir):

try:

if not is_dir(parent_path):

return

cf = parent_path._flavour.casefold

for name in listdir(parent_path):

casefolded = cf(name)

if self.pat.match(casefolded):

path = parent_path._make_child_relpath(name)

for p in self.successor._select_from(path, is_dir, exists, listdir):

yield p

except PermissionError:

return

class _RecursiveWildcardSelector(_Selector):

def __init__(self, pat, child_parts):

_Selector.__init__(self, child_parts)

def _iterate_directories(self, parent_path, is_dir, listdir):

yield parent_path

try:

for name in listdir(parent_path):

path = parent_path._make_child_relpath(name)

if is_dir(path) and not path.is_symlink():

for p in self._iterate_directories(path, is_dir, listdir):

yield p

except PermissionError:

return

def _select_from(self, parent_path, is_dir, exists, listdir):

try:

if not is_dir(parent_path):

return

with _cached(listdir) as listdir:

yielded = set()

try:

successor_select = self.successor._select_from

for starting_point in self._iterate_directories(parent_path, is_dir, listdir):

for p in successor_select(starting_point, is_dir, exists, listdir):

if p not in yielded:

yield p

yielded.add(p)

finally:

yielded.clear()

except PermissionError:

return

# Public API

class _PathParents(Sequence):

"""This object provides sequence-like access to the logical ancestors

of a path. Don't try to construct it yourself."""

__slots__ = ('_pathcls', '_drv', '_root', '_parts')

def __init__(self, path):

# We don't store the instance to avoid reference cycles

self._pathcls = type(path)

self._drv = path._drv

self._root = path._root

self._parts = path._parts

def __len__(self):

if self._drv or self._root:

return len(self._parts) - 1

else:

return len(self._parts)

def __getitem__(self, idx):

if idx < 0 or idx >= len(self):

raise IndexError(idx)

return self._pathcls._from_parsed_parts(self._drv, self._root,

self._parts[:-idx - 1])

def __repr__(self):

return "<{}.parents>".format(self._pathcls.__name__)

class PurePath(object):

"""PurePath represents a filesystem path and offers operations which

don't imply any actual filesystem I/O. Depending on your system,

instantiating a PurePath will return either a PurePosixPath or a

PureWindowsPath object. You can also instantiate either of these classes

directly, regardless of your system.

"""

__slots__ = (

'_drv', '_root', '_parts',

'_str', '_hash', '_pparts', '_cached_cparts',

)

def __new__(cls, *args):

"""Construct a PurePath from one or several strings and or existing

PurePath objects. The strings and path objects are combined so as

to yield a canonicalized path, which is incorporated into the

new PurePath object.

"""

if cls is PurePath:

cls = PureWindowsPath if os.name == 'nt' else PurePosixPath

return cls._from_parts(args)

def __reduce__(self):

# Using the parts tuple helps share interned path parts

# when pickling related paths.

return (self.__class__, tuple(self._parts))

@classmethod

def _parse_args(cls, args):

# This is useful when you don't want to create an instance, just

# canonicalize some constructor arguments.

parts = []

for a in args:

if isinstance(a, PurePath):

parts += a._parts

elif isinstance(a, str):

# Force-cast str subclasses to str (issue #21127)

parts.append(str(a))

else:

raise TypeError(

"argument should be a path or str object, not %r"

% type(a))

return cls._flavour.parse_parts(parts)

@classmethod

def _from_parts(cls, args, init=True):

# We need to call _parse_args on the instance, so as to get the

# right flavour.

self = object.__new__(cls)

drv, root, parts = self._parse_args(args)

self._drv = drv

self._root = root

self._parts = parts

if init:

self._init()

return self

@classmethod

def _from_parsed_parts(cls, drv, root, parts, init=True):

self = object.__new__(cls)

self._drv = drv

self._root = root

self._parts = parts

if init:

self._init()

return self

@classmethod

def _format_parsed_parts(cls, drv, root, parts):

if drv or root:

return drv + root + cls._flavour.join(parts[1:])

else:

return cls._flavour.join(parts)

def _init(self):

# Overridden in concrete Path

pass

def _make_child(self, args):

drv, root, parts = self._parse_args(args)

drv, root, parts = self._flavour.join_parsed_parts(

self._drv, self._root, self._parts, drv, root, parts)

return self._from_parsed_parts(drv, root, parts)

def __str__(self):

"""Return the string representation of the path, suitable for

passing to system calls."""

try:

return self._str

except AttributeError:

self._str = self._format_parsed_parts(self._drv, self._root,

self._parts) or '.'

return self._str

def as_posix(self):

"""Return the string representation of the path with forward (/)

slashes."""

f = self._flavour

return str(self).replace(f.sep, '/')

def __bytes__(self):

"""Return the bytes representation of the path. This is only

recommended to use under Unix."""

return os.fsencode(str(self))

def __repr__(self):

return "{}({!r})".format(self.__class__.__name__, self.as_posix())

def as_uri(self):

"""Return the path as a 'file' URI."""

if not self.is_absolute():

raise ValueError("relative path can't be expressed as a file URI")

return self._flavour.make_uri(self)

@property

def _cparts(self):

# Cached casefolded parts, for hashing and comparison

try:

return self._cached_cparts

except AttributeError:

self._cached_cparts = self._flavour.casefold_parts(self._parts)

return self._cached_cparts

def __eq__(self, other):

if not isinstance(other, PurePath):

return NotImplemented

return self._cparts == other._cparts and self._flavour is other._flavour

def __hash__(self):

try:

return self._hash

except AttributeError:

self._hash = hash(tuple(self._cparts))

return self._hash

def __lt__(self, other):

if not isinstance(other, PurePath) or self._flavour is not other._flavour:

return NotImplemented

return self._cparts < other._cparts

def __le__(self, other):

if not isinstance(other, PurePath) or self._flavour is not other._flavour:

return NotImplemented

return self._cparts <= other._cparts

def __gt__(self, other):

if not isinstance(other, PurePath) or self._flavour is not other._flavour:

return NotImplemented

return self._cparts > other._cparts

def __ge__(self, other):

if not isinstance(other, PurePath) or self._flavour is not other._flavour:

return NotImplemented

return self._cparts >= other._cparts

drive = property(attrgetter('_drv'),

doc="""The drive prefix (letter or UNC path), if any.""")

root = property(attrgetter('_root'),

doc="""The root of the path, if any.""")

@property

def anchor(self):

"""The concatenation of the drive and root, or ''."""

anchor = self._drv + self._root

return anchor

@property

def name(self):

"""The final path component, if any."""

parts = self._parts

if len(parts) == (1 if (self._drv or self._root) else 0):

return ''

return parts[-1]

@property

def suffix(self):

"""The final component's last suffix, if any."""

name = self.name

i = name.rfind('.')

if 0 < i < len(name) - 1:

return name[i:]

else:

return ''

@property

def suffixes(self):

"""A list of the final component's suffixes, if any."""

name = self.name

if name.endswith('.'):

return []

name = name.lstrip('.')

return ['.' + suffix for suffix in name.split('.')[1:]]

@property

def stem(self):

"""The final path component, minus its last suffix."""

name = self.name

i = name.rfind('.')

if 0 < i < len(name) - 1:

return name[:i]

else:

return name

def with_name(self, name):

"""Return a new path with the file name changed."""

if not self.name:

raise ValueError("%r has an empty name" % (self,))

drv, root, parts = self._flavour.parse_parts((name,))

if (not name or name[-1] in [self._flavour.sep, self._flavour.altsep]

or drv or root or len(parts) != 1):

raise ValueError("Invalid name %r" % (name))

return self._from_parsed_parts(self._drv, self._root,

self._parts[:-1] + [name])

def with_suffix(self, suffix):

"""Return a new path with the file suffix changed (or added, if none)."""

# XXX if suffix is None, should the current suffix be removed?

f = self._flavour

if f.sep in suffix or f.altsep and f.altsep in suffix:

raise ValueError("Invalid suffix %r" % (suffix))

if suffix and not suffix.startswith('.') or suffix == '.':

raise ValueError("Invalid suffix %r" % (suffix))

name = self.name

if not name:

raise ValueError("%r has an empty name" % (self,))

old_suffix = self.suffix

if not old_suffix:

name = name + suffix

else:

name = name[:-len(old_suffix)] + suffix

return self._from_parsed_parts(self._drv, self._root,

self._parts[:-1] + [name])

def relative_to(self, *other):

"""Return the relative path to another path identified by the passed

arguments. If the operation is not possible (because this is not

a subpath of the other path), raise ValueError.

"""

# For the purpose of this method, drive and root are considered

# separate parts, i.e.:

# Path('c:/').relative_to('c:') gives Path('/')

# Path('c:/').relative_to('/') raise ValueError

if not other:

raise TypeError("need at least one argument")

parts = self._parts

drv = self._drv

root = self._root

if root:

abs_parts = [drv, root] + parts[1:]

else:

abs_parts = parts

to_drv, to_root, to_parts = self._parse_args(other)

if to_root:

to_abs_parts = [to_drv, to_root] + to_parts[1:]

else:

to_abs_parts = to_parts

n = len(to_abs_parts)

cf = self._flavour.casefold_parts

if (root or drv) if n == 0 else cf(abs_parts[:n]) != cf(to_abs_parts):

formatted = self._format_parsed_parts(to_drv, to_root, to_parts)

raise ValueError("{!r} does not start with {!r}"

.format(str(self), str(formatted)))

return self._from_parsed_parts('', root if n == 1 else '',

abs_parts[n:])

@property

def parts(self):

"""An object providing sequence-like access to the

components in the filesystem path."""

# We cache the tuple to avoid building a new one each time .parts

# is accessed. XXX is this necessary?

try:

return self._pparts

except AttributeError:

self._pparts = tuple(self._parts)

return self._pparts

def joinpath(self, *args):

"""Combine this path with one or several arguments, and return a

new path representing either a subpath (if all arguments are relative

paths) or a totally different path (if one of the arguments is

anchored).

"""

return self._make_child(args)

def __truediv__(self, key):

return self._make_child((key,))

def __rtruediv__(self, key):

return self._from_parts([key] + self._parts)

@property

def parent(self):

"""The logical parent of the path."""

drv = self._drv

root = self._root

parts = self._parts

if len(parts) == 1 and (drv or root):

return self

return self._from_parsed_parts(drv, root, parts[:-1])

@property

def parents(self):

"""A sequence of this path's logical parents."""

return _PathParents(self)

def is_absolute(self):

"""True if the path is absolute (has both a root and, if applicable,

a drive)."""

if not self._root:

return False

return not self._flavour.has_drv or bool(self._drv)

def is_reserved(self):

"""Return True if the path contains one of the special names reserved

by the system, if any."""

return self._flavour.is_reserved(self._parts)

def match(self, path_pattern):

"""

Return True if this path matches the given pattern.

"""

cf = self._flavour.casefold

path_pattern = cf(path_pattern)

drv, root, pat_parts = self._flavour.parse_parts((path_pattern,))

if not pat_parts:

raise ValueError("empty pattern")

if drv and drv != cf(self._drv):

return False

if root and root != cf(self._root):

return False

parts = self._cparts

if drv or root:

if len(pat_parts) != len(parts):

return False

pat_parts = pat_parts[1:]

elif len(pat_parts) > len(parts):

return False

for part, pat in zip(reversed(parts), reversed(pat_parts)):

if not fnmatch.fnmatchcase(part, pat):

return False

return True

class PurePosixPath(PurePath):

_flavour = _posix_flavour

__slots__ = ()

class PureWindowsPath(PurePath):

_flavour = _windows_flavour

__slots__ = ()

# Filesystem-accessing classes

class Path(PurePath):

__slots__ = (

'_accessor',

'_closed',

)

def __new__(cls, *args, **kwargs):

if cls is Path:

cls = WindowsPath if os.name == 'nt' else PosixPath

self = cls._from_parts(args, init=False)

if not self._flavour.is_supported:

raise NotImplementedError("cannot instantiate %r on your system"

% (cls.__name__,))

self._init()

return self

def _init(self,

# Private non-constructor arguments

template=None,

self._closed = False

if template is not None:

self._accessor = template._accessor

else:

self._accessor = _normal_accessor

def _make_child_relpath(self, part):

# This is an optimization used for dir walking. `part` must be

# a single part relative to this path.

parts = self._parts + [part]

return self._from_parsed_parts(self._drv, self._root, parts)

def __enter__(self):

if self._closed:

self._raise_closed()

return self

def __exit__(self, t, v, tb):

self._closed = True

def _raise_closed(self):

View remainder of file in raw view

cpython/Lib/pathlib.py at 3.5 · python/cpython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

pathlib.py

Latest commit

History

Breadcrumbs

pathlib.py

File metadata and controls