cpython: e11642068f85 (original) (raw)

Mercurial > cpython

changeset 79566:e11642068f85

Closes #1492704: Make shutil.copyfile() raise a distinct SameFileError Patch by Atsuo Ishimoto. [#1492704]

line wrap: on

line diff

--- a/Doc/library/shutil.rst +++ b/Doc/library/shutil.rst @@ -53,7 +53,7 @@ Directory and files operations dst and return dst. src and dst are path names given as strings. dst must be the complete target file name; look at :func:shutil.copy for a copy that accepts a target directory path. If src and dst

• specify the same file, :exc:Error is raised.

• specify the same file, :exc:SameFileError is raised. The destination location must be writable; otherwise, an :exc:OSError exception will be raised. If dst already exists, it will be replaced. @@ -69,6 +69,18 @@ Directory and files operations Added follow_symlinks argument. Now returns dst.
• .. versionchanged:: 3.4

•  Raise :exc:`SameFileError` instead of :exc:`Error`.[](#l1.17)

+ + +.. exception:: SameFileError +

• This exception is raised if source and destination in :func:copyfile
• are the same file. +
• .. versionadded:: 3.4 +

+ .. function:: copymode(src, dst, *, follow_symlinks=True) Copy the permission bits from src to dst. The file contents, owner, and

--- a/Lib/shutil.py +++ b/Lib/shutil.py @@ -42,6 +42,9 @@ except ImportError: class Error(EnvironmentError): pass +class SameFileError(Error):

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

+ class SpecialFileError(EnvironmentError): """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)""" @@ -90,7 +93,7 @@ def copyfile(src, dst, *, follow_symlink """ if _samefile(src, dst):

•    raise Error("`%s` and `%s` are the same file" % (src, dst))[](#l2.17)

•    raise SameFileError("{!r} and {!r} are the same file".format(src, dst))[](#l2.18)

for fn in [src, dst]: try: @@ -215,6 +218,9 @@ def copy(src, dst, *, follow_symlinks=Tr 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))

--- a/Lib/test/test_shutil.py +++ b/Lib/test/test_shutil.py @@ -18,7 +18,8 @@ from shutil import (_make_tarball, _make register_archive_format, unregister_archive_format, get_archive_formats, Error, unpack_archive, register_unpack_format, RegistryError,

•                unregister_unpack_format, get_unpack_formats)[](#l3.7)

•                unregister_unpack_format, get_unpack_formats,[](#l3.8)

•                SameFileError)[](#l3.9)

import tarfile import warnings @@ -688,7 +689,7 @@ class TestShutil(unittest.TestCase): with open(src, 'w') as f: f.write('cheddar') os.link(src, dst)

•        self.assertRaises(shutil.Error, shutil.copyfile, src, dst)[](#l3.17)

•        self.assertRaises(shutil.SameFileError, shutil.copyfile, src, dst)[](#l3.18)
         with open(src, 'r') as f:[](#l3.19)
             self.assertEqual(f.read(), 'cheddar')[](#l3.20)
         os.remove(dst)[](#l3.21)

@@ -708,7 +709,7 @@ class TestShutil(unittest.TestCase): # to TESTFN/TESTFN/cheese, while it should point at # TESTFN/cheese. os.symlink('cheese', dst)

•        self.assertRaises(shutil.Error, shutil.copyfile, src, dst)[](#l3.26)

•        self.assertRaises(shutil.SameFileError, shutil.copyfile, src, dst)[](#l3.27)
         with open(src, 'r') as f:[](#l3.28)
             self.assertEqual(f.read(), 'cheddar')[](#l3.29)
         os.remove(dst)[](#l3.30)

@@ -1215,6 +1216,14 @@ class TestShutil(unittest.TestCase): self.assertTrue(os.path.exists(rv)) self.assertEqual(read_file(src_file), read_file(dst_file))

• def test_copyfile_same_file(self):

•    # copyfile() should raise SameFileError if the source and destination[](#l3.36)

•    # are the same.[](#l3.37)

•    src_dir = self.mkdtemp()[](#l3.38)

•    src_file = os.path.join(src_dir, 'foo')[](#l3.39)

•    write_file(src_file, 'foo')[](#l3.40)

•    self.assertRaises(SameFileError, shutil.copyfile, src_file, src_file)[](#l3.41)

+ def test_copytree_return_value(self): # copytree returns its destination path. src_dir = self.mkdtemp()

--- a/Misc/NEWS +++ b/Misc/NEWS @@ -39,6 +39,9 @@ Core and Builtins Library ------- +- Issue #1492704: shutil.copyfile() raises a distinct SameFileError now if

• source and destination are the same file. Patch by Atsuo Ishimoto. +

• Issue #13896: Make shelf instances work with 'with' as context managers. Original patch by Filip Gruszczyński.