Merge pull request agentstack-ai#103 from tcdent/pre-commit

Run mypy and ruff on pre commit, type checking fixes

Author: tcdent

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+repos:
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.0
+    hooks:
+    -   id: ruff
+        args: [--fix]
+    -   id: ruff-format
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.8.0
+    hooks:
+    -   id: mypy

CONTRIBUTING.md

@@ -13,7 +13,7 @@ The best place to engage in conversation about your contribution is in the Issue
 
 1. Clone the repo
 2. `poetry install`
-3. `pip install -e .`
+3. `pip install -e .[dev,test]`
    - This will install the CLI locally and in editable mode so you can use `agentstack <command>` to test your latest changes
 
 ## Project Structure
@@ -46,5 +46,17 @@ pip install ruff
 ruff format .
 ```
 
+### Type Checking
+AgentStack uses MyPy for type checking. To check types, run:
+```bash
+mypy agentstack
+```
+
+### Pre-Commit Hooks
+Ruff and MyPy can be run as pre-commit hooks. To enable these hooks, run:
+```bash
+pre-commit install
+```
+
 ## Tests
 HAHAHAHAHAHAHA good one

agentstack/cli/agentstack_data.py

@@ -1,6 +1,6 @@
 import json
 from datetime import datetime
-from typing import Optional, Literal, List
+from typing import Optional
 
 from agentstack.utils import clean_input, get_version
 from agentstack.logger import log
@@ -9,8 +9,8 @@
 class ProjectMetadata:
     def __init__(
         self,
-        project_name: str = None,
-        project_slug: str = None,
+        project_name: Optional[str] = None,
+        project_slug: Optional[str] = None,
         description: str = "",
         author_name: str = "",
         version: str = "",
@@ -80,7 +80,7 @@ class FrameworkData:
     def __init__(
         self,
         # name: Optional[Literal["crewai"]] = None
-        name: str = None,  # TODO: better framework handling, Literal or Enum
+        name: Optional[str] = None,  # TODO: better framework handling, Literal or Enum
     ):
         self.name = name
 

agentstack/cli/cli.py

@@ -122,7 +122,7 @@ def init_project_builder(
 
     try:
         packaging.install(f'{AGENTSTACK_PACKAGE}[{framework}]', path=slug_name)
-    except Exception as e:
+    except Exception:
         print(
             term_color(
                 f"Failed to install dependencies for {slug_name}. Please try again by running `agentstack update`",
@@ -151,7 +151,7 @@ def configure_default_model(path: Optional[str] = None):
         return  # Default model already set
 
     print("Project does not have a default model configured.")
-    other_msg = f"Other (enter a model name)"
+    other_msg = "Other (enter a model name)"
     model = inquirer.list_input(
         message="Which model would you like to use?",
         choices=PREFERRED_MODELS + [other_msg],
@@ -279,7 +279,7 @@ def ask_design() -> dict:
                     inquirer.List(
                         "agent",
                         message="Which agent should be assigned this task?",
-                        choices=[a['name'] for a in agents],
+                        choices=[a['name'] for a in agents],  # type: ignore
                     ),
                 ]
             )
@@ -374,8 +374,8 @@ def insert_template(
         version="0.0.1",
         license="MIT",
         year=datetime.now().year,
-        template=template_data['name'] if template_data else None,
-        template_version=template_data['template_version'] if template_data else None,
+        template=template_data['name'] if template_data else 'none',
+        template_version=template_data['template_version'] if template_data else '0',
     )
 
     project_structure = ProjectStructure()

agentstack/generation/files.py

@@ -36,7 +36,7 @@ class ConfigFile(BaseModel):
         The default model to use when generating agent configurations.
     """
 
-    framework: Optional[str] = DEFAULT_FRAMEWORK
+    framework: str = DEFAULT_FRAMEWORK
     tools: list[str] = []
     telemetry_opt_out: Optional[bool] = None
     default_model: Optional[str] = None

agentstack/generation/tool_generation.py

@@ -1,15 +1,12 @@
-import os, sys
-from typing import Optional, Any, List
-import importlib.resources
-from pathlib import Path
-import json
+import os
 import sys
-from typing import Optional, List, Dict, Union
+from typing import Optional, List
+from pathlib import Path
+from typing import Union
 
 from . import get_agent_names
-from .gen_utils import insert_code_after_tag, string_in_file, _framework_filename
+from .gen_utils import insert_code_after_tag, _framework_filename
 from ..utils import open_json_file, get_framework, term_color
-import os
 import shutil
 import fileinput
 import astor
@@ -19,8 +16,6 @@
 from agentstack import packaging
 from agentstack.utils import get_package_path
 from agentstack.generation.files import ConfigFile, EnvFile
-from .gen_utils import insert_code_after_tag, string_in_file
-from ..utils import open_json_file, get_framework, term_color
 
 
 TOOL_INIT_FILENAME = "src/tools/__init__.py"
@@ -69,7 +64,7 @@ def from_json(cls, path: Path) -> 'ToolConfig':
         except ValidationError as e:
             print(term_color(f"Error validating tool config JSON: \n{path}", 'red'))
             for error in e.errors():
-                print(f"{' '.join(error['loc'])}: {error['msg']}")
+                print(f"{' '.join([str(loc) for loc in error['loc']])}: {error['msg']}")
             sys.exit(1)
 
     def get_import_statement(self) -> str:
@@ -148,7 +143,7 @@ def remove_tool(tool_name: str, path: Optional[str] = None):
     framework = get_framework()
     agentstack_config = ConfigFile(path)
 
-    if not tool_name in agentstack_config.tools:
+    if tool_name not in agentstack_config.tools:
         print(term_color(f'Tool {tool_name} is not installed', 'red'))
         sys.exit(1)
 
@@ -195,7 +190,10 @@ def remove_tool_from_tools_init(tool_data: ToolConfig, path: str = ''):
 
 
 def add_tool_to_agent_definition(
-    framework: str, tool_data: ToolConfig, path: str = '', agents: list[str] = []
+    framework: str,
+    tool_data: ToolConfig,
+    path: str = '',
+    agents: Optional[list[str]] = [],
 ):
     """
     Add tools to specific agent definitions using AST transformation.
@@ -285,7 +283,7 @@ def _process_tools_list(
     tool_data: ToolConfig,
     operation: str,
     base_name: str = 'tools',
-) -> List[ast.AST]:
+) -> List[ast.AST]:  # type: ignore[return-type,arg-type]
     """
     Process a tools list according to the specified operation.
 
@@ -347,10 +345,9 @@ def _modify_agent_tools(
                     if kw.arg == 'tools':
                         if isinstance(kw.value, ast.List):
                             # Process the tools list
-                            new_tools = _process_tools_list(kw.value.elts, tool_data, operation, base_name)
-
+                            new_tools = _process_tools_list(kw.value.elts, tool_data, operation, base_name)  # type: ignore
                             # Replace with new list
-                            kw.value = ast.List(elts=new_tools, ctx=ast.Load())
+                            kw.value = ast.List(elts=new_tools, ctx=ast.Load())  # type: ignore
 
     return node
 

agentstack/utils.py

@@ -1,6 +1,4 @@
 from typing import Optional
-
-import os
 import sys
 import json
 import re
@@ -35,7 +33,7 @@ def get_package_path() -> Path:
     """This is the Path where agentstack is installed."""
     if sys.version_info <= (3, 9):
         return Path(sys.modules['agentstack'].__path__[0])
-    return importlib.resources.files('agentstack')
+    return importlib.resources.files('agentstack')  # type: ignore[return-value]
 
 
 def get_framework(path: Optional[str] = None) -> str:
@@ -54,7 +52,7 @@ def get_framework(path: Optional[str] = None) -> str:
         sys.exit(1)
 
 
-def get_telemetry_opt_out(path: Optional[str] = None) -> str:
+def get_telemetry_opt_out(path: Optional[str] = None) -> bool:
     from agentstack.generation import ConfigFile
 
     try:

pyproject.toml

@@ -24,17 +24,19 @@ dependencies = [
     "psutil==5.9.8",
     "astor==0.8.1",
     "pydantic>=2.10",
-    "packaging>=23.2",
+    "packaging==23.2",
     "requests>=2.32",
-    "appdirs>=1.4.4"
+    "appdirs>=1.4.4",
 ]
 
 [project.optional-dependencies]
 dev = [
-    "ruff",
+    "mypy>=1.13.0",
+    "pre-commit>=4.0.1",
+    "ruff>=0.8.2",
 ]
 test = [
-    "tox>=4.23.2",
+    "tox",
 ]
 crewai = [
     "crewai==0.83.0",
@@ -67,4 +69,13 @@ exclude = [
 line-length = 110
 
 [tool.ruff.format]
-quote-style = "preserve"
+quote-style = "preserve"
+
+[tool.mypy]
+exclude = [
+    "templates/.*" # cookiecutter paths are not compatible
+]
+allow_untyped_defs = true
+disable_error_code = ["var-annotated", "import-untyped"]
+ignore_missing_imports = true
+