Skip to content

Support Direct URL editable requirements #13495

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ichard26
Copy link
Member

@ichard26 ichard26 commented Jul 20, 2025

This is crucial for the deprecation of non-bare egg URL fragments as they used to be the sole way to request an extra for a VCS editable install.

I've also removed all references to egg fragments from the user docs and added further explanation of the Direct URL form in the VCS support topic.

Getting the error handling right was a pain. That's why I extracted the two parsing flows into their own functions.

Towards #13157.
Towards #1289.
Supersedes #9471.

@ichard26 ichard26 added this to the 25.2 milestone Jul 20, 2025
@ichard26 ichard26 force-pushed the feat/direct-editables branch from 4164131 to 47e7040 Compare July 20, 2025 19:50
@@ -66,8 +66,8 @@ for the name and project version (this is in theory slightly less reliable
than using the ``egg_info`` command, but avoids downloading and processing
unnecessary numbers of files).

Any URL may use the ``#egg=name`` syntax (see :doc:`../topics/vcs-support`) to
explicitly state the project name.
The :pep:`508` requirement syntax can be used to explicitly state the project
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hate that I'm adding more references to individual PEPs in the user documentation, but I legitimately don't know where to find a good user guide for Direct URL requirements. Linking to the specification is not exactly user friendly. I defaulted to linking the PEP as this document already does that.

Suggestions would be welcome.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ichard26 ichard26 force-pushed the feat/direct-editables branch from 47e7040 to fcae387 Compare July 20, 2025 20:18
@ichard26
Copy link
Member Author

Ugh, why is everything filled with so many exceptions and undocumented extensions. There is a backwards compatibility break here. I'll fix it, but I do want to take a closer look at why it's happening.

@ichard26 ichard26 marked this pull request as draft July 20, 2025 20:36
This is crucial for the deprecation of non-bare egg URL fragments as they
used to be the sole way to request an extra for a VCS editable install.

I've also removed all references to egg fragments from the user docs and
added further explanation of the Direct URL form in the VCS support
topic.

Getting the error handling right was a pain. That's why I extracted the
two parsing flows into their own functions.

Co-authored-by: Tzu-ping Chung <[email protected]>
@ichard26 ichard26 force-pushed the feat/direct-editables branch from fcae387 to 8850376 Compare July 21, 2025 21:12
@ichard26 ichard26 marked this pull request as ready for review July 21, 2025 21:31
@ichard26 ichard26 modified the milestones: 25.2, 25.3 Jul 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants