Rename ServiceError to BaseError

Signed-off-by: Paul Van Eck <[email protected]>

Author: pvaneck

sdk/core/azure-core/azure/core/exceptions.py

@@ -47,7 +47,7 @@
 from gencore.exceptions import (
     SerializationError,
     DeserializationError,
-    ServiceError as AzureError,
+    BaseError as AzureError,
 )
 
 _LOGGER = logging.getLogger(__name__)

sdk/core/generic-core/gencore/exceptions.py

@@ -45,7 +45,7 @@
 
 
 __all__ = [
-    "ServiceError",
+    "BaseError",
     "ServiceRequestError",
     "ServiceResponseError",
     "HttpResponseError",
@@ -124,7 +124,7 @@ def map_error(
     raise error
 
 
-class ServiceError(Exception):
+class BaseError(Exception):
     """Base exception for all errors.
 
     :param object message: The message object stringified as 'message' attribute
@@ -154,16 +154,16 @@ def __init__(self, message: Optional[object], *args: Any, **kwargs: Any) -> None
         self.exc_msg: str = "{}, {}: {}".format(message, self.exc_type.__name__, self.exc_value)
         self.message: str = str(message)
         self.continuation_token: Optional[str] = kwargs.get("continuation_token")
-        super(ServiceError, self).__init__(self.message, *args)
+        super(BaseError, self).__init__(self.message, *args)
 
 
-class ServiceRequestError(ServiceError):
+class ServiceRequestError(BaseError):
     """An error occurred while attempt to make a request to the service.
     No request was sent.
     """
 
 
-class ServiceResponseError(ServiceError):
+class ServiceResponseError(BaseError):
     """The request was sent, but the client failed to understand the response.
     The connection may have timed out. These errors can be retried for idempotent or
     safe operations"""
@@ -177,7 +177,7 @@ class ServiceResponseTimeoutError(ServiceResponseError):
     """Error raised when timeout happens"""
 
 
-class HttpResponseError(ServiceError):
+class HttpResponseError(BaseError):
     """A request was made, and a non-success status code was received from the service.
 
     :param object message: The message object stringified as 'message' attribute
@@ -253,7 +253,7 @@ class ResourceNotModifiedError(HttpResponseError):
     This will not be raised directly by the core pipeline."""
 
 
-class StreamConsumedError(ServiceError):
+class StreamConsumedError(BaseError):
     """Error thrown if you try to access the stream of a response once consumed.
 
     It is thrown if you try to read / stream an ~gencore.rest.HttpResponse or
@@ -271,7 +271,7 @@ def __init__(self, response: _HttpResponseCommonAPI) -> None:
         super(StreamConsumedError, self).__init__(message)
 
 
-class StreamClosedError(ServiceError):
+class StreamClosedError(BaseError):
     """Error thrown if you try to access the stream of a response once closed.
 
     It is thrown if you try to read / stream an ~gencore.rest.HttpResponse or
@@ -289,7 +289,7 @@ def __init__(self, response: _HttpResponseCommonAPI) -> None:
         super(StreamClosedError, self).__init__(message)
 
 
-class ResponseNotReadError(ServiceError):
+class ResponseNotReadError(BaseError):
     """Error thrown if you try to access a response's content without reading first.
 
     It is thrown if you try to access an ~gencore.rest.HttpResponse or

sdk/core/generic-core/gencore/paging.py

@@ -38,7 +38,7 @@
 )
 import logging
 
-from .exceptions import ServiceError
+from .exceptions import BaseError
 
 
 _LOGGER = logging.getLogger(__name__)
@@ -84,7 +84,7 @@ def __next__(self) -> Iterator[ReturnType]:
             raise StopIteration("End of paging")
         try:
             self._response = self._get_next(self.continuation_token)
-        except ServiceError as error:
+        except BaseError as error:
             if not error.continuation_token:
                 error.continuation_token = self.continuation_token
             raise
@@ -181,7 +181,7 @@ async def __anext__(self) -> AsyncIterator[ReturnType]:
             raise StopAsyncIteration("End of paging")
         try:
             self._response = await self._get_next(self.continuation_token)
-        except ServiceError as error:
+        except BaseError as error:
             if not error.continuation_token:
                 error.continuation_token = self.continuation_token
             raise

sdk/core/generic-core/gencore/runtime/policies/_retry.py

@@ -33,7 +33,7 @@
 from ...transport import HttpTransport
 from ...rest import HttpResponse, AsyncHttpResponse, HttpRequest
 from ...exceptions import (
-    ServiceError,
+    BaseError,
     ClientAuthenticationError,
     ServiceResponseError,
     ServiceRequestError,
@@ -152,7 +152,7 @@ def _is_connection_error(self, err: Exception) -> bool:
         request, so it should be safe to retry.
 
         :param err: The error raised by the pipeline.
-        :type err: ~gencore.exceptions.ServiceError
+        :type err: ~gencore.exceptions.BaseError
         :return: True if connection error, False if not.
         :rtype: bool
         """
@@ -163,7 +163,7 @@ def _is_read_error(self, err: Exception) -> bool:
         assume that the server began processing it.
 
         :param err: The error raised by the pipeline.
-        :type err: ~gencore.exceptions.ServiceError
+        :type err: ~gencore.exceptions.BaseError
         :return: True if read error, False if not.
         :rtype: bool
         """
@@ -258,7 +258,7 @@ def increment(
         :type response: ~gencore.runtime.pipeline.PipelineResponse
         :param error: An error encountered during the request, or
          None if the response was received successfully.
-        :type error: ~gencore.exceptions.ServiceError
+        :type error: ~gencore.exceptions.BaseError
         :return: Whether any retry attempt is available
          True if more retry attempts available, False otherwise
         :rtype: bool
@@ -484,7 +484,7 @@ def send(self, request: PipelineRequest[HttpRequest]) -> PipelineResponse[HttpRe
         :type request: ~gencore.runtime.pipeline.PipelineRequest
         :return: Returns the PipelineResponse or raises error if maximum retries exceeded.
         :rtype: ~gencore.runtime.pipeline.PipelineResponse
-        :raises: ~gencore.exceptions.ServiceError if maximum retries exceeded.
+        :raises: ~gencore.exceptions.BaseError if maximum retries exceeded.
         :raises: ~gencore.exceptions.ClientAuthenticationError if authentication
         """
         retry_active = True
@@ -518,7 +518,7 @@ def send(self, request: PipelineRequest[HttpRequest]) -> PipelineResponse[HttpRe
                 # the authentication policy failed such that the client's request can't
                 # succeed--we'll never have a response to it, so propagate the exception
                 raise
-            except ServiceError as err:
+            except BaseError as err:
                 if absolute_timeout > 0 and self._is_method_retryable(retry_settings, request.http_request):
                     retry_active = self.increment(retry_settings, response=request, error=err)
                     if retry_active:
@@ -534,7 +534,7 @@ def send(self, request: PipelineRequest[HttpRequest]) -> PipelineResponse[HttpRe
                 if absolute_timeout:
                     absolute_timeout -= end_time - start_time
         if not response:
-            raise ServiceError("Maximum retries exceeded.")
+            raise BaseError("Maximum retries exceeded.")
 
         self.update_context(response.context, retry_settings)
         return response

sdk/core/generic-core/gencore/runtime/policies/_retry_async.py

@@ -34,7 +34,7 @@
 from ...transport import AsyncHttpTransport
 from ...rest import AsyncHttpResponse, HttpRequest
 from ...exceptions import (
-    ServiceError,
+    BaseError,
     ClientAuthenticationError,
     ServiceRequestError,
 )
@@ -140,7 +140,7 @@ async def send(self, request: PipelineRequest[HttpRequest]) -> PipelineResponse[
         :type request: ~gencore.runtime.pipeline.PipelineRequest
         :return: Returns the PipelineResponse or raises error if maximum retries exceeded.
         :rtype: ~gencore.runtime.pipeline.PipelineResponse
-        :raise: ~gencore.exceptions.ServiceError if maximum retries exceeded.
+        :raise: ~gencore.exceptions.BaseError if maximum retries exceeded.
         :raise: ~gencore.exceptions.ClientAuthenticationError if authentication fails
         """
         retry_active = True
@@ -178,7 +178,7 @@ async def send(self, request: PipelineRequest[HttpRequest]) -> PipelineResponse[
                 # the authentication policy failed such that the client's request can't
                 # succeed--we'll never have a response to it, so propagate the exception
                 raise
-            except ServiceError as err:
+            except BaseError as err:
                 if absolute_timeout > 0 and self._is_method_retryable(retry_settings, request.http_request):
                     retry_active = self.increment(retry_settings, response=request, error=err)
                     if retry_active:
@@ -194,7 +194,7 @@ async def send(self, request: PipelineRequest[HttpRequest]) -> PipelineResponse[
                 if absolute_timeout:
                     absolute_timeout -= end_time - start_time
         if not response:
-            raise ServiceError("Maximum retries exceeded.")
+            raise BaseError("Maximum retries exceeded.")
 
         self.update_context(response.context, retry_settings)
         return response

sdk/core/generic-core/gencore/serialization.py

@@ -12,7 +12,6 @@
 
 
 __all__ = ["NULL", "CoreJSONEncoder"]
-TZ_UTC = timezone.utc
 
 
 class _Null:
@@ -97,9 +96,9 @@ def _datetime_as_isostr(dt: Union[datetime, date, time, timedelta]) -> str:
         dt = cast(datetime, dt)
         # astimezone() fails for naive times in Python 2.7, so make make sure dt is aware (tzinfo is set)
         if not dt.tzinfo:
-            iso_formatted = dt.replace(tzinfo=TZ_UTC).isoformat()
+            iso_formatted = dt.replace(tzinfo=timezone.utc).isoformat()
         else:
-            iso_formatted = dt.astimezone(TZ_UTC).isoformat()
+            iso_formatted = dt.astimezone(timezone.utc).isoformat()
         # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt)
         return iso_formatted.replace("+00:00", "Z")
     # Next try datetime.date or datetime.time

sdk/core/generic-core/gencore/transport/requests/_requests_basic.py

@@ -47,7 +47,7 @@
 if TYPE_CHECKING:
     from ...rest import HttpRequest as RestHttpRequest, HttpResponse as RestHttpResponse
 
-ServiceErrorUnion = Union[
+BaseErrorUnion = Union[
     ServiceRequestError,
     ServiceResponseError,
     IncompleteReadError,
@@ -132,7 +132,7 @@ def send(self, request: "RestHttpRequest", **kwargs) -> "RestHttpResponse":
         """
         self.open()
         response = None
-        error: Optional[ServiceErrorUnion] = None
+        error: Optional[BaseErrorUnion] = None
 
         try:
             connection_timeout = kwargs.pop("connection_timeout", self.connection_config.get("timeout"))

sdk/core/generic-core/gencore/utils/_utils.py

@@ -16,11 +16,8 @@
     Union,
     Dict,
 )
-from datetime import timezone
 from urllib.parse import urlparse
 
-TZ_UTC = timezone.utc
-
 
 class _FixedOffset(datetime.tzinfo):
     """Fixed offset in minutes east from UTC.

sdk/core/generic-core/tests/async_tests/test_retry_policy_async.py

@@ -17,7 +17,7 @@
 
 import pytest
 from gencore.exceptions import (
-    ServiceError,
+    BaseError,
     ServiceRequestError,
     ServiceRequestTimeoutError,
     ServiceResponseError,
@@ -149,7 +149,7 @@ async def send(self, request: PipelineRequest, **kwargs: Any) -> PipelineRespons
             if self._first:
                 self._first = False
                 request.content.seek(0, 2)
-                raise ServiceError("fail on first")
+                raise BaseError("fail on first")
             position = request.content.tell()
             assert position == 0
             response = create_http_response(http_response, request, None, status_code=400)
@@ -185,7 +185,7 @@ async def send(self, request: PipelineRequest, **kwargs: Any) -> PipelineRespons
                     name, body = value[0], value[1]
                     if name and body and hasattr(body, "read"):
                         body.seek(0, 2)
-                        raise ServiceError("fail on first")
+                        raise BaseError("fail on first")
             for value in request._files.values():
                 name, body = value[0], value[1]
                 if name and body and hasattr(body, "read"):

sdk/core/generic-core/tests/async_tests/test_streaming_async.py

@@ -40,7 +40,7 @@ async def test_decompress_plain_no_header(http_request):
     client = AsyncPipelineClient(account_url)
     async with client:
         request = http_request("GET", url)
-        pipeline_response = await client._pipeline.run(request, stream=True)
+        pipeline_response = await client.pipeline.run(request, stream=True)
         response = pipeline_response.http_response
         data = response.iter_bytes()
         content = b""
@@ -60,7 +60,7 @@ async def test_compress_plain_no_header(http_request):
     client = AsyncPipelineClient(account_url)
     async with client:
         request = http_request("GET", url)
-        pipeline_response = await client._pipeline.run(request, stream=True)
+        pipeline_response = await client.pipeline.run(request, stream=True)
         response = pipeline_response.http_response
         data = response.iter_raw()
         content = b""
@@ -80,7 +80,7 @@ async def test_decompress_compressed_no_header(http_request):
     client = AsyncPipelineClient(account_url)
     async with client:
         request = http_request("GET", url)
-        pipeline_response = await client._pipeline.run(request, stream=True)
+        pipeline_response = await client.pipeline.run(request, stream=True)
         response = pipeline_response.http_response
         data = response.iter_bytes()
         content = b""
@@ -103,7 +103,7 @@ async def test_compress_compressed_no_header(http_request):
     client = AsyncPipelineClient(account_url)
     async with client:
         request = http_request("GET", url)
-        pipeline_response = await client._pipeline.run(request, stream=True)
+        pipeline_response = await client.pipeline.run(request, stream=True)
         response = pipeline_response.http_response
         data = response.iter_raw()
         content = b""
@@ -129,7 +129,7 @@ async def test_decompress_plain_header(http_request):
     client = AsyncPipelineClient(account_url)
     async with client:
         request = http_request("GET", url)
-        pipeline_response = await client._pipeline.run(request, stream=True)
+        pipeline_response = await client.pipeline.run(request, stream=True)
         response = pipeline_response.http_response
         data = response.iter_bytes()
         try:
@@ -151,7 +151,7 @@ async def test_compress_plain_header(http_request):
     client = AsyncPipelineClient(account_url)
     async with client:
         request = http_request("GET", url)
-        pipeline_response = await client._pipeline.run(request, stream=True)
+        pipeline_response = await client.pipeline.run(request, stream=True)
         response = pipeline_response.http_response
         data = response.iter_raw()
         content = b""
@@ -171,7 +171,7 @@ async def test_decompress_compressed_header(http_request):
     client = AsyncPipelineClient(account_url)
     async with client:
         request = http_request("GET", url)
-        pipeline_response = await client._pipeline.run(request, stream=True)
+        pipeline_response = await client.pipeline.run(request, stream=True)
         response = pipeline_response.http_response
         data = response.iter_bytes()
         content = b""
@@ -192,7 +192,7 @@ async def test_compress_compressed_header(http_request):
     client = AsyncPipelineClient(account_url)
     async with client:
         request = http_request("GET", url)
-        pipeline_response = await client._pipeline.run(request, stream=True)
+        pipeline_response = await client.pipeline.run(request, stream=True)
         response = pipeline_response.http_response
         data = response.iter_raw()
         content = b""