Skip to content

Commit e9d2916

Browse files
committed
WIP: docs: change new resolver to default
1 parent 70e543a commit e9d2916

File tree

4 files changed

+9
-5
lines changed

4 files changed

+9
-5
lines changed

README.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ We release updates regularly, with a new version every 3 months. Find more detai
1919
* `Release notes`_
2020
* `Release process`_
2121

22-
In 2020, we're working on improvements to the heart of pip. Please `learn more and take our survey`_ to help us do it right.
22+
In pip 20.3, we're making a big improvement to the heart of pip. Please `learn more`_ and `take our survey`_ to help us do it right.
2323

2424
If you find bugs, need help, or want to talk to the developers, please use our mailing lists or chat rooms:
2525

@@ -48,7 +48,8 @@ rooms, and mailing lists is expected to follow the `PSF Code of Conduct`_.
4848
.. _Release process: https://pip.pypa.io/en/latest/development/release-process/
4949
.. _GitHub page: https://github.com/pypa/pip
5050
.. _Development documentation: https://pip.pypa.io/en/latest/development
51-
.. _learn more and take our survey: https://pyfound.blogspot.com/2020/03/new-pip-resolver-to-roll-out-this-year.html
51+
.. _learn more: https://pip.pypa.io/en/latest/user_guide/#changes-to-the-pip-dependency-resolver-in-20-3-2020
52+
.. _take our survey: https://pyfound.blogspot.com/2020/03/new-pip-resolver-to-roll-out-this-year.html
5253
.. _Issue tracking: https://github.com/pypa/pip/issues
5354
.. _Discourse channel: https://discuss.python.org/c/packaging
5455
.. _Development mailing list: https://mail.python.org/mailman3/lists/distutils-sig.python.org/

docs/html/development/architecture/anatomy.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,7 @@ Within ``src/``:
9797

9898
* ``pep425tags.py`` -- getting refactored into packaging.tags (a library on PyPI) which is external to pip (but vendored by pip). :pep:`425` tags: turns out lots of people want this! Compatibility tags for built distributions -> e.g., platform, Python version, etc.
9999
* ``pyproject.py`` -- ``pyproject.toml`` is a new standard (:pep:`518` and :pep:`517`). This file reads pyproject.toml and passes that info elsewhere. The rest of the processing happens in a different file. All the handling for 517 and 518 is in a different file.
100-
* ``req/`` *[*\ **A DIRECTORY THAT NEEDS REFACTORING. A LOT**\ *\ …… Remember Step 3? Dependency resolution etc.? This is that step! Each file represents … have the entire flow of installing & uninstalling, getting info about packages…. Some files here are more than 1,000 lines long! (used to be longer?!) Refactor will deeply improve developer experience.]*
101-
* ``resolve.py`` -- This is where the current dependency resolution algorithm sits. Pradyun is `improving the pip dependency resolver`_. Pradyun will get rid of this file and replace it with a directory called “resolution”. (this work is in git master…. There is further work that is going to be in a branch soon)
100+
* ``req/`` *[*\ **A DIRECTORY THAT NEEDS REFACTORING. A LOT**\ *\ …… Remember Step 3? Dependency resolution etc.? This is that step! Each file represents … have the entire flow of installing & uninstalling, getting info about packages…. Some files here are more than 1,000 lines long! (used to be longer?!) Refactor will deeply improve developer experience. Also, we're `improving the pip dependency resolver`_ in 2020 so a bunch of this is changing.]*
102101
* ``utils/`` *[everything that is not “operationally” pip ….. Misc functions and files get dumped. There’s some organization here. There’s a models.py here which needs refactoring. Deprecation.py is useful, as are other things, but some things do not belong here. There ought to be some GitHub issues for refactoring some things here. Maybe a few issues with checkbox lists.]*
103102
* ``vcs/`` *[stands for Version Control System. Where pip handles all version control stuff -- one of the ``pip install`` arguments you can use is a version control link. Are any of these commands vendored? No, via subprocesses. For performance, it makes sense (we think) to do this instead of pygitlib2 or similar -- and has to be pure Python, can’t include C libraries, because you can’t include compiled C stuff, because you might not have it for the platform you are running on.]*
104103

docs/html/development/architecture/upgrade-options.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ When installing packages, pip chooses a distribution file, and installs it in
66
the user's environment. There are many choices involved in deciding which file
77
to install, and these are controlled by a variety of options.
88

9+
.. note::
10+
11+
This section of the documentation needs to be updated per
12+
:ref:`Resolver changes 2020`.
913

1014
Controlling what gets installed
1115
===============================

docs/html/user_guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1389,7 +1389,7 @@ pip 20.3 has a new dependency resolver, on by default. (pip 20.1 and
13891389
20.2 included pre-release versions of the new dependency resolver,
13901390
hidden behind optional user flags.) Read below for a migration guide,
13911391
how to invoke the legacy resolver, and the deprecation timeline. We
1392-
also made a `two-minute video explanation`__ you can watch.
1392+
also made a `two-minute video explanation`_ you can watch.
13931393

13941394
We will continue to improve the pip dependency resolver in response to
13951395
testers' feedback. Please give us feedback through the `resolver

0 commit comments

Comments
 (0)