[ES-53] Allow deriving from Session and JsonApiSession (#6631)

GitOrigin-RevId: 0fe426a00fe8eaa86d8ce8d4ba543805fb16610a

descarteslabs/catalog/catalog_client.py

@@ -1,74 +1,18 @@
 # jsonapi_document
 
 
-import json
 import os
 
 from descarteslabs.client.auth import Auth
-from descarteslabs.client.exceptions import ClientError
 from descarteslabs.client.services.service.service import (
     JsonApiService,
-    JsonApiSession,
     HttpRequestMethod,
 )
 
 
 HttpRequestMethod = HttpRequestMethod
 
 
-class _RewriteErrorSession(JsonApiSession):
-    """Rewrite JSON ClientErrors that are returned to make them easier to read"""
-
-    def request(self, *args, **kwargs):
-        try:
-            return super(_RewriteErrorSession, self).request(*args, **kwargs)
-        except ClientError as client_error:
-            self._rewrite_error(client_error)
-            raise
-
-    def _rewrite_error(self, client_error):
-        KEY_ERRORS = "errors"
-        KEY_TITLE = "title"
-        KEY_STATUS = "status"
-        KEY_DETAIL = "detail"
-        KEY_SOURCE = "source"
-        KEY_POINTER = "pointer"
-        message = ""
-
-        for arg in client_error.args:
-            try:
-                errors = json.loads(arg)[KEY_ERRORS]
-
-                for error in errors:
-                    line = ""
-                    seperator = ""
-
-                    if KEY_TITLE in error:
-                        line += error[KEY_TITLE]
-                        seperator = ": "
-                    elif KEY_STATUS in error:
-                        line += error[KEY_STATUS]
-                        seperator = ": "
-
-                    if KEY_DETAIL in error:
-                        line += seperator + error[KEY_DETAIL].strip(".")
-                        seperator = ": "
-
-                    if KEY_SOURCE in error:
-                        source = error[KEY_SOURCE]
-                        if KEY_POINTER in source:
-                            source = source[KEY_POINTER].split("/")[-1]
-                        line += seperator + source
-
-                    if line:
-                        message += "\n    " + line
-            except Exception:
-                return
-
-        if message:
-            client_error.args = (message,)
-
-
 class CatalogClient(JsonApiService):
     """
     The CatalogClient handles the HTTP communication with the Descartes Labs catalog.
@@ -106,7 +50,7 @@ def __init__(self, url=None, auth=None, retries=None):
             )
 
         super(CatalogClient, self).__init__(
-            url, auth=auth, retries=retries, session_class=_RewriteErrorSession
+            url, auth=auth, retries=retries, rewrite_errors=True
         )
 
     @staticmethod

descarteslabs/client/exceptions.py

@@ -49,6 +49,12 @@ class NotFoundError(ClientError):
     status = 404
 
 
+class ProxyAuthenticationRequiredError(ClientError):
+    """Client request needs proxy authentication."""
+
+    status = 407
+
+
 class ConflictError(ClientError):
     """Client request conflicts with existing state."""
 

descarteslabs/client/services/catalog/catalog.py

@@ -1455,7 +1455,11 @@ def upload_image(
                 )
         else:
             failed, upload_id, error = self._do_upload(
-                files, product_id, image_id, metadata=metadata, add_namespace=add_namespace
+                files,
+                product_id,
+                image_id,
+                metadata=metadata,
+                add_namespace=add_namespace,
             )
 
         if failed:
@@ -1770,7 +1774,9 @@ def _do_multi_file_upload(
 
         return failed, upload_id, error
 
-    def _do_upload(self, file_ish, product_id, image_id=None, metadata=None, add_namespace=False):
+    def _do_upload(
+        self, file_ish, product_id, image_id=None, metadata=None, add_namespace=False
+    ):
         # kwargs are treated as metadata fields and restricted to primitives
         # for the key val pairs.
         fd = None
@@ -1808,7 +1814,9 @@ def _do_upload(self, file_ish, product_id, image_id=None, metadata=None, add_nam
             return True, upload_id, e
 
         try:
-            upload_id = image_id or metadata.pop("image_id", None) or os.path.basename(fd.name)
+            upload_id = (
+                image_id or metadata.pop("image_id", None) or os.path.basename(fd.name)
+            )
 
             r = self.session.post(
                 "/products/{}/images/upload/{}".format(product_id, upload_id),

descarteslabs/client/services/metadata/readme.rst

@@ -6,7 +6,7 @@ Metadata (deprecated)
 
 
 Filtering
----------
+~~~~~~~~~
 
 .. py:attribute:: properties
 

descarteslabs/client/services/service/__init__.py

@@ -12,6 +12,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from .service import Service, JsonApiService, ThirdPartyService, NotFoundError
+from .service import (
+    Service,
+    Session,
+    JsonApiService,
+    JsonApiSession,
+    ThirdPartyService,
+    NotFoundError,
+)
 
-__all__ = ["Service", "JsonApiService", "ThirdPartyService", "NotFoundError"]
+__all__ = [
+    "Service",
+    "Session",
+    "JsonApiService",
+    "JsonApiSession",
+    "ThirdPartyService",
+    "NotFoundError",
+]

descarteslabs/client/services/service/readme.rst

@@ -0,0 +1,38 @@
+.. default-role:: py:obj
+
+Service
+-------
+
+.. autosummary::
+  :nosignatures:
+
+  ~descarteslabs.client.services.service.Service
+  ~descarteslabs.client.services.service.JsonApiService
+  ~descarteslabs.client.services.service.ThirdPartyService
+  ~descarteslabs.client.services.service.Session
+  ~descarteslabs.client.services.service.JsonApiSession
+
+-----
+
+.. autoclass:: descarteslabs.client.services.service.Service
+  :autosummary:
+  :members:
+
+.. autoclass:: descarteslabs.client.services.service.JsonApiService
+  :autosummary:
+  :members:
+  :inherited-members:
+  :show-inheritance:
+
+.. autoclass:: descarteslabs.client.services.service.ThirdPartyService
+  :autosummary:
+  :members:
+
+.. autoclass:: descarteslabs.client.services.service.Session
+  :autosummary:
+  :members:
+
+.. autoclass:: descarteslabs.client.services.service.JsonApiSession
+  :autosummary:
+  :members:
+  :show-inheritance: