sumo-wrapper-python 1.0.25__tar.gz → 1.0.27__tar.gz

{sumo_wrapper_python-1.0.25 → sumo_wrapper_python-1.0.27}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: sumo-wrapper-python
-Version: 1.0.25
+Version: 1.0.27
 Summary: Python wrapper for the Sumo API
 Author: Equinor
 License:                                  Apache License
@@ -229,6 +229,7 @@ Requires-Dist: sphinxcontrib-apidoc; extra == "docs"
 Provides-Extra: dev
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
+Dynamic: license-file
 
 # sumo-wrapper-python
 

{sumo_wrapper_python-1.0.25 → sumo_wrapper_python-1.0.27}/src/sumo/wrapper/_auth_provider.py

@@ -1,10 +1,13 @@
 import errno
 import json
 import os
+import platform
 import stat
 import sys
 import time
 from datetime import datetime, timedelta, timezone
+from pathlib import Path
+from typing import Dict
 from urllib.parse import parse_qs
 
 import jwt
@@ -74,10 +77,10 @@ class AuthProvider:
         # ELSE
         return result["access_token"]
 
-    def get_authorization(self):
+    def get_authorization(self) -> Dict:
         token = self.get_token()
         if token is None:
-            return ""
+            return {}
 
         return {"Authorization": "Bearer " + token}
 
@@ -99,6 +102,13 @@ class AuthProvider:
     pass
 
 
+class AuthProviderNone(AuthProvider):
+    def get_token(self):
+        raise Exception("No valid authorization provider found.")
+
+    pass
+
+
 class AuthProviderSilent(AuthProvider):
     def __init__(self, client_id, authority, resource_id):
         super().__init__(resource_id)
@@ -421,7 +431,7 @@ def get_auth_provider(
     refresh_token=None,
     devicecode=False,
     case_uuid=None,
-):
+) -> AuthProvider:
     if refresh_token:
         return AuthProviderRefreshToken(
             refresh_token, client_id, authority, resource_id
@@ -441,6 +451,18 @@ def get_auth_provider(
         pass
     # ELSE
     if interactive:
+        lockfile_path = Path.home() / ".config/chromium/SingletonLock"
+
+        if Path(lockfile_path).is_symlink() and not str(
+            Path(lockfile_path).resolve()
+        ).__contains__(platform.node()):
+            # https://github.com/equinor/sumo-wrapper-python/issues/193
+            print(
+                "\n\n\033[1mDetected chromium lockfile for different node; using firefox to authenticate.\033[0m"
+            )
+            os.environ["BROWSER"] = "firefox"
+            pass
+
         return AuthProviderInteractive(client_id, authority, resource_id)
     # ELSE
     if devicecode:
@@ -458,6 +480,8 @@ def get_auth_provider(
         ]
     ):
         return AuthProviderManaged(resource_id)
+    # ELSE
+    return AuthProviderNone(resource_id)
 
 
 def cleanup_shared_keys():
@@ -467,7 +491,7 @@ def cleanup_shared_keys():
     for f in os.listdir(tokendir):
         ff = os.path.join(tokendir, f)
         if os.path.isfile(ff):
-            (name, ext) = os.path.splitext(ff)
+            (_, ext) = os.path.splitext(ff)
             if ext.lower() == ".sharedkey":
                 try:
                     with open(ff, "r") as file:

{sumo_wrapper_python-1.0.25 → sumo_wrapper_python-1.0.27}/src/sumo/wrapper/_logging.py

@@ -1,5 +1,5 @@
 import logging
-from datetime import datetime
+from datetime import datetime, timezone
 
 
 class LogHandlerSumo(logging.Handler):
@@ -11,8 +11,8 @@ class LogHandlerSumo(logging.Handler):
     def emit(self, record):
         try:
             dt = (
-                datetime.now(datetime.timezone.utc)
-                .replace(microsecond=0)
+                datetime.now(timezone.utc)
+                .replace(microsecond=0, tzinfo=None)
                 .isoformat()
                 + "Z"
             )

{sumo_wrapper_python-1.0.25 → sumo_wrapper_python-1.0.27}/src/sumo/wrapper/_retry_strategy.py

@@ -44,7 +44,7 @@ class RetryStrategy:
         self._exp_base = exp_base
         return
 
-    def make_retryer(self):
+    def make_retryer(self) -> tn.Retrying:
         return tn.Retrying(
             stop=tn.stop_after_attempt(self._stop_after),
             retry=(
@@ -63,7 +63,7 @@ class RetryStrategy:
             before_sleep=_log_retry_info,
         )
 
-    def make_retryer_async(self):
+    def make_retryer_async(self) -> tn.AsyncRetrying:
         return tn.AsyncRetrying(
             stop=tn.stop_after_attempt(self._stop_after),
             retry=(

{sumo_wrapper_python-1.0.25 → sumo_wrapper_python-1.0.27}/src/sumo/wrapper/_version.py

@@ -1,8 +1,13 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
 else:
     VERSION_TUPLE = object
@@ -12,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.0.25'
-__version_tuple__ = version_tuple = (1, 0, 25)
+__version__ = version = '1.0.27'
+__version_tuple__ = version_tuple = (1, 0, 27)

{sumo_wrapper_python-1.0.25 → sumo_wrapper_python-1.0.27}/src/sumo/wrapper/login.py

@@ -1,7 +1,5 @@
 import logging
-import platform
 from argparse import ArgumentParser
-from pathlib import Path
 
 from sumo.wrapper import SumoClient
 
@@ -69,16 +67,6 @@ def main():
     if mode != "silent":
         print("Login to Sumo environment: " + env)
 
-    if mode == "interactive":
-        lockfile_path = Path.home() / ".config/chromium/SingletonLock"
-
-        if Path(lockfile_path).is_symlink() and not str(
-            Path(lockfile_path).resolve()
-        ).__contains__(platform.node()):
-            # https://github.com/equinor/sumo-wrapper-python/issues/193
-            is_interactive = False
-            is_devicecode = True
-
     sumo = SumoClient(
         env,
         interactive=is_interactive,

{sumo_wrapper_python-1.0.25 → sumo_wrapper_python-1.0.27}/src/sumo/wrapper/sumo_client.py

@@ -2,6 +2,8 @@ import asyncio
 import contextlib
 import logging
 import re
+import time
+from typing import Dict, Optional, Tuple
 
 import httpx
 import jwt
@@ -24,10 +26,13 @@ DEFAULT_TIMEOUT = httpx.Timeout(30.0)
 class SumoClient:
     """Authenticate and perform requests to the Sumo API."""
 
+    _client: httpx.Client
+    _async_client: httpx.AsyncClient
+
     def __init__(
         self,
         env: str,
-        token: str = None,
+        token: Optional[str] = None,
         interactive: bool = False,
         devicecode: bool = False,
         verbosity: str = "CRITICAL",
@@ -118,26 +123,23 @@ class SumoClient:
     def __enter__(self):
         return self
 
-    def __exit__(self, exc_type, exc_value, traceback):
+    def __exit__(self, *_):
         if not self._borrowed_client:
             self._client.close()
-        self._client = None
         return False
 
     async def __aenter__(self):
         return self
 
-    async def __aexit__(self, exc_type, exc_value, traceback):
+    async def __aexit__(self, *_):
         if not self._borrowed_async_client:
             await self._async_client.aclose()
-        self._async_client = None
         return False
 
     def __del__(self):
         if self._client is not None and not self._borrowed_client:
             self._client.close()
             pass
-        self._client = None
         if self._async_client is not None and not self._borrowed_async_client:
 
             async def closeit(client):
@@ -150,7 +152,6 @@ class SumoClient:
             except RuntimeError:
                 pass
             pass
-        self._async_client = None
 
     def authenticate(self):
         if self.auth is None:
@@ -185,7 +186,7 @@ class SumoClient:
         )
 
     @raise_for_status
-    def get(self, path: str, params: dict = None) -> dict:
+    def get(self, path: str, params: Optional[Dict] = None) -> httpx.Response:
         """Performs a GET-request to the Sumo API.
 
         Args:
@@ -246,9 +247,9 @@ class SumoClient:
     def post(
         self,
         path: str,
-        blob: bytes = None,
-        json: dict = None,
-        params: dict = None,
+        blob: Optional[bytes] = None,
+        json: Optional[dict] = None,
+        params: Optional[dict] = None,
     ) -> httpx.Response:
         """Performs a POST-request to the Sumo API.
 
@@ -319,7 +320,10 @@ class SumoClient:
 
     @raise_for_status
     def put(
-        self, path: str, blob: bytes = None, json: dict = None
+        self,
+        path: str,
+        blob: Optional[bytes] = None,
+        json: Optional[dict] = None,
     ) -> httpx.Response:
         """Performs a PUT-request to the Sumo API.
 
@@ -364,7 +368,9 @@ class SumoClient:
         return retryer(_put)
 
     @raise_for_status
-    def delete(self, path: str, params: dict = None) -> dict:
+    def delete(
+        self, path: str, params: Optional[dict] = None
+    ) -> httpx.Response:
         """Performs a DELETE-request to the Sumo API.
 
         Args:
@@ -372,7 +378,7 @@ class SumoClient:
             params: query parameters, as dictionary
 
         Returns:
-            Sumo JSON resposne as a dictionary
+            Sumo JSON response as a dictionary
 
         Examples:
             Deleting object::
@@ -401,6 +407,45 @@ class SumoClient:
 
         return retryer(_delete)
 
+    def _get_retry_details(self, response_in) -> Tuple[str, int]:
+        assert response_in.status_code == 202, (
+            "Incorrect status code; expcted 202"
+        )
+        headers = response_in.headers
+        location: str = headers.get("location")
+        assert location is not None, "Missing header: Location"
+        assert location.startswith(self.base_url)
+        retry_after = headers.get("retry-after")
+        assert retry_after is not None, "Missing header: Retry-After"
+        location = location[len(self.base_url) :]
+        retry_after = int(retry_after)
+        return location, retry_after
+
+    def poll(
+        self, response_in: httpx.Response, timeout=None
+    ) -> httpx.Response:
+        """Poll a specific endpoint until a result is obtained.
+
+        Args:
+            response_in: httpx.Response from a previous request, with 'location' and 'retry-after' headers.
+
+        Returns:
+            A new httpx.response object.
+        """
+        location, retry_after = self._get_retry_details(response_in)
+        expiry = time.time() + timeout if timeout is not None else None
+        while True:
+            time.sleep(retry_after)
+            response = self.get(location)
+            if response.status_code != 202:
+                return response
+            if expiry is not None and time.time() > expiry:
+                raise httpx.TimeoutException(
+                    "No response within specified timeout."
+                )
+            location, retry_after = self._get_retry_details(response)
+            pass
+
     def getLogger(self, name):
         """Gets a logger object that sends log objects into the message_log
         index for the Sumo instance.
@@ -454,7 +499,9 @@ class SumoClient:
             return self
 
     @raise_for_status_async
-    async def get_async(self, path: str, params: dict = None):
+    async def get_async(
+        self, path: str, params: Optional[dict] = None
+    ) -> httpx.Response:
         """Performs an async GET-request to the Sumo API.
 
         Args:
@@ -515,9 +562,9 @@ class SumoClient:
     async def post_async(
         self,
         path: str,
-        blob: bytes = None,
-        json: dict = None,
-        params: dict = None,
+        blob: Optional[bytes] = None,
+        json: Optional[dict] = None,
+        params: Optional[dict] = None,
     ) -> httpx.Response:
         """Performs an async POST-request to the Sumo API.
 
@@ -589,7 +636,10 @@ class SumoClient:
 
     @raise_for_status_async
     async def put_async(
-        self, path: str, blob: bytes = None, json: dict = None
+        self,
+        path: str,
+        blob: Optional[bytes] = None,
+        json: Optional[dict] = None,
     ) -> httpx.Response:
         """Performs an async PUT-request to the Sumo API.
 
@@ -634,7 +684,9 @@ class SumoClient:
         return await retryer(_put)
 
     @raise_for_status_async
-    async def delete_async(self, path: str, params: dict = None) -> dict:
+    async def delete_async(
+        self, path: str, params: Optional[dict] = None
+    ) -> httpx.Response:
         """Performs an async DELETE-request to the Sumo API.
 
         Args:
@@ -642,7 +694,7 @@ class SumoClient:
             params: query parameters, as dictionary
 
         Returns:
-            Sumo JSON resposne as a dictionary
+            Sumo JSON response as a dictionary
 
         Examples:
             Deleting object::
@@ -670,3 +722,28 @@ class SumoClient:
         retryer = self._retry_strategy.make_retryer_async()
 
         return await retryer(_delete)
+
+    async def poll_async(
+        self, response_in: httpx.Response, timeout=None
+    ) -> httpx.Response:
+        """Poll a specific endpoint until a result is obtained.
+
+        Args:
+            response_in: httpx.Response from a previous request, with 'location' and 'retry-after' headers.
+
+        Returns:
+            A new httpx.response object.
+        """
+        location, retry_after = self._get_retry_details(response_in)
+        expiry = time.time() + timeout if timeout is not None else None
+        while True:
+            await asyncio.sleep(retry_after)
+            response = await self.get_async(location)
+            if response.status_code != 202:
+                return response
+            if expiry is not None and time.time() > expiry:
+                raise httpx.TimeoutException(
+                    "No response within specified timeout."
+                )
+            location, retry_after = self._get_retry_details(response)
+            pass

{sumo_wrapper_python-1.0.25 → sumo_wrapper_python-1.0.27}/src/sumo_wrapper_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: sumo-wrapper-python
-Version: 1.0.25
+Version: 1.0.27
 Summary: Python wrapper for the Sumo API
 Author: Equinor
 License:                                  Apache License
@@ -229,6 +229,7 @@ Requires-Dist: sphinxcontrib-apidoc; extra == "docs"
 Provides-Extra: dev
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
+Dynamic: license-file
 
 # sumo-wrapper-python
 

{sumo_wrapper_python-1.0.25 → sumo_wrapper_python-1.0.27}/tests/test_sumo_thin_client.py

@@ -112,9 +112,13 @@ def test_upload_search_delete_ensemble_child(token):
 
     fmu_surface_metadata["fmu"]["case"]["uuid"] = case_uuid
 
-    response_surface = _upload_child_level_json(
-        conn=sumo_client, parent_id=case_id, json=fmu_surface_metadata
-    )
+    try:
+        response_surface = _upload_child_level_json(
+            conn=sumo_client, parent_id=case_id, json=fmu_surface_metadata
+        )
+    except Exception as ex:
+        print(ex.response.text)
+        raise ex
 
     assert 200 <= response_surface.status_code <= 202
     assert isinstance(response_surface.json(), dict)
@@ -237,3 +241,12 @@ def test_upload_duplicate_ensemble(token):
     # Search for ensemble
     with pytest.raises(Exception):
         assert _download_object(conn, object_id=case_id2)
+
+
+def test_poll(token):
+    conn = SumoClient(env="dev", token=token)
+    res = conn.get("/admin/index/orphans")
+    res2 = conn.poll(res)
+    assert res2.status_code == 200
+    indexorphans = res2.json()
+    assert isinstance(indexorphans, list)

{sumo_wrapper_python-1.0.25 → sumo_wrapper_python-1.0.27}/tests/testdata/surface.yml

@@ -75,7 +75,7 @@ fmu:
 file:
   relative_path: realization-33/iter-0/share/results/maps/volantis_gp_base--amplitude.gri # case-relative
   absolute_path: /some/absolute/path//realization-33/iter-0/share/results/maps/volantis_gp_base--amplitude.gri
-  checksum_md5: kjhsdfvsdlfk23knerknvk23  # checksum of the file, not the data.
+  checksum_md5: 0123456789abcdef0123456789abcdef  # checksum of the file, not the data.
 
 data: # The data block describes the actual data (e.g. surface). Only present in data objects