feat: Initial support for httpx

Liora Milbaum · Liora Milbaum · commit 3a363d240540 · 2022-10-20T13:52:41.000+03:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -23,9 +23,10 @@ repos:
     rev: v2.15.4
     hooks:
       - id: pylint
-        additional_dependencies:
+        additional_dependencies: 
           - argcomplete==2.0.0
           - pytest==7.1.3
+          - httpx==0.23.0
           - requests==2.28.1
           - requests-toolbelt==0.9.1
         files: 'gitlab/'
@@ -35,6 +36,7 @@ repos:
       - id: mypy
         args: []
         additional_dependencies:
+          - httpx==0.23.0
           - types-PyYAML==6.0.12
           - types-requests==2.28.11.2
           - types-setuptools==64.0.1
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -2,10 +2,12 @@
 
 import os
 import re
+import sys
 import time
 from typing import Any, cast, Dict, List, Optional, Tuple, TYPE_CHECKING, Union
 from urllib import parse
 
+import httpx
 import requests
 import requests.utils
 from requests_toolbelt.multipart.encoder import MultipartEncoder  # type: ignore
@@ -16,6 +18,14 @@
 import gitlab.exceptions
 from gitlab import utils
 
+from .clients.httpx_client import Httpx_Client
+from .clients.requests_client import Requests_Client
+
+if sys.version_info >= (3, 8):
+    from typing import Literal
+else:
+    from typing_extensions import Literal
+
 REDIRECT_MSG = (
     "python-gitlab detected a {status_code} ({reason!r}) redirection. You must update "
     "your GitLab URL to the correct URL to avoid issues. The redirection was from: "
@@ -66,7 +76,9 @@ def __init__(
         http_password: Optional[str] = None,
         timeout: Optional[float] = None,
         api_version: str = "4",
+        http: Optional[Literal["requests", "httpx"]] = "requests",
         session: Optional[requests.Session] = None,
+        client: Optional[httpx.Client] = None,
         per_page: Optional[int] = None,
         pagination: Optional[str] = None,
         order_by: Optional[str] = None,
@@ -97,8 +109,11 @@ def __init__(
         self.job_token = job_token
         self._set_auth_info()
 
-        #: Create a session object for requests
-        self.session = session or requests.Session()
+        if http == "requests":
+            self._requests_client = Requests_Client(session=session)
+            self.session = self._requests_client.get_session
+        elif http == "httpx":
+            self._httpx_client = Httpx_Client(client=client)
 
         self.per_page = per_page
         self.pagination = pagination
diff --git a/gitlab/clients/__init__.py b/gitlab/clients/__init__.py
diff --git a/gitlab/clients/httpx_client.py b/gitlab/clients/httpx_client.py
@@ -0,0 +1,11 @@
+from typing import Optional
+
+import httpx
+
+
+class Httpx_Client:
+    def __init__(
+        self,
+        client: Optional[httpx.Client] = None,
+    ) -> None:
+        self._client = client or httpx.Client()
diff --git a/gitlab/clients/requests_client.py b/gitlab/clients/requests_client.py
@@ -0,0 +1,15 @@
+from typing import Optional
+
+import requests
+
+
+class Requests_Client:
+    def __init__(
+        self,
+        session: Optional[requests.Session] = None,
+    ) -> None:
+        self._session = session or requests.Session()
+
+    @property
+    def get_session(self) -> requests.Session:
+        return self._session
diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,3 @@
-requests==2.28.1
+httpx==0.23.0
 requests-toolbelt==0.10.0
+requests==2.28.1
diff --git a/tox.ini b/tox.ini
@@ -43,7 +43,8 @@ commands =
 [testenv:mypy]
 basepython = python3
 envdir={toxworkdir}/lint
-deps = -r{toxinidir}/requirements-lint.txt
+deps = -r requirements.txt
+       -r requirements-lint.txt
 commands =
   mypy {posargs}
 
@@ -57,7 +58,8 @@ commands =
 [testenv:pylint]
 basepython = python3
 envdir={toxworkdir}/lint
-deps = -r{toxinidir}/requirements-lint.txt
+deps = -r requirements.txt
+       -r requirements-lint.txt
 commands =
   pylint {posargs} gitlab/
 
@@ -121,7 +123,8 @@ commands =
   pytest --cov --cov-report xml tests/functional/api {posargs}
 
 [testenv:smoke]
-deps = -r{toxinidir}/requirements-test.txt
+deps = -r requirements.txt
+       -r requirements-test.txt
 commands = pytest tests/smoke {posargs}
 
 [testenv:pre-commit]
