Add base64 encoding support for bytes in ApiClient and update .openapi-generator-ignore

Author: webysther

build.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+if [ -z "$1" ]; then
+  echo "Use: $0 <version> (ex: 10_10 or 10_11)"
+  exit 1
+fi
+
+VERSION="$1"
+
+openapi-generator-cli generate -g python \
+  -t ./templates/python \
+  -i ./specs/openapi_${VERSION}.json \
+  -p packageName=jellyfin.generated.api_${VERSION},packageVersion=${VERSION/_/.} \
+  -o ./src/

src/.openapi-generator-ignore

@@ -12,4 +12,5 @@ setup.cfg
 tox.ini
 pyproject.toml
 jellyfin/__init__.py
+jellyfin/generated/__init__.py
 .openapi-generator/

src/jellyfin/api.py

@@ -80,6 +80,7 @@ def client(self) -> ApiClient:
         """Returns the ApiClient instance."""
         if self._client is None:
             self._client = self.generated.ApiClient(self.configuration)
+            self.generated.ApiClient.set_default(self._client)
         return self._client
 
     def register_client(self, client_name: str = None, device_name: str = None, device_id: str = None, device_version: str = None) -> Self:

src/jellyfin/generated/api_10_10/api_client.py

@@ -11,7 +11,7 @@
     Do not edit the class manually.
 """  # noqa: E501
 
-
+import base64
 import datetime
 from dateutil.parser import parse
 from enum import Enum
@@ -353,6 +353,9 @@ def sanitize_for_serialization(self, obj):
             return None
         elif isinstance(obj, Enum):
             return obj.value
+        elif isinstance(obj, bytes):
+            # https://github.com/jellyfin/jellyfin/issues/12447#issuecomment-2292569926
+            return base64.b64encode(obj).decode("utf-8")
         elif isinstance(obj, SecretStr):
             return obj.get_secret_value()
         elif isinstance(obj, self.PRIMITIVE_TYPES):

src/jellyfin/generated/api_10_11/api_client.py

@@ -11,7 +11,7 @@
     Do not edit the class manually.
 """  # noqa: E501
 
-
+import base64
 import datetime
 from dateutil.parser import parse
 from enum import Enum
@@ -353,6 +353,9 @@ def sanitize_for_serialization(self, obj):
             return None
         elif isinstance(obj, Enum):
             return obj.value
+        elif isinstance(obj, bytes):
+            # https://github.com/jellyfin/jellyfin/issues/12447#issuecomment-2292569926
+            return base64.b64encode(obj).decode("utf-8")
         elif isinstance(obj, SecretStr):
             return obj.get_secret_value()
         elif isinstance(obj, self.PRIMITIVE_TYPES):

templates/python/api_client.mustache

@@ -2,7 +2,7 @@
 
 {{>partial_header}}
 
-
+import base64
 import datetime
 from dateutil.parser import parse
 from enum import Enum
@@ -362,6 +362,9 @@ class ApiClient:
             return None
         elif isinstance(obj, Enum):
             return obj.value
+        elif isinstance(obj, bytes):
+            # https://github.com/jellyfin/jellyfin/issues/12447#issuecomment-2292569926
+            return base64.b64encode(obj).decode("utf-8")
         elif isinstance(obj, SecretStr):
             return obj.get_secret_value()
         elif isinstance(obj, self.PRIMITIVE_TYPES):