PEP 778: Add initial text and reserve 777 #3786
Conversation
|
Hi Ethan! We normally assign the next available PEP numbers (for example, 747), what's the justification for jumping up to 777? @warsaw Please can you confirm you're sponsoring the second PEP here ("Supporting Symlinks in Wheels")? And we need a sponsor for the first one ("Reinventing the Wheel (Wheel 2.0)" - excellent title btw!). @warsaw Will you sponsor this one as well? And for next time, we normally don't open a PEP discussion thread (https://discuss.python.org/t/pep-778-supporting-symlinks-in-wheels/53824) until after the draft PEP has been merged into the repo - it means a first pass review and fixes can be made, but more importantly, means we have a stable PR for people to review. We've had situations where people were still looking at the old PR preview even after merge and subsequent PR updates. |
|
Hey Hugo! Sorry! I selected 777 because I expect a series of related PEPs (wheel 2.0) and I wanted to have their numbers grouped together (like 482, 483, 484), if someone puts a new PEP up between now and when I get to writing the other PEPs, it would break the grouping. I posted to discuss to get feedback on 778 while I work on 777. Sorry for not following the process I'll try to follow it more closely in future. |
Confirmed! |
Just to be explicit, yes I'll sponsor this one as well. |
There was a problem hiding this comment.
Please could you copy the "New PEP" template into the PR message and check them off?
https://github.com/python/peps/blob/main/.github/PULL_REQUEST_TEMPLATE/Add%20a%20new%20PEP.md
For example, please also add Barry to the CODEOWNERS file for these.
| Status: Draft | ||
| Type: Standards Track | ||
| Topic: Packaging | ||
| Content-Type: text/x-rst |
There was a problem hiding this comment.
This is no longer needed and no longer in the template: https://github.com/python/peps/blob/main/peps/pep-0012/pep-NNNN.rst?plain=1
| Content-Type: text/x-rst |
There was a problem hiding this comment.
I must have had an old checkout, thanks for correcting!
| PEP 660 and Deferring Editable Installation Support | ||
| ------------------------------------------------------ |
There was a problem hiding this comment.
| PEP 660 and Deferring Editable Installation Support | |
| ------------------------------------------------------ | |
| PEP 660 and Deferring Editable Installation Support | |
| --------------------------------------------------- |
| symlinks are unsupported on the platform, and explain why installation has failed. | ||
|
|
||
| For people building libraries, documentation on ``packaging.python.org`` should describe the use | ||
| cases and caveats (especially platform suppport) of symlinks in wheels. Otherwise it should be |
There was a problem hiding this comment.
| cases and caveats (especially platform suppport) of symlinks in wheels. Otherwise it should be | |
| cases and caveats (especially platform suppport) of symlinks in wheels. Otherwise it should be |
|
|
||
| Installers **MUST** follow the following steps when handling a wheel with symlinks: | ||
|
|
||
| 1. Check for the existance of a ``LINKS`` file in the ``.dist-info``. If it does not exist, |
There was a problem hiding this comment.
| 1. Check for the existance of a ``LINKS`` file in the ``.dist-info``. If it does not exist, | |
| 1. Check for the existence of a ``LINKS`` file in the ``.dist-info``. If it does not exist, |
| Topic: Packaging | ||
| Created: 20-May-2024 | ||
|
|
||
| - Should mention https://discuss.python.org/t/speculative-wheel-2-0-and-migration-strategies/21600/13 |
There was a problem hiding this comment.
Let's start with a short text saying something like this is a placeholder and the PEP will be added in future.
There was a problem hiding this comment.
I'll write that up and push shortly, thank you! Wasn't sure how to handle that.
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
|
EDIT: this was indeed raised in the Discourse thread already. For symlinks - have you looked at the approach @njsmith took for pybi and the rationale for it? https://github.com/njsmith/posy/blob/main/pybi/README.md#symlinks They are stored both as actual symlinks in the zip file with one of the common extensions for representing them, and as metadata in the RECORD file. This means that if you're just using a naive zip tool (e.g. In general I think it would be good to unify wheel 2.0 with pybi as far as possible / make it so that the pybi format doesn't need to exist and it's just wheel 2.0. (BTW - are you all still at sprints?) (Also should I be commenting here or on the Discourse thread?) |
Discourse for more general discussion like this, thanks. |
Posting here to reserve the PEP numbers and posting the text of PEP 778 to share on discuss.
📚 Documentation preview 📚: https://pep-previews--3786.org.readthedocs.build/pep-0778/