gh-78707: deprecate passing >1 argument to `PurePath.[is_]relative_to()` by barneygale · Pull Request #94469 · python/cpython · GitHub

This brings relative_to() and is_relative_to() more in line with other pathlib methods like rename() and symlink_to().

Resolves #78707.

Issue: Path.relative_to() taking multiple arguments could be better documented #78707

Automerge-Triggered-By: GH:brettcannon

…ive_to()` This brings `relative_to()` and `is_relative_to()` more in line with other pathlib methods like `rename()` and `symlink_to()`.

While I support the idea, I think there are some ergonomic tweaks we can make the to new call signature. The docs also need deprecation warnings.

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

I have made the requested changes; please review again

Thanks for making the requested changes!

@brettcannon: please review the changes made to this pull request.

One change to make to use a newer deprecation mechanism, but otherwise LGTM!

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Will fix conflicts when #99031 lands.

I have made the requested changes; please review again

Thanks for making the requested changes!

@brettcannon: please review the changes made to this pull request.

Hey @JelleZijlstra, as Brett is winding down his involvement in pathlib, do you think you could review this, please? I ask because you commented on #78707 some time ago :) Thanks!

A couple of documentation suggestions, and shall also include it in "What’s New In Python 3.12"> "Pending Removal in Python 3.14"?

https://docs.python.org/3.12/whatsnew/3.12.html#pending-removal-in-python-3-14

These will help increase visibility for users.

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

✅ Deploy Preview for python-cpython-preview ready!

Name	Link
🔨 Latest commit	0374a35
🔍 Latest deploy log	https://app.netlify.com/sites/python-cpython-preview/deploys/638fc037932d91000ada8424
😎 Deploy Preview	https://deploy-preview-94469--python-cpython-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Thank you for the feedback!

* origin/main: (1306 commits) Correct CVE-2020-10735 documentation (python#100306) pythongh-100272: Fix JSON serialization of OrderedDict (pythonGH-100273) pythongh-93649: Split tracemalloc tests from _testcapimodule.c (python#99551) Docs: Use `PY_VERSION_HEX` for version comparison (python#100179) pythongh-97909: Fix markup for `PyMethodDef` members (python#100089) pythongh-99240: Reset pointer to NULL when the pointed memory is freed in argument parsing (python#99890) pythongh-99240: Reset pointer to NULL when the pointed memory is freed in argument parsing (python#99890) pythonGH-98831: Add DECREF_INPUTS(), expanding to DECREF() each stack input (python#100205) pythongh-78707: deprecate passing >1 argument to `PurePath.[is_]relative_to()` (pythonGH-94469) pythongh-99540: Constant hash for _PyNone_Type to aid reproducibility (pythonGH-99541) pythongh-100039: enhance __signature__ to work with str and callables (pythonGH-100168) pythongh-99830: asyncio: Document returns of remove_{reader,writer} (python#100302) "Compound statement" docs: Fix with-statement step indexing (python#100286) pythonGH-90043: Handle NaNs in COMPARE_OP_FLOAT_JUMP (pythonGH-100278) Improve stats presentation for calls. (pythonGH-100274) Better stats for `LOAD_ATTR` and `STORE_ATTR` (pythonGH-100295) pythongh-81057: Move the Cached Parser Dummy Name to _PyRuntimeState (python#100277) Document that zipfile's pwd parameter is a `bytes` object (python#100209) pythongh-99767: mark `PyTypeObject.tp_watched` as internal use only in table (python#100271) Fix typo in introduction.rst (python#100266) ...

* main: pythongh-89727: Fix os.walk RecursionError on deep trees (python#99803) Docs: Don't upload CI artifacts (python#100330) pythongh-94912: Added marker for non-standard coroutine function detection (python#99247) Correct CVE-2020-10735 documentation (python#100306) pythongh-100272: Fix JSON serialization of OrderedDict (pythonGH-100273) pythongh-93649: Split tracemalloc tests from _testcapimodule.c (python#99551) Docs: Use `PY_VERSION_HEX` for version comparison (python#100179) pythongh-97909: Fix markup for `PyMethodDef` members (python#100089) pythongh-99240: Reset pointer to NULL when the pointed memory is freed in argument parsing (python#99890) pythongh-99240: Reset pointer to NULL when the pointed memory is freed in argument parsing (python#99890) pythonGH-98831: Add DECREF_INPUTS(), expanding to DECREF() each stack input (python#100205) pythongh-78707: deprecate passing >1 argument to `PurePath.[is_]relative_to()` (pythonGH-94469)

pythongh-78707 : deprecate passing >1 argument to `PurePath.[is_]relat…

594bd8f

…ive_to()` This brings `relative_to()` and `is_relative_to()` more in line with other pathlib methods like `rename()` and `symlink_to()`.

barneygale requested a review from brettcannon as a code owner June 30, 2022 23:02

bedevere-bot added the awaiting review label Jun 30, 2022

brettcannon requested changes Jul 4, 2022

View reviewed changes

Comment thread Lib/pathlib.py Outdated

Comment thread Doc/library/pathlib.rst

bedevere-bot added awaiting changes and removed awaiting review labels Jul 4, 2022

Address review feedback

3268a10

bedevere-bot removed the awaiting changes label Jul 9, 2022

bedevere-bot added the awaiting change review label Jul 9, 2022

bedevere-bot requested a review from brettcannon July 9, 2022 02:05

brettcannon requested changes Oct 22, 2022

View reviewed changes

Comment thread Lib/pathlib.py Outdated

bedevere-bot added awaiting changes and removed awaiting change review labels Oct 22, 2022

barneygale marked this pull request as draft November 3, 2022 00:04

barneygale added 2 commits November 25, 2022 20:32

Merge branch 'main' into pythongh-78707 -pathlib-relative-to-arguments

0e79a85

Use new deprecation mechanism

7e8e553

bedevere-bot mentioned this pull request Nov 25, 2022

Path.relative_to() taking multiple arguments could be better documented #78707

Closed

barneygale marked this pull request as ready for review November 25, 2022 20:34

barneygale added 3 commits November 25, 2022 20:38

Fix dodgy merge

6ac36fc

Tweak NEWS now we have walk_up.

00e6677

Make deprecation notices uniform.

6e966ba

bedevere-bot added awaiting change review and removed awaiting changes labels Nov 25, 2022

bedevere-bot requested a review from brettcannon November 25, 2022 21:04

hugovk reviewed Dec 4, 2022

View reviewed changes

Comment thread Doc/library/pathlib.rst Outdated

Comment thread Doc/library/pathlib.rst Outdated

Apply suggestions from code review

0374a35

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

brettcannon approved these changes Dec 17, 2022

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting change review labels Dec 17, 2022

brettcannon added the 🤖 automerge label Dec 17, 2022

miss-islington merged commit 5a991da into python:main Dec 17, 2022

bedevere-bot removed the awaiting merge label Dec 17, 2022

barneygale mentioned this pull request Jan 14, 2023

bpo-34526：[doc] Add description and examples of multiple arguments for Path.relative_to #31368

Closed

gh-78707: deprecate passing >1 argument to `PurePath.[is_]relative_to()` by barneygale · Pull Request #94469 · python/cpython · GitHub

Uh oh!

Uh oh!

gh-78707: deprecate passing >1 argument to PurePath.[is_]relative_to() - #94469

gh-78707: deprecate passing >1 argument to PurePath.[is_]relative_to()#94469miss-islington merged 8 commits intopython:mainpython/cpython:mainfrom barneygale:gh-78707-pathlib-relative-to-argumentsbarneygale/cpython:gh-78707-pathlib-relative-to-argumentsCopy head branch name to clipboard

Conversation

barneygale commented Jun 30, 2022 • edited by miss-islington Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

brettcannon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bedevere-bot commented Jul 4, 2022

Uh oh!

barneygale commented Jul 9, 2022

Uh oh!

bedevere-bot commented Jul 9, 2022

Uh oh!

brettcannon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bedevere-bot commented Oct 22, 2022

Uh oh!

barneygale commented Nov 3, 2022

Uh oh!

barneygale commented Nov 25, 2022

Uh oh!

bedevere-bot commented Nov 25, 2022

Uh oh!

barneygale commented Dec 4, 2022

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

netlify Bot commented Dec 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for python-cpython-preview ready!

Uh oh!

barneygale commented Dec 6, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

gh-78707: deprecate passing >1 argument to PurePath.[is_]relative_to()#94469
miss-islington merged 8 commits into
python:mainfrom
barneygale:gh-78707-pathlib-relative-to-arguments

barneygale commented Jun 30, 2022 •
edited by miss-islington
Loading

netlify Bot commented Dec 6, 2022 •
edited
Loading