inspectr 0.0.4__tar.gz → 0.0.5__tar.gz

{inspectr-0.0.4 → inspectr-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: inspectr
-Version: 0.0.4
+Version: 0.0.5
 Summary: A collection of python tools to inspect code quality. 
 Maintainer-email: Alex Mueller <amueller474@gmail.com>
 License-Expression: Apache-2.0
@@ -36,6 +36,7 @@ where `<subtool>` is one of the following:
 - `authenticity`: looks for TODO comments, empty try/except blocks, and stub functions
 - `bare_ratio`: checks for the ratio of bare excepts to meaningful exception usage
 - `count_exceptions`: counts how many of each type of exception there are (including bare except)
+- `duplicates`: looks for occurrences of duplicate code (default: 10+ lines, 3+ occurrences)
 - `size_counts`: various linecount-related code complexity checks
 - `with_open`: checks for `open` in the absense of `with` and manual calls to `close()`
 

{inspectr-0.0.4 → inspectr-0.0.5}/README.md

@@ -18,8 +18,9 @@ where `<subtool>` is one of the following:
 - `authenticity`: looks for TODO comments, empty try/except blocks, and stub functions
 - `bare_ratio`: checks for the ratio of bare excepts to meaningful exception usage
 - `count_exceptions`: counts how many of each type of exception there are (including bare except)
+- `duplicates`: looks for occurrences of duplicate code (default: 10+ lines, 3+ occurrences)
 - `size_counts`: various linecount-related code complexity checks
 - `with_open`: checks for `open` in the absense of `with` and manual calls to `close()`
 
 **Please note:** this project is in the early alpha stage, so don't expect the above subtool names 
-to be stable between versions. I might even merge/split them at some point.
+to be stable between versions. I might even merge/split them at some point.

{inspectr-0.0.4 → inspectr-0.0.5}/inspectr/authenticity.py

@@ -6,13 +6,18 @@ from typing import List
 
 def main(files: List[pathlib.Path]) -> None:
     todo_count = 0
+    fixme_count = 0
+    placeholder_count = 0
     empty_try_except_count = 0
     stub_functions = []
 
     for f in files:
         src = f.read_text(encoding="utf-8")
 
+        # TODO: make these case insensitive
         todo_count += src.count("TODO")
+        fixme_count += src.count("FIXME")
+        placeholder_count += src.count("Placeholder")
 
         try:
             tree = ast.parse(src, filename=str(f))
@@ -36,6 +41,9 @@ def main(files: List[pathlib.Path]) -> None:
                         continue
                     elif isinstance(stmt, ast.Return) and stmt.value is None:
                         continue
+                    elif isinstance(stmt, ast.Expr) and isinstance(stmt.value, ast.Constant) and isinstance(stmt.value.value, str):
+                        # ignore docstrings
+                        continue
                     else:
                         is_stub = False
                         break
@@ -44,6 +52,8 @@ def main(files: List[pathlib.Path]) -> None:
 
     print("Analysis results:")
     print(f"  TODO comments: {todo_count}")
+    print(f"  FIXME comments: {fixme_count}")
+    print(f"  Placeholder comments: {placeholder_count}")
     print(f"  Empty try/except blocks: {empty_try_except_count}")
     print(f"  Stub functions/methods: {len(stub_functions)}")
     for stub in stub_functions:

{inspectr-0.0.4 → inspectr-0.0.5}/inspectr.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: inspectr
-Version: 0.0.4
+Version: 0.0.5
 Summary: A collection of python tools to inspect code quality. 
 Maintainer-email: Alex Mueller <amueller474@gmail.com>
 License-Expression: Apache-2.0
@@ -36,6 +36,7 @@ where `<subtool>` is one of the following:
 - `authenticity`: looks for TODO comments, empty try/except blocks, and stub functions
 - `bare_ratio`: checks for the ratio of bare excepts to meaningful exception usage
 - `count_exceptions`: counts how many of each type of exception there are (including bare except)
+- `duplicates`: looks for occurrences of duplicate code (default: 10+ lines, 3+ occurrences)
 - `size_counts`: various linecount-related code complexity checks
 - `with_open`: checks for `open` in the absense of `with` and manual calls to `close()`
 

{inspectr-0.0.4 → inspectr-0.0.5}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "inspectr"
-version = "0.0.4"
+version = "0.0.5"
 description = "A collection of python tools to inspect code quality. "
 maintainers = [
     {name = "Alex Mueller", email="amueller474@gmail.com"},