linter

Author: p1003

fishjam/__init__.py

@@ -1,6 +1,4 @@
-"""
-.. include:: ../README.md
-"""
+""".. include:: ../README.md"""
 
 # pylint: disable=locally-disabled, no-name-in-module, import-error
 

fishjam/_webhook_notifier.py

@@ -1,8 +1,4 @@
-"""
-Module defining a function allowing decoding received webhook 
-notification from fishjam to notification structs.
-"""
-
+"""Module for decoding received webhook notifications from Fishjam."""
 from typing import Union
 
 import betterproto
@@ -15,8 +11,8 @@
 
 
 def receive_binary(binary: bytes) -> Union[AllowedNotification, None]:
-    """
-    Transform received protobuf notification to adequate notification instance.
+    """Transform received protobuf notification to adequate notification instance.
+
     The available notifications are listed in `fishjam.events` module.
     """
     message = ServerMessage().parse(binary)

fishjam/_ws_notifier.py

@@ -1,6 +1,4 @@
-"""
-Notifier listening to WebSocket events
-"""
+"""Notifier listening to WebSocket events"""
 
 import asyncio
 import inspect
@@ -32,19 +30,14 @@
 
 
 class FishjamNotifier:
-    """
-    Allows for receiving WebSocket messages from Fishjam.
-    """
+    """Allows for receiving WebSocket messages from Fishjam."""
 
     def __init__(
         self,
         fishjam_id: str,
         management_token: str,
     ):
-        """
-        Create FishjamNotifier instance, providing the fishjam id and management token.
-        """
-
+        """Create a FishjamNotifier instance with an ID and management token."""
         websocket_url = get_fishjam_url(fishjam_id).replace("http", "ws")
         self._fishjam_url = f"{websocket_url}/socket/server/websocket"
         self._management_token: str = management_token
@@ -56,16 +49,12 @@ def __init__(
         self._notification_handler: NotificationHandler | None = None
 
     def on_server_notification(self, handler: NotificationHandler):
-        """
-        Decorator used for defining handler for Fishjam Notifications
-        """
+        """Decorator used for defining handler for Fishjam Notifications"""
         self._notification_handler = handler
         return handler
 
     async def connect(self):
-        """
-        A coroutine which connects FishjamNotifier to Fishjam and listens for
-        all incoming messages from the Fishjam.
+        """Connects to Fishjam and listens for all incoming messages.
 
         It runs until the connection isn't closed.
 
@@ -94,8 +83,7 @@ async def connect(self):
                 self._websocket = None
 
     async def wait_ready(self) -> None:
-        """
-        Waits until the notifier is connected and authenticated to Fishjam.
+        """Waits until the notifier is connected and authenticated to Fishjam.
 
         If already connected, returns immediately.
         """

fishjam/agent/agent.py

@@ -58,11 +58,10 @@ class OutgoingAudioTrackOptions:
 
 @dataclass(frozen=True)
 class OutgoingTrack:
-    """
-    Represents an outgoing track of an agent connected to Fishjam,
-    created by :func:`Agent.add_track`.
-    """
+    """Represents an outgoing track of an agent connected to Fishjam.
 
+    This is created by :func:`Agent.add_track`.
+    """
     id: str
     """The global identifier of the track."""
     session: AgentSession
@@ -71,8 +70,7 @@ class OutgoingTrack:
     """The parameters used to create the track."""
 
     async def send_chunk(self, data: bytes):
-        """
-        Send a chunk of audio to Fishjam on this track.
+        """Send a chunk of audio to Fishjam on this track.
 
         Peers connected to the room of the agent will receive this data.
         """
@@ -86,8 +84,7 @@ async def send_chunk(self, data: bytes):
         await self.session._send(message)
 
     async def interrupt(self):
-        """
-        Interrupt current track.
+        """Interrupt current track.
 
         Any audio that has been sent, but not played
         will be cleared and be prevented from playing.
@@ -111,10 +108,7 @@ def __init__(self, agent: Agent, websocket: ClientConnection):
         self._closed = False
 
     async def receive(self) -> AsyncIterator[IncomingAgentMessage]:
-        """
-        Returns an infinite async iterator over the incoming messages from Fishjam to
-        the agent.
-        """
+        """Returns an infinite async iterator over incoming messages from Fishjam."""
         while message := await self._ws.recv(decode=False):
             parsed = AgentResponse().parse(message)
             _, msg = betterproto.which_one_of(parsed, "content")
@@ -123,8 +117,7 @@ async def receive(self) -> AsyncIterator[IncomingAgentMessage]:
                     yield content
 
     async def add_track(self, options: OutgoingAudioTrackOptions):
-        """
-        Adds a track to the connected agent, with the specified options and metadata.
+        """Adds a track to the connected agent, with the specified options and metadata.
 
         Returns an instance of :class:`OutgoingTrack`, which can be used to send data
         over the added track.
@@ -152,27 +145,25 @@ async def _send(self, message: AgentRequest):
         await self._ws.send(bytes(message), text=False)
 
     async def disconnect(self):
-        """
-        Ends the agent session by closing the websocket connection.
+        """Ends the agent session by closing the websocket connection.
+
         Useful when you don't use the context manager to obtain the session.
         """
         await self._ws.close()
 
 
 class Agent:
