-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This command ensures that all packages installed have all the requirements they need, and that requirements have compatible versions. This is useful because pip can install incompatible dependencies[1], or a user may have manually (un)installed a package. [1] pypa#775
- Loading branch information
Showing
3 changed files
with
102 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
from pip.log import logger | ||
from pip.basecommand import Command | ||
from pip.util import get_installed_distributions | ||
|
||
|
||
class CheckCommand(Command): | ||
"""Verify installed packages have compatible dependencies.""" | ||
name = 'check' | ||
usage = """ | ||
%prog [options]""" | ||
summary = 'Verify installed packages have compatible dependencies.' | ||
|
||
def setup_logging(self): | ||
logger.move_stdout_to_stderr() | ||
|
||
def run(self, options, args): | ||
all_requirements_met = True | ||
|
||
installed = get_installed_distributions() | ||
for dist in installed: | ||
|
||
missing_requirements = self.get_missing_requirements(dist, installed) | ||
for requirement in missing_requirements: | ||
logger.notify("%s %s requires %s, which is not installed." % | ||
(dist.project_name, dist.version, requirement.project_name)) | ||
|
||
incompatible_requirements = self.get_incompatible_requirements(dist, installed) | ||
for requirement, actual in incompatible_requirements: | ||
logger.notify("%s %s has requirement %s, but you have %s %s." % | ||
(dist.project_name, dist.version, requirement, | ||
actual.project_name, actual.version)) | ||
|
||
if missing_requirements or incompatible_requirements: | ||
all_requirements_met = False | ||
|
||
if not all_requirements_met: | ||
return 1 | ||
|
||
def get_missing_requirements(self, dist, installed_dists): | ||
"""Return all of the requirements of `dist` that aren't present in | ||
`installed_dists`. | ||
""" | ||
installed_names = set(d.project_name for d in installed_dists) | ||
|
||
missing_requirements = set() | ||
for requirement in dist.requires(): | ||
if requirement.project_name not in installed_names: | ||
missing_requirements.add(requirement) | ||
yield requirement | ||
|
||
def get_incompatible_requirements(self, dist, installed_dists): | ||
"""Return all of the requirements of `dist` that are present in | ||
`installed_dists`, but have incompatible versions. | ||
""" | ||
installed_dists_by_name = {} | ||
for installed_dist in installed_dists: | ||
installed_dists_by_name[installed_dist.project_name] = installed_dist | ||
|
||
incompatible_requirements = set() | ||
for requirement in dist.requires(): | ||
present_dist = installed_dists_by_name.get(requirement.project_name) | ||
|
||
if present_dist and present_dist not in requirement: | ||
incompatible_requirements.add((requirement, present_dist)) | ||
yield (requirement, present_dist) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
def test_check_clean(script): | ||
"""On a clean environment, check shouldn't return anything. | ||
""" | ||
result = script.pip('check') | ||
assert result.stdout == "" | ||
|
||
|
||
def test_check_missing_dependency(script): | ||
# this will also install ipython, a dependency | ||
script.pip('install', 'ipdb==0.7') | ||
|
||
# deliberately remove the dependency | ||
script.pip('uninstall', 'ipython', '--yes') | ||
|
||
result = script.pip('check', expect_error=True, expect_stderr=True) | ||
|
||
assert result.stderr == "ipdb 0.7 requires ipython, which is not installed.\n" | ||
assert result.returncode == 1 | ||
|
||
|
||
def test_check_broken_dependency(script): | ||
# this will also install a compatible version of jinja2 | ||
script.pip('install', 'flask==0.10.1') | ||
|
||
# deliberately change dependency to a version that is too old | ||
script.pip('install', 'jinja2==2.3') | ||
|
||
result = script.pip('check', expect_error=True, expect_stderr=True) | ||
|
||
assert result.stderr == "Flask 0.10.1 has requirement Jinja2>=2.4, but you have Jinja2 2.3.\n" | ||
assert result.returncode == 1 |