- fixed handling of import from __future__

- self-tested and added own requirements.txt
- cleaned up usage to require a file or directory to scan (rather than
  defaulting to ".")
- vendored code from pip 1.6dev which fixes bug in search_packages_info
  until pip 1.6 is released

Author: r1chardj0n3s

CHANGELOG.rst

@@ -0,0 +1,13 @@
+Release History
+---------------
+
+1.1.1
+- fixed handling of import from __future__
+- self-tested and added own requirements.txt
+- cleaned up usage to require a file or directory to scan (rather than
+  defaulting to ".")
+- vendored code from pip 1.6dev which fixes bug in search_packages_info
+  until pip 1.6 is released
+
+1.1.0 
+- implemented --ignore-module

pip_missing_reqs/find_missing_reqs.py

@@ -2,20 +2,56 @@
 import collections
 import fnmatch
 import imp
+import logging
 import optparse
 import os
 import re
-import logging
+import sys
 
+import pkg_resources
 from pip.req import parse_requirements
 from pip.download import PipSession
-from pip.commands.show import search_packages_info
 from pip.util import get_installed_distributions, normalize_name
 
-
 log = logging.getLogger(__name__)
 
 
+# TODO: remove me when pip 1.6 is released (vendored from pypa/pip git)
+def search_packages_info(query):  # pragma: no cover
+    """
+    Gather details from installed distributions. Print distribution name,
+    version, location, and installed files. Installed files requires a
+    pip generated 'installed-files.txt' in the distributions '.egg-info'
+    directory.
+    """
+    installed = dict(
+        [(p.project_name.lower(), p) for p in pkg_resources.working_set])
+    query_names = [name.lower() for name in query]
+    for dist in [installed[pkg] for pkg in query_names if pkg in installed]:
+        package = {
+            'name': dist.project_name,
+            'version': dist.version,
+            'location': dist.location,
+            'requires': [dep.project_name for dep in dist.requires()],
+        }
+        file_list = None
+        if isinstance(dist, pkg_resources.DistInfoDistribution):
+            # RECORDs should be part of .dist-info metadatas
+            if dist.has_metadata('RECORD'):
+                lines = dist.get_metadata_lines('RECORD')
+                paths = [l.split(',')[0] for l in lines]
+                paths = [os.path.join(dist.location, p) for p in paths]
+                file_list = [os.path.relpath(p, dist.egg_info)
+                             for p in paths]
+        else:
+            # Otherwise use pip's log for .egg-info's
+            if dist.has_metadata('installed-files.txt'):
+                file_list = dist.get_metadata_lines('installed-files.txt')
+        # use and short-circuit to check for None
+        package['files'] = file_list and sorted(file_list)
+        yield package
+
+
 class FoundModule:
     def __init__(self, modname, filename, locations=None):
         self.modname = modname
@@ -41,6 +77,9 @@ def visit_Import(self, node):
             self.__addModule(alias.name, node.lineno)
 
     def visit_ImportFrom(self, node):
+        if node.module == '__future__':
+            # not an actual module
+            return
         for alias in node.names:
             self.__addModule(node.module + '.' + alias.name, node.lineno)
 
@@ -180,7 +219,8 @@ def f(candidate, ignore_cfg=ignore_cfg):
 
 
 def main():
-    parser = optparse.OptionParser()
+    usage = 'usage: %prog [options] files or directories'
+    parser = optparse.OptionParser(usage)
     parser.add_option("-f", "--ignore-file", dest="ignore_files",
         action="append", default=[],
         help="file paths globs to ignore")
@@ -191,6 +231,11 @@ def main():
         action="store_true", default=False, help="be more verbose")
 
     (options, args) = parser.parse_args()
+
+    if not args:
+        parser.error("no source files or directories specified")
+        sys.exit(-1)
+
     options.ignore_files = ignorer(options.ignore_files)
     options.ignore_mods = ignorer(options.ignore_mods)
 

pip_missing_reqs/test_find_missing_reqs.py

@@ -87,10 +87,10 @@ def test_pyfiles_package(monkeypatch):
 
 
 @pytest.mark.parametrize(["ignore_ham", "ignore_hashlib", "expect", "locs"], [
-    (False, False, ['ast', 'os', 'hashlib'], [('spam.py', 1), ('ham.py', 2)]),
-    (False, True, ['ast', 'os'], [('spam.py', 1), ('ham.py', 2)]),
-    (True, False, ['ast'], [('spam.py', 1)]),
-    (True, True, ['ast'], [('spam.py', 1)]),
+    (False, False, ['ast', 'os', 'hashlib'], [('spam.py', 2), ('ham.py', 2)]),
+    (False, True, ['ast', 'os'], [('spam.py', 2), ('ham.py', 2)]),
+    (True, False, ['ast'], [('spam.py', 2)]),
+    (True, True, ['ast'], [('spam.py', 2)]),
 ])
 def test_find_imported_modules(monkeypatch, caplog, ignore_ham, ignore_hashlib,
         expect, locs):
