GH-70303: Emit FutureWarning when pathlib glob pattern ends with `**` (GH-105413)

In a future Python release, patterns with this ending will match both files
and directories. Users may add a trailing slash to remove the warning.
This commit is contained in:
Barney Gale 2023-08-05 00:12:12 +01:00 committed by GitHub
parent 2c25bd82f4
commit ec0a0d2bd9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 30 additions and 3 deletions

View File

@ -976,6 +976,11 @@ call fails (for example because the path doesn't exist).
.. versionchanged:: 3.13
The *follow_symlinks* parameter was added.
.. versionchanged:: 3.13
Emits :exc:`FutureWarning` if the pattern ends with "``**``". In a
future Python release, patterns with this ending will match both files
and directories. Add a trailing slash to match only directories.
.. method:: Path.group()
Return the name of the group owning the file. :exc:`KeyError` is raised

View File

@ -1069,6 +1069,11 @@ class Path(PurePath):
pattern_parts.append('')
if pattern_parts[-1] == '**':
# GH-70303: '**' only matches directories. Add trailing slash.
warnings.warn(
"Pattern ending '**' will match files and directories in a "
"future Python release. Add a trailing slash to match only "
"directories and remove this warning.",
FutureWarning, 3)
pattern_parts.append('')
if case_sensitive is None:

View File

@ -1903,11 +1903,11 @@ class PathTest(unittest.TestCase):
"dirC/dirD", "dirC/dirD/fileD"])
_check(p.rglob("file*"), ["dirC/fileC", "dirC/dirD/fileD"])
_check(p.rglob("**/file*"), ["dirC/fileC", "dirC/dirD/fileD"])
_check(p.rglob("dir*/**"), ["dirC/dirD"])
_check(p.rglob("dir*/**/"), ["dirC/dirD"])
_check(p.rglob("*/*"), ["dirC/dirD/fileD"])
_check(p.rglob("*/"), ["dirC/dirD"])
_check(p.rglob(""), ["dirC", "dirC/dirD"])
_check(p.rglob("**"), ["dirC", "dirC/dirD"])
_check(p.rglob("**/"), ["dirC", "dirC/dirD"])
# gh-91616, a re module regression
_check(p.rglob("*.txt"), ["dirC/novel.txt"])
_check(p.rglob("*.*"), ["dirC/novel.txt"])
@ -2057,7 +2057,20 @@ class PathTest(unittest.TestCase):
path.mkdir(parents=True)
with set_recursion_limit(recursion_limit):
list(base.glob('**'))
list(base.glob('**/'))
def test_glob_recursive_no_trailing_slash(self):
P = self.cls
p = P(BASE)
with self.assertWarns(FutureWarning):
p.glob('**')
with self.assertWarns(FutureWarning):
p.glob('*/**')
with self.assertWarns(FutureWarning):
p.rglob('**')
with self.assertWarns(FutureWarning):
p.rglob('*/**')
def test_readlink(self):
if not self.can_symlink:

View File

@ -0,0 +1,4 @@
Emit :exc:`FutureWarning` from :meth:`pathlib.Path.glob` and
:meth:`~pathlib.Path.rglob` if the given pattern ends with "``**``". In a
future Python release, patterns with this ending will match both files and
directories. Add a trailing slash to only match directories.