fixed most linting errors

Author: miguelg719

evals/act/google_jobs.py

@@ -1,6 +1,6 @@
 import asyncio
 import traceback
-from typing import Any, Dict, Optional
+from typing import Any, Optional, dict
 
 from pydantic import BaseModel
 
@@ -10,23 +10,24 @@
 
 class Qualifications(BaseModel):
     degree: Optional[str] = None
-    yearsOfExperience: Optional[float] = None  # Representing the number
+    years_of_experience: Optional[float] = None  # Representing the number
 
 
 class JobDetails(BaseModel):
-    applicationDeadline: Optional[str] = None
-    minimumQualifications: Qualifications
-    preferredQualifications: Qualifications
+    application_deadline: Optional[str] = None
+    minimum_qualifications: Qualifications
+    preferred_qualifications: Qualifications
 
 
-def is_job_details_valid(details: Dict[str, Any]) -> bool:
+def is_job_details_valid(details: dict[str, Any]) -> bool:
     """
     Validates that each top-level field in the extracted job details is not None.
-    For nested dictionary values, each sub-value must be non-null and a string or a number.
+    For nested dictionary values, each sub-value must be non-null and a string
+    or a number.
     """
     if not details:
         return False
-    for key, value in details.items():
+    for _key, value in details.items():
         if value is None:
             return False
         if isinstance(value, dict):
@@ -53,9 +54,9 @@ async def google_jobs(model_name: str, logger, use_text_extract: bool) -> dict:
       4. Extracting job posting details using an AI-driven extraction schema.
 
     The extraction schema requires:
-      - applicationDeadline: The opening date until which applications are accepted.
-      - minimumQualifications: An object with degree and yearsOfExperience.
-      - preferredQualifications: An object with degree and yearsOfExperience.
+      - application_deadline: The opening date until which applications are accepted.
+      - minimum_qualifications: An object with degree and years_of_experience.
+      - preferred_qualifications: An object with degree and years_of_experience.
 
     Returns a dictionary containing:
       - _success (bool): Whether valid job details were extracted.
@@ -90,8 +91,9 @@ async def google_jobs(model_name: str, logger, use_text_extract: bool) -> dict:
         job_details = await stagehand.page.extract(
             ExtractOptions(
                 instruction=(
-                    "Extract the following details from the job posting: application deadline, "
-                    "minimum qualifications (degree and years of experience), and preferred qualifications "
+                    "Extract the following details from the job posting: "
+                    "application deadline, minimum qualifications "
+                    "(degree and years of experience), and preferred qualifications "
                     "(degree and years of experience)"
                 ),
                 schemaDefinition=JobDetails.model_json_schema(),

evals/extract/extract_press_releases.py

@@ -19,7 +19,8 @@ class PressReleases(BaseModel):
 
 async def extract_press_releases(model_name: str, logger, use_text_extract: bool):
     """
-    Extract press releases from the dummy press releases page using the Stagehand client.
+    Extract press releases from the dummy press releases page using the Stagehand
+    client.
 
     Args:
         model_name (str): Name of the AI model to use.
@@ -56,7 +57,10 @@ async def extract_press_releases(model_name: str, logger, use_text_extract: bool
         # TODO - FAILING - extract is likely timing out
         raw_result = await stagehand.page.extract(
             ExtractOptions(
-                instruction="extract the title and corresponding publish date of EACH AND EVERY press releases on this page. DO NOT MISS ANY PRESS RELEASES.",
+                instruction=(
+                    "extract the title and corresponding publish date of EACH AND EVERY "
+                    "press releases on this page. DO NOT MISS ANY PRESS RELEASES."
+                ),
                 schemaDefinition=PressReleases.model_json_schema(),
                 useTextExtract=use_text_extract,
             )

evals/init_stagehand.py

@@ -6,10 +6,12 @@
 
 async def init_stagehand(model_name: str, logger, dom_settle_timeout_ms: int = 3000):
     """
-    Initialize a Stagehand client with the given model name, logger, and DOM settle timeout.
+    Initialize a Stagehand client with the given model name, logger, and DOM settle
+    timeout.
 
-    This function creates a configuration from environment variables, initializes the Stagehand client,
-    and returns a tuple of (stagehand, init_response). The init_response contains debug and session URLs.
+    This function creates a configuration from environment variables, initializes
+    the Stagehand client, and returns a tuple of (stagehand, init_response).
+    The init_response contains debug and session URLs.
 
     Args:
         model_name (str): The name of the AI model to use.
@@ -37,7 +39,8 @@ async def init_stagehand(model_name: str, logger, dom_settle_timeout_ms: int = 3
         model_client_options={"apiKey": os.getenv("MODEL_API_KEY")},
     )
 
-    # Create a Stagehand client with the configuration; server_url is taken from environment variables.
+    # Create a Stagehand client with the configuration; server_url is taken from
+    # environment variables.
     stagehand = Stagehand(
         config=config, server_url=os.getenv("STAGEHAND_SERVER_URL"), verbose=2
     )

examples/example.py

@@ -87,7 +87,7 @@ async def main():
     if len(observed) > 0:
         element = observed[0]
         console.print("✅ [success]Found element:[/] News button")
-        console.print(f"\n▶️ [highlight] Performing action on observed element")
+        console.print("\n▶️ [highlight] Performing action on observed element")
         await page.act(element)
         console.print("✅ [success]Performing Action:[/] Action completed successfully")
 

examples/example_sync.py

@@ -6,8 +6,8 @@
 from rich.panel import Panel
 from rich.theme import Theme
 
-from stagehand.sync import Stagehand
 from stagehand.config import StagehandConfig
+from stagehand.sync import Stagehand
 
 # Create a custom theme for consistent styling
 custom_theme = Theme(
@@ -60,6 +60,7 @@ def main():
     )
 
     import time
+
     time.sleep(2)
 
     console.print("\n▶️ [highlight] Navigating[/] to Google")
@@ -112,4 +113,4 @@ def main():
             padding=(1, 10),
         ),
     )
