fixes for debian/ubuntu

Author: r1chardj0n3s

CHANGELOG.rst

@@ -2,6 +2,23 @@
 Release History
 ---------------
 
+1.1.9
+
+- test fixes and cleanup
+- remove hard-coded simplejson debugging behaviour
+
+1.1.8
+
+- use os.path.realpath to avoid symlink craziness on debian/ubuntu
+
+1.1.7
+
+- tweak to debug output
+
+1.1.6
+
+- add debug (very verbose) run output
+
 1.1.5
 
 - add header to output to make it clearer when in a larger test run

pip_missing_reqs/__init__.py

@@ -1 +1 @@
-__version__ = '1.1.5'
+__version__ = '1.1.8'

pip_missing_reqs/find_missing_reqs.py

@@ -56,7 +56,7 @@ def search_packages_info(query):  # pragma: no cover
 class FoundModule:
     def __init__(self, modname, filename, locations=None):
         self.modname = modname
-        self.filename = filename
+        self.filename = os.path.realpath(filename)
         self.locations = locations or []         # filename, lineno
 
     def __repr__(self):
@@ -154,6 +154,7 @@ def find_imported_modules(options):
             if options.ignore_files(filename):
                 log.info('ignoring: %s', os.path.relpath(filename))
                 continue
+            log.debug('scanning: %s', os.path.relpath(filename))
             with open(filename) as f:
                 content = f.read()
             vis.set_location(filename)
@@ -180,8 +181,10 @@ def find_missing_reqs(options):
     installed_files = {}
     all_pkgs = (pkg.project_name for pkg in get_installed_distributions())
     for package in search_packages_info(all_pkgs):
+        log.debug('installed package: %s (at %s)', package['name'],
+            package['location'])
         for file in package['files'] or []:
-            path = os.path.normpath(os.path.join(package['location'], file))
+            path = os.path.realpath(os.path.join(package['location'], file))
             installed_files[path] = package['name']
             package_path = is_package_file(path)
             if package_path:
@@ -190,17 +193,25 @@ def find_missing_reqs(options):
                 # a package by its directory path later
                 installed_files[package_path] = package['name']
 
+    # 3. match imported modules against those packages
     used = collections.defaultdict(list)
     for modname, info in used_modules.items():
         # probably standard library if it's not in the files list
         if info.filename in installed_files:
             used_name = normalize_name(installed_files[info.filename])
+            log.debug('used module: %s (from package %s)', modname,
+                installed_files[info.filename])
             used[used_name].append(info)
+        else:
+            log.debug(
+                'used module: %s (from file %s, assuming stdlib or local)',
+                modname, info.filename)
 
-    # 3. compare with requirements.txt
+    # 4. compare with requirements.txt
     explicit = set()
     for requirement in parse_requirements('requirements.txt',
             session=PipSession()):
+        log.debug('found requirement: %s', requirement.name)
         explicit.add(normalize_name(requirement.name))
 
     return [(name, used[name]) for name in used
@@ -222,6 +233,8 @@ def f(candidate, ignore_cfg=ignore_cfg):
 
 
 def main():
+    from pip_missing_reqs import __version__
+
     usage = 'usage: %prog [options] files or directories'
     parser = optparse.OptionParser(usage)
     parser.add_option("-f", "--ignore-file", dest="ignore_files",
@@ -232,13 +245,14 @@ def main():
         help="used module names (globs are ok) to ignore")
     parser.add_option("-v", "--verbose", dest="verbose",
         action="store_true", default=False, help="be more verbose")
+    parser.add_option("-d", "--debug", dest="debug",
+        action="store_true", default=False, help="be *really* verbose")
     parser.add_option("--version", dest="version",
         action="store_true", default=False, help="display version information")
 
     (options, args) = parser.parse_args()
 
     if options.version:
-        from pip_missing_reqs import __version__
         sys.exit(__version__)
 
     if not args:
@@ -251,7 +265,14 @@ def main():
     options.paths = args
 
     logging.basicConfig(format='%(message)s')
-    log.setLevel(logging.INFO if options.verbose else logging.WARN)
+    if options.debug:
+        log.setLevel(logging.DEBUG)
+    elif options.verbose:
+        log.setLevel(logging.INFO)
+    else:
+        log.setLevel(logging.WARN)
+
+    log.info('using pip_missing_reqs-%s from %s', __version__, __file__)
 
     missing = find_missing_reqs(options)
 

pip_missing_reqs/test_find_missing_reqs.py

@@ -20,7 +20,8 @@ def fake_opts():
     class FakeOptParse:
         class options:
             paths = ['dummy']
-            verbose = True
+            verbose = False
+            debug = False
             version = False
             ignore_files = []
             ignore_mods = []
@@ -56,7 +57,7 @@ def test_is_package_file(path, result):
 def test_FoundModule():
     fm = find_missing_reqs.FoundModule('spam', 'ham')
     assert fm.modname == 'spam'
-    assert fm.filename == 'ham'
+    assert fm.filename == os.path.realpath('ham')
     assert fm.locations == []
     assert str(fm) == 'FoundModule("spam")'
 
@@ -257,14 +258,17 @@ def test_ignorer(monkeypatch, ignore_cfg, candidate, result):
     assert ignorer(candidate) == result
 
 
-@pytest.mark.parametrize(["verbose_cfg", "events", "result"], [
-    (False, [(logging.INFO, 'info'), (logging.WARN, 'warn')], ['warn']),
-    (True, [(logging.INFO, 'info'), (logging.WARN, 'warn')], ['info', 'warn']),
+@pytest.mark.parametrize(["verbose_cfg", "debug_cfg", "result"], [
+    (False, False, ['warn']),
+    (True, False, ['info', 'warn']),
+    (False, True, ['debug', 'info', 'warn']),
+    (True, True, ['debug', 'info', 'warn']),
 ])
-def test_logging_config(monkeypatch, caplog, verbose_cfg, events, result):
+def test_logging_config(monkeypatch, caplog, verbose_cfg, debug_cfg, result):
     class options:
         paths = ['dummy']
         verbose = verbose_cfg
+        debug = debug_cfg
         version = False
         ignore_files = []
         ignore_mods = []
@@ -285,11 +289,16 @@ def parse_args(self):
     monkeypatch.setattr(find_missing_reqs, 'find_missing_reqs', lambda x: [])
     find_missing_reqs.main()
 
-    for event in events:
+    for event in [(logging.DEBUG, 'debug'), (logging.INFO, 'info'),
+            (logging.WARN, 'warn')]:
         find_missing_reqs.log.log(*event)
 
     messages = [r.message for r in caplog.records()]
-    assert messages == result
+    # first message is always the usage message
+    if verbose_cfg or debug_cfg:
+        assert messages[1:] == result
+    else:
+        assert messages == result
 
 
 def test_main_version(monkeypatch, caplog, fake_opts):