diracx-client 0.0.1a18__py3-none-any.whl → 0.0.1a20__py3-none-any.whl

diracx/client/generated/py.typed

@@ -0,0 +1 @@
+# Marker file for PEP 561.

diracx/client/models.py

@@ -0,0 +1,5 @@
+from .generated.models import *  # pylint: disable=unused-wildcard-import
+
+
+# TODO: replace with postprocess
+from .generated.models import DeviceFlowErrorResponse

diracx/client/patches/__init__.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from typing import List
+
+from .utils import DiracClientMixin
+
+
+from diracx.core.extensions import select_from_extension
+
+real_client = select_from_extension(group="diracx", name="client_class")[0].load()
+DiracGenerated = real_client
+
+
+__all__: List[str] = [
+    "DiracClient",
+]  # Add all objects you want publicly available to users at this package level
+
+
+class DiracClient(DiracClientMixin, DiracGenerated): ...  # type: ignore

diracx/client/patches/aio/__init__.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from typing import List
+
+from .utils import DiracClientMixin
+
+
+from diracx.core.extensions import select_from_extension
+
+real_client = select_from_extension(group="diracx", name="aio_client_class")[0].load()
+DiracGenerated = real_client
+
+__all__: List[str] = [
+    "DiracClient",
+]  # Add all objects you want publicly available to users at this package level
+
+
+class DiracClient(DiracClientMixin, DiracGenerated): ...  # type: ignore

diracx/client/{aio/_patch.py → patches/aio/utils.py}

