Merge pull request #55 from MrMino/requirements-file-flag

Requirements file flag

Author: adamtheturtle

CHANGELOG.rst

@@ -2,6 +2,12 @@
 Release History
 ---------------
 
+2.2.0
+
+- 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.
+
 2.1.1
 
 - Bug fix: Though Python 2 support was removed from the source code, the published wheel was still universal.

pip_check_reqs/__init__.py

@@ -1 +1 @@
-__version__ = '2.1.1'
+__version__ = '2.2.0'

pip_check_reqs/find_extra_reqs.py

@@ -49,7 +49,7 @@ def find_extra_reqs(options, requirements_filename):
                 'used module: %s (from file %s, assuming stdlib or local)',
                 modname, info.filename)
 
-    # 4. compare with requirements.txt
+    # 4. compare with requirements
     explicit = common.find_required_modules(
         options=options,
         requirements_filename=requirements_filename,
@@ -63,6 +63,12 @@ def main():
 
     usage = 'usage: %prog [options] files or directories'
     parser = optparse.OptionParser(usage)
+    parser.add_option("--requirements-file",
+                      dest="requirements_filename",
+                      metavar="PATH",
+                      default="requirements.txt",
+                      help="path to the requirements file "
+                           "(defaults to \"requirements.txt\")")
     parser.add_option("-f",
                       "--ignore-file",
                       dest="ignore_files",
@@ -80,7 +86,7 @@ def main():
                       dest="ignore_reqs",
                       action="append",
                       default=[],
-                      help="reqs in requirements.txt to ignore")
+                      help="reqs in requirements to ignore")
     parser.add_option("-v",
                       "--verbose",
                       dest="verbose",
@@ -124,18 +130,17 @@ def main():
 
     log.info('using pip_check_reqs-%s from %s', __version__, __file__)
 
-    requirements_filename = 'requirements.txt'
     extras = find_extra_reqs(
         options=options,
-        requirements_filename=requirements_filename,
+        requirements_filename=options.requirements_filename,
     )
 
     if extras:
         log.warning('Extra requirements:')
     for name in extras:
         message = '{name} in {requirements_filename}'.format(
             name=name,
-            requirements_filename=requirements_filename,
+            requirements_filename=options.requirements_filename,
         )
         log.warning(message)
 

pip_check_reqs/find_missing_reqs.py

@@ -56,7 +56,7 @@ def find_missing_reqs(options, requirements_filename):
                 'used module: %s (from file %s, assuming stdlib or local)',
                 modname, info.filename)
 
-    # 4. compare with requirements.txt
+    # 4. compare with requirements
     explicit = set()
     for requirement in parse_requirements(
         requirements_filename,
@@ -84,6 +84,12 @@ def main():
 
     usage = 'usage: %prog [options] files or directories'
     parser = optparse.OptionParser(usage)
+    parser.add_option("--requirements-file",
+                      dest="requirements_filename",
+                      metavar="PATH",
+                      default="requirements.txt",
+                      help="path to the requirements file "
+                           "(defaults to \"requirements.txt\")")
     parser.add_option("-f",
                       "--ignore-file",
                       dest="ignore_files",
@@ -138,10 +144,9 @@ def main():
 
     log.info('using pip_check_reqs-%s from %s', __version__, __file__)
 
-    requirements_filename = 'requirements.txt'
     missing = find_missing_reqs(
         options=options,
-        requirements_filename=requirements_filename,
+        requirements_filename=options.requirements_filename,
     )
 
     if missing:

tests/test_find_extra_reqs.py

@@ -15,6 +15,7 @@
 def fake_opts():
     class FakeOptParse:
         class options:
+            requirements_filename = 'requirements.txt'
             paths = ['dummy']
             verbose = False
             debug = False
@@ -124,6 +125,7 @@ def test_main_no_spec(monkeypatch, caplog, fake_opts):
 ])
 def test_logging_config(monkeypatch, caplog, verbose_cfg, debug_cfg, result):
     class options:
+        requirements_filename = ''
         paths = ['dummy']
         verbose = verbose_cfg
         debug = debug_cfg

tests/test_find_missing_reqs.py

@@ -15,6 +15,7 @@
 def fake_opts():
     class FakeOptParse:
         class options:
+            requirements_filename = ''
             paths = ['dummy']
             verbose = False
             debug = False
@@ -136,6 +137,7 @@ def test_main_no_spec(monkeypatch, caplog, fake_opts):
 ])
 def test_logging_config(monkeypatch, caplog, verbose_cfg, debug_cfg, result):
     class options:
+        requirements_filename = '',
         paths = ['dummy']
         verbose = verbose_cfg
         debug = debug_cfg