Update _fishjam_client docstrings (#56)

p1003 · web-flow · commit 8183f0a9fd57 · 2025-12-11T12:57:57.000+01:00
* update _fishjam_client docstrings

* fix too long lines

* update ruff

* linter

* ignore D419 for errors.py

* ignore D415 only in errors.py and __init__.py

* bump ruff to 0.12 and add DOC rule
diff --git a/examples/selective_subscription/selective_subscription/app.py b/examples/selective_subscription/selective_subscription/app.py
@@ -29,14 +29,12 @@ async def create_peer(request: Request) -> Response:
 
         peer, token = room_service.create_peer()
 
-        return JSONResponse(
-            {
-                "peer_id": peer.id,
-                "token": token,
-                "room_name": room_name,
-                "peer_name": peer_name,
-            }
-        )
+        return JSONResponse({
+            "peer_id": peer.id,
+            "token": token,
+            "room_name": room_name,
+            "peer_name": peer_name,
+        })
     except Exception as e:
         return JSONResponse({"error": str(e)}, status_code=500)
 
diff --git a/fishjam/__init__.py b/fishjam/__init__.py
@@ -1,6 +1,4 @@
-"""
-.. include:: ../README.md
-"""
+""".. include:: ../README.md"""
 
 # pylint: disable=locally-disabled, no-name-in-module, import-error
 
diff --git a/fishjam/_openapi_client/__init__.py b/fishjam/_openapi_client/__init__.py
@@ -1,4 +1,5 @@
-""" A client library for accessing Fishjam Media Server """
+"""A client library for accessing Fishjam Media Server"""
+
 from .client import AuthenticatedClient, Client
 
 __all__ = (
diff --git a/fishjam/_openapi_client/api/__init__.py b/fishjam/_openapi_client/api/__init__.py
@@ -1 +1 @@
-""" Contains methods for accessing the API """
+"""Contains methods for accessing the API"""
diff --git a/fishjam/_openapi_client/api/room/__init__.py b/fishjam/_openapi_client/api/room/__init__.py
@@ -1 +1 @@
-""" Contains endpoint functions for accessing the API """
+"""Contains endpoint functions for accessing the API"""
diff --git a/fishjam/_openapi_client/api/stream/__init__.py b/fishjam/_openapi_client/api/stream/__init__.py
@@ -1 +1 @@
-""" Contains endpoint functions for accessing the API """
+"""Contains endpoint functions for accessing the API"""
diff --git a/fishjam/_openapi_client/api/streamer/__init__.py b/fishjam/_openapi_client/api/streamer/__init__.py
@@ -1 +1 @@
-""" Contains endpoint functions for accessing the API """
+"""Contains endpoint functions for accessing the API"""
diff --git a/fishjam/_openapi_client/api/viewer/__init__.py b/fishjam/_openapi_client/api/viewer/__init__.py
@@ -1 +1 @@
-""" Contains endpoint functions for accessing the API """
+"""Contains endpoint functions for accessing the API"""
diff --git a/fishjam/_openapi_client/errors.py b/fishjam/_openapi_client/errors.py
@@ -1,4 +1,4 @@
-""" Contains shared errors types that can be raised from API functions """
+"""Contains shared errors types that can be raised from API functions"""
 
 
 class UnexpectedStatus(Exception):
diff --git a/fishjam/_openapi_client/models/__init__.py b/fishjam/_openapi_client/models/__init__.py
@@ -1,4 +1,4 @@
-""" Contains all the data models used in inputs/outputs """
+"""Contains all the data models used in inputs/outputs"""
 
 from .add_peer_body import AddPeerBody
 from .error import Error
diff --git a/fishjam/_openapi_client/models/add_peer_body.py b/fishjam/_openapi_client/models/add_peer_body.py
@@ -44,12 +44,10 @@ def to_dict(self) -> dict[str, Any]:
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "options": options,
-                "type": type_,
-            }
-        )
+        field_dict.update({
+            "options": options,
+            "type": type_,
+        })
 
         return field_dict
 
diff --git a/fishjam/_openapi_client/models/error.py b/fishjam/_openapi_client/models/error.py
@@ -23,11 +23,9 @@ def to_dict(self) -> dict[str, Any]:
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "errors": errors,
-            }
-        )
+        field_dict.update({
+            "errors": errors,
+        })
 
         return field_dict
 
diff --git a/fishjam/_openapi_client/models/peer.py b/fishjam/_openapi_client/models/peer.py
@@ -72,17 +72,15 @@ def to_dict(self) -> dict[str, Any]:
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "id": id,
-                "metadata": metadata,
-                "status": status,
-                "subscribeMode": subscribe_mode,
-                "subscriptions": subscriptions,
-                "tracks": tracks,
-                "type": type_,
-            }
-        )
+        field_dict.update({
+            "id": id,
+            "metadata": metadata,
+            "status": status,
+            "subscribeMode": subscribe_mode,
+            "subscriptions": subscriptions,
+            "tracks": tracks,
+            "type": type_,
+        })
 
         return field_dict
 
diff --git a/fishjam/_openapi_client/models/peer_details_response.py b/fishjam/_openapi_client/models/peer_details_response.py
@@ -31,11 +31,9 @@ def to_dict(self) -> dict[str, Any]:
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "data": data,
-            }
-        )
+        field_dict.update({
+            "data": data,
+        })
 
         return field_dict
 
diff --git a/fishjam/_openapi_client/models/peer_details_response_data.py b/fishjam/_openapi_client/models/peer_details_response_data.py
@@ -42,12 +42,10 @@ def to_dict(self) -> dict[str, Any]:
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "peer": peer,
-                "token": token,
-            }
-        )
+        field_dict.update({
+            "peer": peer,
+            "token": token,
+        })
         if peer_websocket_url is not UNSET:
             field_dict["peer_websocket_url"] = peer_websocket_url
 
diff --git a/fishjam/_openapi_client/models/peer_options_agent.py b/fishjam/_openapi_client/models/peer_options_agent.py
@@ -30,9 +30,9 @@ class PeerOptionsAgent:
     """
 
     output: Union[Unset, "PeerOptionsAgentOutput"] = UNSET
-    subscribe_mode: Union[
-        Unset, PeerOptionsAgentSubscribeMode
-    ] = PeerOptionsAgentSubscribeMode.AUTO
+    subscribe_mode: Union[Unset, PeerOptionsAgentSubscribeMode] = (
+        PeerOptionsAgentSubscribeMode.AUTO
+    )
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> dict[str, Any]:
diff --git a/fishjam/_openapi_client/models/peer_options_agent_output.py b/fishjam/_openapi_client/models/peer_options_agent_output.py
@@ -30,12 +30,12 @@ class PeerOptionsAgentOutput:
             Default: PeerOptionsAgentOutputAudioSampleRate.VALUE_16000. Example: 16000.
     """
 
-    audio_format: Union[
-        Unset, PeerOptionsAgentOutputAudioFormat
-    ] = PeerOptionsAgentOutputAudioFormat.PCM16
-    audio_sample_rate: Union[
-        Unset, PeerOptionsAgentOutputAudioSampleRate
-    ] = PeerOptionsAgentOutputAudioSampleRate.VALUE_16000
+    audio_format: Union[Unset, PeerOptionsAgentOutputAudioFormat] = (
+        PeerOptionsAgentOutputAudioFormat.PCM16
+    )
+    audio_sample_rate: Union[Unset, PeerOptionsAgentOutputAudioSampleRate] = (
+        PeerOptionsAgentOutputAudioSampleRate.VALUE_16000
+    )
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> dict[str, Any]:
diff --git a/fishjam/_openapi_client/models/peer_options_web_rtc.py b/fishjam/_openapi_client/models/peer_options_web_rtc.py
@@ -32,9 +32,9 @@ class PeerOptionsWebRTC:
 
     enable_simulcast: Union[Unset, bool] = True
     metadata: Union[Unset, "PeerOptionsWebRTCMetadata"] = UNSET
-    subscribe_mode: Union[
-        Unset, PeerOptionsWebRTCSubscribeMode
-    ] = PeerOptionsWebRTCSubscribeMode.AUTO
+    subscribe_mode: Union[Unset, PeerOptionsWebRTCSubscribeMode] = (
+        PeerOptionsWebRTCSubscribeMode.AUTO
+    )
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> dict[str, Any]:
diff --git a/fishjam/_openapi_client/models/peer_refresh_token_response.py b/fishjam/_openapi_client/models/peer_refresh_token_response.py
@@ -31,11 +31,9 @@ def to_dict(self) -> dict[str, Any]:
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "data": data,
-            }
-        )
+        field_dict.update({
+            "data": data,
+        })
 
         return field_dict
 
diff --git a/fishjam/_openapi_client/models/peer_refresh_token_response_data.py b/fishjam/_openapi_client/models/peer_refresh_token_response_data.py
@@ -22,11 +22,9 @@ def to_dict(self) -> dict[str, Any]:
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "token": token,
-            }
-        )
+        field_dict.update({
+            "token": token,
+        })
 
         return field_dict
 
diff --git a/fishjam/_openapi_client/models/room.py b/fishjam/_openapi_client/models/room.py
@@ -43,13 +43,11 @@ def to_dict(self) -> dict[str, Any]:
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "config": config,
-                "id": id,
-                "peers": peers,
-            }
-        )
+        field_dict.update({
+            "config": config,
+            "id": id,
+            "peers": peers,
+        })
 
         return field_dict
 
diff --git a/fishjam/_openapi_client/models/room_create_details_response.py b/fishjam/_openapi_client/models/room_create_details_response.py
@@ -31,11 +31,9 @@ def to_dict(self) -> dict[str, Any]:
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "data": data,
-            }
-        )
+        field_dict.update({
+            "data": data,
+        })
 
         return field_dict
 
