[Python-checkins] bpo-40982: shutil docs: Remove outdated copytree() example (GH-24778)

JelleZijlstra webhook-mailer at python.org
Mon Apr 4 22:57:27 EDT 2022


https://github.com/python/cpython/commit/e06f920c5bc6e9fad29082ba0d84043722806e17
commit: e06f920c5bc6e9fad29082ba0d84043722806e17
branch: main
author: Zackery Spytz <zspytz at gmail.com>
committer: JelleZijlstra <jelle.zijlstra at gmail.com>
date: 2022-04-04T19:57:17-07:00
summary:

bpo-40982: shutil docs: Remove outdated copytree() example (GH-24778)

It is not preferable to keep a copy of the implementation in the
docs.

files:
M Doc/library/shutil.rst

diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index 16b8d3cdeebc8..ac271ce9ffbe4 100644
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -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
 



More information about the Python-checkins mailing list