Update pre-commit

Author: ashwinb

.pre-commit-config.yaml

@@ -5,29 +5,70 @@ default_language_version:
 
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v5.0.0  # Latest stable version
     hooks:
-    -   id: trailing-whitespace
-    -   id: check-ast
     -   id: check-merge-conflict
     -   id: check-added-large-files
         args: ['--maxkb=1000']
     -   id: end-of-file-fixer
         exclude: '^(.*\.svg)$'
 
--   repo: https://github.com/pycqa/flake8
-    rev: 34cbf8ef3950f43d09b85e2e45c15ae5717dc37b
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.4
     hooks:
-    -   id: flake8
-        files: ^src/llama_stack_client/lib/.*  # Only run on files in specific-folder
-        additional_dependencies:
-          - flake8-bugbear == 22.4.25
-          - pep8-naming == 0.12.1
-          - torchfix
-        args: ['--config=.flake8']
+    -   id: ruff
+        files: ^src/llama_stack_client/lib/.*
+        args: [
+            --fix,
+            --exit-non-zero-on-fix
+        ]
+    -   id: ruff-format
+        files: ^src/llama_stack_client/lib/.*
 
--   repo: https://github.com/pycqa/isort
-    rev: 5.13.2
+-   repo: https://github.com/adamchainz/blacken-docs
+    rev: 1.19.0
     hooks:
-    -   id: isort
+    -   id: blacken-docs
         files: ^src/llama_stack_client/lib/.*
+        additional_dependencies:
+        - black==24.3.0
+
+# -   repo: https://github.com/pre-commit/mirrors-mypy
+#     rev: v1.14.0
+#     hooks:
+#     -   id: mypy
+#         additional_dependencies:
+#           - types-requests
+#           - types-setuptools
+#           - pydantic
+#         args: [--ignore-missing-imports]
+
+# - repo: https://github.com/jsh9/pydoclint
+#   rev: d88180a8632bb1602a4d81344085cf320f288c5a
+#   hooks:
+#     - id: pydoclint
+#       args: [--config=pyproject.toml]
+
+# - repo: https://github.com/tcort/markdown-link-check
+#   rev: v3.11.2
+#   hooks:
+#     - id: markdown-link-check
+#       args: ['--quiet']
+
+# -   repo: local
+#     hooks:
+#       - id: distro-codegen
+#         name: Distribution Template Codegen
+#         additional_dependencies:
+#           - rich
+#           - pydantic
+#         entry: python -m llama_stack.scripts.distro_codegen
+#         language: python
+#         pass_filenames: false
+#         require_serial: true
+#         files: ^llama_stack/templates/.*$
+#         stages: [manual]
+
+ci:
+    autofix_commit_msg: 🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
+    autoupdate_commit_msg: ⬆ [pre-commit.ci] pre-commit autoupdate

.flake8 renamed to .ruff.toml

@@ -1,30 +1,37 @@
-[flake8]
 # Suggested config from pytorch that we can adapt
-select = B,C,E,F,N,P,T4,W,B9,TOR0,TOR1,TOR2
-max-line-length = 120
+lint.select = ["B", "C", "E" , "F" , "N", "W", "B9"]
+
+line-length = 120
+
 # C408 ignored because we like the dict keyword argument syntax
 # E501 is not flexible enough, we're using B950 instead
 # N812 ignored because import torch.nn.functional as F is PyTorch convention
 # N817 ignored because importing using acronyms is convention (DistributedDataParallel as DDP)
 # E731 allow usage of assigning lambda expressions
 # E701 let black auto-format statements on one line
 # E704 let black auto-format statements on one line
-ignore =
-    E203,E305,E402,E501,E721,E741,F405,F821,F841,F999,W503,W504,C408,E302,W291,E303,N812,N817,E731,E701,E704
+lint.ignore = [
+    "E203", "E305", "E402", "E501", "E721", "E741", "F405", "F821", "F841",
+    "C408", "E302", "W291", "E303", "N812", "N817", "E731", "E701",
+    # These are the additional ones we started ignoring after moving to ruff. We should look into each one of them later.
+    "C901", "C405", "C414", "N803", "N999", "C403", "C416", "B028", "C419", "C401", "B023",
     # shebang has extra meaning in fbcode lints, so I think it's not worth trying
     # to line this up with executable bit
-    EXE001,
+    "EXE001",
     # random naming hints don't need
-    N802,
+    "N802",
     # these ignores are from flake8-bugbear; please fix!
-    B007,B008,B950
-optional-ascii-coding = True
-exclude =
-    ./.git,
-    ./docs/*,
-    ./build,
-    ./venv,
-    *.pyi,
-    .pre-commit-config.yaml,
-    *.md,
-    .flake8
+    "B007", "B008"
+]
+
+exclude = [
+    "./.git",
+    "./docs/*",
+    "./build",
+    "./scripts",
+    "./venv",
+    "*.pyi",
+    ".pre-commit-config.yaml",
+    "*.md",
+    ".flake8"
+]

examples/post_training/supervised_fine_tune_client.py

@@ -30,7 +30,6 @@ async def run_main(
     checkpoint_dir: Optional[str] = None,
     cert_path: Optional[str] = None,
 ):
-
     # Construct the base URL with the appropriate protocol
     protocol = "https" if use_https else "http"
     base_url = f"{protocol}://{host}:{port}"
@@ -102,9 +101,7 @@ def main(
     cert_path: Optional[str] = None,
 ):
     job_uuid = str(job_uuid)
-    asyncio.run(
-        run_main(host, port, job_uuid, model, use_https, checkpoint_dir, cert_path)
-    )
+    asyncio.run(run_main(host, port, job_uuid, model, use_https, checkpoint_dir, cert_path))
 
 
 if __name__ == "__main__":

src/llama_stack_client/_models.py

@@ -172,7 +172,7 @@ def to_json(
     @override
     def __str__(self) -> str:
         # mypy complains about an invalid self arg
-        return f'{self.__repr_name__()}({self.__repr_str__(", ")})'  # type: ignore[misc]
+        return f"{self.__repr_name__()}({self.__repr_str__(', ')})"  # type: ignore[misc]
 
     # Override the 'construct' method in a way that supports recursive parsing without validation.
     # Based on https://github.com/samuelcolvin/pydantic/issues/1168#issuecomment-817742836.

src/llama_stack_client/lib/agents/agent.py

@@ -9,15 +9,14 @@
 from llama_stack_client.types import ToolResponseMessage, UserMessage
 from llama_stack_client.types.agent_create_params import AgentConfig
 from llama_stack_client.types.agents.turn import Turn
-from llama_stack_client.types.agents.turn_create_params import (Document,
-                                                                Toolgroup)
-from llama_stack_client.types.agents.turn_create_response import \
-    AgentTurnResponseStreamChunk
+from llama_stack_client.types.agents.turn_create_params import Document, Toolgroup
+from llama_stack_client.types.agents.turn_create_response import AgentTurnResponseStreamChunk
 
 from .client_tool import ClientTool
 
 DEFAULT_MAX_ITER = 10
 
+
 class Agent:
     def __init__(
         self,
@@ -88,7 +87,7 @@ def create_turn(
                 pass
             if not chunk:
                 raise Exception("No chunk returned")
-            if chunk.event.payload.event_type != 'turn_complete':
+            if chunk.event.payload.event_type != "turn_complete":
                 raise Exception("Turn did not complete")
             return chunk.event.payload.turn
 
@@ -102,7 +101,7 @@ def _create_turn_streaming(
     ) -> Iterator[AgentTurnResponseStreamChunk]:
         stop = False
         n_iter = 0
-        max_iter = self.agent_config.get('max_infer_iters', DEFAULT_MAX_ITER)
+        max_iter = self.agent_config.get("max_infer_iters", DEFAULT_MAX_ITER)
         while not stop and n_iter < max_iter:
             response = self.client.agents.turn.create(
                 agent_id=self.agent_id,

src/llama_stack_client/lib/agents/client_tool.py

@@ -46,10 +46,7 @@ def parameters_for_system_prompt(self) -> str:
             {
                 "name": self.get_name(),
                 "description": self.get_description(),
-                "parameters": {
-                    name: definition.__dict__
-                    for name, definition in self.get_params_definition().items()
-                },
+                "parameters": {name: definition.__dict__ for name, definition in self.get_params_definition().items()},
             }
         )
 

src/llama_stack_client/lib/agents/event_logger.py

@@ -60,32 +60,22 @@ def __init__(self):
         self.previous_step_type = None
 
     def yield_printable_events(self, chunk):
-        for printable_event in self._yield_printable_events(
-            chunk, self.previous_event_type, self.previous_step_type
-        ):
+        for printable_event in self._yield_printable_events(chunk, self.previous_event_type, self.previous_step_type):
             yield printable_event
 
-        self.previous_event_type, self.previous_step_type = (
-            self._get_event_type_step_type(chunk)
-        )
+        self.previous_event_type, self.previous_step_type = self._get_event_type_step_type(chunk)
 
-    def _yield_printable_events(
-        self, chunk, previous_event_type=None, previous_step_type=None
-    ):
+    def _yield_printable_events(self, chunk, previous_event_type=None, previous_step_type=None):
         if hasattr(chunk, "error"):
-            yield TurnStreamPrintableEvent(
-                role=None, content=chunk.error["message"], color="red"
-            )
+            yield TurnStreamPrintableEvent(role=None, content=chunk.error["message"], color="red")
             return
 
         if not hasattr(chunk, "event"):
             # Need to check for custom tool first
             # since it does not produce event but instead
             # a Message
             if isinstance(chunk, ToolResponseMessage):
-                yield TurnStreamPrintableEvent(
-                    role="CustomTool", content=chunk.content, color="green"
-                )
+                yield TurnStreamPrintableEvent(role="CustomTool", content=chunk.content, color="green")
                 return
 
         event = chunk.event
@@ -101,9 +91,7 @@ def _yield_printable_events(
         if step_type == "shield_call" and event_type == "step_complete":
             violation = event.payload.step_details.violation
             if not violation:
-                yield TurnStreamPrintableEvent(
-                    role=step_type, content="No Violation", color="magenta"
-                )
+                yield TurnStreamPrintableEvent(role=step_type, content="No Violation", color="magenta")
             else:
                 yield TurnStreamPrintableEvent(
                     role=step_type,
@@ -114,9 +102,7 @@ def _yield_printable_events(
         # handle inference
         if step_type == "inference":
             if event_type == "step_start":
-                yield TurnStreamPrintableEvent(
-                    role=step_type, content="", end="", color="yellow"
-                )
+                yield TurnStreamPrintableEvent(role=step_type, content="", end="", color="yellow")
             elif event_type == "step_progress":
                 if event.payload.delta.type == "tool_call":
                     if isinstance(event.payload.delta.tool_call, str):
@@ -167,13 +153,9 @@ def _yield_printable_events(
 
     def _get_event_type_step_type(self, chunk):
         if hasattr(chunk, "event"):
-            previous_event_type = (
-                chunk.event.payload.event_type if hasattr(chunk, "event") else None
-            )
+            previous_event_type = chunk.event.payload.event_type if hasattr(chunk, "event") else None
             previous_step_type = (
-                chunk.event.payload.step_type
-                if previous_event_type not in {"turn_start", "turn_complete"}
-                else None
+                chunk.event.payload.step_type if previous_event_type not in {"turn_start", "turn_complete"} else None
             )
             return previous_event_type, previous_step_type
         return None, None

src/llama_stack_client/lib/cli/configure.py

@@ -11,8 +11,7 @@
 from prompt_toolkit import prompt
 from prompt_toolkit.validation import Validator
 
-from llama_stack_client.lib.cli.constants import (
-    LLAMA_STACK_CLIENT_CONFIG_DIR, get_config_file_path)
+from llama_stack_client.lib.cli.constants import LLAMA_STACK_CLIENT_CONFIG_DIR, get_config_file_path
 
 
 def get_config():

src/llama_stack_client/lib/cli/inference/inference.py

@@ -45,5 +45,6 @@ def chat_completion(ctx, message: str, stream: bool, model_id: Optional[str]):
         for event in EventLogger().log(response):
             event.print()
 
+
 # Register subcommands
 inference.add_command(chat_completion)

src/llama_stack_client/lib/cli/llama_stack_client.py

@@ -29,15 +29,9 @@
 
 
 @click.group()
-@click.version_option(
-    version=version("llama-stack-client"), prog_name="llama-stack-client"
-)
-@click.option(
-    "--endpoint", type=str, help="Llama Stack distribution endpoint", default=""
-)
-@click.option(
-    "--api-key", type=str, help="Llama Stack distribution API key", default=""
-)
+@click.version_option(version=version("llama-stack-client"), prog_name="llama-stack-client")
+@click.option("--endpoint", type=str, help="Llama Stack distribution endpoint", default="")
+@click.option("--api-key", type=str, help="Llama Stack distribution API key", default="")
 @click.option("--config", type=str, help="Path to config file", default=None)
 @click.pass_context
 def cli(ctx, endpoint: str, api_key: str, config: str | None):

src/llama_stack_client/lib/cli/models/models.py

@@ -44,9 +44,7 @@ def list_models(ctx):
         # Configure columns with specific styling
         table.add_column("model_type", style="blue")
         table.add_column("identifier", style="bold cyan", no_wrap=True, overflow="fold")
-        table.add_column(
-            "provider_resource_id", style="yellow", no_wrap=True, overflow="fold"
-        )
+        table.add_column("provider_resource_id", style="yellow", no_wrap=True, overflow="fold")
         table.add_column("metadata", style="magenta", max_width=30, overflow="fold")
         table.add_column("provider_id", style="green", max_width=20)
 

src/llama_stack_client/lib/cli/post_training/post_training.py

@@ -9,8 +9,7 @@
 import click
 from rich.console import Console
 
-from llama_stack_client.types.post_training_supervised_fine_tune_params import (
-    AlgorithmConfigParam, TrainingConfig)
+from llama_stack_client.types.post_training_supervised_fine_tune_params import AlgorithmConfigParam, TrainingConfig
 
 from ..common.utils import handle_client_errors
 
@@ -26,9 +25,7 @@ def post_training():
 @click.option("--model", required=True, help="Model ID")
 @click.option("--algorithm-config", required=True, help="Algorithm Config")
 @click.option("--training-config", required=True, help="Training Config")
-@click.option(
-    "--checkpoint-dir", required=False, help="Checkpoint Config", default=None
-)
+@click.option("--checkpoint-dir", required=False, help="Checkpoint Config", default=None)
 @click.pass_context
 @handle_client_errors("post_training supervised_fine_tune")
 def supervised_fine_tune(
@@ -65,9 +62,7 @@ def get_training_jobs(ctx):
     console = Console()
 
     post_training_jobs = client.post_training.job.list()
-    console.print(
-        [post_training_job.job_uuid for post_training_job in post_training_jobs]
-    )
+    console.print([post_training_job.job_uuid for post_training_job in post_training_jobs])
 
 
 @click.command("status")

src/llama_stack_client/lib/cli/shields/shields.py

@@ -44,9 +44,7 @@ def list(ctx):
         )
 
         table.add_column("identifier", style="bold cyan", no_wrap=True, overflow="fold")
-        table.add_column(
-            "provider_alias", style="yellow", no_wrap=True, overflow="fold"
-        )
+        table.add_column("provider_alias", style="yellow", no_wrap=True, overflow="fold")
         table.add_column("params", style="magenta", max_width=30, overflow="fold")
         table.add_column("provider_id", style="green", max_width=20)