-    main() 
+    main()

format.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+# Define source directories (adjust as needed)
+SOURCE_DIRS="evals stagehand"
+
+# Apply Black formatting only to source directories
+echo "Applying Black formatting..."
+black $SOURCE_DIRS
+
+# Fix import sorting (addresses I001 errors)
+echo "Sorting imports..."
+isort $SOURCE_DIRS
+
+# Apply Ruff with autofix for remaining issues
+echo "Applying Ruff autofixes..."
+ruff check --fix $SOURCE_DIRS
+
+echo "Checking for remaining issues..."
+ruff check $SOURCE_DIRS
+
+echo "Done! Code has been formatted and linted." 

pyproject.toml

@@ -1,7 +1,8 @@
 [tool.ruff]
 # Enable flake8-comprehensions, flake8-bugbear, naming, etc.
 select = ["E", "F", "B", "C4", "UP", "N", "I", "C"]
-ignore = []
+# Ignore line length errors - let Black handle those
+ignore = ["E501"]
 
 # Same as Black
 line-length = 88
@@ -46,4 +47,40 @@ classmethod-decorators = ["classmethod", "validator"]
 
 # Add more customizations if needed
 [tool.ruff.lint.pydocstyle]
-convention = "google"
+convention = "google"
+
+# Black configuration
+[tool.black]
+line-length = 88
+target-version = ["py39"]
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+  | __pycache__
+  | python-sdk
+)/
+'''
+# Ensure Black will wrap long strings and docstrings
+skip-string-normalization = false
+preview = true
+
+# isort configuration to work with Black
+[tool.isort]
+profile = "black"
+line_length = 88
+multi_line_output = 3
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
+ensure_newline_before_comments = true
+skip_gitignore = true
+skip_glob = ["**/venv/**", "**/.venv/**", "**/__pycache__/**"]

requirements-dev.txt

@@ -4,4 +4,5 @@ pytest-mock>=3.10.0
 pytest-cov>=4.1.0
 black>=23.3.0
 isort>=5.12.0
-mypy>=1.3.0 
+mypy>=1.3.0 
+ruff

stagehand/__init__.py

@@ -2,8 +2,6 @@
 from .config import StagehandConfig
 from .page import StagehandPage
 
-
 __version__ = "0.2.2"
 
 __all__ = ["Stagehand", "StagehandConfig", "StagehandPage"]
-

stagehand/base.py

@@ -1,13 +1,12 @@
+import logging
+import os
+import time
 from abc import ABC, abstractmethod
-from typing import Any, Callable, Dict, Optional, Union
-from playwright.async_api import Page
+from typing import Any, Callable, Optional
 
 from .config import StagehandConfig
 from .page import StagehandPage
 from .utils import default_log_handler
-import os
-import time
-import logging
 
 logger = logging.getLogger(__name__)
 
@@ -17,6 +16,7 @@ class StagehandBase(ABC):
     Base class for Stagehand client implementations.
     Defines the common interface and functionality for both sync and async versions.
     """
+
     def __init__(
         self,
         config: Optional[StagehandConfig] = None,
@@ -25,30 +25,46 @@ def __init__(
         browserbase_api_key: Optional[str] = None,
         browserbase_project_id: Optional[str] = None,
         model_api_key: Optional[str] = None,
-        on_log: Optional[Callable[[Dict[str, Any]], Any]] = default_log_handler,
+        on_log: Optional[Callable[[dict[str, Any]], Any]] = default_log_handler,
         verbose: int = 1,
         model_name: Optional[str] = None,
         dom_settle_timeout_ms: Optional[int] = None,
         debug_dom: Optional[bool] = None,
         timeout_settings: Optional[float] = None,
         stream_response: Optional[bool] = None,
-        model_client_options: Optional[Dict[str, Any]] = None,
+        model_client_options: Optional[dict[str, Any]] = None,
     ):
         """
         Initialize the Stagehand client with common configuration.
         """
         self.server_url = server_url or os.getenv("STAGEHAND_SERVER_URL")
 
         if config:
-            self.browserbase_api_key = config.api_key or browserbase_api_key or os.getenv("BROWSERBASE_API_KEY")
-            self.browserbase_project_id = config.project_id or browserbase_project_id or os.getenv("BROWSERBASE_PROJECT_ID")
+            self.browserbase_api_key = (
+                config.api_key
+                or browserbase_api_key
+                or os.getenv("BROWSERBASE_API_KEY")
+            )
+            self.browserbase_project_id = (
+                config.project_id
+                or browserbase_project_id
+                or os.getenv("BROWSERBASE_PROJECT_ID")
+            )
             self.session_id = config.browserbase_session_id or session_id
             self.model_name = config.model_name or model_name
-            self.dom_settle_timeout_ms = config.dom_settle_timeout_ms or dom_settle_timeout_ms
-            self.debug_dom = config.debug_dom if config.debug_dom is not None else debug_dom
+            self.dom_settle_timeout_ms = (
+                config.dom_settle_timeout_ms or dom_settle_timeout_ms
+            )
+            self.debug_dom = (
+                config.debug_dom if config.debug_dom is not None else debug_dom
+            )
         else:
-            self.browserbase_api_key = browserbase_api_key or os.getenv("BROWSERBASE_API_KEY")
-            self.browserbase_project_id = browserbase_project_id or os.getenv("BROWSERBASE_PROJECT_ID")
+            self.browserbase_api_key = browserbase_api_key or os.getenv(
+                "BROWSERBASE_API_KEY"
+            )
+            self.browserbase_project_id = browserbase_project_id or os.getenv(
+                "BROWSERBASE_PROJECT_ID"
+            )
             self.session_id = session_id
             self.model_name = model_name
             self.dom_settle_timeout_ms = dom_settle_timeout_ms
@@ -61,7 +77,9 @@ def __init__(
             self.model_client_options["apiKey"] = self.model_api_key
 
         # Handle streaming response setting directly
-        self.streamed_response = stream_response if stream_response is not None else True
+        self.streamed_response = (
+            stream_response if stream_response is not None else True
+        )
 
         self.on_log = on_log
         self.verbose = verbose
@@ -74,9 +92,13 @@ def __init__(
         # Validate essential fields if session_id was provided
         if self.session_id:
             if not self.browserbase_api_key:
-                raise ValueError("browserbase_api_key is required (or set BROWSERBASE_API_KEY in env).")
+                raise ValueError(
+                    "browserbase_api_key is required (or set BROWSERBASE_API_KEY in env)."
+                )
             if not self.browserbase_project_id:
-                raise ValueError("browserbase_project_id is required (or set BROWSERBASE_PROJECT_ID in env).")
+                raise ValueError(
+                    "browserbase_project_id is required (or set BROWSERBASE_PROJECT_ID in env)."
+                )
 
     @abstractmethod
     def init(self):
@@ -106,4 +128,4 @@ def _log(self, message: str, level: int = 1):
             elif level == 2:
                 logger.warning(formatted_msg)
             else:
-                logger.debug(formatted_msg) 
+                logger.debug(formatted_msg)