new pool_connections arg

Author: amazy

orthanc_api_client/api_client.py

@@ -51,7 +51,13 @@ def get(self, metric_name: str) -> Optional[str]:
 
 class OrthancApiClient(HttpClient):
 
-    def __init__(self, orthanc_root_url: str, user: Optional[str] = None, pwd: Optional[str] = None, api_token: Optional[str] = None, headers: Optional[Dict[str, str]] = None ) -> None:
+    def __init__(self, 
+                 orthanc_root_url: str, 
+                 user: Optional[str] = None, 
+                 pwd: Optional[str] = None, 
+                 api_token: Optional[str] = None, 
+                 headers: Optional[Dict[str, str]] = None,
+                 pool_connections: int = 10) -> None:
         """Creates an HttpClient
 
         Parameters
@@ -62,6 +68,8 @@ def __init__(self, orthanc_root_url: str, user: Optional[str] = None, pwd: Optio
         api_token: a token obtained from inside an Orthanc python plugin through orthanc.GenerateRestApiAuthorizationToken
                    format: 'Bearer 3d03892c-fe...' or '3d03892c-fe...'
         headers: HTTP headers that will be included in each requests
+        pool_connections: The number of HTTP connections in the pool (default=10).  If you are using the client from more than 10 threads,
+                          you should increase this configuration.
         """
         if api_token:
             if headers is None:
@@ -72,7 +80,7 @@ def __init__(self, orthanc_root_url: str, user: Optional[str] = None, pwd: Optio
                 header_value = f'Bearer {api_token}'
             headers['authorization'] = header_value
 
-        super().__init__(root_url=orthanc_root_url, user=user, pwd=pwd, headers=headers)
+        super().__init__(root_url=orthanc_root_url, user=user, pwd=pwd, headers=headers, pool_connections=pool_connections)
 
         self.patients = Patients(api_client=self)
         self.studies = Studies(api_client=self)

orthanc_api_client/http_client.py

@@ -9,7 +9,7 @@
 
 class HttpClient:
 
-    def __init__(self, root_url: str, user: str = None, pwd: str = None, headers: any = None) -> None:
+    def __init__(self, root_url: str, user: str = None, pwd: str = None, headers: any = None, pool_connections: int = 10) -> None:
         self._root_url = root_url
         self._http_session = requests.Session()
 
@@ -31,7 +31,9 @@ def __init__(self, root_url: str, user: str = None, pwd: str = None, headers: an
             backoff_factor=0.2
         )
         url_schema = urllib.parse.urlparse(root_url).scheme + "://"
-        self._http_session.mount(url_schema, HTTPAdapter(max_retries=retries))
+        self._http_session.mount(url_schema, HTTPAdapter(max_retries=retries,
+                                                         pool_connections=pool_connections,
+                                                         pool_maxsize=pool_connections))
 
 
     def get_abs_url(self, endpoint: str) -> str:

release-notes.md

@@ -1,3 +1,10 @@
+v 0.24.2
+========
+
+- new optional `pool_connections` argument when creating an `OrthancApiClient`.
+  By default, the value is `10` which can create a bottleneck when e.g. 20 worker
+  threads are using the same client.
+
 V 0.24.1
 ========
 

setup.py

@@ -28,7 +28,7 @@
     # For a discussion on single-sourcing the version across setup.py and the
     # project code, see
     # https://packaging.python.org/guides/single-sourcing-package-version/
-    version='0.24.1',  # Required
+    version='0.24.2',  # Required
 
     # This is a one-line description or tagline of what your project does. This
     # corresponds to the "Summary" metadata field: