From 44fce949af8947b391b3cbc9555c439c0d3dcf6e Mon Sep 17 00:00:00 2001 From: Barney Gale Date: Tue, 23 Jan 2024 01:06:44 +0000 Subject: [PATCH] GH-99334: Explain that `PurePath.is_relative_to()` is purely lexical. (GH-114031) (cherry picked from commit 3a61d24062aaa1e13ba794360b6c765d9a1f2b06) Co-authored-by: Barney Gale --- Doc/library/pathlib.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst index 46a4d10b11d602..701131b5b2ec46 100644 --- a/Doc/library/pathlib.rst +++ b/Doc/library/pathlib.rst @@ -509,6 +509,13 @@ Pure paths provide the following methods and properties: >>> p.is_relative_to('/usr') False + This method is string-based; it neither accesses the filesystem nor treats + "``..``" segments specially. The following code is equivalent: + + >>> u = PurePath('/usr') + >>> u == p or u in p.parents + False + .. versionadded:: 3.9 .. deprecated-removed:: 3.12 3.14