cpython/Lib/shutil.py at main · 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

"""Utility functions for copying and archiving files and directory trees.

XXX The functions here don't copy the resource fork or other metadata on Mac.

"""

import os

import sys

import stat

import fnmatch

import collections

import errno

try:

import zlib

del zlib

_ZLIB_SUPPORTED = True

except ImportError:

_ZLIB_SUPPORTED = False

# bz2, lzma and compression.zstd are pure Python wrappers whose only

# importable dependency that may be missing is the extension module they

# wrap. Probe those extensions directly instead: it gives the same answer

# without executing the wrappers, which shutil only needs when an archive

# is actually created or extracted.

try:

import _bz2

del _bz2

_BZ2_SUPPORTED = True

except ImportError:

_BZ2_SUPPORTED = False

try:

import _lzma

del _lzma

_LZMA_SUPPORTED = True

except ImportError:

_LZMA_SUPPORTED = False

try:

import _zstd

del _zstd

_ZSTD_SUPPORTED = True

except ImportError:

_ZSTD_SUPPORTED = False

_WINDOWS = os.name == 'nt'

posix = nt = None

if os.name == 'posix':

import posix

elif _WINDOWS:

import nt

if sys.platform == 'win32':

import _winapi

else:

_winapi = None

COPY_BUFSIZE = 1024 * 1024 if _WINDOWS else 256 * 1024

# This should never be removed, see rationale in:

# https://bugs.python.org/issue43743#msg393429

_USE_CP_SENDFILE = (hasattr(os, "sendfile")

and sys.platform.startswith(("linux", "android", "sunos")))

_USE_CP_COPY_FILE_RANGE = hasattr(os, "copy_file_range")

_HAS_FCOPYFILE = posix and hasattr(posix, "_fcopyfile") # macOS

# CMD defaults in Windows 10

_WIN_DEFAULT_PATHEXT = ".COM;.EXE;.BAT;.CMD;.VBS;.JS;.WS;.MSC"

__all__ = ["copyfileobj", "copyfile", "copymode", "copystat", "copy", "copy2",

"copytree", "move", "rmtree", "Error", "SpecialFileError",

"make_archive", "get_archive_formats",

"register_archive_format", "unregister_archive_format",

"get_unpack_formats", "register_unpack_format",

"unregister_unpack_format", "unpack_archive",

"ignore_patterns", "chown", "which", "get_terminal_size",

"SameFileError"]

# disk_usage is added later, if available on the platform

class Error(OSError):

pass

class SameFileError(Error):

"""Raised when source and destination are the same file."""

class SpecialFileError(OSError):

"""Raised when trying to do a kind of operation (e.g. copying) which is

not supported on a special file (e.g. a named pipe)"""

class ReadError(OSError):

"""Raised when an archive cannot be read"""

class RegistryError(Exception):

"""Raised when a registry operation with the archiving

and unpacking registries fails"""

class _GiveupOnFastCopy(Exception):

"""Raised as a signal to fallback on using raw read()/write()

file copy when fast-copy functions fail to do so.

"""

def _fastcopy_fcopyfile(fsrc, fdst, flags):

"""Copy a regular file content or metadata by using high-performance

fcopyfile(3) syscall (macOS).

"""

try:

infd = fsrc.fileno()

outfd = fdst.fileno()

except Exception as err:

raise _GiveupOnFastCopy(err) # not a regular file

try:

posix._fcopyfile(infd, outfd, flags)

except OSError as err:

err.filename = fsrc.name

err.filename2 = fdst.name

if err.errno in {errno.EINVAL, errno.ENOTSUP}:

raise _GiveupOnFastCopy(err)

else:

raise err from None

def _determine_linux_fastcopy_blocksize(infd):

"""Determine blocksize for fastcopying on Linux.

Hopefully the whole file will be copied in a single call.

The copying itself should be performed in a loop 'till EOF is

reached (0 return) so a blocksize smaller or bigger than the actual

file size should not make any difference, also in case the file

content changes while being copied.

"""

try:

blocksize = max(os.fstat(infd).st_size, 2 ** 23) # min 8 MiB

except OSError:

blocksize = 2 ** 27 # 128 MiB

