Issue #227, Feature/pathformat, adds --absolute-paths option

.gitignore

@@ -9,3 +9,4 @@ vulture.egg-info/
 .pytest_cache/
 .tox/
 .venv/
+.idea/

CHANGELOG.md

@@ -1,5 +1,8 @@
 # unreleased
 
+* added --absolute-paths option to have vulture output absolute paths instead of relative paths (mcooperman, #227)
+  changed git signing key to correct verification
+
 * Only parse format strings when being used with `locals()` (jingw, #225).
 
 # 2.1 (2020-08-19)

README.md

@@ -152,6 +152,7 @@ ignore_names = ["visit_*", "do_*"]
 make_whitelist = true
 min_confidence = 80
 sort_by_size = true
+absolute_paths = false
 verbose = true
 paths = ["myscript.py", "mydir"]
 ```

tests/test_config.py

@@ -27,6 +27,7 @@ def test_cli_args():
         ignore_names=["name1", "name2"],
         make_whitelist=True,
         min_confidence=10,
+        absolute_paths=True,
         sort_by_size=True,
         verbose=True,
     )
@@ -39,6 +40,7 @@ def test_cli_args():
             "--min-confidence=10",
             "--sort-by-size",
             "--verbose",
+            "--absolute-paths",
             "path1",
             "path2",
         ]
@@ -97,6 +99,7 @@ def test_config_merging():
         min_confidence = 10
         sort_by_size = false
         verbose = false
+        absolute_paths = true
         paths = ["toml_path"]
         """
         )
@@ -108,6 +111,7 @@ def test_config_merging():
         "--make-whitelist",
         "--min-confidence=20",
         "--sort-by-size",
+        "--absolute-paths",
         "--verbose",
         "cli_path",
     ]
@@ -120,6 +124,7 @@ def test_config_merging():
         make_whitelist=True,
         min_confidence=20,
         sort_by_size=True,
+        absolute_paths=True,
         verbose=True,
     )
     assert result == expected

tests/test_utils.py

@@ -1,8 +1,34 @@
+"""module: test-utils"""
+
+# standard imports
 import ast
+import pathlib
+
+# external imports
 
+# local imports
 from vulture import utils
 
 
+def check_paths(filename, absolute=False):
+    pathstr = utils.format_path(filename, absolute)
+    # platform dependencies and path types need to be accounted for
+    pp = pathlib.PurePath(pathstr)
+    check = pp.is_absolute()
+    if absolute:
+        assert check
+    # even if absolute == True, the path might have been specified absolute
+    # so can't conclude negatively
+
+
+def test_absolute_path():
+    check_paths(__file__, absolute=True)
+
+
+def test_relative_path():
+    check_paths(__file__, absolute=False)
+
+
 def check_decorator_names(code, expected_names):
     decorator_names = []
 

tox.ini

@@ -25,12 +25,13 @@ deps =
   flake8-2020
   flake8-bugbear
   flake8-comprehensions
+  flake8_formatter_abspath
   pyupgrade
 whitelist_externals =
   bash
 commands =
   black --check --diff .
-  flake8 setup.py tests/ vulture/
+  flake8 --format=abspath setup.py tests/ vulture/
   bash -c "pyupgrade --py36-plus `find dev/ tests/ vulture/ -name '*.py'` setup.py"
 
 [testenv:fix-style]

vulture/__main__.py

@@ -1,3 +1,5 @@
+"""module: __main__"""
+
 from vulture.core import main
 
 main()

vulture/config.py

@@ -20,6 +20,7 @@
     "make_whitelist": False,
     "sort_by_size": False,
     "verbose": False,
+    "absolute_paths": False,
 }
 
 
@@ -69,6 +70,7 @@ def _parse_toml(infile):
         make_whitelist = true
         min_confidence = 10
         sort_by_size = true
+        absolute_paths = false
         verbose = true
         paths = ["path1", "path2"]
     """
@@ -149,6 +151,13 @@ def csv(exclude):
         default=missing,
         help="Sort unused functions and classes by their lines of code.",
     )
+    parser.add_argument(
+        "--absolute-paths",
+        action="store_true",
+        default=False,
+        required=False,
+        help="Output absolute file paths.",
+    )
     parser.add_argument(
         "-v", "--verbose", action="store_true", default=missing
     )