@@ -6,10 +6,14 @@
 
 Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize
 """
+from __future__ import annotations
+
+import abc
 import json
+from importlib.metadata import PackageNotFoundError, distribution
 from types import TracebackType
 from pathlib import Path
-from typing import Any, List, Optional
+from typing import Any, List, Optional, Self
 from azure.core.credentials import AccessToken
 from azure.core.credentials_async import AsyncTokenCredential
 from azure.core.pipeline import PipelineRequest
@@ -17,8 +21,7 @@ from azure.core.pipeline.policies import AsyncBearerTokenCredentialPolicy
 
 from diracx.core.preferences import get_diracx_preferences, DiracxPreferences
 
-from ._client import Dirac as DiracGenerated
-from .._patch import (
+from ..utils import (
     get_openid_configuration,
     get_token,
     refresh_token,
@@ -30,15 +33,6 @@ __all__: List[str] = [
 ]  # Add all objects you want publicly available to users at this package level
 
 
-def patch_sdk():
-    """Do not remove from this file.
-
-    `patch_sdk` is a last resort escape hatch that allows you to do customizations
-    you can't accomplish using the techniques described in
-    https://aka.ms/azsdk/python/dpcodegen/python/customize
-    """
-
-
 class DiracTokenCredential(AsyncTokenCredential):
     """Tailor get_token() for our context"""
 
@@ -140,7 +134,7 @@ class DiracBearerTokenCredentialPolicy(AsyncBearerTokenCredentialPolicy):
         request.http_request.headers["Authorization"] = f"Bearer {self._token.token}"
 
 
-class DiracClient(DiracGenerated):
+class DiracClientMixin(metaclass=abc.ABCMeta):
     """This class inherits from the generated Dirac client and adds support for tokens,
     so that the caller does not need to configure it by itself.
     """
@@ -163,8 +157,25 @@ class DiracClient(DiracGenerated):
         # Get .well-known configuration
         openid_configuration = get_openid_configuration(self._endpoint, verify=verify)
 
+        try:
+            self.client_version = distribution("diracx").version
+        except PackageNotFoundError:
+            try:
+                self.client_version = distribution("diracx-client").version
+            except PackageNotFoundError:
+                print("Error while getting client version")
+                self.client_version = "Unknown"
+
+        # Setting default headers
+        kwargs.setdefault("base_headers", {})[
+            "DiracX-Client-Version"
+        ] = self.client_version
+
         # Initialize Dirac with a Dirac-specific token credential policy
-        super().__init__(
+        # We need to ignore types here because mypy complains that we give
+        # too many arguments to "object" constructor as this is a mixin
+
+        super().__init__(  # type: ignore
             endpoint=self._endpoint,
             authentication_policy=DiracBearerTokenCredentialPolicy(
                 DiracTokenCredential(
@@ -180,8 +191,3 @@ class DiracClient(DiracGenerated):
     @property
     def client_id(self):
         return self._client_id
-
-    async def __aenter__(self) -> "DiracClient":
-        """Redefined to provide the patched Dirac client in the managed context"""
-        await self._client.__aenter__()
-        return self

diracx/client/{_patch.py → patches/utils.py}

@@ -1,45 +1,120 @@
-# ------------------------------------
-# Copyright (c) Microsoft Corporation.
-# Licensed under the MIT License.
-# ------------------------------------
-"""Customize generated code here.
-
-Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize
-"""
 from __future__ import annotations
 
-from datetime import datetime, timezone
+
 import json
 import jwt
 import requests
 
+from datetime import datetime, timezone
+from importlib.metadata import PackageNotFoundError, distribution
+
 from pathlib import Path
-from typing import Any, Dict, List, Optional, cast
+from typing import Any, Dict, List, Optional, cast, Self
 from urllib import parse
 from azure.core.credentials import AccessToken
 from azure.core.credentials import TokenCredential
 from azure.core.pipeline import PipelineRequest
 from azure.core.pipeline.policies import BearerTokenCredentialPolicy
 
-from diracx.client.models import TokenResponse
+from ..generated.models import TokenResponse
 from diracx.core.models import TokenResponse as CoreTokenResponse
 from diracx.core.preferences import DiracxPreferences, get_diracx_preferences
 
-from ._client import Dirac as DiracGenerated
+import sys
+
+
+def refresh_token(
+    location: Path,
+    token_endpoint: str,
+    client_id: str,
+    refresh_token: str,
+    *,
+    verify: bool | str = True,
+) -> AccessToken:
+    """Refresh the access token using the refresh_token flow."""
+    from diracx.core.utils import write_credentials
+
+    response = requests.post(
+        url=token_endpoint,
+        data={
+            "client_id": client_id,
+            "grant_type": "refresh_token",
+            "refresh_token": refresh_token,
+        },
+        verify=verify,
+    )
 
+    if response.status_code != 200:
+        raise RuntimeError(
+            f"An issue occured while refreshing your access token: {response.json()['detail']}"
+        )
 
-__all__: List[str] = [
-    "DiracClient",
-]  # Add all objects you want publicly available to users at this package level
+    res = response.json()
+    token_response = TokenResponse(
+        access_token=res["access_token"],
+        expires_in=res["expires_in"],
+        token_type=res.get("token_type"),
+        refresh_token=res.get("refresh_token"),
+    )
 
+    write_credentials(cast(CoreTokenResponse, token_response), location=location)
+    credentials = json.loads(location.read_text())
+    return AccessToken(credentials.get("access_token"), credentials.get("expires_on"))
 
-def patch_sdk():
-    """Do not remove from this file.
 