# On 32-bit architectures truncate to 1 GiB to avoid OverflowError,

# see gh-82500.

if sys.maxsize < 2 ** 32:

blocksize = min(blocksize, 2 ** 30)

return blocksize

def _fastcopy_copy_file_range(fsrc, fdst):

"""Copy data from one regular mmap-like fd to another by using

a high-performance copy_file_range(2) syscall that gives filesystems

an opportunity to implement the use of reflinks or server-side copy.

This should work on Linux >= 4.5 only.

"""

try:

infd = fsrc.fileno()

outfd = fdst.fileno()

except Exception as err:

raise _GiveupOnFastCopy(err) # not a regular file

blocksize = _determine_linux_fastcopy_blocksize(infd)

offset = 0

while True:

try:

n_copied = os.copy_file_range(infd, outfd, blocksize, offset_dst=offset)

except OSError as err:

# ...in oder to have a more informative exception.

err.filename = fsrc.name

err.filename2 = fdst.name

if err.errno == errno.ENOSPC: # filesystem is full

raise err from None

# Give up on first call and if no data was copied.

if offset == 0 and os.lseek(outfd, 0, os.SEEK_CUR) == 0:

raise _GiveupOnFastCopy(err)

raise err

else:

if n_copied == 0:

# If no bytes have been copied yet, copy_file_range

# might silently fail.

# https://lore.kernel.org/linux-fsdevel/20210126233840.GG4626@dread.disaster.area/T/#m05753578c7f7882f6e9ffe01f981bc223edef2b0

if offset == 0:

raise _GiveupOnFastCopy()

break

offset += n_copied

def _fastcopy_sendfile(fsrc, fdst):

"""Copy data from one regular mmap-like fd to another by using

high-performance sendfile(2) syscall.

This should work on Linux >= 2.6.33, Android and Solaris.

"""

# Note: copyfileobj() is left alone in order to not introduce any

# unexpected breakage. Possible risks by using zero-copy calls

# in copyfileobj() are:

# - fdst cannot be open in "a"(ppend) mode

# - fsrc and fdst may be open in "t"(ext) mode

# - fsrc may be a BufferedReader (which hides unread data in a buffer),

# GzipFile (which decompresses data), HTTPResponse (which decodes

# chunks).

# - possibly others (e.g. encrypted fs/partition?)

global _USE_CP_SENDFILE

try:

infd = fsrc.fileno()

outfd = fdst.fileno()

except Exception as err:

raise _GiveupOnFastCopy(err) # not a regular file

blocksize = _determine_linux_fastcopy_blocksize(infd)

offset = 0

while True:

try:

sent = os.sendfile(outfd, infd, offset, blocksize)

except OSError as err:

# ...in order to have a more informative exception.

err.filename = fsrc.name

err.filename2 = fdst.name

if err.errno == errno.ENOTSOCK:

# sendfile() on this platform (probably Linux < 2.6.33)

# does not support copies between regular files (only

# sockets).

_USE_CP_SENDFILE = False

raise _GiveupOnFastCopy(err)

if err.errno == errno.ENOSPC: # filesystem is full

raise err from None

# Give up on first call and if no data was copied.

if offset == 0 and os.lseek(outfd, 0, os.SEEK_CUR) == 0:

raise _GiveupOnFastCopy(err)

raise err

else:

if sent == 0:

break # EOF

offset += sent

def _copyfileobj_readinto(fsrc, fdst, length=COPY_BUFSIZE):

"""readinto()/memoryview() based variant of copyfileobj().

*fsrc* must support readinto() method and both files must be

open in binary mode.

"""

# Localize variable access to minimize overhead.

fsrc_readinto = fsrc.readinto

fdst_write = fdst.write

with memoryview(bytearray(length)) as mv:

while True:

n = fsrc_readinto(mv)

if not n:

break

elif n < length:

with mv[:n] as smv:

fdst_write(smv)

break

else:

fdst_write(mv)

def copyfileobj(fsrc, fdst, length=0):

"""copy data from file-like object fsrc to file-like object fdst"""

if not length:

length = COPY_BUFSIZE

# Localize variable access to minimize overhead.

fsrc_read = fsrc.read

fdst_write = fdst.write

while buf := fsrc_read(length):

fdst_write(buf)

def _samefile(src, dst):

# Macintosh, Unix.

if isinstance(src, os.DirEntry) and hasattr(os.path, 'samestat'):

try:

return os.path.samestat(src.stat(), os.stat(dst))

except OSError:

return False

if hasattr(os.path, 'samefile'):

try:

return os.path.samefile(src, dst)

except OSError:

return False

# All other platforms: check for same pathname.

return (os.path.normcase(os.path.abspath(src)) ==

os.path.normcase(os.path.abspath(dst)))

def _stat(fn):

return fn.stat() if isinstance(fn, os.DirEntry) else os.stat(fn)

def _islink(fn):

return fn.is_symlink() if isinstance(fn, os.DirEntry) else os.path.islink(fn)

def copyfile(src, dst, *, follow_symlinks=True):

"""Copy data from src to dst in the most efficient way possible.

If follow_symlinks is not set and src is a symbolic link, a new

symlink will be created instead of copying the file it points to.

"""

sys.audit("shutil.copyfile", src, dst)

if _samefile(src, dst):

raise SameFileError("{!r} and {!r} are the same file".format(src, dst))

copy_symlink = not follow_symlinks and _islink(src)

file_size = 0

for i, fn in enumerate([src, dst]):

if copy_symlink and i == 0:

continue

try:

st = _stat(fn)

except OSError:

# File most likely does not exist

pass

else:

if stat.S_ISFIFO(st.st_mode):

fn = fn.path if isinstance(fn, os.DirEntry) else fn

raise SpecialFileError("`%s` is a named pipe" % fn)

elif stat.S_ISSOCK(st.st_mode):

fn = fn.path if isinstance(fn, os.DirEntry) else fn

raise SpecialFileError("`%s` is a socket" % fn)

elif stat.S_ISBLK(st.st_mode):

fn = fn.path if isinstance(fn, os.DirEntry) else fn

raise SpecialFileError("`%s` is a block device" % fn)

elif stat.S_ISCHR(st.st_mode):

fn = fn.path if isinstance(fn, os.DirEntry) else fn

raise SpecialFileError("`%s` is a character device" % fn)

if _WINDOWS and i == 0:

file_size = st.st_size

if copy_symlink:

os.symlink(os.readlink(src), dst)

else:

with open(src, 'rb') as fsrc:

try:

with open(dst, 'wb') as fdst:

# macOS

if _HAS_FCOPYFILE:

try:

_fastcopy_fcopyfile(fsrc, fdst, posix._COPYFILE_DATA)

return dst

except _GiveupOnFastCopy:

pass

# Linux / Android / Solaris

elif _USE_CP_SENDFILE or _USE_CP_COPY_FILE_RANGE:

# reflink may be implicit in copy_file_range.

if _USE_CP_COPY_FILE_RANGE:

try:

_fastcopy_copy_file_range(fsrc, fdst)

return dst

except _GiveupOnFastCopy:

pass

if _USE_CP_SENDFILE:

try:

_fastcopy_sendfile(fsrc, fdst)

return dst

except _GiveupOnFastCopy:

pass

# Windows, see:

# https://github.com/python/cpython/pull/7160#discussion_r195405230

elif _WINDOWS and file_size > 0:

_copyfileobj_readinto(fsrc, fdst, min(file_size, COPY_BUFSIZE))

return dst

copyfileobj(fsrc, fdst)

# Issue 43219, raise a less confusing exception

except IsADirectoryError as e:

if not os.path.exists(dst):

raise FileNotFoundError(f'Directory does not exist: {dst}') from e

else:

raise

return dst

def copymode(src, dst, *, follow_symlinks=True):

"""Copy mode bits from src to dst.

If follow_symlinks is not set, symlinks aren't followed if and only

if both `src` and `dst` are symlinks. If `lchmod` isn't available

(e.g. Linux) this method does nothing.

"""

sys.audit("shutil.copymode", src, dst)

if not follow_symlinks and _islink(src) and os.path.islink(dst):

if hasattr(os, 'lchmod'):

stat_func, chmod_func = os.lstat, os.lchmod

else:

return

else:

stat_func = _stat

if os.name == 'nt' and os.path.islink(dst):

def chmod_func(*args):

os.chmod(*args, follow_symlinks=True)

else:

chmod_func = os.chmod

st = stat_func(src)

chmod_func(dst, stat.S_IMODE(st.st_mode))

if hasattr(os, 'listxattr'):

def _copyxattr(src, dst, *, follow_symlinks=True):

"""Copy extended filesystem attributes from `src` to `dst`.

Overwrite existing attributes.

If `follow_symlinks` is false, symlinks won't be followed.

"""

try:

names = os.listxattr(src, follow_symlinks=follow_symlinks)

except OSError as e:

if e.errno not in (errno.ENOTSUP, errno.ENODATA, errno.EINVAL):

raise

return

for name in names:

try:

value = os.getxattr(src, name, follow_symlinks=follow_symlinks)

os.setxattr(dst, name, value, follow_symlinks=follow_symlinks)

except OSError as e:

if e.errno not in (errno.EPERM, errno.ENOTSUP, errno.ENODATA,

errno.EINVAL, errno.EACCES):

raise

else:

def _copyxattr(*args, **kwargs):

pass

def copystat(src, dst, *, follow_symlinks=True):

"""Copy file metadata

Copy the permission bits, last access time, last modification time, and

flags from `src` to `dst`. On Linux, copystat() also copies the "extended

attributes" where possible. The file contents, owner, and group are

unaffected. `src` and `dst` are path-like objects or path names given as

strings.

If the optional flag `follow_symlinks` is not set, symlinks aren't

followed if and only if both `src` and `dst` are symlinks.

"""

sys.audit("shutil.copystat", src, dst)

def _nop(*args, ns=None, follow_symlinks=None):

pass

# follow symlinks (aka don't not follow symlinks)

follow = follow_symlinks or not (_islink(src) and os.path.islink(dst))

if follow:

# use the real function if it exists

def lookup(name):

return getattr(os, name, _nop)

else:

# use the real function only if it exists

# *and* it supports follow_symlinks

def lookup(name):

fn = getattr(os, name, _nop)

if fn in os.supports_follow_symlinks:

return fn

return _nop

if isinstance(src, os.DirEntry):

st = src.stat(follow_symlinks=follow)

else:

st = lookup("stat")(src, follow_symlinks=follow)

mode = stat.S_IMODE(st.st_mode)

lookup("utime")(dst, ns=(st.st_atime_ns, st.st_mtime_ns),

follow_symlinks=follow)

# We must copy extended attributes before the file is (potentially)

# chmod()'ed read-only, otherwise setxattr() will error with -EACCES.

_copyxattr(src, dst, follow_symlinks=follow)

try:

lookup("chmod")(dst, mode, follow_symlinks=follow)

except NotImplementedError:

# if we got a NotImplementedError, it's because

# * follow_symlinks=False,

# * lchown() is unavailable, and

# * either

# * fchownat() is unavailable or

# * fchownat() doesn't implement AT_SYMLINK_NOFOLLOW.

# (it returned ENOSUP.)

# therefore we're out of options--we simply cannot chown the

# symlink. give up, suppress the error.

# (which is what shutil always did in this circumstance.)

pass

if hasattr(st, 'st_flags'):

try:

lookup("chflags")(dst, st.st_flags, follow_symlinks=follow)

except OSError as why:

for err in 'EOPNOTSUPP', 'ENOTSUP':

if hasattr(errno, err) and why.errno == getattr(errno, err):

break

else:

raise

def copy(src, dst, *, follow_symlinks=True):

"""Copy data and mode bits ("cp src dst"). Return the file's destination.

The destination may be a directory.

If follow_symlinks is false, symlinks won't be followed. This

resembles GNU's "cp -P src dst".

If source and destination are the same file, a SameFileError will be

raised.

"""

if os.path.isdir(dst):

dst = os.path.join(dst, os.path.basename(src))

copyfile(src, dst, follow_symlinks=follow_symlinks)

copymode(src, dst, follow_symlinks=follow_symlinks)

return dst

def copy2(src, dst, *, follow_symlinks=True):