diff --git a/fishjam/_openapi_client/models/room_create_details_response_data.py b/fishjam/_openapi_client/models/room_create_details_response_data.py
@@ -35,12 +35,10 @@ def to_dict(self) -> dict[str, Any]:
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "fishjam_address": fishjam_address,
-                "room": room,
-            }
-        )
+        field_dict.update({
+            "fishjam_address": fishjam_address,
+            "room": room,
+        })
 
         return field_dict
 
diff --git a/fishjam/_openapi_client/models/room_details_response.py b/fishjam/_openapi_client/models/room_details_response.py
@@ -31,11 +31,9 @@ def to_dict(self) -> dict[str, Any]:
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "data": data,
-            }
-        )
+        field_dict.update({
+            "data": data,
+        })
 
         return field_dict
 
diff --git a/fishjam/_openapi_client/models/rooms_listing_response.py b/fishjam/_openapi_client/models/rooms_listing_response.py
@@ -34,11 +34,9 @@ def to_dict(self) -> dict[str, Any]:
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "data": data,
-            }
-        )
+        field_dict.update({
+            "data": data,
+        })
 
         return field_dict
 
diff --git a/fishjam/_openapi_client/models/stream.py b/fishjam/_openapi_client/models/stream.py
@@ -61,15 +61,13 @@ def to_dict(self) -> dict[str, Any]:
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "connectedViewers": connected_viewers,
-                "id": id,
-                "public": public,
-                "streamers": streamers,
-                "viewers": viewers,
-            }
-        )
+        field_dict.update({
+            "connectedViewers": connected_viewers,
+            "id": id,
+            "public": public,
+            "streamers": streamers,
+            "viewers": viewers,
+        })
         if audio_only is not UNSET:
             field_dict["audioOnly"] = audio_only
 
diff --git a/fishjam/_openapi_client/models/streamer.py b/fishjam/_openapi_client/models/streamer.py
@@ -41,13 +41,11 @@ def to_dict(self) -> dict[str, Any]:
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "id": id,
-                "status": status,
-                "token": token,
-            }
-        )
+        field_dict.update({
+            "id": id,
+            "status": status,
+            "token": token,
+        })
 
         return field_dict
 
diff --git a/fishjam/_openapi_client/models/streamer_token.py b/fishjam/_openapi_client/models/streamer_token.py
@@ -23,11 +23,9 @@ def to_dict(self) -> dict[str, Any]:
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "token": token,
-            }
-        )
+        field_dict.update({
+            "token": token,
+        })
 
         return field_dict
 
diff --git a/fishjam/_openapi_client/models/streams_listing_response.py b/fishjam/_openapi_client/models/streams_listing_response.py
@@ -34,11 +34,9 @@ def to_dict(self) -> dict[str, Any]:
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "data": data,
-            }
-        )
+        field_dict.update({
+            "data": data,
+        })
 
         return field_dict
 
diff --git a/fishjam/_openapi_client/models/subscribe_tracks_body.py b/fishjam/_openapi_client/models/subscribe_tracks_body.py
@@ -26,11 +26,9 @@ def to_dict(self) -> dict[str, Any]:
 
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
-        field_dict.update(
-            {
-                "track_ids": track_ids,
-            }
-        )
+        field_dict.update({
+            "track_ids": track_ids,
+        })
 
         return field_dict
 
diff --git a/fishjam/_openapi_client/models/subscriptions.py b/fishjam/_openapi_client/models/subscriptions.py
diff --git a/fishjam/_openapi_client/models/viewer.py b/fishjam/_openapi_client/models/viewer.py
diff --git a/fishjam/_openapi_client/models/viewer_token.py b/fishjam/_openapi_client/models/viewer_token.py
diff --git a/fishjam/_openapi_client/types.py b/fishjam/_openapi_client/types.py
diff --git a/fishjam/_webhook_notifier.py b/fishjam/_webhook_notifier.py
diff --git a/fishjam/_ws_notifier.py b/fishjam/_ws_notifier.py
diff --git a/fishjam/agent/agent.py b/fishjam/agent/agent.py
diff --git a/fishjam/agent/errors.py b/fishjam/agent/errors.py
diff --git a/fishjam/api/_fishjam_client.py b/fishjam/api/_fishjam_client.py
diff --git a/fishjam/errors.py b/fishjam/errors.py
diff --git a/fishjam/events/__init__.py b/fishjam/events/__init__.py
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-""" Contains methods for accessing the API """`
	`1`	`+"""Contains methods for accessing the API"""`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-""" Contains endpoint functions for accessing the API """`
	`1`	`+"""Contains endpoint functions for accessing the API"""`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-""" Contains shared errors types that can be raised from API functions """`
	`1`	`+"""Contains shared errors types that can be raised from API functions"""`
`2`	`2`
`3`	`3`
`4`	`4`	`class UnexpectedStatus(Exception):`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-""" Contains all the data models used in inputs/outputs """`
	`1`	`+"""Contains all the data models used in inputs/outputs"""`
`2`	`2`
`3`	`3`	`from .add_peer_body import AddPeerBody`
`4`	`4`	`from .error import Error`