gh-68320, gh-88302 - Allow for `pathlib.Path` subclassing #31691

barneygale · 2022-03-05T02:18:41Z

Users may wish to define subclasses of pathlib.PurePath and Path to add or modify existing methods. Before this change, attempting to instantiate a subclass raised an exception like:

AttributeError: type object 'PPath' has no attribute '_flavour'

Previously the _flavour attribute was assigned as follows:

PurePath._flavour        = xxx not set!! xxx
PurePosixPath._flavour   = _PosixFlavour()
PureWindowsPath._flavour = _WindowsFlavour()

It's now set as follows:

PurePath._flavour        = os.path
PurePosixPath._flavour   = posixpath
PureWindowsPath._flavour = ntpath

Functionality from _PosixFlavour and _WindowsFlavour is moved into PurePath as underscored-prefixed classmethods. Flavour classes are removed.

A deeper dive into this patch can be read here: https://discuss.python.org/t/make-pathlib-extensible/3428/42

Fixes #68320 #88302

Issue: Direct sub-classing of pathlib.Path #68320

Users may wish to define subclasses of `pathlib.Path` to add or modify existing methods. Before this change, attempting to instantiate a subclass raised an exception like: AttributeError: type object 'PPath' has no attribute '_flavour' Previously the `_flavour` attribute was assigned as follows: PurePath._flavour = xxx not set!! xxx PurePosixPath._flavour = _PosixFlavour() PureWindowsPath._flavour = _WindowsFlavour() This commit replaces it with a `_pathmod` attribute, set as follows: PurePath._pathmod = os.path PurePosixPath._pathmod = posixpath PureWindowsPath._pathmod = ntpath Functionality from `_PosixFlavour` and `_WindowsFlavour` is moved into `PurePath` as underscored-prefixed classmethods. Flavours are removed.

Misc/NEWS.d/next/Library/2022-03-05-02-14-09.bpo-24132.W6iORO.rst

Lib/pathlib.py

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

…ygale/cpython into bpo-44136-remove-pathlib-flavour-2

Makes the code a little more direct.

barneygale · 2022-04-06T19:35:59Z

Hey @brettcannon, just bumping this PR in case it dropped off your radar.

brettcannon · 2022-04-07T19:25:07Z

@barneygale it hasn't, but my PR review queue is 11 PRs deep, this is in position 7, and I have worry about getting PEP 594 done in time for 3.11b1. Plus I have some stuff I need to get done for work this month which is eating into my paid OSS time.

brettcannon

Most of the comments are either code touch-ups or asking to make the code more self-describing.

Lib/pathlib.py

bedevere-bot · 2022-04-29T21:30:19Z

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.

Co-authored-by: Brett Cannon <brett@python.org>

bedevere-bot · 2022-11-15T18:04:48Z

Thanks for making the requested changes!

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

This is no longer true as of 99fcf15, see python#96290

brettcannon · 2022-11-25T19:23:13Z

@barneygale now that #99031 is merged, let me know when you're ready for me to review this again.

brettcannon

Merge conflicts

bedevere-bot · 2022-11-25T19:23:32Z

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.

barneygale · 2022-11-25T20:35:09Z

I have made the requested changes; please review again

Thanks Brett :)

bedevere-bot · 2022-11-25T20:35:14Z

Thanks for making the requested changes!

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

brettcannon

One small tweak to the tests, otherwise LGTM!

Lib/test/test_pathlib.py

bedevere-bot · 2022-12-17T00:12:21Z

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.

barneygale · 2022-12-17T21:43:39Z

I have made the requested changes; please review again

Thanks v much for all your help!

bedevere-bot · 2022-12-17T21:43:44Z

Thanks for making the requested changes!

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

Lib/pathlib.py

bedevere-bot added the awaiting review label Mar 5, 2022

the-knights-who-say-ni added the CLA signed label Mar 5, 2022

Add tests

8431d12

barneygale mentioned this pull request Mar 5, 2022

bpo-24132: Add pathlib._AbstractPath #31085

Draft

Add tests for PurePath subclasses

bf2ad3a

AlexWaygood reviewed Mar 5, 2022

View changes

Misc/NEWS.d/next/Library/2022-03-05-02-14-09.bpo-24132.W6iORO.rst Outdated Show resolved Hide resolved

merwok reviewed Mar 5, 2022

View changes

Lib/pathlib.py Show resolved Hide resolved

barneygale and others added 3 commits Mar 5, 2022

Update Misc/NEWS.d/next/Library/2022-03-05-02-14-09.bpo-24132.W6iORO.rst

4036e2e

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

Rename PurePath._pathmod to PurePath._flavour to reduce the diff.

0d08533

Merge branch 'bpo-44136-remove-pathlib-flavour-2' of github.com:barne…

0ad8022

…ygale/cpython into bpo-44136-remove-pathlib-flavour-2

brettcannon self-requested a review Mar 7, 2022

barneygale added 2 commits Mar 25, 2022

Undo an unnecessary change to Path.__new__()

28992fc

Remove _casefold() and _casefold_parts() methods.

dbec230

Makes the code a little more direct.

barneygale mentioned this pull request Apr 15, 2022

OSError when try convert URI to pathlib.Path #91504

Closed

barneygale changed the title ~~bpo-24132, bpo-44136 - Fix pathlib.Path subclassing.~~ gh-68320, gh-88302 - Fix pathlib.Path subclassing. Apr 24, 2022

brettcannon closed this Apr 27, 2022

brettcannon reopened this Apr 27, 2022

barneygale added 2 commits Apr 29, 2022

Merge branch 'main' into bpo-44136-remove-pathlib-flavour-2

d814ee4

Further simplify overall diff by inlining code from compile_pattern()

63f1d68

barneygale closed this Apr 29, 2022

barneygale reopened this Apr 29, 2022

brettcannon requested changes Apr 29, 2022

View changes

bedevere-bot added awaiting changes and removed awaiting review labels Apr 29, 2022

barneygale and others added 2 commits Apr 29, 2022

Apply suggestions from code review

8dddfdf

Co-authored-by: Brett Cannon <brett@python.org>

Address a couple bits of review feedback

b4da721

bedevere-bot added the awaiting change review label Nov 15, 2022

bedevere-bot requested a review from brettcannon Nov 15, 2022

barneygale added 5 commits Nov 15, 2022

Clarify repr roundtrip tests.

07c67d0

Reduce tests diff

950aa47

Remove test that /b/c/d and ///b/c/d are equivalent.

d5f6f03

This is no longer true as of 99fcf15, see python#96290

Fix missing full stops.

b66a4fb

Remove four more test assertions affected by python#96290

fbaadf4

brettcannon requested changes Nov 25, 2022

View changes

bedevere-bot removed the awaiting change review label Nov 25, 2022

bedevere-bot added the awaiting changes label Nov 25, 2022

Merge branch 'main' into bpo-44136-remove-pathlib-flavour-2

3692fdf

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

bedevere-bot requested a review from brettcannon Nov 25, 2022

brettcannon requested changes Dec 17, 2022

View changes

Lib/test/test_pathlib.py Show resolved Hide resolved

Lib/test/test_pathlib.py Outdated Show resolved Hide resolved

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

Wrap repr test cases in self.subTest() block

40dc514

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

bedevere-bot requested a review from brettcannon Dec 17, 2022

eryksun reviewed Dec 22, 2022

View changes

Lib/pathlib.py Show resolved Hide resolved

gh-68320, gh-88302 - Allow for `pathlib.Path` subclassing #31691

gh-68320, gh-88302 - Allow for `pathlib.Path` subclassing #31691

barneygale commented Mar 5, 2022 •

edited by bedevere-bot

barneygale commented Apr 6, 2022

brettcannon commented Apr 7, 2022

brettcannon left a comment

bedevere-bot commented Apr 29, 2022

bedevere-bot commented Nov 15, 2022

brettcannon commented Nov 25, 2022

brettcannon left a comment

bedevere-bot commented Nov 25, 2022

barneygale commented Nov 25, 2022

bedevere-bot commented Nov 25, 2022

brettcannon left a comment

bedevere-bot commented Dec 17, 2022

barneygale commented Dec 17, 2022

bedevere-bot commented Dec 17, 2022

gh-68320, gh-88302 - Allow for pathlib.Path subclassing #31691

Are you sure you want to change the base?

gh-68320, gh-88302 - Allow for pathlib.Path subclassing #31691

Conversation

barneygale commented Mar 5, 2022 • edited by bedevere-bot

barneygale commented Apr 6, 2022

brettcannon commented Apr 7, 2022

brettcannon left a comment

bedevere-bot commented Apr 29, 2022

bedevere-bot commented Nov 15, 2022

brettcannon commented Nov 25, 2022

brettcannon left a comment

bedevere-bot commented Nov 25, 2022

barneygale commented Nov 25, 2022

bedevere-bot commented Nov 25, 2022

brettcannon left a comment

bedevere-bot commented Dec 17, 2022

barneygale commented Dec 17, 2022

bedevere-bot commented Dec 17, 2022

gh-68320, gh-88302 - Allow for `pathlib.Path` subclassing #31691

gh-68320, gh-88302 - Allow for `pathlib.Path` subclassing #31691

barneygale commented Mar 5, 2022 •

edited by bedevere-bot