Merge pull request #725 from guardrails-ai/karan/ruffify

Replace black, isort and flake8 with ruff

Author: zsimjee

.flake8

@@ -40,7 +40,7 @@ jobs:
         run: |
           make full
 
-      - name: Lint with isort, black, docformatter, flake8
+      - name: Lint with ruff
         run: |
           make lint
 

.github/workflows/ci.yml

@@ -0,0 +1,13 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.1
+    hooks:
+      # Performs ruff check with safe fixes
+      - id: ruff
+        name: ruff
+        description: "Run 'ruff' for linting"
+        args: ["--fix"]
+      # Performs ruff format
+      - id: ruff-format
+        name: ruff-format
+        description: "Run 'ruff format' for formatting"

.pre-commit-config.yaml

@@ -8,8 +8,8 @@ PYDANTIC_VERSION_MAJOR := $(shell poetry run python -c 'import pydantic; print(p
 TYPING_CMD := type-pydantic-v$(PYDANTIC_VERSION_MAJOR)-openai-v$(OPENAI_VERSION_MAJOR)
 
 autoformat:
-	poetry run black guardrails/ tests/
-	poetry run isort --atomic guardrails/ tests/
+	poetry run ruff check guardrails/ tests/ --fix
+	poetry run ruff format guardrails/ tests/
 	poetry run docformatter --in-place --recursive guardrails tests
 
 .PHONY: type
@@ -37,9 +37,8 @@ type-pydantic-v2-openai-v1:
 	rm pyrightconfig.json
 
 lint:
-	poetry run isort -c guardrails/ tests/
-	poetry run black guardrails/ tests/ --check
-	poetry run flake8 guardrails/ tests/
+	poetry run ruff check guardrails/ tests/
+	poetry run ruff format guardrails/ tests/ --check
 
 test:
 	poetry run pytest tests/
@@ -66,6 +65,7 @@ docs-deploy:
 
 dev:
 	poetry install
+	poetry run pre-commit install
 
 full:
 	poetry install --all-extras

Makefile

@@ -227,7 +227,8 @@ def validation_response(self) -> Optional[Union[str, Dict, ReAsk]]:
             self.inputs.full_schema_reask
             or number_of_iterations < 2
             or isinstance(
-                self.iterations.last.validation_response, ReAsk  # type: ignore
+                self.iterations.last.validation_response,  # type: ignore
+                ReAsk,  # type: ignore
             )
             or isinstance(self.iterations.last.validation_response, str)  # type: ignore
         ):
@@ -410,9 +411,7 @@ def tree(self) -> Tree:
                 title="Validated Output",
                 style="on #F0FFF0",
             )
-            tree.children[
-                -1
-            ].label.renderable._renderables = previous_panels + (  # type: ignore
+            tree.children[-1].label.renderable._renderables = previous_panels + (  # type: ignore
                 validated_outcome_panel,
             )
 

guardrails/classes/history/call.py

@@ -166,7 +166,7 @@ def status(self) -> str:
     @property
     def rich_group(self) -> Group:
         def create_msg_history_table(
-            msg_history: Optional[List[Dict[str, Prompt]]]
+            msg_history: Optional[List[Dict[str, Prompt]]],
         ) -> Union[str, Table]:
             if msg_history is None:
                 return "No message history."

guardrails/classes/history/iteration.py

@@ -1,3 +1,4 @@
+# ruff: noqa: E501
 import os
 from datetime import date
 from string import Template

guardrails/cli/hub/create_validator.py

@@ -245,7 +245,8 @@ def install(
 
     console.print(f"\nInstalling {package_uri}...\n")
     logger.log(
-        level=LEVELS.get("SPAM"), msg=f"Installing {package_uri}..."  # type: ignore
+        level=LEVELS.get("SPAM"),  # type: ignore
+        msg=f"Installing {package_uri}...",
     )
 
     # Validation

guardrails/cli/hub/install.py

@@ -1,9 +1,9 @@
 import logging
 import os
 
-os.environ[
-    "COLOREDLOGS_LEVEL_STYLES"
-] = "spam=white,faint;success=green,bold;debug=magenta;verbose=blue;notice=cyan,bold;warning=yellow;error=red;critical=background=red"  # noqa
+os.environ["COLOREDLOGS_LEVEL_STYLES"] = (
+    "spam=white,faint;success=green,bold;debug=magenta;verbose=blue;notice=cyan,bold;warning=yellow;error=red;critical=background=red"  # noqa
+)
 LEVELS = {
     "SPAM": 5,
     "VERBOSE": 15,

guardrails/cli/logger.py

@@ -52,8 +52,7 @@ class DocumentStoreBase(ABC):
     The store can be queried by text for similar documents.
     """
 
-    def __init__(self, vector_db: VectorDBBase, path: Optional[str] = None):
-        ...
+    def __init__(self, vector_db: VectorDBBase, path: Optional[str] = None): ...
 
     @abstractmethod
     def add_document(self, document: Document) -> None:
@@ -182,9 +181,7 @@ class RealSqlDocument(Base):
         __tablename__ = "documents"
 
         id: Mapped[int] = mapped_column(primary_key=True)  # type: ignore
-        page_num: Mapped[int] = mapped_column(
-            sqlalchemy.Integer, primary_key=True
-        )  # type: ignore
+        page_num: Mapped[int] = mapped_column(sqlalchemy.Integer, primary_key=True)  # type: ignore
         text: Mapped[str] = mapped_column(sqlalchemy.String)  # type: ignore
         meta: Mapped[dict] = mapped_column(sqlalchemy.PickleType)  # type: ignore
         vector_index: Mapped[int] = mapped_column(sqlalchemy.Integer)  # type: ignore