Skip to content

bpo-40982: Fix outdated copytree() "example" in the shutil docs #24778

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 5, 2022
Merged

bpo-40982: Fix outdated copytree() "example" in the shutil docs #24778

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ae62d7
bpo-40982: Fix outdated copytree() "example" in the shutil docs
ZackerySpytz Mar 7, 2021
f112ba3
Merge branch 'main' into bpo-40982-shutil-copytree-example
JelleZijlstra Apr 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 1 addition & 36 deletions Doc/library/shutil.rst
View file
Open in desktop
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
~~~~~~~~~~~~~~~~
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think removing it would make sense but you leave a hanging heading. Do you have a reason for this?

Also, the bpo asked for a fix to the example, I would think deciding to remove it instead requires some consensus, maybe @willingc and @Mariatta can advise.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this leaves the header dangling - it relates to the next example (not that the last modified like changes "Another example..." to "An example...", because the next one is now the first).


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