omnata-plugin-runtime 0.4.5a100__py3-none-any.whl → 0.4.6a101__py3-none-any.whl

omnata_plugin_runtime/rate_limiting.py

@@ -8,7 +8,7 @@ import re
 import threading
 from email.utils import parsedate_to_datetime
 from logging import getLogger
-from typing import List, Literal, Optional, Dict, Tuple
+from typing import Any, List, Literal, Optional, Dict, Tuple
 import requests
 from pydantic import Field, root_validator
 from pydantic.json import pydantic_encoder
@@ -349,6 +349,32 @@ class RetryLaterException(Exception):
         self.message = message
         super().__init__(self.message)
 
+class RetryWithLogging(Retry):
+    """
+        Adding extra logs before making a retry request     
+    """
+    def __call__(self, *args: Any, thread_cancellation_token:threading.Event, **kwargs: Any) -> Any:
+        self.thread_cancellation_token = thread_cancellation_token
+        return super().__call__(*args, **kwargs)
+    
+    def sleep_for_retry(self, response=None):
+        retry_after = self.get_retry_after(response)
+        if retry_after:
+            logger.info(f"Retrying after {retry_after} seconds due to Retry-After header")
+            if self.thread_cancellation_token.wait(retry_after):
+                raise InterruptedWhileWaitingException(message="The sync was interrupted while waiting for rate limiting to expire")
+            return True
+        return False
+
+    def _sleep_backoff(self):
+        backoff = self.get_backoff_time()
+        if backoff <= 0:
+            return
+        logger.info(f"Retrying after {backoff} seconds due to backoff time")
+        if self.thread_cancellation_token.wait(backoff):
+            raise InterruptedWhileWaitingException(message="The sync was interrupted while waiting for rate limiting to expire")
+
+
 class RateLimitedSession(requests.Session):
     """
     Creates a requests session that will automatically handle rate limiting.
@@ -366,7 +392,7 @@ class RateLimitedSession(requests.Session):
         self.thread_cancellation_token = thread_cancellation_token
         self.statuses_to_include = statuses_to_include
 
-        retry_strategy = Retry(
+        retry_strategy = RetryWithLogging(
             total=max_retries,
             backoff_factor=backoff_factor,
             status_forcelist=statuses_to_include,
@@ -398,7 +424,7 @@ class RateLimitedSession(requests.Session):
     def request(self, method, url, **kwargs):
         while True:
             response = super().request(method, url, **kwargs)
-            
+            # TODO: this is probably all redundant as the Retry object should handle this at a lower level (urllib3)
             if response.status_code in self.statuses_to_include:
                 if 'Retry-After' in response.headers:
                     retry_after = response.headers['Retry-After']

{omnata_plugin_runtime-0.4.5a100.dist-info → omnata_plugin_runtime-0.4.6a101.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-runtime
-Version: 0.4.5a100
+Version: 0.4.6a101
 Summary: Classes and common runtime components for building and running Omnata Plugins
 Author: James Weakley
 Author-email: james.weakley@omnata.com

{omnata_plugin_runtime-0.4.5a100.dist-info → omnata_plugin_runtime-0.4.6a101.dist-info}/RECORD

@@ -5,8 +5,8 @@ omnata_plugin_runtime/forms.py,sha256=pw_aKVsXSz47EP8PFBI3VDwdSN5IjvZxp8JTjO1V13
 omnata_plugin_runtime/logging.py,sha256=bn7eKoNWvtuyTk7RTwBS9UARMtqkiICtgMtzq3KA2V0,3272
 omnata_plugin_runtime/omnata_plugin.py,sha256=UJZNTcG6s5APZ7EIOYc5N4bFiyFEq3ekbSP6EK7tCBY,108065
 omnata_plugin_runtime/plugin_entrypoints.py,sha256=JAGEdVcy9QEXv7TO5zt7co64LTP8nqGusOc0sJG9GtU,29149
-omnata_plugin_runtime/rate_limiting.py,sha256=29Hjsr0i1rE8jERVdIFGINfQfp_kI3PDft-IM_ZxvCA,21509
-omnata_plugin_runtime-0.4.5a100.dist-info/LICENSE,sha256=IMF9i4xIpgCADf0U-V1cuf9HBmqWQd3qtI3FSuyW4zE,26526
-omnata_plugin_runtime-0.4.5a100.dist-info/METADATA,sha256=2aKHJ52tkpcD2jtVtFT77_-53YJz08SUDl2HUH2h2cU,1642
-omnata_plugin_runtime-0.4.5a100.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-omnata_plugin_runtime-0.4.5a100.dist-info/RECORD,,
+omnata_plugin_runtime/rate_limiting.py,sha256=9Cv0sGOFnQaF-SQJaqJIWGAzkTcBGaJ1USZU5khhQIQ,22798
+omnata_plugin_runtime-0.4.6a101.dist-info/LICENSE,sha256=IMF9i4xIpgCADf0U-V1cuf9HBmqWQd3qtI3FSuyW4zE,26526
+omnata_plugin_runtime-0.4.6a101.dist-info/METADATA,sha256=zUn9jISlyAuv1aU8oCAKgG1bTUrWgyYIJ-SEg9fOA_M,1642
+omnata_plugin_runtime-0.4.6a101.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+omnata_plugin_runtime-0.4.6a101.dist-info/RECORD,,