"""Copy data and metadata. Return the file's destination.

Metadata is copied with copystat(). Please see the copystat function

for more information.

The destination may be a directory.

If follow_symlinks is false, symlinks won't be followed. This

resembles GNU's "cp -P src dst".

"""

if os.path.isdir(dst):

dst = os.path.join(dst, os.path.basename(src))

if hasattr(_winapi, "CopyFile2"):

src_ = os.fsdecode(src)

dst_ = os.fsdecode(dst)

flags = _winapi.COPY_FILE_ALLOW_DECRYPTED_DESTINATION # for compat

if not follow_symlinks:

flags |= _winapi.COPY_FILE_COPY_SYMLINK

try:

_winapi.CopyFile2(src_, dst_, flags)

return dst

except OSError as exc:

if (exc.winerror == _winapi.ERROR_PRIVILEGE_NOT_HELD

and not follow_symlinks):

# Likely encountered a symlink we aren't allowed to create.

# Fall back on the old code

pass

elif exc.winerror == _winapi.ERROR_ACCESS_DENIED:

# Possibly encountered a hidden or readonly file we can't

# overwrite. Fall back on old code

pass

else:

raise

copyfile(src, dst, follow_symlinks=follow_symlinks)

copystat(src, dst, follow_symlinks=follow_symlinks)

return dst

def ignore_patterns(*patterns):

"""Function that can be used as copytree() ignore parameter.

Patterns is a sequence of glob-style patterns

that are used to exclude files"""

def _ignore_patterns(path, names):

ignored_names = []

for pattern in patterns:

ignored_names.extend(fnmatch.filter(names, pattern))

return set(ignored_names)

return _ignore_patterns

def _copytree(entries, src, dst, symlinks, ignore, copy_function,

ignore_dangling_symlinks, dirs_exist_ok=False):

if ignore is not None:

ignored_names = ignore(os.fspath(src), [x.name for x in entries])

else:

ignored_names = ()

os.makedirs(dst, exist_ok=dirs_exist_ok)

errors = []

use_srcentry = copy_function is copy2 or copy_function is copy

for srcentry in entries:

if srcentry.name in ignored_names:

continue

srcname = os.path.join(src, srcentry.name)

dstname = os.path.join(dst, srcentry.name)

srcobj = srcentry if use_srcentry else srcname

try:

is_symlink = srcentry.is_symlink()

if is_symlink and os.name == 'nt':

# Special check for directory junctions, which appear as

# symlinks but we want to recurse.

lstat = srcentry.stat(follow_symlinks=False)

if lstat.st_reparse_tag == stat.IO_REPARSE_TAG_MOUNT_POINT:

is_symlink = False

if is_symlink:

linkto = os.readlink(srcname)

if symlinks:

# We can't just leave it to `copy_function` because legacy

# code with a custom `copy_function` may rely on copytree

# doing the right thing.

os.symlink(linkto, dstname)

copystat(srcobj, dstname, follow_symlinks=not symlinks)

else:

# ignore dangling symlink if the flag is on

if not os.path.exists(linkto) and ignore_dangling_symlinks:

continue

# otherwise let the copy occur. copy2 will raise an error

if srcentry.is_dir():

copytree(srcobj, dstname, symlinks, ignore,

copy_function, ignore_dangling_symlinks,

dirs_exist_ok)

else:

copy_function(srcobj, dstname)

elif srcentry.is_dir():

copytree(srcobj, dstname, symlinks, ignore, copy_function,

ignore_dangling_symlinks, dirs_exist_ok)

else:

# Will raise a SpecialFileError for unsupported file types

copy_function(srcobj, dstname)

# catch the Error from the recursive copytree so that we can

# continue with other files

except Error as err:

errors.extend(err.args[0])

except OSError as why:

errors.append((srcname, dstname, str(why)))

try:

copystat(src, dst)

except OSError as why:

# Copying file access times may fail on Windows

if getattr(why, 'winerror', None) is None:

errors.append((src, dst, str(why)))

if errors:

raise Error(errors)

return dst

def copytree(src, dst, symlinks=False, ignore=None, copy_function=copy2,

ignore_dangling_symlinks=False, dirs_exist_ok=False):

