python-code-validator 0.3.0__tar.gz → 0.4.0__tar.gz

{python_code_validator-0.3.0/src/python_code_validator.egg-info → python_code_validator-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-code-validator
-Version: 0.3.0
+Version: 0.4.0
 Summary: A flexible, AST-based framework for static validation of Python code using declarative JSON rules.
 Author-email: Qu1nel <covach.qn@gmail.com>
 License: MIT License

{python_code_validator-0.3.0 → python_code_validator-0.4.0}/pyproject.toml

@@ -10,7 +10,7 @@ build-backend = "setuptools.build_meta"
 # ==============================================================================
 [project]
 name = "python-code-validator"
-version = "0.3.0"
+version = "0.4.0"
 description = "A flexible, AST-based framework for static validation of Python code using declarative JSON rules."
 keywords = ["validation", "linter", "static analysis", "testing", "education", "ast"]
 authors = [{ name = "Qu1nel", email = "covach.qn@gmail.com" }]

{python_code_validator-0.3.0 → python_code_validator-0.4.0}/src/code_validator/__init__.py

@@ -1,57 +1,57 @@
-"""A flexible framework for static validation of Python code.
-
-This package provides a comprehensive toolkit for statically analyzing Python
-source code based on a declarative set of rules defined in a JSON format. It
-allows for checking syntax, style, structure, and constraints without
-executing the code.
-
-The primary entry point for using this package programmatically is the
-`StaticValidator` class.
-
-Example:
-    A minimal example of using the validator as a library.
-
-    .. code-block:: python
-
-        from code_validator import StaticValidator, AppConfig, LogLevel
-        from code_validator.output import Console, setup_logging
-        from pathlib import Path
-
-        # Basic setup
-        logger = setup_logging(LogLevel.INFO)
-        console = Console(logger)
-        config = AppConfig(
-            solution_path=Path("path/to/solution.py"),
-            rules_path=Path("path/to/rules.json"),
-            log_level=LogLevel.INFO,
-            is_silent=False,
-            stop_on_first_fail=False
-        )
-
-        # Run validation
-        validator = StaticValidator(config, console)
-        is_valid = validator.run()
-
-        if is_valid:
-            print("Validation Passed!")
-
-Attributes:
-    __version__ (str): The current version of the package.
-    __all__ (list[str]): The list of public objects exposed by the package.
-
-"""
-
-from .config import AppConfig, ExitCode, LogLevel
-from .core import StaticValidator
-from .exceptions import RuleParsingError, ValidationFailedError
-
-__all__ = [
-    "StaticValidator",
-    "AppConfig",
-    "ExitCode",
-    "LogLevel",
-    "ValidationFailedError",
-    "RuleParsingError",
-]
-
-__version__ = "0.3.0"
+"""A flexible framework for static validation of Python code.
+
+This package provides a comprehensive toolkit for statically analyzing Python
+source code based on a declarative set of rules defined in a JSON format. It
+allows for checking syntax, style, structure, and constraints without
+executing the code.
+
+The primary entry point for using this package programmatically is the
+`StaticValidator` class.
+
+Example:
+    A minimal example of using the validator as a library.
+
+    .. code-block:: python
+
+        from code_validator import StaticValidator, AppConfig, LogLevel
+        from code_validator.output import Console, setup_logging
+        from pathlib import Path
+
+        # Basic setup
+        logger = setup_logging(LogLevel.INFO)
+        console = Console(logger)
+        config = AppConfig(
+            solution_path=Path("path/to/solution.py"),
+            rules_path=Path("path/to/rules.json"),
+            log_level=LogLevel.INFO,
+            is_silent=False,
+            stop_on_first_fail=False
+        )
+
+        # Run validation
+        validator = StaticValidator(config, console)
+        is_valid = validator.run()
+
+        if is_valid:
+            print("Validation Passed!")
+
+Attributes:
+    __version__ (str): The current version of the package.
+    __all__ (list[str]): The list of public objects exposed by the package.
+
+"""
+
+from .config import AppConfig, ExitCode, LogLevel
+from .core import StaticValidator
+from .exceptions import RuleParsingError, ValidationFailedError
+
+__all__ = [
+    "StaticValidator",
+    "AppConfig",
+    "ExitCode",
+    "LogLevel",
+    "ValidationFailedError",
+    "RuleParsingError",
+]
+
+__version__ = "0.4.0"

{python_code_validator-0.3.0 → python_code_validator-0.4.0}/src/code_validator/components/definitions.py

@@ -1,89 +1,91 @@
-"""Defines the core component interfaces for the validator using Protocols.
-
-This module establishes the fundamental "contracts" for the main architectural
-components: Rules, Selectors, and Constraints. By using `typing.Protocol`, we
-ensure that any class conforming to these interfaces can be used interchangeably
-by the system's factories and core engine. This enables a flexible and
-decoupled plugin-style architecture, where new components can be added without
-modifying the core logic.
-"""
-
-import ast
-from typing import Protocol, runtime_checkable
-
-from ..config import FullRuleConfig, ShortRuleConfig
-
-
-@runtime_checkable
-class Selector(Protocol):
-    """An interface for objects that find and select specific nodes from an AST.
-
-    A Selector's main responsibility is to traverse the Abstract Syntax Tree (AST)
-    of a Python source file and return a list of nodes that match a specific
-    criterion (e.g., all function definitions, all import statements).
-    """
-
-    def select(self, tree: ast.Module) -> list[ast.AST]:
-        """Selects and returns a list of relevant AST nodes from the tree.
-
-        Args:
-            tree: The full, parsed AST of the source code to be searched.
-
-        Returns:
-            A list of ast.AST nodes that match the selector's criteria.
-            An empty list should be returned if no matching nodes are found.
-        """
-        ...
-
-
-@runtime_checkable
-class Constraint(Protocol):
-    """An interface for objects that apply a condition to a set of AST nodes.
-
-    A Constraint takes the list of nodes found by a Selector and checks if they
-    satisfy a specific condition (e.g., the list must not be empty, the node
-    must inherit from a specific class).
-    """
-
-    def check(self, nodes: list[ast.AST]) -> bool:
-        """Checks if the given list of nodes satisfies the constraint.
-
-        Args:
-            nodes: A list of AST nodes provided by a Selector.
-
-        Returns:
-            True if the constraint is satisfied, False otherwise.
-        """
-        ...
-
-
-@runtime_checkable
-class Rule(Protocol):
-    """An interface for any complete, executable validation rule.
-
-    A Rule represents a single, self-contained validation check. It can be a
-    "short" rule (like a linter check) or a "full" rule that internally uses
-    a Selector and a Constraint. The core validator engine interacts with
-    objects conforming to this protocol.
-
-    Attributes:
-        config: The dataclass object holding the configuration for this rule,
-            parsed from the JSON file.
-    """
-
-    config: FullRuleConfig | ShortRuleConfig
-
-    def execute(self, tree: ast.Module | None, source_code: str | None = None) -> bool:
-        """Executes the validation rule.
-
-        Depending on the rule type, this method might operate on the AST, the
-        raw source code, or both.
-
-        Args:
-            tree: The full AST of the source code (for structural checks).
-            source_code: The raw source code string (e.g., for linter checks).
-
-        Returns:
-            True if the validation check passes, False otherwise.
-        """
-        ...
+"""Defines the core component interfaces for the validator using Protocols.
+
+This module establishes the fundamental "contracts" for the main architectural
+components: Rules, Selectors, and Constraints. By using `typing.Protocol`, we
+ensure that any class conforming to these interfaces can be used interchangeably
+by the system's factories and core engine. This enables a flexible and
+decoupled plugin-style architecture, where new components can be added without
+modifying the core logic.
+"""
+
+import ast
+from typing import Protocol, runtime_checkable
+
+from ..config import FullRuleConfig, ShortRuleConfig
+
+
+@runtime_checkable
+class Selector(Protocol):
+    """An interface for objects that find and select specific nodes from an AST.
+
+    A Selector's main responsibility is to traverse the Abstract Syntax Tree (AST)
+    of a Python source file and return a list of nodes that match a specific
+    criterion (e.g., all function definitions, all import statements).
+    """
+
+    def select(self, tree: ast.Module) -> list[ast.AST]:
+        """Selects and returns a list of relevant AST nodes from the tree.
+
+        Args:
+            tree: The full, parsed AST of the source code to be searched.
+
+        Returns:
+            A list of ast.AST nodes that match the selector's criteria.
+            An empty list should be returned if no matching nodes are found.
+        """
+        ...
+
+
+@runtime_checkable
+class Constraint(Protocol):
+    """An interface for objects that apply a condition to a set of AST nodes.
+
+    A Constraint takes the list of nodes found by a Selector and checks if they
+    satisfy a specific condition (e.g., the list must not be empty, the node
+    must inherit from a specific class).
+    """
+
+    def check(self, nodes: list[ast.AST]) -> bool:
+        """Checks if the given list of nodes satisfies the constraint.
+
+        Args:
+            nodes: A list of AST nodes provided by a Selector.
+
+        Returns:
+            True if the constraint is satisfied, False otherwise.
+        """
+        ...
+
+
+@runtime_checkable
+class Rule(Protocol):
+    """An interface for any complete, executable validation rule.
+
+    A Rule represents a single, self-contained validation check. It can be a
+    "short" rule (like a linter check) or a "full" rule that internally uses
+    a Selector and a Constraint. The core validator engine interacts with
+    objects conforming to this protocol.
+
+    Attributes:
+        config: The dataclass object holding the configuration for this rule,
+            parsed from the JSON file.
+        typo_suggestion: Optional typo suggestion message for user display.
+    """
+
+    config: FullRuleConfig | ShortRuleConfig
+    typo_suggestion: str | None
+
+    def execute(self, tree: ast.Module | None, source_code: str | None = None) -> bool:
+        """Executes the validation rule.
+
+        Depending on the rule type, this method might operate on the AST, the
+        raw source code, or both.
+
+        Args:
+            tree: The full AST of the source code (for structural checks).
+            source_code: The raw source code string (e.g., for linter checks).
+
+        Returns:
+            True if the validation check passes, False otherwise.
+        """
+        ...