python-code-validator 0.1.2__py3-none-any.whl → 0.2.1__py3-none-any.whl

code_validator/rules_library/selector_nodes.py

@@ -3,7 +3,8 @@
 Each class in this module implements the `Selector` protocol and is responsible
 for finding and returning specific types of nodes from an Abstract Syntax Tree.
 They use `ast.walk` to traverse the tree and can be constrained to specific
-scopes using the ScopedSelector base class.
+scopes via the `ScopedSelector` base class, which uses the `scope_handler`.
+These classes are instantiated by the `SelectorFactory`.
 """
 
 import ast
@@ -12,6 +13,7 @@ from typing import Any
 from ..components.ast_utils import get_full_name
 from ..components.definitions import Selector
 from ..components.scope_handler import find_scope_node
+from ..output import LogLevel, log_initialization
 
 
 class ScopedSelector(Selector):
@@ -27,11 +29,11 @@ class ScopedSelector(Selector):
     """
 
     def __init__(self, **kwargs: Any):
-        """Initializes the ScopedSelector.
+        """Initializes the ScopedSelector base class.
 
         Args:
-            **kwargs: Keyword arguments containing the scope configuration.
-                Expects `in_scope` key.
+            **kwargs: Keyword arguments passed from a subclass constructor.
+                It extracts the `in_scope` configuration.
         """
         self.in_scope_config = kwargs.get("in_scope")
 
@@ -66,7 +68,14 @@ class FunctionDefSelector(ScopedSelector):
         name (str): The name of the function to find. Use "*" to find all.
     """
 
+    @log_initialization(level=LogLevel.TRACE)
     def __init__(self, **kwargs: Any):
+        """Initializes the FunctionDefSelector.
+
+        Args:
+            **kwargs: Keyword arguments from the JSON rule's selector config.
+                Expects `name` (str) and optionally `in_scope` (dict).
+        """
         super().__init__(**kwargs)
         self.name_to_find = kwargs.get("name")
 
@@ -91,6 +100,7 @@ class ClassDefSelector(ScopedSelector):
         name (str): The name of the class to find. Use "*" to find all.
     """
 
+    @log_initialization(level=LogLevel.TRACE)
     def __init__(self, **kwargs: Any):
         """Initializes the selector."""
         super().__init__(**kwargs)
@@ -117,7 +127,14 @@ class ImportStatementSelector(ScopedSelector):
         name (str): The name of the module to find (e.g., "os", "requests").
     """
 
+    @log_initialization(level=LogLevel.TRACE)
     def __init__(self, **kwargs: Any):
+        """Initializes the ImportStatementSelector.
+
+        Args:
+            **kwargs: Keyword arguments from the JSON rule's selector config.
+                Expects `name` (str) for the module name and optionally `in_scope`.
+        """
         super().__init__(**kwargs)
         self.module_name_to_find = kwargs.get("name")
 
@@ -156,6 +173,7 @@ class FunctionCallSelector(ScopedSelector):
         name (str): The full name of the function being called.
     """
 
+    @log_initialization(level=LogLevel.TRACE)
     def __init__(self, **kwargs: Any):
         """Initializes the selector."""
         super().__init__(**kwargs)
@@ -187,7 +205,14 @@ class AssignmentSelector(ScopedSelector):
         name (str): The full name of the variable or attribute being assigned to.
     """
 
+    @log_initialization(level=LogLevel.TRACE)
     def __init__(self, **kwargs: Any):
+        """Initializes the AssignmentSelector.
+
+        Args:
+            **kwargs: Keyword arguments from the JSON rule's selector config.
+                Expects `name` (str) for the assignment target and optionally `in_scope`.
+        """
         super().__init__(**kwargs)
         self.target_name_to_find = kwargs.get("name")
 
@@ -220,7 +245,15 @@ class UsageSelector(ScopedSelector):
         name (str): The name of the variable or attribute being used.
     """
 
+    @log_initialization(level=LogLevel.TRACE)
     def __init__(self, **kwargs: Any):
+        """Initializes the UsageSelector.
+
+        Args:
+            **kwargs: Keyword arguments from the JSON rule's selector config.
+                Expects `name` (str) for the variable/attribute being used and
+                optionally `in_scope`.
+        """
         super().__init__(**kwargs)
         self.variable_name_to_find = kwargs.get("name")
 
@@ -247,11 +280,32 @@ class LiteralSelector(ScopedSelector):
         name (str): The type of literal to find. Supported: "number", "string".
     """
 
+    @log_initialization(level=LogLevel.TRACE)
     def __init__(self, **kwargs: Any):
+        """Initializes the LiteralSelector.
+
+        Args:
+            **kwargs: Keyword arguments from the JSON rule's selector config.
+                Expects `name` (str) to be "string" or "number" and optionally
+                `in_scope`.
+        """
         super().__init__(**kwargs)
