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

Liora Milbaum · Liora Milbaum · commit 99f321a9e324 · 2022-12-26T19:30:11.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
@@ -13,6 +13,7 @@
 import gitlab.const
 import gitlab.exceptions
 from gitlab import http_backends, utils
+from gitlab.protocols.client import Client
 
 REDIRECT_MSG = (
     "python-gitlab detected a {status_code} ({reason!r}) redirection. You must update "
@@ -28,7 +29,7 @@
 )
 
 
-class Gitlab:
+class Gitlab(Client):
 
     """Represents a GitLab server connection.
 
diff --git a/gitlab/protocols/__init__.py b/gitlab/protocols/__init__.py
@@ -0,0 +1,3 @@
+"""
+Defines protocols
+"""
diff --git a/gitlab/protocols/client.py b/gitlab/protocols/client.py
@@ -0,0 +1,30 @@
+import sys
+from abc import abstractmethod
+from typing import Any, Dict, Optional, Union
+
+import requests
+
+if sys.version_info >= (3, 8):
+    from typing import Protocol
+else:
+    from typing_extensions import Protocol
+
+
+class Client(Protocol):
+    @abstractmethod
+    def http_request(
+        self,
+        verb: str,
+        path: str,
+        query_data: Optional[Dict[str, Any]],
+        post_data: Optional[Union[Dict[str, Any], bytes]],
+        raw: bool,
+        streamed: bool,
+        files: Optional[Dict[str, Any]],
+        timeout: Optional[float],
+        obey_rate_limit: bool,
+        retry_transient_errors: Optional[bool],
+        max_retries: int,
+        **kwargs: Any,
+    ) -> requests.Response:
+        ...