-    """
-    Allows for connecting to a Fishjam room as an agent peer.
+    """Allows for connecting to a Fishjam room as an agent peer.
+
     Provides callbacks for receiving audio.
     """
 
     def __init__(self, id: str, room_id: str, token: str, fishjam_url: str):
-        """
-        Create Agent instance, providing the fishjam id and management token.
+        """Create Agent instance, providing the fishjam id and management token.
 
         This constructor should not be called directly.
         Instead, you should call :func:`fishjam.FishjamClient.create_agent`.
         """
-
         self.id = id
         self.room_id = room_id
 
@@ -181,8 +172,7 @@ def __init__(self, id: str, room_id: str, token: str, fishjam_url: str):
 
     @asynccontextmanager
     async def connect(self):
-        """
-        Connect the agent to Fishjam to start receiving messages.
+        """Connect the agent to Fishjam to start receiving messages.
 
         Incoming messages from Fishjam will be routed to handlers
         defined with :func:`on_track_data`.

fishjam/api/_fishjam_client.py

@@ -1,6 +1,4 @@
-"""
-Fishjam client used to manage rooms
-"""
+"""Fishjam client used to manage rooms"""
 
 from dataclasses import dataclass, field
 from typing import Any, Literal, cast
@@ -263,7 +261,6 @@ def get_all_rooms(self) -> list[Room]:
         Returns:
             list[Room]: A list of all available Room objects.
         """
-
         rooms = cast(RoomsListingResponse, self._request(room_get_all_rooms)).data
 
         return [
@@ -279,7 +276,6 @@ def get_room(self, room_id: str) -> Room:
         Returns:
             Room: The Room object corresponding to the given ID.
         """
-
         room = cast(
             RoomDetailsResponse, self._request(room_get_room, room_id=room_id)
         ).data
@@ -293,7 +289,6 @@ def delete_peer(self, room_id: str, peer_id: str) -> None:
             room_id: The ID of the room the peer belongs to.
             peer_id: The ID of the peer to delete.
         """
-
         return self._request(room_delete_peer, id=peer_id, room_id=room_id)
 
     def delete_room(self, room_id: str) -> None:
@@ -302,7 +297,6 @@ def delete_room(self, room_id: str) -> None:
         Args:
             room_id: The ID of the room to delete.
         """
-
         return self._request(room_delete_room, room_id=room_id)
 
     def refresh_peer_token(self, room_id: str, peer_id: str) -> str:
@@ -315,7 +309,6 @@ def refresh_peer_token(self, room_id: str, peer_id: str) -> str:
         Returns:
             str: The new peer token.
         """
-
         response = cast(
             PeerRefreshTokenResponse,
             self._request(room_refresh_token, id=peer_id, room_id=room_id),
@@ -332,7 +325,6 @@ def create_livestream_viewer_token(self, room_id: str) -> str:
         Returns:
             str: The generated viewer token.
         """
-
         response = cast(
             ViewerToken, self._request(viewer_generate_viewer_token, room_id=room_id)
         )
@@ -348,7 +340,6 @@ def create_livestream_streamer_token(self, room_id: str) -> str:
         Returns:
             str: The generated streamer token.
         """
-
         response = cast(
             StreamerToken,
             self._request(streamer_generate_streamer_token, room_id=room_id),
@@ -364,7 +355,6 @@ def subscribe_peer(self, room_id: str, peer_id: str, target_peer_id: str):
             peer_id: The ID of the subscribing peer.
             target_peer_id: The ID of the peer to subscribe to.
         """
-
         self._request(
             room_subscribe_peer,
             room_id=room_id,
@@ -380,7 +370,6 @@ def subscribe_tracks(self, room_id: str, peer_id: str, track_ids: list[str]):
             peer_id: The ID of the subscribing peer.
             track_ids: A list of track IDs to subscribe to.
         """
-
         self._request(
             room_subscribe_tracks,
             room_id=room_id,

fishjam/errors.py

@@ -5,12 +5,9 @@
 
 
 class HTTPError(Exception):
-    """"""
-
     @staticmethod
     def from_response(response: Response[Error]):
         """@private"""
-
         if not response.parsed:
             raise RuntimeError("Got endpoint error reponse without parsed field")
 

fishjam/events/__init__.py

@@ -1,6 +1,4 @@
-"""
-.. include:: ../../docs/server_notifications.md
-"""
+""".. include:: ../../docs/server_notifications.md"""
 
 # Exported messages
 from fishjam.events._protos.fishjam import (

pyproject.toml

@@ -69,13 +69,28 @@ build-backend = "hatchling.build"
 
 [tool.ruff.lint]
 select = ["W", "I", "F", "E", "D"]
-ignore = ["D107"]
+ignore = [
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    "D104",
+    "D105",
+    "D107",
+    "D415",  # """@private""" would not be allowed
+]
 
 [tool.ruff.lint.pydocstyle]
 convention = "google"
 
 [tool.ruff.lint.extend-per-file-ignores]
-"fishjam/_openapi_client/**" = ["E501"]
+"fishjam/_openapi_client/**" = ["E501", "D"]
+"fishjam/events/_protos/**" = ["D"]
+"tests/**" = ["D"]
+"scripts.py" = ["D"]
+"" = ["D"]
+
+
 
 [tool.pytest.ini_options]
 markers = [