inspectr 0.0.1__py3-none-any.whl

inspectr/__main__.py

@@ -0,0 +1,27 @@
+import sys
+import pathlib
+import importlib
+
+def main():
+    if len(sys.argv) < 2:
+        print("Usage: inspectr <subtool> [files...]")
+        sys.exit(1)
+
+    subtool = sys.argv[1]
+    args = [pathlib.Path(arg) for arg in sys.argv[2:]]
+
+    try:
+        mod = importlib.import_module(f"inspectr.{subtool}")
+    except ModuleNotFoundError:
+        print(f"Unknown subtool: {subtool}")
+        sys.exit(1)
+
+    # Each subtool should define a `main(args)` function
+    if not hasattr(mod, "main"):
+        print(f"Subtool '{subtool}' does not define a main(args) function")
+        sys.exit(1)
+
+    mod.main(args)
+
+if __name__ == "__main__":
+    main()

inspectr/authenticity.py

@@ -0,0 +1,50 @@
+#!/usr/bin/env python3
+import ast
+import pathlib
+from typing import List
+
+
+def main(files: List[pathlib.Path]) -> None:
+    todo_count = 0
+    empty_try_except_count = 0
+    stub_functions = []
+
+    for f in files:
+        src = f.read_text(encoding="utf-8")
+
+        todo_count += src.count("TODO")
+
+        try:
+            tree = ast.parse(src, filename=str(f))
+        except SyntaxError:
+            continue  # skip broken files
+
+        for node in ast.walk(tree):
+            # Empty try/except blocks
+            if isinstance(node, ast.Try):
+                try_empty = len(node.body) == 0
+                except_empty = all(len(h.body) == 0 or all(isinstance(s, ast.Pass) for s in h.body) for h in node.handlers)
+                if try_empty and except_empty:
+                    empty_try_except_count += 1
+
+            # Stub functions/methods
+            if isinstance(node, ast.FunctionDef):
+                # Only consider body statements that are `pass` or empty return
+                is_stub = True
+                for stmt in node.body:
+                    if isinstance(stmt, ast.Pass):
+                        continue
+                    elif isinstance(stmt, ast.Return) and stmt.value is None:
+                        continue
+                    else:
+                        is_stub = False
+                        break
+                if is_stub:
+                    stub_functions.append(f"{f}:{node.name}")
+
+    print("Analysis results:")
+    print(f"  TODO comments: {todo_count}")
+    print(f"  Empty try/except blocks: {empty_try_except_count}")
+    print(f"  Stub functions/methods: {len(stub_functions)}")
+    for stub in stub_functions:
+        print(f"    {stub}")

inspectr/bare_ratio.py

@@ -0,0 +1,50 @@
+#!/usr/bin/env python3
+import ast
+import pathlib
+from collections import defaultdict, Counter
+from typing import List
+
+
+def main(files: List[pathlib.Path]) -> None:
+    # distinct exception types
+    exception_types = Counter()
+
+    # Per-file counts
+    bare_or_exception_per_file = defaultdict(int)
+    other_exceptions_per_file = defaultdict(int)
+
+    for f in files:
+        src = f.read_text(encoding="utf-8")
+        try:
+            tree = ast.parse(src, filename=str(f))
+        except SyntaxError:
+            continue  # skip broken files
+
+        for node in ast.walk(tree):
+            if isinstance(node, ast.ExceptHandler):
+                # Bare except or except Exception
+                if node.type is None or (isinstance(node.type, ast.Name) and node.type.id == "Exception"):
+                    bare_or_exception_per_file[f] += 1
+                else:
+                    # Count other exception types
+                    if isinstance(node.type, ast.Tuple):
+                        for elt in node.type.elts:
+                            if isinstance(elt, ast.Name):
+                                other_exceptions_per_file[f] += 1
+                                exception_types[elt.id] += 1
+                    elif isinstance(node.type, ast.Name):
+                        other_exceptions_per_file[f] += 1
+                        exception_types[node.type.id] += 1
+
+    print("Distinct exception types used (excluding bare/Exception):")
+    for exc, count in exception_types.most_common():
+        print(f"  {exc}: {count} occurrence(s)")
+
+    print("\nBare excepts / 'except Exception' ratio per file:")
+    for f in sorted(set(list(bare_or_exception_per_file.keys()) + list(other_exceptions_per_file.keys()))):
+        bare = bare_or_exception_per_file.get(f, 0)
+        other = other_exceptions_per_file.get(f, 0)
+        total = bare + other
+        ratio = bare / total if total > 0 else 0
+        print(f"  {f}: {bare} bare / {other} typed => ratio = {ratio:.2f}")
+

inspectr/count_exceptions.py

@@ -0,0 +1,43 @@
+#!/usr/bin/env python3
+import ast
+import pathlib
+from collections import Counter, defaultdict
+from typing import List
+
+
+def main(files: List[pathlib.Path]) -> None:
+    exception_types = Counter()
+    bare_or_exception_per_file = defaultdict(int)
+
+    for f in files:
+        src = f.read_text(encoding="utf-8")
+        try:
+            tree = ast.parse(src, filename=str(f))
+        except SyntaxError:
+            continue  # skip broken files
+
+        for node in ast.walk(tree):
+            if isinstance(node, ast.ExceptHandler):
+                # Bare except
+                if node.type is None:
+                    bare_or_exception_per_file[f] += 1
+                # except Exception
+                elif isinstance(node.type, ast.Name) and node.type.id == "Exception":
+                    bare_or_exception_per_file[f] += 1
+                else:
+                    # record the exception type (support multiple names in tuple)
+                    if isinstance(node.type, ast.Tuple):
+                        for elt in node.type.elts:
+                            if isinstance(elt, ast.Name):
+                                exception_types[elt.id] += 1
+                    elif isinstance(node.type, ast.Name):
+                        exception_types[node.type.id] += 1
+
+    print("Distinct exception types used:")
+    for exc, count in exception_types.most_common():
+        print(f"  {exc}: {count} occurrence(s)")
+
+    print("\nBare excepts or 'except Exception' per file:")
+    for f, count in sorted(bare_or_exception_per_file.items()):
+        print(f"  {f}: {count}")
+

inspectr/size_counts.py

@@ -0,0 +1,81 @@
+#!/usr/bin/env python3
+import ast
+import pathlib
+from typing import List
+
+# TODO: put these in a config file
+# Thresholds
+LINE_THRESHOLD = 1000
+METHOD_LINES = 50
+FUNC_PARAMS = 5
+CLASS_METHODS = 20
+
+
+def main(files: List[pathlib.Path]) -> None:
+    files = list(pathlib.Path.cwd().rglob("*.py"))
+
+    # TODO: rename these
+    # Counters and diagnostics
+    files_over_1000 = []
+    methods_over_50 = []
+    functions_over_5params = []
+    classes_over_20methods = []
+
+    for fname in files:
+        with open(fname, "r", encoding="utf-8") as f:
+            src = f.read()
+        lines = src.splitlines()
+        if len(lines) > LINE_THRESHOLD:
+            files_over_1000.append((fname, len(lines)))
+
+        tree = ast.parse(src, filename=fname)
+        for node in ast.walk(tree):
+            # Functions
+            if isinstance(node, ast.FunctionDef):
+                n_params = len(node.args.args)
+                n_lines = len(node.body) if hasattr(node, "body") else 0
+
+                if n_params > FUNC_PARAMS:
+                    functions_over_5params.append((fname, node.name, n_params))
+                if n_lines > METHOD_LINES:
+                    methods_over_50.append((fname, node.name, n_lines))
+
+            # Classes
+            if isinstance(node, ast.ClassDef):
+                public_methods = [
+                    n for n in node.body
+                    if isinstance(n, ast.FunctionDef) and not n.name.startswith("_")
+                ]
+                n_public_methods = len(public_methods)
+                if n_public_methods > CLASS_METHODS:
+                    method_names = [m.name for m in public_methods]
+                    classes_over_20methods.append((fname, node.name, n_public_methods, method_names))
+
+    # Print diagnostics if counts > 0
+    if files_over_1000:
+        print(f"Files > {LINE_THRESHOLD} lines:")
+        for fname, nlines in files_over_1000:
+            print(f"  {fname}: {nlines} lines")
+
+    if methods_over_50:
+        print(f"\nMethods > {METHOD_LINES} lines:")
+        for fname, name, nlines in methods_over_50:
+            print(f"  {fname}.{name}: {nlines} lines")
+
+    if functions_over_5params:
+        print(f"\nFunctions > {FUNC_PARAMS} parameters:")
+        for fname, name, nparams in functions_over_5params:
+            print(f"  {fname}.{name}: {nparams} parameters")
+
+    if classes_over_20methods:
+        print(f"\nClasses > {CLASS_METHODS} public methods:")
+        for fname, cls_name, nmethods, method_names in classes_over_20methods:
+            print(f"  {fname}.{cls_name}: {nmethods} public methods -> {', '.join(method_names)}")
+
+    # Summary
+    print("\nSummary:")
+    print(f"  Files > {LINE_THRESHOLD} lines: {len(files_over_1000)}")
+    print(f"  Methods > {METHOD_LINES} lines: {len(methods_over_50)}")
+    print(f"  Functions > {FUNC_PARAMS} parameters: {len(functions_over_5params)}")
+    print(f"  Classes > {CLASS_METHODS} public methods: {len(classes_over_20methods)}")
+

inspectr/with_open.py

@@ -0,0 +1,18 @@
+import ast
+import pathlib
+import sys
+from typing import List
+
+
+def main(files: List[pathlib.Path]) -> None:
+    if not files:
+        print("Usage: inspectr with_open <file1> [file2 ...]")
+        sys.exit(1)
+
+    for filepath in files:
+        tree = ast.parse(filepath.read_text(), filename=str(filepath))
+        for node in ast.walk(tree):
+            if isinstance(node, ast.Call) and getattr(node.func, "id", "")=="open":
+                if not any(isinstance(p, ast.With) and node in ast.walk(p) for p in ast.walk(tree)):
+                    print(f"{filepath}:{node.lineno}: open() outside with")
+

inspectr-0.0.1.dist-info/METADATA

@@ -0,0 +1,43 @@
+Metadata-Version: 2.4
+Name: inspectr
+Version: 0.0.1
+Summary: A collection of python tools to inspect code quality. 
+Maintainer-email: Alex Mueller <amueller474@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/ajcm474/inspectr
+Project-URL: Issues, https://github.com/ajcm474/inspectr/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Software Development
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# inspectr
+A collection of python tools to inspect code quality.
+
+## Installation
+```bash
+python -m venv .venv/
+source .venv/bin/activate
+pip install inspectr
+```
+
+## Usage
+Generally, the syntax goes:
+```bash
+inspectr <subtool> [files...]
+```
+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)
+- `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.

inspectr-0.0.1.dist-info/RECORD

@@ -0,0 +1,13 @@
+inspectr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+inspectr/__main__.py,sha256=Rojob_KTdzcHjItkGgA3TPLqPd223pIfeajpCWDP3Gc,652
+inspectr/authenticity.py,sha256=fgKJSE_1qYE1NgLdXmOjPQjo-dwD42sEhqpcsazIj3U,1703
+inspectr/bare_ratio.py,sha256=oQfag96zjGnmFHofZ5qabBGGVoKUnmRNzGq_WX_8ZZg,1997
+inspectr/count_exceptions.py,sha256=UhUc3ZZY8eDxLtlLX1USKzP_JEPY3clx8R8TPvtQ5LE,1588
+inspectr/size_counts.py,sha256=B-KiSoNEirNqYbaqnUASn1pdUBEnXrs_eu2cvRj26F4,2972
+inspectr/with_open.py,sha256=qbCAb14cZ15yX7SbLo2C3nE1sDEKLiZ48bvFQfTAKJk,606
+inspectr-0.0.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+inspectr-0.0.1.dist-info/METADATA,sha256=6wxAsClGG7QYvnwsixtXZLFAlKt-L9A5M9vNAatCVhg,1573
+inspectr-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+inspectr-0.0.1.dist-info/entry_points.txt,sha256=IrOM4SpCRfFZzBWngg3ezXuX31ZqFBR-flSU5c8tbTo,52
+inspectr-0.0.1.dist-info/top_level.txt,sha256=NlTFBMaWgYmxFzjQtp4Y6itVQQV8sBPtAAZvFnviT-A,9
+inspectr-0.0.1.dist-info/RECORD,,

inspectr-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

inspectr-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+inspectr = inspectr.__main__:main

inspectr-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

inspectr-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+inspectr