Merge pull request #108 from python-astrodynamics/feature/timeout

Increase default timeouts and add per-request timeout parameter
python-astrodynamics · Feb 24, 2025 · 33f4b52 · 33f4b52
2 parents 71786ee + da6396d
commit 33f4b52
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 7 deletions.
diff --git a/src/spacetrack/aio.py b/src/spacetrack/aio.py
@@ -6,6 +6,7 @@
 import outcome
 import sniffio
 from filelock import AsyncFileLock
+from httpx import USE_CLIENT_DEFAULT
 
 from .base import (
     BASE_URL,
@@ -51,7 +52,7 @@ def __init__(
         cache_path=None,
     ):
         if httpx_client is None:
-            httpx_client = httpx.AsyncClient()
+            httpx_client = httpx.AsyncClient(timeout=30)
         elif not isinstance(httpx_client, httpx.AsyncClient):
             raise TypeError("httpx_client must be an httpx.AsyncClient instance")
         super().__init__(
@@ -162,6 +163,7 @@ async def generic_request(
         iter_content=False,
         controller=None,
         parse_types=False,
+        timeout=USE_CLIENT_DEFAULT,
         **kwargs,
     ):
         r"""Generic Space-Track query.
@@ -230,6 +232,7 @@ async def generic_request(
                 iter_content=iter_content,
                 controller=controller,
                 parse_types=parse_types,
+                timeout=timeout,
                 **kwargs,
             )
         )

diff --git a/src/spacetrack/base.py b/src/spacetrack/base.py
@@ -18,6 +18,7 @@
 import httpx
 import outcome
 from filelock import FileLock
+from httpx import USE_CLIENT_DEFAULT
 from logbook import Logger
 from platformdirs import user_cache_path
 from represent import ReprHelper, ReprHelperMixin
@@ -323,7 +324,7 @@ def __init__(
         cache_path=None,
     ):
         if httpx_client is None:
-            httpx_client = httpx.Client()
+            httpx_client = httpx.Client(timeout=30)
         self.client = httpx_client
         self.identity = identity
         self.password = password
@@ -495,10 +496,11 @@ def logout(self):
     def _generic_request_generator(
         self,
         class_,
-        iter_lines=False,
-        iter_content=False,
-        controller=None,
-        parse_types=False,
+        iter_lines,
+        iter_content,
+        controller,
+        parse_types,
+        timeout,
         **kwargs,
     ):
         if iter_lines and iter_content:
@@ -586,11 +588,14 @@ def _generic_request_generator(
                 url,
                 files={"file": kwargs["file"]},
                 params=params,
+                timeout=timeout,
             )
             logger.debug(request.url)
             resp = yield from self._ratelimited_send_generator(request)
         else:
-            request = self.client.build_request("GET", url, params=params)
+            request = self.client.build_request(
+                "GET", url, params=params, timeout=timeout
+            )
             logger.debug(request.url)
             resp = yield from self._ratelimited_send_generator(
                 request, stream=iter_lines or iter_content
@@ -637,6 +642,7 @@ def generic_request(
         iter_content=False,
         controller=None,
         parse_types=False,
+        timeout=USE_CLIENT_DEFAULT,
         **kwargs,
     ):
         r"""Generic Space-Track query.
@@ -670,6 +676,8 @@ def generic_request(
             parse_types: Parse string values in response according to type given
                 in predicate information, e.g. ``'2017-01-01'`` ->
                 ``datetime.date(2017, 1, 1)``.
+            timeout: Override default client timeout for this request. See
+                `HTTPX Timeouts`_.
             **kwargs: These keywords must match the predicate fields on
                 Space-Track. You may check valid keywords with the following
                 snippet:
@@ -697,6 +705,8 @@ def generic_request(
 
                 Passing ``format='json'`` will return the JSON **unparsed**. Do
                 not set ``format`` if you want the parsed JSON object returned!
+
+        .. _`HTTPX Timeouts`: https://www.python-httpx.org/advanced/timeouts/
         """
         return self._run_event_generator(
             self._generic_request_generator(
@@ -705,6 +715,7 @@ def generic_request(
                 iter_content=iter_content,
                 controller=controller,
                 parse_types=parse_types,
+                timeout=timeout,
                 **kwargs,
             )
         )