-    `patch_sdk` is a last resort escape hatch that allows you to do customizations
-    you can't accomplish using the techniques described in
-    https://aka.ms/azsdk/python/dpcodegen/python/customize
-    """
+def get_openid_configuration(
+    endpoint: str, *, verify: bool | str = True
+) -> Dict[str, str]:
+    """Get the openid configuration from the .well-known endpoint"""
+    response = requests.get(
+        url=parse.urljoin(endpoint, ".well-known/openid-configuration"),
+        verify=verify,
+    )
+    if not response.ok:
+        raise RuntimeError("Cannot fetch any information from the .well-known endpoint")
+    return response.json()
+
+
+def get_token(location: Path, token: AccessToken | None) -> AccessToken | None:
+    """Get token if available and still valid."""
+    # If the credentials path does not exist, raise an error
+    if not location.exists():
+        raise RuntimeError("credentials are not set")
+
+    # Load the existing credentials
+    if not token:
+        credentials = json.loads(location.read_text())
+        token = AccessToken(
+            cast(str, credentials.get("access_token")),
+            cast(int, credentials.get("expires_on")),
+        )
+
+    # We check the validity of the token
+    # If not valid, then return None to inform the caller that a new token
+    # is needed
+    if not is_token_valid(token):
+        return None
+
+    return token
+
+
+def is_refresh_token_valid(refresh_token: str) -> bool:
+    """Check if the refresh token is still valid."""
+    # Decode the refresh token
+    refresh_payload = jwt.decode(refresh_token, options={"verify_signature": False})
+    if not refresh_payload or "exp" not in refresh_payload:
+        return False
+
+    # Check the expiration time
+    return refresh_payload["exp"] > datetime.now(tz=timezone.utc).timestamp()
+
+
+def is_token_valid(token: AccessToken) -> bool:
+    """Condition to get a new token"""
+    return (
+        datetime.fromtimestamp(token.expires_on, tz=timezone.utc)
+        - datetime.now(tz=timezone.utc)
+    ).total_seconds() > 300
 
 
 class DiracTokenCredential(TokenCredential):
@@ -125,7 +200,7 @@ class DiracBearerTokenCredentialPolicy(BearerTokenCredentialPolicy):
         request.http_request.headers["Authorization"] = f"Bearer {self._token.token}"
 
 
-class DiracClient(DiracGenerated):
+class DiracClientMixin:
     """This class inherits from the generated Dirac client and adds support for tokens,
     so that the caller does not need to configure it by itself.
     """
@@ -148,8 +223,25 @@ class DiracClient(DiracGenerated):
         # Get .well-known configuration
         openid_configuration = get_openid_configuration(self._endpoint, verify=verify)
 
+        try:
+            self.client_version = distribution("diracx").version
+        except PackageNotFoundError:
+            try:
+                self.client_version = distribution("diracx-client").version
+            except PackageNotFoundError:
+                print("Error while getting client version")
+                self.client_version = "Unknown"
+
+        # Setting default headers
+        kwargs.setdefault("base_headers", {})[
+            "DiracX-Client-Version"
+        ] = self.client_version
+
         # Initialize Dirac with a Dirac-specific token credential policy
-        super().__init__(
+        # We need to ignore types here because mypy complains that we give
+        # too many arguments to "object" constructor as this is a mixin
+
+        super().__init__(  # type: ignore
             endpoint=self._endpoint,
             authentication_policy=DiracBearerTokenCredentialPolicy(
                 DiracTokenCredential(
@@ -165,102 +257,3 @@ class DiracClient(DiracGenerated):
     @property
     def client_id(self):
         return self._client_id
-
-    def __aenter__(self) -> "DiracClient":
-        """Redefined to provide the patched Dirac client in the managed context"""
-        self._client.__enter__()
-        return self
-
-
-def refresh_token(
-    location: Path,
-    token_endpoint: str,
-    client_id: str,
-    refresh_token: str,
-    *,
-    verify: bool | str = True,
-) -> AccessToken:
-    """Refresh the access token using the refresh_token flow."""
-    from diracx.core.utils import write_credentials
-
-    response = requests.post(
-        url=token_endpoint,
-        data={
-            "client_id": client_id,
-            "grant_type": "refresh_token",
-            "refresh_token": refresh_token,
-        },
-        verify=verify,
-    )
-
-    if response.status_code != 200:
-        raise RuntimeError(
-            f"An issue occured while refreshing your access token: {response.json()['detail']}"
-        )
-
-    res = response.json()
-    token_response = TokenResponse(
-        access_token=res["access_token"],
-        expires_in=res["expires_in"],
-        token_type=res.get("token_type"),
-        refresh_token=res.get("refresh_token"),
-    )
-
-    write_credentials(cast(CoreTokenResponse, token_response), location=location)
-    credentials = json.loads(location.read_text())
-    return AccessToken(credentials.get("access_token"), credentials.get("expires_on"))
-
-
-def get_openid_configuration(
-    endpoint: str, *, verify: bool | str = True
-) -> Dict[str, str]:
-    """Get the openid configuration from the .well-known endpoint"""
-    response = requests.get(
-        url=parse.urljoin(endpoint, ".well-known/openid-configuration"),
-        verify=verify,
-    )
-    if not response.ok:
-        raise RuntimeError("Cannot fetch any information from the .well-known endpoint")
-    return response.json()
-
-
-def get_token(location: Path, token: AccessToken | None) -> AccessToken | None:
-    """Get token if available and still valid."""
-    # If the credentials path does not exist, raise an error
-    if not location.exists():
-        raise RuntimeError("credentials are not set")
-
-    # Load the existing credentials
-    if not token:
-        credentials = json.loads(location.read_text())
-        token = AccessToken(
-            cast(str, credentials.get("access_token")),
-            cast(int, credentials.get("expires_on")),
-        )
-
-    # We check the validity of the token
-    # If not valid, then return None to inform the caller that a new token
-    # is needed
-    if not is_token_valid(token):
-        return None
-
-    return token
-
-
-def is_refresh_token_valid(refresh_token: str) -> bool:
-    """Check if the refresh token is still valid."""
-    # Decode the refresh token
-    refresh_payload = jwt.decode(refresh_token, options={"verify_signature": False})
-    if not refresh_payload or "exp" not in refresh_payload:
-        return False
-
-    # Check the expiration time
-    return refresh_payload["exp"] > datetime.now(tz=timezone.utc).timestamp()
-
-
-def is_token_valid(token: AccessToken) -> bool:
-    """Condition to get a new token"""
-    return (
-        datetime.fromtimestamp(token.expires_on, tz=timezone.utc)
-        - datetime.now(tz=timezone.utc)
-    ).total_seconds() > 300

{diracx_client-0.0.1a18.dist-info → diracx_client-0.0.1a20.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: diracx-client
-Version: 0.0.1a18
+Version: 0.0.1a20
 Summary: TODO
 License: GPL-3.0-only
 Classifier: Intended Audience :: Science/Research
@@ -18,4 +18,3 @@ Provides-Extra: testing
 Requires-Dist: diracx-testing; extra == "testing"
 Provides-Extra: types
 Requires-Dist: types-requests; extra == "types"
-

diracx_client-0.0.1a20.dist-info/RECORD

@@ -0,0 +1,36 @@
+diracx/client/__init__.py,sha256=aLo7lP4xwlCtxs7MKD55gr2oDLQyWEvRHZVHwj5Sl2c,165
+diracx/client/aio.py,sha256=gqVCOxYYl-q6hrz6dbhiT8kXuYWZfQeIQLHAHF9liI4,37
+diracx/client/extensions.py,sha256=igHJAXhgpYQq-Di1ZOX2b2okqgjQHTs9HL8mBTHb6ss,3385
+diracx/client/models.py,sha256=ToGTZHywDTtn-uw1woTLxNAcSw1eRCx2A_kr67ix2Hw,163
+diracx/client/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
+diracx/client/generated/__init__.py,sha256=vJe8ZP3hLFwRK36KPA2n6P4ti0nOXJgrOAhxN6bRuzU,719
+diracx/client/generated/_client.py,sha256=e_LERq7nLIMtOUL84foK5S4kZAOF9mJlFOdAcdGCwDs,4831
+diracx/client/generated/_configuration.py,sha256=qzFZ089UDtXIYEClN5w6iJj0Hm72qy_FL0pJsXathfM,1936
+diracx/client/generated/_patch.py,sha256=ZsuUeieEbKp0OjXJz2qAW-z6W0Xt8wwb38J-RvQxfNE,1328
+diracx/client/generated/_serialization.py,sha256=4C5vtTgquShn3QH7J2QaSEukQIMLW67tfNoEdGvWn5k,86948
+diracx/client/generated/_vendor.py,sha256=M1s4hEh-jejSih4eDGzFu1MQkNyWQM5pmzMxyp0eBCE,1936
+diracx/client/generated/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
+diracx/client/generated/aio/__init__.py,sha256=vJe8ZP3hLFwRK36KPA2n6P4ti0nOXJgrOAhxN6bRuzU,719
+diracx/client/generated/aio/_client.py,sha256=ctZbEdAhSPJtDYWsbh8nfvbXI_C932xd58T0Mw0q-dk,4952
+diracx/client/generated/aio/_configuration.py,sha256=6V0bK2A8i_0Au-ojhZOSqYIgYTe3QkVyFADKygWWHDQ,1968
+diracx/client/generated/aio/_patch.py,sha256=6FYNV6Yt0ttTc7A5EQui764Ujuzypkjpv47LVdccmD8,697
+diracx/client/generated/aio/_vendor.py,sha256=M1s4hEh-jejSih4eDGzFu1MQkNyWQM5pmzMxyp0eBCE,1936
+diracx/client/generated/aio/operations/__init__.py,sha256=FcU_imELohqiaOtPzeopEEPTAXgsvrIqgXjFK6VmltU,887
+diracx/client/generated/aio/operations/_operations.py,sha256=JelQdNzyG5bBISE42vtbt0PL4E2iJLBXKONNMdxVhgM,95035
+diracx/client/generated/aio/operations/_patch.py,sha256=3oHjHqBF7DXruMSVUTRxW0Xpv_mY1WaB8iyo47YBTec,4229
+diracx/client/generated/models/__init__.py,sha256=dWjCnKAE_-4-biZ5yX9TTRZnKgtqh4psNmGOL5tFwwU,3129
+diracx/client/generated/models/_enums.py,sha256=5JfOHTo7OQXAHqaoRDwiyKI3LyS0sTgxetEJ0Wjk2_I,2389
+diracx/client/generated/models/_models.py,sha256=k-YMiEs8SO3ArL6Q5dcRWoW8faM_4I17MBQsdssSwa8,39708
+diracx/client/generated/models/_patch.py,sha256=uvLwKzjWO_t-VZ4aSuLhuJ05RVxAP9UJxZV3XDeGMnU,1497
+diracx/client/generated/operations/__init__.py,sha256=FcU_imELohqiaOtPzeopEEPTAXgsvrIqgXjFK6VmltU,887
+diracx/client/generated/operations/_operations.py,sha256=iXr64Yr519jJtLjjoWVM4FNtiaqqg9cAS2GSIlfS8Nw,119966
+diracx/client/generated/operations/_patch.py,sha256=FvemlcswH_zZkdyoGObyTwRnwTsYIZJa3seO66C2BQI,4202
+diracx/client/patches/__init__.py,sha256=8mzMyg1Kd9lJH1K7DYJ6FgjkTJgPRJmF0sYmuFv5wcs,468
+diracx/client/patches/utils.py,sha256=3HSRDgdv0Ssxe53lVRFp-qlXU0Gz5mse2EqXcVmL9a0,8978
+diracx/client/patches/aio/__init__.py,sha256=qIy1qj8HzaZDEU2PCjEHjFbylwfYRAM0i90WEDs2WuQ,471
+diracx/client/patches/aio/utils.py,sha256=smZhoXpqZaWh1GV34oJdNcLRgogZtkWPmflHPq49O3A,6986
+diracx_client-0.0.1a20.dist-info/METADATA,sha256=R20omnd-mfFWp-xo45anxzMM72tqbb9-boSqyA5yYzA,676
+diracx_client-0.0.1a20.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+diracx_client-0.0.1a20.dist-info/entry_points.txt,sha256=NP67B7z-VIy8vEG3ZYtOAyxZqLtrOAD5hh2pA2AFBKI,123
+diracx_client-0.0.1a20.dist-info/top_level.txt,sha256=vJx10tdRlBX3rF2Psgk5jlwVGZNcL3m_7iQWwgPXt-U,7
+diracx_client-0.0.1a20.dist-info/RECORD,,

{diracx_client-0.0.1a18.dist-info → diracx_client-0.0.1a20.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.1.0)
+Generator: setuptools (75.6.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

diracx_client-0.0.1a20.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[diracx]
+aio_client_class = diracx.client.generated.aio._client:Dirac
+client_class = diracx.client.generated._client:Dirac

diracx_client-0.0.1a18.dist-info/RECORD

@@ -1,26 +0,0 @@
-diracx/client/__init__.py,sha256=NpsBFQPgWn_D_IVhT2RbRy0Y9oIKicEh6QBD0zGYHy4,701
-diracx/client/_client.py,sha256=agmWB402dpROnDRlqL_StInHTBIqDj-ZLSPinGfrxGk,4788
-diracx/client/_configuration.py,sha256=87XGycT5MOvmixM7v4Hq8kGsJhDAA6Zv_8pxO2sCAvQ,1937
-diracx/client/_patch.py,sha256=Dgf3pYZrSRurPsx6yxio9kMRmW30LHNEqL744ksZiPI,9130
-diracx/client/_serialization.py,sha256=jd8QTNv6p8YvcNhCkJPIjiZyuVQL55YEGOpy4cVcVzI,80965
-diracx/client/_vendor.py,sha256=ubmRRLS5-52w6qbvaWwOZBz-gS-MH3StxRlmXROIMvs,1937
-diracx/client/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
-diracx/client/aio/__init__.py,sha256=NpsBFQPgWn_D_IVhT2RbRy0Y9oIKicEh6QBD0zGYHy4,701
-diracx/client/aio/_client.py,sha256=zaVOzCPZfUPTTXfHohO7fm43mjo5_zPHVWFwG0ZSvOs,4909
-diracx/client/aio/_configuration.py,sha256=5AiZRmwQ1B8SjUPIY6bYtD-V71eumeHxQUj7Maigs4c,1969
-diracx/client/aio/_patch.py,sha256=fCRZTD-wvBE2-QZo4jiN1OsZzM2mWbtSAXk9X9Als9Q,6688
-diracx/client/aio/_vendor.py,sha256=ubmRRLS5-52w6qbvaWwOZBz-gS-MH3StxRlmXROIMvs,1937
-diracx/client/aio/operations/__init__.py,sha256=NpQ6cr321ysggDkN62imu0BAD6VXTF2GZNG0Zs6hqj4,869
-diracx/client/aio/operations/_operations.py,sha256=mM1UgFGr3e5KeE591Bb0drPjz1VNdzLZ1-_SKtcHQ18,99720
-diracx/client/aio/operations/_patch.py,sha256=3oHjHqBF7DXruMSVUTRxW0Xpv_mY1WaB8iyo47YBTec,4229
-diracx/client/models/__init__.py,sha256=cidagrv48gYiRwqXgAtkiAG2CBHoEF5aMuKt8gqOOjE,3043
-diracx/client/models/_enums.py,sha256=Cn1A9abUE1EK7Z5saAFj5Ea6sk_QdcvDsdMbZiyGFlo,2395
-diracx/client/models/_models.py,sha256=jzLNS8kQO8U0x_CAAjtuK--K5rZrUkLXaLRdFiNV13s,38145
-diracx/client/models/_patch.py,sha256=uvLwKzjWO_t-VZ4aSuLhuJ05RVxAP9UJxZV3XDeGMnU,1497
-diracx/client/operations/__init__.py,sha256=NpQ6cr321ysggDkN62imu0BAD6VXTF2GZNG0Zs6hqj4,869
-diracx/client/operations/_operations.py,sha256=Favj5uZ_UeRbA0UT2FYJSENNpH6qz2IkcQu0TNAjGiI,124423
-diracx/client/operations/_patch.py,sha256=FvemlcswH_zZkdyoGObyTwRnwTsYIZJa3seO66C2BQI,4202
-diracx_client-0.0.1a18.dist-info/METADATA,sha256=y-d6UJ0EVqhFlyzIO78WRBUmDcuLik88svsNSAQ0C7U,677
-diracx_client-0.0.1a18.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-diracx_client-0.0.1a18.dist-info/top_level.txt,sha256=vJx10tdRlBX3rF2Psgk5jlwVGZNcL3m_7iQWwgPXt-U,7
-diracx_client-0.0.1a18.dist-info/RECORD,,