feat: PEP 544 – Protocols: Structural subtyping (static duck typing)

Liora Milbaum · Liora Milbaum · commit a34c5c0fc758 · 2023-01-24T06:51:43.000+02:00
diff --git a/.github/workflows/protocol.yml b/.github/workflows/protocol.yml
@@ -0,0 +1,20 @@
+name: 'Protocaol'
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - gitlab/protocols/**
+  pull_request:
+    branches:
+      - main
+    paths:
+      - gitlab/protocols/**
+
+jobs:
+  protocol:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Fail
+      run: /bin/false
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -746,10 +746,10 @@ def http_request(
 
                 raise
 
-            self._check_redirects(result.response)
+            self._check_redirects(result)
 
             if 200 <= result.status_code < 300:
-                return result.response
+                return result
 
             def should_retry() -> bool:
                 if result.status_code == 429 and obey_rate_limit:
diff --git a/gitlab/http_backends/requests_backend.py b/gitlab/http_backends/requests_backend.py
@@ -6,8 +6,11 @@
 from requests.structures import CaseInsensitiveDict
 from requests_toolbelt.multipart.encoder import MultipartEncoder  # type: ignore
 
+from gitlab.protocols.http_backend import HttpBackend
+from gitlab.protocols.http_backend_response import HttpBackendResponse
 
-class RequestsResponse:
+
+class RequestsResponse(HttpBackendResponse):
     def __init__(self, response: requests.Response) -> None:
         self._response: requests.Response = response
 
@@ -35,7 +38,7 @@ def json(self) -> Any:
         return self._response.json()
 
 
-class RequestsBackend:
+class RequestsBackend(HttpBackend):
     def __init__(self, session: Optional[requests.Session] = None) -> None:
         self._client: requests.Session = session or requests.Session()
 
@@ -86,7 +89,7 @@ def http_request(
         verify: Optional[Union[bool, str]] = True,
         stream: Optional[bool] = False,
         **kwargs: Any,
-    ) -> RequestsResponse:
+    ) -> requests.Response:
         """Make HTTP request
 
         Args:
@@ -103,7 +106,7 @@ def http_request(
         Returns:
             A requests Response object.
         """
-        response: requests.Response = self._client.request(
+        return self._client.request(
             method=method,
             url=url,
             params=params,
@@ -114,4 +117,3 @@ def http_request(
             json=json,
             **kwargs,
         )
-        return RequestsResponse(response=response)
diff --git a/gitlab/protocols/__init__.py b/gitlab/protocols/__init__.py
@@ -0,0 +1,3 @@
+"""
+Defines protocols
+"""
diff --git a/gitlab/protocols/http_backend.py b/gitlab/protocols/http_backend.py
@@ -0,0 +1,28 @@
+import sys
+from abc import abstractmethod
+from typing import Any, Dict, Optional, Union
+
+import requests
+from requests_toolbelt.multipart.encoder import MultipartEncoder  # type: ignore
+
+if sys.version_info >= (3, 8):
+    from typing import Protocol
+else:
+    from typing_extensions import Protocol
+
+
+class HttpBackend(Protocol):
+    @abstractmethod
+    def http_request(
+        self,
+        method: str,
+        url: str,
+        json: Optional[Union[Dict[str, Any], bytes]],
+        data: Optional[Union[Dict[str, Any], MultipartEncoder]],
+        params: Optional[Any],
+        timeout: Optional[float],
+        verify: Optional[Union[bool, str]],
+        stream: Optional[bool],
+        **kwargs: Any,
+    ) -> requests.Response:
+        ...
diff --git a/gitlab/protocols/http_backend_response.py b/gitlab/protocols/http_backend_response.py
@@ -0,0 +1,15 @@
+import sys
+from abc import abstractmethod
+
+import requests
+
+if sys.version_info >= (3, 8):
+    from typing import Protocol
+else:
+    from typing_extensions import Protocol
+
+
+class HttpBackendResponse(Protocol):
+    @abstractmethod
+    def __init__(self, response: requests.Response) -> None:
+        ...
