CLASPLint 0.3.0__tar.gz → 0.4.1__tar.gz

CLASPLint-0.4.1/CLASPLint/__init__.py

@@ -0,0 +1,78 @@
+# -*- coding: utf-8 -*-
+"""
+THIS FILE IS CORE PART OF CLASPLINT BY MATT BELFAST BROWN.
+
+===============================================================================
+
+MODULE               : CLASPLint.__init__
+
+TYPE                 : Python Script
+
+DESCRIPTION          :
+    Package entry point and public API surface. Exposes the runner and reporter
+    modules as the primary public interface for programmatic use of the CLASP
+    3.2 / PEP 2606 static analysis engine.
+
+AUTHOR               : Matt Belfast Brown
+
+CONTACT              : thedayofthedo@gmail.com
+
+MAINTAINER           :
+    Matt Belfast Brown (thedayofthedo@gmail.com)
+
+
+PROJECT CREATE DATE  : 2026-06-17
+
+PROJECT VERSION DATE : 2026-07-06
+
+PROJECT VERSION      : 0.4.1
+
+
+FILE CREATE DATE     : 2026-06-17
+
+FILE VERSION DATE    : 2026-07-06
+
+FILE VERSION         : 0.4.1
+
+
+STATUS               : Stable
+
+PYTHON               : >=3.8
+
+LICENSE              : GPL-3.0-only
+
+SPDX ID              : GPL-3.0-only
+
+
+USAGE                :
+    import CLASPLint
+
+    report = CLASPLint.runner.run(["path/to/code/"])
+    print(report.summary())
+
+===============================================================================
+
+THIS PROGRAM IS LICENSED UNDER GPL-3.0-only LICENSE.
+YOU SHOULD HAVE RECEIVED A COPY OF GPL-3.0-only LICENSE.
+
+Copyright (C) 2026 Matt Belfast Brown.
+
+Sort License:
+
+    CLASPLint is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, version 3 of the License.
+
+    CLASPLint is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty
+    of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with CLASPLint.  If not, see <https://www.gnu.org/licenses/>.
+"""
+
+# Define the package version string.
+__version__ = "0.4.1"
+# Expose the runner and reporter modules as the public API.
+__all__ = ["runner", "reporter"]

{CLASPLint-0.3.0 → CLASPLint-0.4.1}/CLASPLint/__main__.py

@@ -1,29 +1,74 @@
 # -*- coding: utf-8 -*-
 """
-THIS FILE IS PART OF CLASPLINT BY MATT BELFAST BROWN
-CLASPLint.__main__ -- command-line entry point for the CLASP 3.1.1 static analysis tool.
+THIS FILE IS CORE PART OF CLASPLINT BY MATT BELFAST BROWN.
 
-Author: Matt Belfast Brown
-Create Date: 2026-06-17
-Version Date: 2026-07-01
-Version: 0.3.0
+===============================================================================
 
-THIS PROGRAM IS LICENSED UNDER GPL-3.0
-YOU SHOULD HAVE RECEIVED A COPY OF GPL-3.0 LICENSE.
+MODULE               : CLASPLint.__main__
 
-Copyright (C) 2026 Matt Belfast Brown
+TYPE                 : Python Script
 
-CLASPLint is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, version 3 of the License.
+DESCRIPTION          :
+    Command-line entry point for the CLASP 3.2 / PEP 2606 static analysis tool.
 
-CLASPLint is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty
-of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+AUTHOR               : Matt Belfast Brown
 
-You should have received a copy of the GNU General Public License
-along with CLASPLint.  If not, see <https://www.gnu.org/licenses/>.
+CONTACT              : thedayofthedo@gmail.com
+
+MAINTAINER           :
+    Matt Belfast Brown (thedayofthedo@gmail.com)
+
+
+PROJECT CREATE DATE  : 2026-06-17
+
+PROJECT VERSION DATE : 2026-07-06
+
+PROJECT VERSION      : 0.4.1
+
+
+FILE CREATE DATE     : 2026-06-17
+
+FILE VERSION DATE    : 2026-07-06
+
+FILE VERSION         : 0.4.1
+
+
+STATUS               : Stable
+
+PYTHON               : >=3.8
+
+LICENSE              : GPL-3.0-only
+
+SPDX ID              : GPL-3.0-only
+
+
+USAGE                :
+    CLASPLint path/to/file.py
+
+    CLASPLint --quiet src/
+
+    CLASPLint --category variable src/
+
+===============================================================================
+
+THIS PROGRAM IS LICENSED UNDER GPL-3.0-only LICENSE.
+YOU SHOULD HAVE RECEIVED A COPY OF GPL-3.0-only LICENSE.
+
+Copyright (C) 2026 Matt Belfast Brown.
+
+Sort License:
+
+    CLASPLint is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, version 3 of the License.
+
+    CLASPLint is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty
+    of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with CLASPLint.  If not, see <https://www.gnu.org/licenses/>.
 """
 
 import argparse
@@ -36,13 +81,20 @@ from . import __version__
 
 
 def _init_build_parser_function_() -> argparse.ArgumentParser:
-    """Construct the argument parser for the CLASPLint CLI."""
+    """Construct the argument parser for the CLASPLint command-line interface.
+
+    Registers positional paths, --version, --no-recursive, --quiet,
+    and --category arguments on a new ArgumentParser instance.
+
+    :return: A configured ArgumentParser ready for parse_args.
+    :rtype: argparse.ArgumentParser
+    """
     # Create the top-level argument parser with a description.
     parser_result = argparse.ArgumentParser(
         # Set the program name displayed in help text.
         prog="CLASPLint",
         # Provide a description of what the tool does.
-        description="CLASP 3.1.1 / PEP 2606 static analysis tool. "
+        description="CLASP 3.2 / PEP 2606 static analysis tool. "
                     # Continue the description across multiple lines for readability.
                     "Checks variable, dict key, function, class naming "
                     # Complete the tool description with comment and log conventions.
@@ -96,15 +148,24 @@ def _init_build_parser_function_() -> argparse.ArgumentParser:
 
 
 def main(argv: Optional[Sequence[str]] = None) -> int:
-    """Execute the CLASPLint analysis and return an exit code (0 = clean, 1 = violations)."""
+    """Execute the CLASPLint analysis and return an exit code.
+
+    Parses command-line arguments, resolves input paths, dispatches
+    to the runner, applies category filters, and prints the report.
+
+    :param argv: Optional list of command-line argument strings.
+    :type argv: Optional[Sequence[str]]
+    :return: Exit code 0 when no violations are found, 1 otherwise.
+    :rtype: int
+    """
     # Build and parse command-line arguments.
-    parser = _init_build_parser_function_()
+    command_parser = _init_build_parser_function_()
     # Parse the provided arguments or default to sys.argv.
-    args = parser.parse_args(argv)
+    parsed_options = command_parser.parse_args(argv)
     # Resolve all input paths to absolute paths for consistent processing.
     list_resolved = []
     # Iterate over each provided path argument.
-    for string_path in args.paths:
+    for string_path in parsed_options.paths:
         # Convert the path to an absolute path.
         string_absolute = os.path.abspath(string_path)
         # Only include paths that exist on the filesystem.
@@ -118,23 +179,23 @@ def main(argv: Optional[Sequence[str]] = None) -> int:
         # Return exit code 2 for usage errors.
         return 2
     # Determine whether to recurse into subdirectories.
-    bool_recursive = not args.no_recursive
+    bool_recursive = not parsed_options.no_recursive
     # Run all checkers on the resolved paths.
     report_result = run(list_resolved, bool_recursive=bool_recursive)
     # Apply category filter if one was specified.
-    if args.category:
+    if parsed_options.category:
         # Filter violations to only the requested category.
         report_result.list_violations = [
             # Iterate over each violation to check against the filter.
-            v for v in report_result.list_violations
+            violation_item for violation_item in report_result.list_violations
             # Keep only violations matching the requested category filter.
-            if v.string_category == args.category
+            if violation_item.string_category == parsed_options.category
         # Close the filtered list comprehension.
         ]
     # Print the summary line to stdout.
     print(report_result.summary())
     # Print individual violations unless quiet mode is active.
-    if report_result.list_violations and not args.quiet:
+    if report_result.list_violations and not parsed_options.quiet:
         # Add a blank line before the violation listing.
         print()
         # Print the formatted violation details.