Merge pull request #1 from FHPythonUtils/v3

V3

Author: FredHappyface

.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+repos:
+  - repo: local
+    hooks:
+      - id: lint
+        name: lint
+        language: system
+        pass_filenames: false
+        entry: uvx ruff check --fix
+      - id: format
+        name: format
+        language: system
+        pass_filenames: false
+        entry: uvx ruff format
+      - id: vulture
+        name: vulture
+        language: system
+        pass_filenames: false
+        entry: uvx vulture
+      - id: pyright
+        name: pyright
+        language: system
+        pass_filenames: false
+        entry: uv run pyright mypy_boto3_builder
+      - id: mypy
+        name: mypy
+        language: system
+        pass_filenames: false
+        entry: uv run mypy mypy_boto3_builder
+      - id: pytest
+        name: pytest
+        language: system
+        pass_filenames: false
+        entry: uv run pytest

handsdown/__init__.py

@@ -1,6 +1,4 @@
-"""
-Root of `handsdown` source code.
-"""
+"""Root of `handsdown` source code."""
 
 name = "handsdown"
 __all__ = ["name"]

handsdown/__main__.py

@@ -1,6 +1,4 @@
-"""
-Main module entrypoint.
-"""
+"""Main module entrypoint."""
 from handsdown.main import main
 
 if __name__ == "__main__":

handsdown/ast_parser/__init__.py

@@ -1,5 +1,5 @@
 """
-# AST Parser
+# AST Parser.
 
 Collection of tools for analyzing AST and also rendering it back to a valid Python code.
 

handsdown/ast_parser/analyzers/__init__.py

@@ -1,3 +1 @@
-"""
-AST Analyzers.
-"""
+"""AST Analyzers."""

handsdown/ast_parser/analyzers/base_analyzer.py

@@ -1,7 +1,4 @@
-"""
-Base AST analyzer.
-"""
-from typing import List
+"""Base AST analyzer."""
 
 import handsdown.ast_parser.smart_ast as ast
 
@@ -14,7 +11,7 @@ class BaseAnalyzer(ast.NodeVisitor):
     """
 
     def __init__(self) -> None:
-        self.related_names: List[str] = []
+        self.related_names: list[str] = []
 
     def get_docstring(self, node: ast.AST) -> str:
         """
@@ -25,6 +22,7 @@ def get_docstring(self, node: ast.AST) -> str:
 
         Returns:
             Docstring.
+
         """
         if isinstance(node, (ast.AsyncFunctionDef, ast.FunctionDef, ast.ClassDef, ast.Module)):
             return ast.get_docstring(node, clean=False) or ""

handsdown/ast_parser/analyzers/class_analyzer.py

@@ -1,24 +1,20 @@
-"""
-AST analyzer for `ast.ClassDef` records.
-"""
-from typing import List, Union
+"""AST analyzer for `ast.ClassDef` records."""
+from typing import Union
 
 import handsdown.ast_parser.smart_ast as ast
 from handsdown.ast_parser.analyzers.base_analyzer import BaseAnalyzer
 from handsdown.ast_parser.type_defs import ASTFunctionDef
 
 
 class ClassAnalyzer(BaseAnalyzer):
-    """
-    AST analyzer for `ast.ClassDef` records.
-    """
+    """AST analyzer for `ast.ClassDef` records."""
 
     def __init__(self) -> None:
         super().__init__()
-        self.base_nodes: List[ast.expr] = []
-        self.decorator_nodes: List[ast.expr] = []
-        self.method_nodes: List[ASTFunctionDef] = []
-        self.attribute_nodes: List[Union[ast.Assign, ast.AnnAssign]] = []
+        self.base_nodes: list[ast.expr] = []
+        self.decorator_nodes: list[ast.expr] = []
+        self.method_nodes: list[ASTFunctionDef] = []
+        self.attribute_nodes: list[Union[ast.Assign, ast.AnnAssign]] = []
 
     def visit_ClassDef(self, node: ast.ClassDef) -> None:
         """
@@ -37,6 +33,7 @@ def my_func():
 
         Arguments:
             node -- AST node.
+
         """
         for decorator_node in node.decorator_list:
             self.decorator_nodes.append(decorator_node)
@@ -51,14 +48,12 @@ def _visit_FunctionDef(self, node: ASTFunctionDef) -> None:
         docstring = self.get_docstring(node)
 
         # skip private methods with no docstrings
-        if name.startswith("_"):
-            if not name.startswith("__") and not docstring:
-                return
+        if name.startswith("_") and not name.startswith("__") and not docstring:
+            return
 
         # skip magic methods with no docstrings
-        if name.startswith("__"):
-            if name != "__init__" and not docstring:
-                return
+        if name.startswith("__") and name != "__init__" and not docstring:
+            return
 
         self.method_nodes.append(node)
 
@@ -77,6 +72,7 @@ def my_method(self, arg):
 
         Arguments:
             node -- AST node.
+
         """
         self._visit_FunctionDef(node)
 
@@ -95,6 +91,7 @@ async def my_method(self, arg):
 
         Arguments:
             node -- AST node.
+
         """
         self._visit_FunctionDef(node)
 
@@ -121,6 +118,7 @@ class MyClass:
 
         Arguments:
             node -- AST node.
+
         """
         # skip multiple assignments
         if len(node.targets) != 1:
@@ -154,6 +152,7 @@ class MyClass:
 
         Arguments:
             node -- AST node.
+
         """
         # skip complex assignments
         if not isinstance(node.target, ast.Name):
@@ -173,4 +172,5 @@ def generic_visit(self, node: ast.AST) -> None:
 
         Arguments:
             node -- AST node.
+
         """