https://github.com/python/cpython/commit/3375dfed400494ba5cc1b744d52f6fb8b7796059
commit: 3375dfed400494ba5cc1b744d52f6fb8b7796059
branch: main
author: Barney Gale <[email protected]>
committer: barneygale <[email protected]>
date: 2024-01-05T22:56:04Z
summary:
GH-113568: Stop raising deprecation warnings from pathlib ABCs (#113757)
files:
A Misc/NEWS.d/next/Library/2024-01-05-21-52-59.gh-issue-113568._0FkpZ.rst
M Lib/pathlib/__init__.py
M Lib/pathlib/_abc.py
M Lib/test/test_pathlib/test_pathlib.py
M Lib/test/test_pathlib/test_pathlib_abc.py
diff --git a/Lib/pathlib/__init__.py b/Lib/pathlib/__init__.py
index 6a94886040f95d..115ccf78e3befe 100644
--- a/Lib/pathlib/__init__.py
+++ b/Lib/pathlib/__init__.py
@@ -166,6 +166,33 @@ def __ge__(self, other):
return NotImplemented
return self._parts_normcase >= other._parts_normcase
+ def relative_to(self, other, /, *_deprecated, walk_up=False):
+ """Return the relative path to another path identified by the passed
+ arguments. If the operation is not possible (because this is not
+ related to the other path), raise ValueError.
+
+ The *walk_up* parameter controls whether `..` may be used to resolve
+ the path.
+ """
+ if _deprecated:
+ msg = ("support for supplying more than one positional argument "
+ "to pathlib.PurePath.relative_to() is deprecated and "
+ "scheduled for removal in Python 3.14")
+ warnings.warn(msg, DeprecationWarning, stacklevel=2)
+ other = self.with_segments(other, *_deprecated)
+ return _abc.PurePathBase.relative_to(self, other, walk_up=walk_up)
+
+ def is_relative_to(self, other, /, *_deprecated):
+ """Return True if the path is relative to another path or False.
+ """
+ if _deprecated:
+ msg = ("support for supplying more than one argument to "
+ "pathlib.PurePath.is_relative_to() is deprecated and "
+ "scheduled for removal in Python 3.14")
+ warnings.warn(msg, DeprecationWarning, stacklevel=2)
+ other = self.with_segments(other, *_deprecated)
+ return _abc.PurePathBase.is_relative_to(self, other)
+
def as_uri(self):
"""Return the path as a URI."""
if not self.is_absolute():
diff --git a/Lib/pathlib/_abc.py b/Lib/pathlib/_abc.py
index da8d67f624107a..b1204e88044a3f 100644
--- a/Lib/pathlib/_abc.py
+++ b/Lib/pathlib/_abc.py
@@ -2,7 +2,6 @@
import ntpath
import posixpath
import sys
-import warnings
from _collections_abc import Sequence
from errno import ENOENT, ENOTDIR, EBADF, ELOOP, EINVAL
from itertools import chain
@@ -383,7 +382,7 @@ def with_suffix(self, suffix):
else:
raise ValueError(f"Invalid suffix {suffix!r}")
- def relative_to(self, other, /, *_deprecated, walk_up=False):
+ def relative_to(self, other, *, walk_up=False):
"""Return the relative path to another path identified by the passed
arguments. If the operation is not possible (because this is not
related to the other path), raise ValueError.
@@ -391,13 +390,7 @@ def relative_to(self, other, /, *_deprecated,
walk_up=False):
The *walk_up* parameter controls whether `..` may be used to resolve
the path.
"""
- if _deprecated:
- msg = ("support for supplying more than one positional argument "
- "to pathlib.PurePath.relative_to() is deprecated and "
- "scheduled for removal in Python 3.14")
- warnings.warn(msg, DeprecationWarning, stacklevel=2)
- other = self.with_segments(other, *_deprecated)
- elif not isinstance(other, PurePathBase):
+ if not isinstance(other, PurePathBase):
other = self.with_segments(other)
for step, path in enumerate(chain([other], other.parents)):
if path == self or path in self.parents:
@@ -411,16 +404,10 @@ def relative_to(self, other, /, *_deprecated,
walk_up=False):
parts = ['..'] * step + self._tail[len(path._tail):]
return self._from_parsed_parts('', '', parts)
- def is_relative_to(self, other, /, *_deprecated):
+ def is_relative_to(self, other):
"""Return True if the path is relative to another path or False.
"""
- if _deprecated:
- msg = ("support for supplying more than one argument to "
- "pathlib.PurePath.is_relative_to() is deprecated and "
- "scheduled for removal in Python 3.14")
- warnings.warn(msg, DeprecationWarning, stacklevel=2)
- other = self.with_segments(other, *_deprecated)
- elif not isinstance(other, PurePathBase):
+ if not isinstance(other, PurePathBase):
other = self.with_segments(other)
return other == self or other in self.parents
diff --git a/Lib/test/test_pathlib/test_pathlib.py
b/Lib/test/test_pathlib/test_pathlib.py
index b64e6b59da5d9a..93fe327a0d3c23 100644
--- a/Lib/test/test_pathlib/test_pathlib.py
+++ b/Lib/test/test_pathlib/test_pathlib.py
@@ -214,6 +214,19 @@ def test_repr_roundtrips(self):
self.assertEqual(q, p)
self.assertEqual(repr(q), r)
+ def test_relative_to_several_args(self):
+ P = self.cls
+ p = P('a/b')
+ with self.assertWarns(DeprecationWarning):
+ p.relative_to('a', 'b')
+ p.relative_to('a', 'b', walk_up=True)
+
+ def test_is_relative_to_several_args(self):
+ P = self.cls
+ p = P('a/b')
+ with self.assertWarns(DeprecationWarning):
+ p.is_relative_to('a', 'b')
+
class PurePosixPathTest(PurePathTest):
cls = pathlib.PurePosixPath
diff --git a/Lib/test/test_pathlib/test_pathlib_abc.py
b/Lib/test/test_pathlib/test_pathlib_abc.py
index a67235b4da3dd3..3a7c036077e2a1 100644
--- a/Lib/test/test_pathlib/test_pathlib_abc.py
+++ b/Lib/test/test_pathlib/test_pathlib_abc.py
@@ -542,10 +542,6 @@ def test_relative_to_common(self):
self.assertEqual(p.relative_to('a/b/c', walk_up=True), P('..'))
self.assertEqual(p.relative_to(P('c'), walk_up=True), P('../a/b'))
self.assertEqual(p.relative_to('c', walk_up=True), P('../a/b'))
- # With several args.
- with self.assertWarns(DeprecationWarning):
- p.relative_to('a', 'b')
- p.relative_to('a', 'b', walk_up=True)
# Unrelated paths.
self.assertRaises(ValueError, p.relative_to, P('c'))
self.assertRaises(ValueError, p.relative_to, P('a/b/c'))
@@ -607,9 +603,6 @@ def test_is_relative_to_common(self):
self.assertTrue(p.is_relative_to('a/'))
self.assertTrue(p.is_relative_to(P('a/b')))
self.assertTrue(p.is_relative_to('a/b'))
- # With several args.
- with self.assertWarns(DeprecationWarning):
- p.is_relative_to('a', 'b')
# Unrelated paths.
self.assertFalse(p.is_relative_to(P('c')))
self.assertFalse(p.is_relative_to(P('a/b/c')))
diff --git
a/Misc/NEWS.d/next/Library/2024-01-05-21-52-59.gh-issue-113568._0FkpZ.rst
b/Misc/NEWS.d/next/Library/2024-01-05-21-52-59.gh-issue-113568._0FkpZ.rst
new file mode 100644
index 00000000000000..4900730ddff5fa
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2024-01-05-21-52-59.gh-issue-113568._0FkpZ.rst
@@ -0,0 +1,2 @@
+Raise deprecation warnings from :class:`pathlib.PurePath` and not its
+private base class ``PurePathBase``.
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