@@ -104,7 +104,7 @@ def test_find_imported_modules(monkeypatch, caplog, ignore_ham, ignore_hashlib,
     class FakeFile():
         contents = [
             'from os import path\nimport ast, hashlib',
-            'import ast, sys',
+            'from __future__ import braces\nimport ast, sys',
         ]
 
         def __init__(self, filename):
@@ -190,11 +190,14 @@ class options:
     options = options()
 
     class FakeOptParse:
+        def __init__(self, usage):
+            pass
+
         def add_option(*args, **kw):
             pass
 
         def parse_args(self):
-            return [options, 'ham.py']
+            return (options, ['ham.py'])
 
     monkeypatch.setattr(optparse, 'OptionParser', FakeOptParse)
 
@@ -211,6 +214,30 @@ def parse_args(self):
         'location.py:1 dist=missing module=missing'
 
 
+def test_main_no_spec(monkeypatch, caplog):
+    class FakeOptParse:
+        def __init__(self, usage):
+            pass
+
+        def add_option(*args, **kw):
+            pass
+
+        def parse_args(self):
+            return (None, [])
+
+        error = pretend.call_recorder(lambda *a: None)
+
+    monkeypatch.setattr(optparse, 'OptionParser', FakeOptParse)
+    monkeypatch.setattr(find_missing_reqs, 'ignorer',
+        pretend.call_recorder(lambda a: None))
+
+    with pytest.raises(SystemExit):
+        find_missing_reqs.main()
+
+    assert FakeOptParse.error.calls
+    assert not find_missing_reqs.ignorer.calls
+
+
 @pytest.mark.parametrize(["ignore_cfg", "candidate", "result"], [
     ([], 'spam', False),
     ([], 'ham', False),
@@ -220,8 +247,10 @@ def parse_args(self):
     (['spam*'], 'spam', True),
     (['spam*'], 'spam.ham', True),
     (['spam*'], 'eggs', False),
+    (['spam'], '/spam', True),
 ])
 def test_ignorer(monkeypatch, ignore_cfg, candidate, result):
+    monkeypatch.setattr(os.path, 'relpath', lambda s: s.lstrip('/'))
     ignorer = find_missing_reqs.ignorer(ignore_cfg)
     assert ignorer(candidate) == result
 
@@ -239,11 +268,14 @@ class options:
     options = options()
 
     class FakeOptParse:
+        def __init__(self, usage):
+            pass
+
         def add_option(*args, **kw):
             pass
 
         def parse_args(self):
-            return [options, 'ham.py']
+            return (options, ['ham.py'])
 
     monkeypatch.setattr(optparse, 'OptionParser', FakeOptParse)
 

requirements.txt

@@ -0,0 +1 @@
+pip>1.5

setup.py

@@ -7,9 +7,12 @@
 with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
     long_description = f.read()
 
+with open(path.join(here, 'CHANGELOG.rst'), encoding='utf-8') as f:
+    long_description += f.read()
+
 setup(
     name='pip_missing_reqs',
-    version='1.1.0',
+    version='1.1.1',
     description='Find packages that should be in requirements for a project',
     long_description=long_description,
     url='https://github.com/r1chardj0n3s/pip-missing-reqs',

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py27,py34,pep8
+envlist = py27,py34,pep8,pip-missing-reqs
 
 [testenv]
 deps =
@@ -8,7 +8,8 @@ deps =
     pytest
     pytest-capturelog
 commands =
-    coverage run --source find_missing_reqs.py -m pytest --strict []
+    coverage run --source pip_missing_reqs/find_missing_reqs.py \
+        -m pytest --strict []
     coverage report -m --fail-under 100
 
 [flake8]
@@ -21,3 +22,9 @@ norecursedirs = .git .tox *.egg build
 [testenv:pep8]
 deps = flake8
 commands = flake8 pip_missing_reqs
+
+[testenv:pip-missing-reqs]
+deps = pip_missing_reqs
+commands = pip-missing-reqs --ignore-file=pip_missing_reqs/test* \
+    pip_missing_reqs
+