Merge pull request #57 from MrMino/skip_incompatible_flag

Add --skip-incompatible flag

Author: adamtheturtle

CHANGELOG.rst

@@ -4,6 +4,9 @@ Release History
 
 2.2.0
 
+- Added `--skip-incompatible` flag to `pip-extra-reqs`, which makes it ignore
+  requirements with environment markers that are incompatible with the current
+  environment.
 - Added `--requirements-file` flag to `pip-extra-reqs` and `pip-missing-reqs`
   commands. This flag makes it possible to specify a path to the requirements
   file. Previously, `"requirements.txt"` was always used.

pip_check_reqs/common.py

@@ -6,6 +6,7 @@
 import re
 
 from packaging.utils import canonicalize_name
+from packaging.markers import Marker
 # Between different versions of pip the location of PipSession has changed.
 try:
     from pip._internal.network.session import PipSession
@@ -142,12 +143,33 @@ def find_required_modules(options, requirements_filename: str):
 
         if options.ignore_reqs(requirement):
             log.debug('ignoring requirement: %s', requirement_name)
+            continue
+
+        if options.skip_incompatible:
+            requirement_string = requirement.requirement
+            if not has_compatible_markers(requirement_string):
+                log.debug('ignoring requirement (incompatible environment '
+                          'marker): %s', requirement_string)
+                continue
+
         else:
             log.debug('found requirement: %s', requirement_name)
             explicit.add(canonicalize_name(requirement_name))
+
     return explicit
 
 
+def has_compatible_markers(full_requirement: str) -> bool:
+    if ';' not in full_requirement:
+        return True  # No environment marker.
+
+    enviroment_marker = full_requirement.split(';')[1]
+    if not enviroment_marker:
+        return True  # Empty environment marker.
+
+    return Marker(enviroment_marker).evaluate()
+
+
 def is_package_file(path):
     '''Determines whether the path points to a Python package sentinel
     file - the __init__.py or its compiled variants.

pip_check_reqs/find_extra_reqs.py

@@ -87,6 +87,13 @@ def main():
                       action="append",
                       default=[],
                       help="reqs in requirements to ignore")
+    parser.add_option("-s",
+                      "--skip-incompatible",
+                      dest="skip_incompatible",
+                      action="store_true",
+                      default=False,
+                      help="skip requirements that have incompatible "
+                           "environment markers")
     parser.add_option("-v",
                       "--verbose",
                       dest="verbose",

requirements.txt

@@ -1,3 +1,3 @@
-packaging
+packaging >= 16.0
 # Pinned pip versions are matched in the GitHub workflows CI matrix.
 pip >= 10.0.1

tests/test_common.py

@@ -165,7 +165,7 @@ def test_ignorer(monkeypatch, tmp_path: Path, ignore_cfg, candidate, result):
 
 def test_find_required_modules(monkeypatch, tmp_path: Path):
     class options:
-        pass
+        skip_incompatible = False
 
     options.ignore_reqs = common.ignorer(ignore_cfg=['barfoo'])
 
@@ -177,3 +177,22 @@ class options:
         requirements_filename=str(fake_requirements_file),
     )
     assert reqs == set(['foobar'])
+
+
+def test_find_required_modules_env_markers(monkeypatch, tmp_path):
+    class options:
+        skip_incompatible = True
+
+        def ignore_reqs(self, modname):
+            return False
+
+    fake_requirements_file = tmp_path / 'requirements.txt'
+    fake_requirements_file.write_text('spam==1; python_version<"2.0"\n'
+                                      'ham==2;\n'
+                                      'eggs==3\n')
+
+    reqs = common.find_required_modules(
+        options=options(),
+        requirements_filename=str(fake_requirements_file),
+    )
+    assert not reqs

tests/test_find_extra_reqs.py

@@ -72,6 +72,7 @@ def test_find_extra_reqs(monkeypatch, tmp_path: Path):
     class options:
         def ignore_reqs(x, y):
             return False
+        skip_incompatible = False
 
     options = options()