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

Add topic guide: Dependency Resolution #10102

Merged
merged 6 commits into from
Jul 13, 2021

Conversation

pradyunsg
Copy link
Member

This one needs a proper review, since I can't figure out how to best explain things here; and what stuff to move into this.

The basic idea was to move https://pip.pypa.io/en/stable/user_guide/#dependency-resolution-backtracking into this document, which would go a long way toward making the user guide shorter.

Toward #9475.

@pradyunsg pradyunsg added type: docs Documentation related skip news Does not need a NEWS file entry (eg: trivial changes) labels Jun 25, 2021
@pradyunsg pradyunsg marked this pull request as draft June 25, 2021 14:26
Copy link
Member

@uranusjr uranusjr left a comment

Choose a reason for hiding this comment

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

This looks pretty good to me! Hopefully it will help more people understand why pip needs to seemingly waste unnecessary resources on this. (The issue is out of pip’s control.)

docs/html/topics/dependency-resolution.md Show resolved Hide resolved
docs/html/topics/dependency-resolution.md Outdated Show resolved Hide resolved
docs/html/topics/dependency-resolution.md Outdated Show resolved Hide resolved
pradyunsg and others added 2 commits July 2, 2021 12:18
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
This reads clearer than the initial iteration.

Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
@pradyunsg
Copy link
Member Author

Uhhh... I should set up GPG signing on this laptop.

@pradyunsg pradyunsg marked this pull request as ready for review July 9, 2021 09:57
Copy link
Member

@uranusjr uranusjr left a comment

Choose a reason for hiding this comment

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

The writeup makes sense to me (with a couple of parts I think can be improved). I am not sure how useful users would find this, but improvements can always be made later as long as the description here is not inaccurate.

Comment on lines 14 to 17
pip does not have all the information it needs to work out the dependencies of
the requested packages. Over the course of the dependency resolution process,
pip needs to download distributions of the package, which can then provide
the list of dependencies that the package requires.
Copy link
Member

Choose a reason for hiding this comment

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

The first sentence is confusing for a pip user IMO. pip cannot work out dependencies? WTF?

Copy link
Member Author

Choose a reason for hiding this comment

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

Nice catch. This needs something like "when it begins".

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 took a stab at this in 14e48b5. If that doesn't look good-enough, just say so on #9475. :)

docs/html/topics/dependency-resolution.md Outdated Show resolved Hide resolved
pradyunsg and others added 2 commits July 11, 2021 09:27
Co-authored-by: Tzu-ping Chung <uranusjr@gmail.com>
- Clarify that pip is incrementally building up this information.
- Clarify that pip has to download files, which contain the dependency information.
- Hint at the fact that this is a recursive process.
@pypa-bot
Copy link

Hello!

I am an automated bot and I have noticed that this pull request is not currently able to be merged. If you are able to either merge the master branch into this pull request or rebase this pull request against master then it will eligible for code review and hopefully merging!

@pypa-bot pypa-bot added the needs rebase or merge PR has conflicts with current master label Jul 13, 2021
@pypa-bot pypa-bot removed the needs rebase or merge PR has conflicts with current master label Jul 13, 2021
@pradyunsg
Copy link
Member Author

Good bot.

@pradyunsg pradyunsg merged commit 7da05f3 into pypa:main Jul 13, 2021
@pradyunsg pradyunsg deleted the topic/dependency-resolution branch July 13, 2021 22:12
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 27, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
skip news Does not need a NEWS file entry (eg: trivial changes) type: docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants