Add timeout argument to all requests.get calls (#31)

This avoids having the program potentially hanging endlessly
GIScience · Sep 13, 2022 · 6678ff3 · 6678ff3
1 parent ba821da
commit 6678ff3
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 9 deletions.
diff --git a/analyses/modules/analysis_completeness.py b/analyses/modules/analysis_completeness.py
@@ -25,7 +25,7 @@
 from analyses.helpers import AnalysisResult, QualityLevel
 from analyses.modules.analysis_base import Analysis
 
-from constants import STATUS_UPDATES_ANALYSES, OHSOME_API
+from constants import STATUS_UPDATES_ANALYSES, OHSOME_API, TIMEOUT_REQUESTS
 from helper_modules.bbox_utils import Bbox
 from helper_modules.progress import update_progress
 
@@ -101,7 +101,8 @@ def request(aggregation: str, **params: Any) -> requests.Response:
         :return: Response from ohsome
         """
         aggregation = aggregation.replace("density", "count/density")
-        return requests.get(f"{OHSOME_API}/elements/{aggregation}", params)
+        return requests.get(f"{OHSOME_API}/elements/{aggregation}", params,
+                            timeout=TIMEOUT_REQUESTS)
 
     def plot_results(self, data: List[Tuple[str, float]], title: str, y_label: str) -> None:
         """

diff --git a/analyses/modules/analysis_landmarks.py b/analyses/modules/analysis_landmarks.py
@@ -43,7 +43,7 @@
 from analyses.modules.analysis_base import Analysis
 from helper_modules.bbox_utils import Bbox
 from helper_modules.progress import update_progress
-from constants import STATUS_UPDATES_ANALYSES, OHSOME_API
+from constants import STATUS_UPDATES_ANALYSES, OHSOME_API, TIMEOUT_REQUESTS
 
 
 class LandmarkAnalysis(Analysis):
@@ -149,7 +149,7 @@ def add_density_for_tag(self, key: Optional[str], value: Optional[str],
                 filter_param += f" and {key}=*"
         params.update({"filter": filter_param})
 
-        result = requests.get(OHSOME_API + url, params)
+        result = requests.get(OHSOME_API + url, params, timeout=TIMEOUT_REQUESTS)
         result = json.loads(result.text)["result"][0]
         self.density_sum += result["value"]
         self.density[category] += result["value"]
@@ -179,7 +179,7 @@ def add_density_for_tag_aggregated(self, key: str, values_categories: Dict[str,
                   "groupByValues": ", ".join(values_categories.keys())
                   }
 
-        result = requests.get(OHSOME_API + url, params)
+        result = requests.get(OHSOME_API + url, params, timeout=TIMEOUT_REQUESTS)
         result = json.loads(result.text)["groupByResult"]
 
         for group_by_result in result:

diff --git a/analyses/run_analyses.py b/analyses/run_analyses.py
@@ -25,7 +25,7 @@
 from helper_modules.progress import update_progress
 from constants import (STATUS_UPDATES_ANALYSES, OHSOME_API,
                        STATUS_ERROR_OHSOME_NOT_AVAILABLE,
-                       TIMEOUT_OHSOME_METADATA)
+                       TIMEOUT_REQUESTS)
 
 
 def run_for_single_bbox(bbox: Bbox,
@@ -60,7 +60,8 @@ def run_for_single_bbox(bbox: Bbox,
               "time": time_str_whole_time
               }
 
-    result = json.loads(requests.get(OHSOME_API + "/elementsFullHistory/bbox", params).text)
+    result = json.loads(requests.get(OHSOME_API + "/elementsFullHistory/bbox", params,
+                        timeout=TIMEOUT_REQUESTS).text)
     if "status" in result.keys() and result["status"] == 503:
         update_progress(result_path=status_path, update=STATUS_ERROR_OHSOME_NOT_AVAILABLE)
         return
@@ -121,7 +122,7 @@ def run_preparations_and_analyses(bboxes_input: List[Bbox], output_path: str) ->
     :param output_path: The location where the analyses' output files will be saved
     """
     try:
-        metadata = requests.get(OHSOME_API + "/metadata", timeout=TIMEOUT_OHSOME_METADATA).json()
+        metadata = requests.get(OHSOME_API + "/metadata", timeout=TIMEOUT_REQUESTS).json()
     except requests.exceptions.ReadTimeout:
         print("ERROR Timeout: Ohsome API not available")
         for bbox in bboxes_input:

diff --git a/constants.py b/constants.py
@@ -15,7 +15,8 @@
 TEMPLATE_ANALYSES = "analyses.html"
 TEMPLATE_ANALYSES_RESULTS = "analyses_result.html"
 
-TIMEOUT_OHSOME_METADATA = 50  # seconds
+TIMEOUT_REQUESTS = 50  # seconds, see
+#                        https://requests.readthedocs.io/en/stable/user/advanced/#timeouts
 
 # Analyses: ---------------------------------------------------------------------------------------
 STATUS_UPDATES_ANALYSES = MappingProxyType({