Skip to content
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

#6369 - detailed documentation for the --platform and --python-version options of the pip download command #13251

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

Shepard2154
Copy link

Fixes #6369

developer added 2 commits March 1, 2025 15:10
@notatallshaw
Copy link
Member

The docs you've writen here don't seem to match the last comment in the thread you are referencing #6369 (comment)

Taking a looking at packaging.tags.get_tags() the fallback is a normalized version of sysconfig.get_platform(), but for Mac, iOS, and Linux there is more complicated logic.

Can you please justify your choices here, or update to reflect the discussion in #6369,

@Shepard2154
Copy link
Author

Shepard2154 commented Mar 17, 2025

The docs you've writen here don't seem to match the last comment in the thread you are referencing #6369 (comment)

Taking a looking at packaging.tags.get_tags() the fallback is a normalized version of sysconfig.get_platform(), but for Mac, iOS, and Linux there is more complicated logic.

Can you please justify your choices here, or update to reflect the discussion in #6369,

I have delved into the problem in more detail and agree with your comment. I added the command packaging.tags.sys_tags(). Starting with packaging version 21.0, the get_tags() function has been replaced by sys_tags(), which provides similar functionality. Does this resolve the issue?

@notatallshaw notatallshaw added this to the 25.1 milestone Mar 20, 2025
@notatallshaw
Copy link
Member

I've put it on the 25.1 milestone so it doesn't get forgotten, but will need a maintainer to review and accept, I'll try but I can't promise anything.

@pfmoore
Copy link
Member

pfmoore commented Apr 1, 2025

Even though this is "only" a docs change, there seem to be questions about the information given, and personally I'm not that convinced we should get into this much detail (these are advanced options, and cross-platform environment identification is a complex subject that I don't think it's pip's place to explain).

I'm not rejecting this change, but I don't think there's any reason it should be targeted to a specific pip release, so I'm removing the 25.1 milestone. It can go in when it's ready.

@pfmoore pfmoore removed this from the 25.1 milestone Apr 1, 2025
@notatallshaw
Copy link
Member

I'll review this week.

As a pip user I am occasionally frustrated with options that are not clear to me where the values are derived or validated against.

So I would like to see more documentation either pointing users to standards or detailing pip's implementation choices.

I added the milestone not because I thought it was needed for 25.1 but rather a reminder to address this PR in some way or another, rather than forgetting about it. I'm happy to take responsibility to review, reject, or postpone PRs that I add to a milestone that are otherwise left unreviewed and unmerged.

@pfmoore
Copy link
Member

pfmoore commented Apr 1, 2025

No worries - I'm happy for it to go in or not, as you prefer. But as we get closer to the release, I want the milestone to reflect stuff that I need to ensure gets resolved, and I don't think this falls into that category, which is why I removed it.

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.

Better documentation on using --platform and --python-version
3 participants