Mod rename to mediacore + some fixes

Author: jstabenow

.gitignore

@@ -2,3 +2,4 @@
 htmlcov
 .coverage
 coverage.xml
+scripts/**

README.md

@@ -1,5 +1,5 @@
-# datarhei Core PyClient
-For rapid development of Python applications around the [datarhei Core](https://github.com/datarhei/core).
+# datarhei MediaCore Python Client
+For rapid development of Python applications around [datarhei Core](https://github.com/datarhei/core) / MediaCore.
 Requires Python 3.7+ and datarhei Core v16.10+.
 
 ---
@@ -63,6 +63,14 @@ pip install https://github.com/datarhei/core-client-python/archive/refs/tags/{re
 
 ## Usage
 
+### Preferred import path
+
+```python
+from datarhei.mediacore import MediaCoreClient, AsyncMediaCoreClient
+```
+
+`core_client` is still supported as a backward-compatible alias during migration.
+
 #### Init arguments
 
 -   `base_url: str`
@@ -76,9 +84,9 @@ pip install https://github.com/datarhei/core-client-python/archive/refs/tags/{re
 #### Sync
 
 ```python
-from core_client import Client
+from datarhei.mediacore import MediaCoreClient
 
-client = Client(base_url="http://127.0.0.1:8080", username="admin", password="datarhei")
+client = MediaCoreClient(base_url="http://127.0.0.1:8080", username="admin", password="datarhei")
 client.login()
 
 about = client.about_get()
@@ -89,9 +97,9 @@ print(about)
 
 ```python
 import asyncio
-from core_client import AsyncClient
+from datarhei.mediacore import AsyncMediaCoreClient
 
-client = AsyncClient(base_url="http://127.0.0.1:8080", username="admin", password="datarhei")
+client = AsyncMediaCoreClient(base_url="http://127.0.0.1:8080", username="admin", password="datarhei")
 client.login()
 
 async def main():

core_client/__init__.py

@@ -8,8 +8,7 @@
 from pydantic import (
     HttpUrl,
     ValidationError as PydanticValidationError,
-    validate_call,
-    TypeAdapter
+    validate_call
 )
 
 from . import base
@@ -38,7 +37,7 @@ def __init__(
         if str(base_url).endswith("/"):
             self.base_url = str(base_url)[:-1]
         else:
-            self.base_url = base_url
+            self.base_url = str(base_url)
         self.username = username
         self.password = password
         self.domain = domain
@@ -51,7 +50,7 @@ def __init__(
         self.timeout = timeout
 
     def _basic_login(self):
-        domain_param = '?domain={self.domain}' if self.domain else ''
+        domain_param = f"?domain={self.domain}" if self.domain else ""
         r_login = httpx.post(
             url=f"{self.base_url}/api/login{domain_param}",
             json={
@@ -74,7 +73,7 @@ def _basic_login(self):
             raise HTTPError("Authorization failed")
 
     def _auth0_login(self):
-        _headers = self.headers
+        _headers = self.headers.copy()
         _headers["authorization"] = f"Bearer {self.auth0_token}"
         r_login = httpx.post(
             url=f"{self.base_url}/api/login",
@@ -95,21 +94,32 @@ def _auth0_login(self):
             raise HTTPError("Authorization failed")
 
     def _set_access_token_expires_at(self, response: Token = None):
-        if response:
+        if response and response.access_token:
             try:
                 self.access_token_expires_at = jwt.decode(
                     response.access_token, options={"verify_signature": False}
                 )["exp"]
-            except (AttributeError, IndexError):
+            except (
+                AttributeError,
+                IndexError,
+                KeyError,
+                TypeError,
+                jwt.exceptions.PyJWTError,
+            ):
                 raise HTTPError("Authorization failed")
             self.access_token = response.access_token
             return self.access_token_expires_at
 
     def _access_token_is_expired(self):
+        if not self.access_token:
+            return True
         if not self.access_token_expires_at:
-            self._set_access_token_expires_at(
-                Token(access_token=self.access_token)
-            )
+            try:
+                self._set_access_token_expires_at(
+                    Token(access_token=self.access_token)
+                )
+            except (PydanticValidationError, TypeError, HTTPError):
+                return True
         if (
             datetime.fromtimestamp(self.access_token_expires_at)
             > datetime.now()
@@ -118,21 +128,32 @@ def _access_token_is_expired(self):
         return True
 
     def _set_refresh_token_expires_at(self, response: Token = None):
-        if response:
+        if response and response.refresh_token:
             try:
                 self.refresh_token_expires_at = jwt.decode(
                     response.refresh_token, options={"verify_signature": False}
                 )["exp"]
-            except (AttributeError, IndexError):
+            except (
+                AttributeError,
+                IndexError,
+                KeyError,
+                TypeError,
+                jwt.exceptions.PyJWTError,
+            ):
                 raise HTTPError("Authorization failed")
             self.refresh_token = response.refresh_token
             return self.refresh_token_expires_at
 
     def _refresh_token_is_expired(self):
+        if not self.refresh_token:
+            return True
         if not self.refresh_token_expires_at:
-            self._set_refresh_token_expires_at(
-                Token(refresh_token=self.refresh_token)
-            )
+            try:
+                self._set_refresh_token_expires_at(
+                    Token(refresh_token=self.refresh_token)
+                )
+            except (PydanticValidationError, TypeError, HTTPError):
+                return True
         if (
             datetime.fromtimestamp(self.refresh_token_expires_at)
             > datetime.now()
@@ -142,7 +163,7 @@ def _refresh_token_is_expired(self):
 
     def _refresh_access_token(self):
         if self.refresh_token:
-            _headers = self.headers
+            _headers = self.headers.copy()
             _headers["authorization"] = f"Bearer {self.refresh_token}"
             r_refresh_access_token = httpx.get(
                 url=f"{self.base_url}/api/login/refresh",
@@ -160,7 +181,7 @@ def _refresh_access_token(self):
             self._basic_login()
 
     def _get_headers(self):
-        _headers = self.headers
+        _headers = self.headers.copy()
         if (self.username and self.password) or \
             self.access_token or self.refresh_token or self.auth0_token:
             if (
@@ -171,18 +192,22 @@ def _get_headers(self):
                 self._refresh_access_token()
             elif self.refresh_token and self._refresh_token_is_expired() is True:
                 self.login()
-            _headers["authorization"] = f"Bearer {self.access_token}"
+            if self.access_token:
+                _headers["authorization"] = f"Bearer {self.access_token}"
         return _headers
 
     def token(self):
+        expires_at = None
+        if self.access_token_expires_at is not None:
+            expires_at = int(self.access_token_expires_at)
         return Token(
             access_token=self.access_token,
             refresh_token=self.refresh_token,
-            expires_at=int(self.access_token_expires_at),
+            expires_at=expires_at,
         )
 
     def login(self):
-        r_about = httpx.get(url=f"{self.base_url}/api")
+        r_about = httpx.get(url=f"{self.base_url}/api", timeout=self.timeout)
         if r_about.status_code == 200:
             try:
                 about = About(**r_about.json())
@@ -279,4 +304,21 @@ async def proxy_method(self, *args, **kwargs):
                 Client._add_proxy_method(method_name, submodule.sync)
 
     except Exception as e:
-        print(f"  ERROR processing {module_info.name}: {e}")
+        print(f"  ERROR processing {module_info.name}: {e}")
+
+
+_METHOD_ALIASES = {
+    "v3_process_get_report": "v3_report_get_process",
+    "v3_iam_put_user_policy_list": "v3_iam_put_user_policy",
+}
+
+for alias, target in _METHOD_ALIASES.items():
+    if hasattr(Client, target) and not hasattr(Client, alias):
+        setattr(Client, alias, getattr(Client, target))
+    if hasattr(AsyncClient, target) and not hasattr(AsyncClient, alias):
+        setattr(AsyncClient, alias, getattr(AsyncClient, target))
+
+
+# New canonical class names for datarhei MediaCore branding.
+MediaCoreClient = Client
+AsyncMediaCoreClient = AsyncClient

…t/base/api/v3_cluster_node_put_state .py …nt/base/api/v3_cluster_node_put_state.pycore_client/base/api/v3_cluster_node_put_state .py renamed to core_client/base/api/v3_cluster_node_put_state.py core_client/base/api/v3_cluster_node_put_state .py renamed to core_client/base/api/v3_cluster_node_put_state.py

@@ -1,6 +1,5 @@
 import httpx
 from pydantic import TypeAdapter, validate_call
-from typing import Union
 
 from ...models import Client
 from ..models import Error
@@ -29,9 +28,15 @@ def _build_request(
 
 def _build_response(response: httpx.Response):
     if response.status_code == 200:
-        print(response.json())
-        response_200 = TypeAdapter(SrtList).validate_python(response.json())
-        return response_200.root
+        payload = response.json()
+        if isinstance(payload, list):
+            response_200 = TypeAdapter(SrtList).validate_python(payload)
+            return response_200.root
+
+        # Core versions >=16.10 may return a single aggregate SRT object
+        # instead of a list. Keep the public return type stable as list[Srt].
+        response_200 = TypeAdapter(Srt).validate_python(payload)
+        return [response_200]
     else:
         response_error = TypeAdapter(Error).validate_python(response.json())
         return response_error

core_client/base/api/v3_srt_get.py

@@ -1,9 +1,11 @@
 from pydantic import BaseModel
+from typing import Optional
 
 
 class Token(BaseModel):
-    access_token: str = None
-    refresh_token: str = None
+    access_token: Optional[str] = None
+    refresh_token: Optional[str] = None
+    expires_at: Optional[int] = None
 
 
 class AccessToken(BaseModel):

core_client/base/models/login.py

@@ -40,9 +40,12 @@ class Srt(BaseModel):
 
     @model_validator(mode="before")
     def remove_empty(cls, values):
-        if values["name"] is None:
-            values.pop("name")
-            values.pop("socketid")
+        if not isinstance(values, dict):
+            return values
+
+        if values.get("name") is None:
+            values.pop("name", None)
+            values.pop("socketid", None)
         else:
-            values.pop("publisher")
+            values.pop("publisher", None)
         return values

core_client/base/models/v3/srt.py

@@ -116,10 +116,13 @@ class SrtConnectionStats(BaseModel):
 
     @model_validator(mode="before")
     def remove_empty(cls, values):
-        if values["sent_unique__bytes"] is None:
-            values.pop("sent_unique__bytes")
-            values.pop("recv_loss__bytes")
+        if not isinstance(values, dict):
+            return values
+
+        if values.get("sent_unique__bytes") is None:
+            values.pop("sent_unique__bytes", None)
+            values.pop("recv_loss__bytes", None)
         else:
-            values.pop("sent_unique_bytes")
-            values.pop("recv_loss_bytes")
+            values.pop("sent_unique_bytes", None)
+            values.pop("recv_loss_bytes", None)
         return values

core_client/base/models/v3/srt_connection_stats.py

@@ -0,0 +1,2 @@
+"""datarhei Python packages."""
+

datarhei/__init__.py

@@ -0,0 +1,36 @@
+"""Public import namespace for the datarhei MediaCore Python client."""
+
+from __future__ import annotations
+
+import sys
+
+import core_client.base as _base
+import core_client.base.api as _base_api
+import core_client.base.models as _base_models
+import core_client.base.models.v3 as _base_models_v3
+import core_client.models as _models
+from core_client import AsyncClient as AsyncMediaCoreClient
+from core_client import Client as MediaCoreClient
+
+# Friendly names for the new package path.
+Client = MediaCoreClient
+AsyncClient = AsyncMediaCoreClient
+
+# Expose legacy submodules on the new import path.
+base = _base
+models = _models
+sys.modules[f"{__name__}.base"] = _base
+sys.modules[f"{__name__}.base.api"] = _base_api
+sys.modules[f"{__name__}.base.models"] = _base_models
+sys.modules[f"{__name__}.base.models.v3"] = _base_models_v3
+sys.modules[f"{__name__}.models"] = _models
+
+__all__ = [
+    "MediaCoreClient",
+    "AsyncMediaCoreClient",
+    "Client",
+    "AsyncClient",
+    "base",
+    "models",
+]
+