feat: add support for Python 3.9, 3.10 and 3.11 (#553)

| Q                 | A
| ----------------- | ----------
| Bug fix?          | yes
| New feature? | no <!-- please update the /CHANGELOG.md file -->
| BC breaks?        | no
| Related Issue     | Fix #549, Fix #551
| Need Doc update   | yes


## Describe your change

This PR removes support for python 2.7, adds support for python 3.11 and
tests the project against 3.9, 3.10, and 3.11:
- Replaced all @asyncio.coroutine decorators by async def function def
- Replaced `yield from` with `await` or `return` statements
- Added python 3.9, 3.10, and 3.11 to tox and circleci

## What problem is this fixing?

Due to a removed syntax in python 3.11, the package was not working.

---------

Co-authored-by: shortcuts <[email protected]>

Author: paul-finary

.circleci/config.yml

@@ -3,7 +3,7 @@ version: 2.1
 jobs:
   test:
     docker:
-      - image: circleci/python:<< parameters.docker_version >>
+      - image: << parameters.docker_version >>
     description: Run tests for Python << parameters.tox_version >>
     parameters:
       docker_version:
@@ -12,49 +12,65 @@ jobs:
         type: string
     steps:
       - checkout
-      - run:
-          command: sudo pip install --upgrade pip
-      - run:
-          command: sudo pip install tox mock
+      - when:
+          condition:
+            matches:
+              pattern: ".*circleci.*"
+              value: << parameters.docker_version >>
+          steps:
+            - run:
+                command: sudo pip install --upgrade pip
+            - run:
+                command: sudo pip install tox mock
+      - when:
+          condition:
+            matches:
+              pattern: ".*cimg.*"
+              value: << parameters.docker_version >>
+          steps:
+            - run:
+                command: pip install --upgrade pip
+            - run:
+                command: pip install tox mock
       - run:
           command: tox -e py<< parameters.tox_version >>-sync,py<< parameters.tox_version >>-async
 
   format:
     docker:
-      - image: circleci/python:3.8.2
+      - image: cimg/python:3.8.2
     description: Run formatting and linting checks
     steps:
       - checkout
       - run:
-          command: sudo pip install --upgrade pip
+          command: pip install --upgrade pip
       - run:
-          command: sudo pip install tox
+          command: pip install tox
       - run:
           command: tox -e format
 
   types:
     docker:
-      - image: circleci/python:3.8.2
+      - image: cimg/python:3.8.2
     description: Run optional type checking with MyPy
     steps:
       - checkout
       - run:
-          command: sudo pip install --upgrade pip
+          command: pip install --upgrade pip
       - run:
-          command: sudo pip install tox
+          command: pip install tox
       - run:
           command: tox -e types
 
   release:
     docker:
-      - image: circleci/python:3.8.2
+      - image: cimg/python:3.8.2
     description: Perform a new release of the Python client
     steps:
       - checkout
       - run:
-          command: sudo pip install --upgrade pip
+          command: pip install --upgrade pip
       - run:
-          command: sudo pip install tox
+          command: pip install tox
       - run:
           command: |
             if [[ -z "$PYPI_USER" ]];     then echo '$PYPI_USER is not set';     exit 1; fi
@@ -65,48 +81,62 @@ workflows:
   version: 2
   build:
     jobs:
-      - test:
-          name: 'test_27'
-          docker_version: '2.7'
-          tox_version: '27'
-          filters:
-            tags:
-              only: /.*/
       - test:
           name: 'test_34'
-          docker_version: '3.4'
+          docker_version: 'circleci/python:3.4'
           tox_version: '34'
           filters:
             tags:
               only: /.*/
       - test:
           name: 'test_35'
-          docker_version: '3.5'
+          docker_version: 'cimg/python:3.5'
           tox_version: '35'
           filters:
             tags:
               only: /.*/
       - test:
           name: 'test_36'
-          docker_version: '3.6'
+          docker_version: 'cimg/python:3.6'
           tox_version: '36'
           filters:
             tags:
               only: /.*/
       - test:
           name: 'test_37'
-          docker_version: '3.7'
+          docker_version: 'cimg/python:3.7'
           tox_version: '37'
           filters:
             tags:
               only: /.*/
       - test:
           name: 'test_38'
-          docker_version: '3.8'
+          docker_version: 'cimg/python:3.8'
           tox_version: '38'
           filters:
             tags:
               only: /.*/
+      - test:
+          name: 'test_39'
+          docker_version: 'cimg/python:3.9'
+          tox_version: '39'
+          filters:
+            tags:
+              only: /.*/
+      - test:
+          name: 'test_310'
+          docker_version: 'cimg/python:3.10'
+          tox_version: '310'
+          filters:
+            tags:
+              only: /.*/
+      - test:
+          name: 'test_311'
+          docker_version: 'cimg/python:3.11.1'
+          tox_version: '311'
+          filters:
+            tags:
+              only: /.*/
       - format:
           name: 'format'
           filters:
@@ -119,12 +149,14 @@ workflows:
               only: /.*/
       - release:
           requires:
-            - test_27
             - test_34
             - test_35
             - test_36
             - test_37
             - test_38
+            - test_39
+            - test_310
+            - test_311
             - format
             - types
           filters:

CHANGELOG.md

@@ -9,6 +9,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased](https://github.com/algolia/algoliasearch-client-python/compare/v2.6.3...master)
 
+## [v3.0.0](https://github.com/algolia/algoliasearch-client-python/compare/v2.6.2...v3.0.0)
+
+### Changed
+
+- Major version: Python 2.7 is no longer supported, adds support until Python 3.11
+
+### Fixed
+ - Unable to initialize SearchClient on Python 3.11 ([#549](https://github.com/algolia/algoliasearch-client-python/issues/549))
+
 ## [v2.6.3](https://github.com/algolia/algoliasearch-client-python/compare/v2.6.2...v2.6.3)
 
 ### Fixed

README.md

@@ -25,7 +25,7 @@
 ## ✨ Features
 
 - Thin & minimal low-level HTTP client to interact with Algolia's API
-- Supports Python: `2.7`, `3.4`, `3.5`, `3.6`, `3.7`, and `3.8`
+- Supports Python from `3.4` to `3.11`
 - Contains blazing-fast asynchronous methods built on top of the [Asyncio](https://docs.python.org/3/library/asyncio.html)
 
 ## 💡 Getting Started

algoliasearch/analytics_client_async.py

@@ -1,6 +1,5 @@
 import types
 
-import asyncio
 from typing import Optional, Type
 
 from algoliasearch.analytics_client import AnalyticsClient
@@ -23,22 +22,23 @@ def __init__(self, analytics_client, transporter, search_config):
 
         _create_async_methods_in(self, client)
 
-    @asyncio.coroutine
-    def __aenter__(self):
-        # type: () -> AnalyticsClientAsync # type: ignore
+    async def __aenter__(self):
+        # type: () -> AnalyticsClientAsync
 
-        return self  # type: ignore
+        return self
 
-    @asyncio.coroutine
-    def __aexit__(self, exc_type, exc, tb):  # type: ignore
+    async def __aexit__(self, exc_type, exc, tb):  # type: ignore
         # type: (Optional[Type[BaseException]], Optional[BaseException],Optional[types.TracebackType]) -> None # noqa: E501
 
-        yield from self.close_async()  # type: ignore
+        self.close_async()
 
-    @asyncio.coroutine
-    def close_async(self):  # type: ignore
+        return
+
+    async def close_async(self):
         # type: () -> None
 
         super().close()
 
-        yield from self._transporter_async.close()  # type: ignore
+        self._transporter_async.close()
+
+        return

algoliasearch/helpers_async.py

@@ -1,4 +1,3 @@
-import asyncio
 import types
 
 from typing import Callable
@@ -29,7 +28,7 @@ def _gen_async(client, method):
 
     m = getattr(client, method)
 
-    def closure(*args, **kwargs):
+    async def closure(*args, **kwargs):
         result = m(*args, **kwargs)
 
         # We make sure we resolve the promise from the raw_responses
@@ -38,16 +37,16 @@ def closure(*args, **kwargs):
                 i,
                 raw_response,
             ) in enumerate(result.raw_responses):
-                result.raw_responses[i] = yield from raw_response
+                result.raw_responses[i] = await raw_response
 
         # We make sure we resolve the promise from the raw_response
         if hasattr(result, "raw_response"):
-            result.raw_response = yield from result.raw_response
+            result.raw_response = await result.raw_response
 
         # We make sure we resolve the promise
         if isinstance(result, types.GeneratorType):
-            result = yield from result
+            result = await result
 
         return result
 
-    return asyncio.coroutine(closure)
+    return closure

algoliasearch/http/requester_async.py

@@ -13,8 +13,7 @@ def __init__(self):
 
         self._session = None
 
-    @asyncio.coroutine  # type: ignore
-    def send(self, request):  # type: ignore
+    async def send(self, request):  # type: ignore
         # type: (Request) -> Response
 
         if self._session is None:
@@ -29,7 +28,7 @@ def send(self, request):  # type: ignore
 
         try:
             with async_timeout.timeout(request.timeout):
-                response = yield from (
+                response = await (
                     self._session.request(  # type: ignore
                         method=request.verb,
                         url=request.url,
@@ -39,20 +38,19 @@ def send(self, request):  # type: ignore
                     )
                 )
 
-                json = yield from response.json()
+                json = await response.json()
 
         except asyncio.TimeoutError as e:
 
             return Response(error_message=str(e), is_timed_out_error=True)
 
         return Response(response.status, json, str(response.reason))
 
-    @asyncio.coroutine
-    def close(self):  # type: ignore
+    async def close(self):  # type: ignore
         # type: () -> None
 
         if self._session is not None:
             session = self._session
             self._session = None
 
-            yield from session.close()  # type: ignore
+            await session.close()  # type: ignore

algoliasearch/http/transporter_async.py

@@ -1,5 +1,3 @@
-import asyncio
-
 from algoliasearch.configs import Config
 from algoliasearch.exceptions import RequestException, AlgoliaUnreachableHostException
 from algoliasearch.http.hosts import HostsCollection
@@ -13,15 +11,14 @@
 
 
 class TransporterAsync(Transporter):
-    @asyncio.coroutine
-    def retry(self, hosts, request, relative_url):  # type: ignore
+    async def retry(self, hosts, request, relative_url):  # type: ignore
         # type: (list, Request, str) -> dict
 
         for host in self._retry_strategy.valid_hosts(hosts):
 
             request.url = "https://{}/{}".format(host.url, relative_url)
 
-            response = yield from self._requester.send(request)  # type: ignore
+            response = await self._requester.send(request)  # type: ignore
 
             decision = self._retry_strategy.decide(host, response)
 
@@ -37,8 +34,7 @@ def retry(self, hosts, request, relative_url):  # type: ignore
 
         raise AlgoliaUnreachableHostException("Unreachable hosts")
 
-    @asyncio.coroutine
-    def close(self):  # type: ignore
+    async def close(self):  # type: ignore
         # type: () -> None
 
-        yield from self._requester.close()  # type: ignore
+        await self._requester.close()  # type: ignore

algoliasearch/insights_client_async.py

@@ -27,25 +27,22 @@ def user(self, user_token):
 
         return UserInsightsClientAsync(self, user_token)
 
-    @asyncio.coroutine
-    def __aenter__(self):
+    async def __aenter__(self):
         # type: () -> InsightsClientAsync # type: ignore
 
         return self  # type: ignore
 
-    @asyncio.coroutine
-    def __aexit__(self, exc_type, exc, tb):  # type: ignore
+    async def __aexit__(self, exc_type, exc, tb):  # type: ignore
         # type: (Optional[Type[BaseException]], Optional[BaseException],Optional[types.TracebackType]) -> None # noqa: E501
 
-        yield from self.close_async()  # type: ignore
+        await self.close_async()  # type: ignore
 
-    @asyncio.coroutine
-    def close_async(self):  # type: ignore
+    async def close_async(self):  # type: ignore
         # type: () -> None
 
         super().close()
 
-        yield from self._transporter_async.close()  # type: ignore
+        await self._transporter_async.close()  # type: ignore
 
 
 class UserInsightsClientAsync(UserInsightsClient):