"""Recursively copy a directory tree and return the destination directory.

If exception(s) occur, an Error is raised with a list of reasons.

If the optional symlinks flag is true, symbolic links in the

source tree result in symbolic links in the destination tree; if

it is false, the contents of the files pointed to by symbolic

links are copied. If the file pointed to by the symlink doesn't

exist, an exception will be added in the list of errors raised in

an Error exception at the end of the copy process.

You can set the optional ignore_dangling_symlinks flag to true if you

want to silence this exception. Notice that this has no effect on

platforms that don't support os.symlink.

The optional ignore argument is a callable. If given, it

is called with the `src` parameter, which is the directory

being visited by copytree(), and `names` which is the list of

`src` contents, as returned by os.listdir():

callable(src, names) -> ignored_names

Since copytree() is called recursively, the callable will be

called once for each directory that is copied. It returns a

list of names relative to the `src` directory that should

not be copied.

The optional copy_function argument is a callable that will be used

to copy each file. It will be called with the source path and the

destination path as arguments. By default, copy2() is used, but any

function that supports the same signature (like copy()) can be used.

If dirs_exist_ok is false (the default) and `dst` already exists, a

`FileExistsError` is raised. If `dirs_exist_ok` is true, the copying

operation will continue if it encounters existing directories, and files

within the `dst` tree will be overwritten by corresponding files from the

`src` tree.

"""

sys.audit("shutil.copytree", src, dst)

with os.scandir(src) as itr:

entries = list(itr)

return _copytree(entries=entries, src=src, dst=dst, symlinks=symlinks,

ignore=ignore, copy_function=copy_function,

ignore_dangling_symlinks=ignore_dangling_symlinks,

dirs_exist_ok=dirs_exist_ok)

if hasattr(os.stat_result, 'st_file_attributes'):

def _rmtree_islink(st):

return (stat.S_ISLNK(st.st_mode) or

(st.st_file_attributes & stat.FILE_ATTRIBUTE_REPARSE_POINT

and st.st_reparse_tag == stat.IO_REPARSE_TAG_MOUNT_POINT))

else:

def _rmtree_islink(st):

return stat.S_ISLNK(st.st_mode)

# version vulnerable to race conditions

def _rmtree_unsafe(path, dir_fd, onexc):

if dir_fd is not None:

raise NotImplementedError("dir_fd unavailable on this platform")

try:

st = os.lstat(path)

except OSError as err:

onexc(os.lstat, path, err)

return

try:

if _rmtree_islink(st):

# symlinks to directories are forbidden, see bug #1669

raise OSError("Cannot call rmtree on a symbolic link")

except OSError as err:

onexc(os.path.islink, path, err)

# can't continue even if onexc hook returns

return

def onerror(err):

if not isinstance(err, FileNotFoundError):

onexc(os.scandir, err.filename, err)

results = os.walk(path, topdown=False, onerror=onerror, followlinks=os._walk_symlinks_as_files)

for dirpath, dirnames, filenames in results:

for name in dirnames:

fullname = os.path.join(dirpath, name)

try:

os.rmdir(fullname)

except FileNotFoundError:

continue

except OSError as err:

onexc(os.rmdir, fullname, err)

for name in filenames:

fullname = os.path.join(dirpath, name)

try:

os.unlink(fullname)

except FileNotFoundError:

continue

except OSError as err:

onexc(os.unlink, fullname, err)

try:

os.rmdir(path)

except FileNotFoundError:

pass

except OSError as err:

onexc(os.rmdir, path, err)

# Version using fd-based APIs to protect against races

def _rmtree_safe_fd(path, dir_fd, onexc):

# While the unsafe rmtree works fine on bytes, the fd based does not.

if isinstance(path, bytes):

path = os.fsdecode(path)

stack = [(os.lstat, dir_fd, path, None)]

try:

while stack:

_rmtree_safe_fd_step(stack, onexc)

finally:

# Close any file descriptors still on the stack.

while stack:

func, fd, path, entry = stack.pop()

if func is not os.close:

continue

try:

os.close(fd)

except OSError as err:

onexc(os.close, path, err)

def _rmtree_safe_fd_step(stack, onexc):

# Each stack item has four elements:

# * func: The first operation to perform: os.lstat, os.close or os.rmdir.

# Walking a directory starts with an os.lstat() to detect symlinks; in

# this case, func is updated before subsequent operations and passed to

# onexc() if an error occurs.

# * dirfd: Open file descriptor, or None if we're processing the top-level

# directory given to rmtree() and the user didn't supply dir_fd.

# * path: Path of file to operate upon. This is passed to onexc() if an

# error occurs.

# * orig_entry: os.DirEntry, or None if we're processing the top-level

# directory given to rmtree(). We used the cached stat() of the entry to

# save a call to os.lstat() when walking subdirectories.

func, dirfd, path, orig_entry = stack.pop()

name = path if orig_entry is None else orig_entry.name

parent_fd = None if func is os.close else dirfd

try:

if func is os.close:

os.close(dirfd)

return

if func is os.rmdir:

os.rmdir(name, dir_fd=dirfd)

return

# Note: To guard against symlink races, we use the standard

# lstat()/open()/fstat() trick.

assert func is os.lstat

if orig_entry is None:

orig_st = os.lstat(name, dir_fd=dirfd)

else:

orig_st = orig_entry.stat(follow_symlinks=False)

func = os.open # For error reporting.

topfd = os.open(name, os.O_RDONLY | os.O_NONBLOCK, dir_fd=dirfd)

func = os.path.islink # For error reporting.

try:

if not os.path.samestat(orig_st, os.fstat(topfd)):

# Symlinks to directories are forbidden, see GH-46010.

raise OSError("Cannot call rmtree on a symbolic link")

stack.append((os.rmdir, dirfd, path, orig_entry))

finally:

stack.append((os.close, topfd, path, orig_entry))

func = os.scandir # For error reporting.

with os.scandir(topfd) as scandir_it:

entries = list(scandir_it)

for entry in entries:

fullname = os.path.join(path, entry.name)

try:

if entry.is_dir(follow_symlinks=False):

# Traverse into sub-directory.

stack.append((os.lstat, topfd, fullname, entry))

continue

except FileNotFoundError:

continue

except OSError:

pass

try:

os.unlink(entry.name, dir_fd=topfd)

except FileNotFoundError:

continue

except OSError as err:

onexc(os.unlink, fullname, err, direntry=entry, dir_fd=topfd)

except FileNotFoundError as err:

if orig_entry is None or func is os.close:

err.filename = path

onexc(func, path, err, direntry=orig_entry, dir_fd=parent_fd)

except OSError as err:

err.filename = path

onexc(func, path, err, direntry=orig_entry, dir_fd=parent_fd)

_use_fd_functions = ({os.open, os.stat, os.unlink, os.rmdir} <=

os.supports_dir_fd and

os.scandir in os.supports_fd and

os.stat in os.supports_follow_symlinks)

_rmtree_impl = _rmtree_safe_fd if _use_fd_functions else _rmtree_unsafe

def rmtree(path, ignore_errors=False, onerror=None, *, onexc=None, dir_fd=None,

_onexc_kwargs=False):

"""Recursively delete a directory tree.

If dir_fd is not None, it should be a file descriptor open to a directory;

path will then be relative to that directory.

dir_fd may not be implemented on your platform.

If it is unavailable, using it will raise a NotImplementedError.

If ignore_errors is set, errors are ignored; otherwise, if onexc or

onerror is set, it is called to handle the error with arguments (func,

path, exc_info) where func is platform and implementation dependent;

path is the argument to that function that caused it to fail; and

the value of exc_info describes the exception. For onexc it is the

exception instance, and for onerror it is a tuple as returned by

sys.exc_info(). If ignore_errors is false and both onexc and

onerror are None, the exception is reraised.

onerror is deprecated and only remains for backwards compatibility.

If both onerror and onexc are set, onerror is ignored and onexc is used.

"""

sys.audit("shutil.rmtree", path, dir_fd)

if ignore_errors:

def onexc(*args, **kwargs):

pass

elif onerror is None and onexc is None:

def onexc(*args, **kwargs):

raise

elif onexc is None:

if onerror is None:

def onexc(*args, **kwargs):

raise

else:

# delegate to onerror

def onexc(*args, **kwargs):

func, path, exc = args

if exc is None:

exc_info = None, None, None

else:

exc_info = type(exc), exc, exc.__traceback__

return onerror(func, path, exc_info)

elif not _onexc_kwargs:

# Only the internal caller in tempfile asks for the extra arguments.

_onexc = onexc

def onexc(func, path, err, **kwargs):

return _onexc(func, path, err)

_rmtree_impl(path, dir_fd, onexc)

# Allow introspection of whether or not the hardening against symlink

# attacks is supported on the current platform

rmtree.avoids_symlink_attacks = _use_fd_functions

def _basename(path):

"""A basename() variant which first strips the trailing slash, if present.

Thus we always get the last component of the path, even for directories.

path: Union[PathLike, str]

e.g.

>>> os.path.basename('/bar/foo')

'foo'

>>> os.path.basename('/bar/foo/')

>>> _basename('/bar/foo/')

'foo'

"""

path = os.fspath(path)

sep = os.path.sep + (os.path.altsep or '')

return os.path.basename(path.rstrip(sep))

def move(src, dst, copy_function=copy2):

"""Recursively move a file or directory to another location. This is

similar to the Unix "mv" command. Return the file or directory's

destination.

If dst is an existing directory or a symlink to a directory, then src is

moved inside that directory. The destination path in that directory must

not already exist.

If dst already exists but is not a directory, it may be overwritten

depending on os.rename() semantics.

os.rename() is preferably used if the source and destination are on the

same filesystem. In case os.rename() fails due to OSError (e.g. the user

has write permission to *dst* file but not to its parent directory),

this method falls back to using *copy_function* silently.

Symlinks are also recreated under the new name if os.rename() fails

because of cross filesystem renames.

It's recommended to use os.rename() if atomic move is strictly required.

The optional `copy_function` argument is a callable that will be used

to copy the source or it will be delegated to `copytree`.

By default, copy2() is used, but any function that supports the same

signature (like copy()) can be used.

A lot more could be done here... A look at a mv.c shows a lot of

the issues this implementation glosses over.

"""

sys.audit("shutil.move", src, dst)

real_dst = dst

if os.path.isdir(dst):

if _samefile(src, dst) and not os.path.islink(src):

# We might be on a case insensitive filesystem,

# perform the rename anyway.

os.rename(src, dst)

return

# Using _basename instead of os.path.basename is important, as we must

# ignore any trailing slash to avoid the basename returning ''

real_dst = os.path.join(dst, _basename(src))

if os.path.exists(real_dst):

raise Error("Destination path '%s' already exists" % real_dst)

try:

os.rename(src, real_dst)

except OSError:

if os.path.islink(src):

linkto = os.readlink(src)

os.symlink(linkto, real_dst)

os.unlink(src)

elif os.path.isdir(src):

if _destinsrc(src, dst):

raise Error("Cannot move a directory '%s' into itself"

" '%s'." % (src, dst))

if (_is_immutable(src)

or (not os.access(src, os.W_OK) and os.listdir(src)

and sys.platform == 'darwin')):

raise PermissionError("Cannot move the non-empty directory "

"'%s': Lacking write permission to '%s'."

% (src, src))

copytree(src, real_dst, copy_function=copy_function,

symlinks=True)

rmtree(src)

else:

copy_function(src, real_dst)

os.unlink(src)

return real_dst

def _destinsrc(src, dst):

src = os.path.realpath(src)

dst = os.path.realpath(dst)

if not src.endswith(os.path.sep):

src += os.path.sep

if not dst.endswith(os.path.sep):

dst += os.path.sep

return dst.startswith(src)

def _is_immutable(src):

st = _stat(src)

immutable_states = [stat.UF_IMMUTABLE, stat.SF_IMMUTABLE]

return hasattr(st, 'st_flags') and st.st_flags in immutable_states

def _get_gid(name):

"""Returns a gid, given a group name."""

if name is None:

return None

try:

from grp import getgrnam

except ImportError:

return None

try:

result = getgrnam(name)

except KeyError:

result = None

if result is not None:

return result.gr_gid

return None

View remainder of file in raw view

cpython/Lib/shutil.py at main · python/cpython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

shutil.py

Latest commit

History

Breadcrumbs

shutil.py

File metadata and controls