Skip to content

Commit 28ae53d

Browse files
committed
WIP: moving test suggestions from other issue
Related to #8099.
1 parent 187e5d0 commit 28ae53d

File tree

1 file changed

+73
-9
lines changed

1 file changed

+73
-9
lines changed

docs/html/user_guide.rst

Lines changed: 73 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1031,8 +1031,9 @@ an optional ``--unstable-feature=resolver`` flag). pip 20.2 includes a
10311031
robust beta of the new resolver (hidden behind an optional
10321032
``--use-feature=2020-resolver`` flag) that we encourage you to
10331033
test. We will continue to improve the pip dependency resolver in
1034-
response to testers' feedback. This will help us prepare to release
1035-
pip 20.3, with the new resolver on by default, in October.
1034+
response to testers' feedback. Please give us feedback through the
1035+
`resolver testing survey`_. This will help us prepare to release pip
1036+
20.3, with the new resolver on by default, in October.
10361037

10371038
Watch out for
10381039
-------------
@@ -1099,11 +1100,20 @@ How to test
10991100
``pip check`` and run into stuff you can’t figure out, please `ask
11001101
for help in our issuetracker or chat <https://pip.pypa.io/>`__.
11011102

1102-
3. **Test the new version of pip** (see below). While we have tried to
1103-
make sure that pip’s test suite covers as many cases as we can, we
1104-
are very aware that there are people using pip with many different
1105-
workflows and build processes, and we will not be able to cover all
1106-
of those without your help.
1103+
3. **Test the new version of pip** (see below). To test the new
1104+
resolver, use the ``--use-feature=2020-resolver`` flag, as in:
1105+
1106+
``pip install example --use-feature=2020-resolver``
1107+
1108+
The more feedback we can get, the more we can make sure that the
1109+
final release is solid. (Only try the new resolver **in a
1110+
non-production environment**, though - it isn't ready for you to
1111+
rely on in production!)
1112+
1113+
While we have tried to make sure that pip’s test suite covers as
1114+
many cases as we can, we are very aware that there are people using
1115+
pip with many different workflows and build processes, and we will
1116+
not be able to cover all of those without your help.
11071117

11081118
- If you use pip to install your software, try out the new resolver
11091119
and let us know if it works for you with ``pip install``. Try:
@@ -1125,7 +1135,7 @@ How to test
11251135
deliver part of your functionality, please test your integration
11261136
with pip 20.2.
11271137

1128-
Please report bugs [GitHub link or something else TKTK].
1138+
4. **Please report bugs** through the `resolver testing survey`_.
11291139

11301140
Setups we might need more testing on
11311141
------------------------------------
@@ -1142,17 +1152,71 @@ Setups we might need more testing on
11421152

11431153
* Requirements files with 100+ packages
11441154

1155+
* Installing a package that has multiple requirements files
1156+
11451157
* Requirements files that include hashes or pinned dependencies (perhaps as output from ``pip-compile`` or ``pip-tools``)
11461158

11471159
* Continuous integration/continuous deployment setups
11481160

1149-
* Installing from any kind of version control systems (i.e., Git, Subversion, Mercurial, or CVS)
1161+
* Installing from any kind of version control systems (i.e., Git, Subversion, Mercurial, or CVS), per :ref:`VCS Support`
11501162

11511163
* Installing from source code held in local directories
11521164

11531165
* Using the most recent versions of Python 3.6, 3.7, 3.8, and 3.9
11541166

1167+
* PyPy
1168+
11551169
* Customized terminals (where you have modified how error messages and standard output display)
11561170

1171+
Examples to try
1172+
^^^^^^^^^^^^^^^
1173+
1174+
Install:
1175+
1176+
* `tensorflow`_
1177+
* ``hacking``
1178+
* ``pycodestyle``
1179+
* ``pandas``
1180+
* ``tablib``
1181+
* ``elasticsearch`` and ``requests`` together
1182+
* ``six`` and ``cherrypy`` together
1183+
* ``pip install flake8-import-order==0.17.1 flake8==3.5.0 --use-feature=2020-resolver``
1184+
* ``pip install tornado==5.0 sprockets.http==1.5.0 --use-feature=2020-resolver``
1185+
1186+
Try:
1187+
1188+
* ``pip install``
1189+
* ``pip uninstall``
1190+
* ``pip check``
1191+
* ``pip cache``
1192+
1193+
1194+
Tell us about
1195+
-------------
1196+
1197+
Specific things we'd love to get feedback on:
1198+
1199+
* Cases where the new resolver produces the wrong result,
1200+
obviously. We hope there won't be too many of these, but we'd like
1201+
to trap such bugs now.
1202+
1203+
* Cases where the resolver produced an error when you believe it
1204+
should have been able to work out what to do.
1205+
1206+
* Cases where the resolver gives an error because there's a problem
1207+
with your requirements, but you need better information to work out
1208+
what's wrong.
1209+
1210+
* If you have workarounds to address issues with the current resolver,
1211+
does the new resolver let you remove those workarounds? Tell us!
1212+
1213+
1214+
Context and followup
1215+
--------------------
1216+
1217+
As discussed in `our announcement on the PSF blog`_, the pip team are in the process of developing a new "dependency resolver" (the part of pip that works out what to install based on your requirements). We have reached a major milestone in this work, and have a testable ("beta") version of the resolver, which you can test, included in this release.
11571218

11581219
.. _freeze: https://pip.pypa.io/en/latest/reference/pip_freeze/
1220+
.. _resolver testing survey: https://tools.simplysecure.org/survey/index.php?r=survey/index&sid=989272&lang=en
1221+
.. _our announcement on the PSF blog: http://pyfound.blogspot.com/2020/03/new-pip-resolver-to-roll-out-this-year.html
1222+
.. _tensorflow: https://pypi.org/project/tensorflow/

0 commit comments

Comments
 (0)