shutil.copytree - 3.8 changed argument types of the ignore callback

[mbarkhau]

BPO	39390
Nosy	@vstinner, @giampaolo, @serhiy-storchaka, @mbarkhau
PRs	bpo-39390: Update shutil.copytree doc - Add versionchanged 3.8 notice for ignore callable #18069 bpo-39390: fix argument types for ignore callback of shutil.copytree #18122 [3.8] bpo-39390 shutil: fix argument types for ignore callback (GH-18122). #18168

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/giampaolo'
closed_at = <Date 2020-01-27.23:48:24.425>
created_at = <Date 2020-01-19.20:40:46.651>
labels = ['3.8', 'type-bug', 'library', '3.9', 'docs']
title = 'shutil.copytree - 3.8 changed argument types of the ignore callback'
updated_at = <Date 2020-01-27.23:48:24.425>
user = 'https://github.com/mbarkhau'

bugs.python.org fields:

activity = <Date 2020-01-27.23:48:24.425>
actor = 'giampaolo.rodola'
assignee = 'giampaolo.rodola'
closed = True
closed_date = <Date 2020-01-27.23:48:24.425>
closer = 'giampaolo.rodola'
components = ['Documentation', 'Library (Lib)']
creation = <Date 2020-01-19.20:40:46.651>
creator = 'mbarkhau'
dependencies = []
files = []
hgrepos = []
issue_num = 39390
keywords = ['patch', '3.8regression']
message_count = 14.0
messages = ['360271', '360300', '360303', '360427', '360431', '360435', '360437', '360621', '360622', '360624', '360625', '360626', '360627', '360825']
nosy_count = 5.0
nosy_names = ['vstinner', 'giampaolo.rodola', 'docs@python', 'serhiy.storchaka', 'mbarkhau']
pr_nums = ['18069', '18122', '18168']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue39390'
versions = ['Python 3.8', 'Python 3.9']

[mbarkhau]

In Python 3.8, the types of the parameters to the ignore callable appear to have changed.

Previously the src parameter was a string and the names parameter was a list of strings. Now the src parameter appears to be either a pathlib.Path or an os.DirEntry, while the names parameter is a set of strings.

I would suggest adding the following to the documentation https://github.com/python/cpython/blob/master/Doc/library/shutil.rst

.. versionchanged:: 3.8
The types of arguments to *ignore* have changed. The first argument
(the directory being visited) is a func:`os.DirEntry` or a
func:`pathlib.Path`; Previously it was a string. The second argument is
a set of strings; previously it was a list of strings.