chore: add ruff linting rules and fix violations (#109)

* feat: configure ruff linting rules and ignore settings in pyproject.toml

* fix: update import statements and formatting across multiple files

* fix: replace os.path with pathlib for file handling and improve readability

* fix: update test cases in test_utils.py for improved file handling and readability

* fix: add flake8-type-checking configuration and reorder imports in schemas.py

Author: twangodev

examples/getting-started/01_simple_tts.py

@@ -18,7 +18,8 @@
     - Audio file contains the spoken text
 """
 
-import os
+from pathlib import Path
+
 from fishaudio import FishAudio
 from fishaudio.utils import save
 
@@ -43,7 +44,7 @@ def main():
     save(audio, output_file)
 
     print(f"✓ Audio saved to {output_file}")
-    print(f"  File size: {os.path.getsize(output_file) / 1024:.2f} KB")
+    print(f"  File size: {Path(output_file).stat().st_size / 1024:.2f} KB")
 
 
 if __name__ == "__main__":

examples/getting_started.ipynb

@@ -39,7 +39,18 @@
     }
    },
    "outputs": [],
-   "source": "from dotenv import load_dotenv\nfrom fishaudio import FishAudio\nfrom fishaudio.utils import play\n# from fishaudio.utils import save  # Uncomment if saving audio to file\n\nload_dotenv()\n\nclient = FishAudio()"
+   "source": [
+    "from dotenv import load_dotenv\n",
+    "\n",
+    "from fishaudio import FishAudio\n",
+    "from fishaudio.utils import play\n",
+    "\n",
+    "# from fishaudio.utils import save  # Uncomment if saving audio to file\n",
+    "\n",
+    "load_dotenv()\n",
+    "\n",
+    "client = FishAudio()"
+   ]
   },
   {
    "cell_type": "markdown",

pyproject.toml

@@ -83,5 +83,34 @@ pages = [
     {title = "Exceptions", name="fishaudio/exceptions", contents = ["fishaudio.exceptions.*"] },
 ]
 
+[tool.ruff.lint]
+extend-select = [
+    "F",        # Pyflakes rules
+    "W",        # PyCodeStyle warnings
+    "E",        # PyCodeStyle errors
+    "I",        # Sort imports properly
+    "UP",       # Warn if certain things can changed due to newer Python versions
+    "C4",       # Catch incorrect use of comprehensions, dict, list, etc
+    "FA",       # Enforce from __future__ import annotations
+    "ISC",      # Good use of string concatenation
+    "ICN",      # Use common import conventions
+    "RET",      # Good return practices
+    "SIM",      # Common simplification rules
+    "TID",      # Some good import practices
+    "TC",       # Enforce importing certain types in a TYPE_CHECKING block
+    "PTH",      # Use pathlib instead of os.path
+    "TD",       # Be diligent with TODO comments
+    "NPY",      # Some numpy-specific things
+]
+ignore = [
+    "E501",     # Line too long (handled by ruff format)
+]
+
+[tool.ruff.lint.flake8-type-checking]
+runtime-evaluated-base-classes = ["pydantic.BaseModel"]
+
+[tool.ruff.lint.pyupgrade]
+keep-runtime-typing = true
+
 [tool.uv.sources]
 fish-audio-sdk = { workspace = true }

scripts/copy_docs.py

@@ -10,6 +10,8 @@
     python scripts/copy_docs.py sdk docs  # In CI context
 """
 
+from __future__ import annotations
+
 import argparse
 import shutil
 from pathlib import Path

src/fish_audio_sdk/__init__.py

@@ -1,18 +1,18 @@
 from .apis import Session
 from .exceptions import HttpCodeErr, WebSocketErr
 from .schemas import (
+    APICreditEntity,
     ASRRequest,
-    TTSRequest,
-    ReferenceAudio,
-    Prosody,
-    PaginatedResponse,
+    CloseEvent,
     ModelEntity,
-    APICreditEntity,
+    PaginatedResponse,
+    Prosody,
+    ReferenceAudio,
     StartEvent,
     TextEvent,
-    CloseEvent,
+    TTSRequest,
 )
-from .websocket import WebSocketSession, AsyncWebSocketSession
+from .websocket import AsyncWebSocketSession, WebSocketSession
 
 __all__ = [
     "Session",

src/fish_audio_sdk/apis.py

@@ -1,4 +1,6 @@
-from typing import Generator, Literal
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Literal
 
 import ormsgpack
 
@@ -7,13 +9,16 @@
     APICreditEntity,
     ASRRequest,
     ASRResponse,
-    ModelEntity,
     Backends,
+    ModelEntity,
     PackageEntity,
     PaginatedResponse,
     TTSRequest,
 )
 
+if TYPE_CHECKING:
+    from collections.abc import Generator
+
 
 class Session(RemoteCall):
     @convert_stream

src/fish_audio_sdk/io.py

@@ -1,21 +1,20 @@
+from __future__ import annotations
+
 import dataclasses
 import typing
+from collections.abc import AsyncGenerator, Awaitable, Generator
 from http.client import responses as http_responses
 from typing import (
     Any,
-    AsyncGenerator,
-    Awaitable,
     Callable,
-    Generator,
     Generic,
     TypeVar,
 )
 
-from typing_extensions import Concatenate, ParamSpec
-
 import httpx
 import httpx._client
 import httpx._types
+from typing_extensions import Concatenate, ParamSpec
 
 from .exceptions import HttpCodeErr
 
@@ -194,8 +193,7 @@ def sync_wrapper(self: RemoteCall, *args: P.args, **kwargs: P.kwargs) -> R:
             return exc.value
         raise RuntimeError("Generator did not stop")
 
-    call = IOCallDescriptor(async_wrapper, sync_wrapper)
-    return call
+    return IOCallDescriptor(async_wrapper, sync_wrapper)
 
 
 GStream = G[Generator[bytes, bytes, None]]
@@ -257,5 +255,4 @@ def sync_wrapper(
 
         raise RuntimeError("Generator did not stop")
 
-    call = StreamIOCallDescriptor(async_wrapper, sync_wrapper)
-    return call
+    return StreamIOCallDescriptor(async_wrapper, sync_wrapper)

src/fish_audio_sdk/schemas.py

@@ -1,10 +1,11 @@
+from __future__ import annotations
+
 import datetime
 import decimal
 from typing import Annotated, Generic, Literal, TypeVar
 
 from pydantic import BaseModel, Field
 
-
 Backends = Literal["speech-1.5", "speech-1.6", "agent-x0", "s1", "s1-mini"]
 
 Item = TypeVar("Item")

src/fish_audio_sdk/websocket.py

@@ -1,14 +1,13 @@
 import asyncio
+from collections.abc import AsyncGenerator, AsyncIterable, Generator, Iterable
 from concurrent.futures import ThreadPoolExecutor
-from typing import AsyncGenerator, AsyncIterable, Generator, Iterable
 
 import httpx
 import ormsgpack
-from httpx_ws import WebSocketDisconnect, connect_ws, aconnect_ws
+from httpx_ws import WebSocketDisconnect, aconnect_ws, connect_ws
 
 from .exceptions import WebSocketErr
-
-from .schemas import Backends, CloseEvent, StartEvent, TTSRequest, TextEvent
+from .schemas import Backends, CloseEvent, StartEvent, TextEvent, TTSRequest
 
 
 class WebSocketSession:

src/fishaudio/client.py

@@ -6,8 +6,8 @@
 
 from .core import AsyncClientWrapper, ClientWrapper
 from .resources import (
-    ASRClient,
     AccountClient,
+    ASRClient,
     AsyncAccountClient,
     AsyncASRClient,
     AsyncTTSClient,