Skip to content

Commit

Permalink
bpo-40982: shutil docs: Remove outdated copytree() example (pythonGH-…
Browse files Browse the repository at this point in the history
…24778)

It is not preferable to keep a copy of the implementation in the
docs.
  • Loading branch information
ZackerySpytz authored Apr 5, 2022
1 parent 772d808 commit e06f920
Showing 1 changed file with 1 addition and 36 deletions.
37 changes: 1 addition & 36 deletions Doc/library/shutil.rst
Original file line number Diff line number Diff line change
Expand Up @@ -476,42 +476,7 @@ file then shutil will silently fallback on using less efficient
copytree example
~~~~~~~~~~~~~~~~

This example is the implementation of the :func:`copytree` function, described
above, with the docstring omitted. It demonstrates many of the other functions
provided by this module. ::

def copytree(src, dst, symlinks=False):
names = os.listdir(src)
os.makedirs(dst)
errors = []
for name in names:
srcname = os.path.join(src, name)
dstname = os.path.join(dst, name)
try:
if symlinks and os.path.islink(srcname):
linkto = os.readlink(srcname)
os.symlink(linkto, dstname)
elif os.path.isdir(srcname):
copytree(srcname, dstname, symlinks)
else:
copy2(srcname, dstname)
# XXX What about devices, sockets etc.?
except OSError as why:
errors.append((srcname, dstname, str(why)))
# catch the Error from the recursive copytree so that we can
# continue with other files
except Error as err:
errors.extend(err.args[0])
try:
copystat(src, dst)
except OSError as why:
# can't copy file access times on Windows
if why.winerror is None:
errors.extend((src, dst, str(why)))
if errors:
raise Error(errors)

Another example that uses the :func:`ignore_patterns` helper::
An example that uses the :func:`ignore_patterns` helper::

from shutil import copytree, ignore_patterns

Expand Down

0 comments on commit e06f920

Please sign in to comment.