-        self.literal_type = kwargs.get("name")  # 'name' - это наш унифицированный ключ
+        self.literal_type = kwargs.get("name")
 
     def select(self, tree: ast.Module) -> list[ast.AST]:
+        """Finds all ast.Constant nodes that match the type criteria.
+
+        This method traverses the given AST (or a sub-tree defined by `in_scope`)
+        and collects all number or string literals. It contains special logic
+        to intelligently ignore nodes that are likely to be docstrings or parts
+        of f-strings to avoid false positives.
+
+        Args:
+            tree: The root of the AST (the module object) to be searched.
+
+        Returns:
+            A list of `ast.Constant` nodes matching the criteria.
+        """
         search_tree = self._get_search_tree(tree)
         if not search_tree:
             return []
@@ -294,7 +348,14 @@ class AstNodeSelector(ScopedSelector):
             as defined in the `ast` module (e.g., "For", "While", "Try").
     """
 
+    @log_initialization(level=LogLevel.TRACE)
     def __init__(self, **kwargs: Any):
+        """Initializes the AstNodeSelector.
+
+        Args:
+            **kwargs: Keyword arguments from the JSON rule's selector config.
+                Expects `node_type` (str or list[str]) and optionally `in_scope`.
+        """
         super().__init__(**kwargs)
         node_type_arg = kwargs.get("node_type")
 

{python_code_validator-0.1.2.dist-info → python_code_validator-0.2.1.dist-info}/METADATA

@@ -1,49 +1,32 @@
 Metadata-Version: 2.4
 Name: python-code-validator
-Version: 0.1.2
-Summary: A flexible framework for static validation of Python code based on JSON rules.
+Version: 0.2.1
+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
-        
-        Copyright (c) 2025 Ivan Kovach
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-        
+License-Expression: MIT
 Project-URL: Homepage, https://github.com/Qu1nel/PythonCodeValidator
 Project-URL: Documentation, https://pythoncodevalidator.readthedocs.io/en/latest/
 Project-URL: Bug Tracker, https://github.com/Qu1nel/PythonCodeValidator/issues
-Keywords: validation,linter,static analysis,testing,education
-Classifier: Development Status :: 3 - Alpha
+Keywords: validation,linter,static analysis,testing,education,ast
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Education
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: flake8>=7.0.0
 Provides-Extra: dev
 Requires-Dist: ruff>=0.4.0; extra == "dev"
-Requires-Dist: flake8>=7.0.0; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: twine; extra == "dev"
-Requires-Dist: coverage>=7.5.0; extra == "dev"
+Requires-Dist: coverage[toml]>=7.5.0; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: sphinx>=7.0.0; extra == "docs"
 Requires-Dist: furo; extra == "docs"
@@ -282,7 +265,7 @@ Validation failed.
   **[Read the Docs](https://[your-project].readthedocs.io)**.
 - **Developer's Guide**: For a deep dive into the architecture, see the
   **[How It Works guide](./docs/how_it_works/index.md)**.
-- **Interactive AI-Powered Docs**: *(Coming Soon)* An interactive documentation experience.
+- **Interactive AI-Powered Docs**: **[DeepWiki](https://deepwiki.com/Qu1nel/PythonCodeValidator)**.
 
 ## 🤝 Contributing
 

python_code_validator-0.2.1.dist-info/RECORD

@@ -0,0 +1,22 @@
+code_validator/__init__.py,sha256=uag-AMj0a1I953aW7JLcxS6q0f_rueJWvO3AmGOWgUI,1721
+code_validator/__main__.py,sha256=Z41EoJqX03AI11gnku_Iwt6rP8SPUkYuxwN7P51qgLc,600
+code_validator/cli.py,sha256=-8pl9iv1ufRWiRKrY0vtk3ncZu6tFj6ZrKa0F-ruuZ4,4826
+code_validator/config.py,sha256=ELi19GC1YeLEZZbm49FO8a1URLBrZxAuOGkrHTK8FvE,5071
+code_validator/core.py,sha256=HyXXxECxsAgiXOl9tMZVqg0Xptx7nA-64IDVv_W4Svo,10117
+code_validator/exceptions.py,sha256=XkiRNQ25FWJkjS2wBaUaKQcEL5WF9tN_HSV3tqJwDcE,1627
+code_validator/output.py,sha256=Saydp1D6JRIzHroK12K38lnoMZCJaIEDyPD1ZXgJFGA,9137
+code_validator/components/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+code_validator/components/ast_utils.py,sha256=v0N3F58oxNMg7bUY6-8x0AeoLsxrzrp_bLTGNVr5EMU,1589
+code_validator/components/definitions.py,sha256=9WEXQ_i-S4Vega6HqOdjreZE_1cgJPC7guZodTKtzhc,3208
+code_validator/components/factories.py,sha256=XvsSXbTHHmPrOvAseSYc9Xl8z-Zu5K5Eb8aWAvIgkuQ,11327
+code_validator/components/scope_handler.py,sha256=q4cFK_YzoYvAqPkw9wPPxgPe-aO0kgy6gk0ETWduj-U,2593
+code_validator/rules_library/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+code_validator/rules_library/basic_rules.py,sha256=RGlHEDnd0Cn72ofbE8Y7wAl9h7iZR8reR80v2oiICTo,7118
+code_validator/rules_library/constraint_logic.py,sha256=-gN6GaIZvPfHqiLCzH5Jwuz6DcPaQKlepbMo2r5V2Yc,11026
+code_validator/rules_library/selector_nodes.py,sha256=wCAnQRSdEB8HM8avTy1wkJzyb6v2EQgHIPASXruiqbc,14733
+python_code_validator-0.2.1.dist-info/licenses/LICENSE,sha256=Lq69RwIO4Dge7OsjgAamJfYSDq2DWI2yzVYI1VX1s6c,1089
+python_code_validator-0.2.1.dist-info/METADATA,sha256=EKuyRnPMen6M3C5YgSWHXmI1BjOyTP_-ttXgIfZDGKc,10794
+python_code_validator-0.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+python_code_validator-0.2.1.dist-info/entry_points.txt,sha256=pw_HijiZyPxokVJHStTkGCwheTjukDomdk81JyHzv74,66
+python_code_validator-0.2.1.dist-info/top_level.txt,sha256=yowMDfABI5oqgW3hhTdec_7UHGeprkvc2BnqRzNbI5w,15
+python_code_validator-0.2.1.dist-info/RECORD,,

python_code_validator-0.1.2.dist-info/RECORD

@@ -1,22 +0,0 @@
-code_validator/__init__.py,sha256=etZcfEkc_LFR8gqYPeH6hitwZ5-HS2WKSjl6LW9M8PY,961
-code_validator/__main__.py,sha256=c7P8Lz3EuwYRHarTEp_DExMUauod9X42p6aTZkpvi10,330
-code_validator/cli.py,sha256=fLbSP_4ABZGZTH6-L4oAXKVRTW-OVMdpcZgT9F4ibtY,3466
-code_validator/config.py,sha256=kTqD8-SFbtUQ9oif-TylqNFPadTq5JSGBv84cI0R8dY,2657
-code_validator/core.py,sha256=4sPdlunmODfNpDrP9QH2jIrGFVLFlo_r8MAoB4_63vo,4560
-code_validator/exceptions.py,sha256=XkiRNQ25FWJkjS2wBaUaKQcEL5WF9tN_HSV3tqJwDcE,1627
-code_validator/output.py,sha256=VRJLGwm6X9i8SnovosNrHu96ueZXz9GIvUQXy4xDtHw,3304
-code_validator/components/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-code_validator/components/ast_utils.py,sha256=7DzyKmLekj_qtuZcS8BrcWXqQXVEPPQ_rwh3BmpIk9o,1412
-code_validator/components/definitions.py,sha256=cFbKL7UZYHqWjz2gJCmZ6fU_ZdQ5L_h1tlQBYkxSO7Q,3126
-code_validator/components/factories.py,sha256=qrQotS7lyqIGhoNGRvSNQKy6p9YJKQC7YaPi4eCtpww,10436
-code_validator/components/scope_handler.py,sha256=vb4pCE-4DyxGkRYGeW2JWxP2IiZH3uRRfReo0IBgM5Y,2459
-code_validator/rules_library/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-code_validator/rules_library/basic_rules.py,sha256=0K45Ed8yjy-pXDZpI1Xvgj94zvaFz-PucFRz__X4uRI,6652
-code_validator/rules_library/constraint_logic.py,sha256=X95g0673hoZey3LGCBH6AscbIuHYq_aY9WRKIkJhOnk,9525
-code_validator/rules_library/selector_nodes.py,sha256=JxhUBXS95Dad_60Ut-8XkW2MFM-7bkeRb_yk7vXlNPE,12200
-python_code_validator-0.1.2.dist-info/licenses/LICENSE,sha256=Lq69RwIO4Dge7OsjgAamJfYSDq2DWI2yzVYI1VX1s6c,1089
-python_code_validator-0.1.2.dist-info/METADATA,sha256=lYCstaPpPsj2KDOze-aYZFkr_NDi3Cy8UAgUCJHB2Mo,11829
-python_code_validator-0.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-python_code_validator-0.1.2.dist-info/entry_points.txt,sha256=pw_HijiZyPxokVJHStTkGCwheTjukDomdk81JyHzv74,66
-python_code_validator-0.1.2.dist-info/top_level.txt,sha256=yowMDfABI5oqgW3hhTdec_7UHGeprkvc2BnqRzNbI5w,15
-python_code_validator-0.1.2.dist-info/RECORD,,