Skip to content

Commit 395e1ae

Browse files
committed
Add detail to docs on constraints changes with new resolver
Related to pypa#8307, pypa#8115.
1 parent 27b100e commit 395e1ae

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

docs/html/user_guide.rst

+14-9
Original file line numberDiff line numberDiff line change
@@ -1449,22 +1449,27 @@ install x y`` in a single command. We would like your thoughts on what
14491449
pip's behavior should be; please answer `our survey on upgrades that
14501450
create conflicts`_.
14511451

1452-
We are also changing our support for :ref:`Constraints Files` and
1453-
related functionality. We did a fairly comprehensive overhaul and
1454-
stripped constraints files down to being purely a way to specify
1455-
global (version) limits for packages. Specifically:
1452+
We are also changing our support for :ref:`Constraints Files`,
1453+
editable installs, and related functionality. We did a fairly
1454+
comprehensive overhaul and stripped constraints files down to being
1455+
purely a way to specify global (version) limits for packages, and so
1456+
some combinations that used to be allowed will now cause
1457+
errors. Specifically:
14561458

14571459
* Constraints don't override the existing requirements; they simply
14581460
constrain what versions are visible as input to the resolver (see
14591461
:issue:`9020`)
1460-
14611462
* Providing an editable requirement (``-e .``) does not cause pip to
1462-
ignore version specifiers or constraints (see :issue:`8076`)
1463-
1463+
ignore version specifiers or constraints (see :issue:`8076`), and if
1464+
you have a conflict between a pinned requirement and a local
1465+
directory then pip will indicate that it cannot find a version
1466+
satisfying both (see :issue:`8307`)
14641467
* Hash-checking mode requires that all requirements are specified as a
1465-
`==` match on a version and may not work well in combination with
1468+
``==`` match on a version and may not work well in combination with
14661469
constraints (see :issue:`9020` and :issue:`8792`)
1467-
1470+
* If necessary to satisfy constraints, pip will happily reinstall
1471+
packages, upgrading or downgrading, without needing any additional
1472+
command-line options (see :issue:`8115` and :doc:`development/architecture/upgrade-options`)
14681473
* Unnamed requirements are not allowed as constraints (see :issue:`6628` and :issue:`8210`)
14691474
* Links are not allowed as constraints (see :issue:`8253`)
14701475
* Constraints cannot have extras (see :issue:`6628`)

0 commit comments

Comments
 (0)