fix(retry decorator): allow retry if retries = 1

IATkachenko · IATkachenko · commit d139814c3705 · 2022-01-13T16:16:05.000+03:00
if we use @Retry(retries=1) we assume that we will try to run function and retry one more time. But range(1) will generate just single element, and actually we will not have chance to retry. By default, we had "try" + "2 retries". To keep it we should decrease default retries value.
diff --git a/tests/unit/test_tion.py b/tests/unit/test_tion.py
@@ -21,23 +21,23 @@ def tearDown(self):
         self.patch.stop()
 
     def test_success_single_try(self):
-        @retry(1)
+        @retry(retries=0)
         def a():
             self.count += 1
             return "expected_result"
         self.assertEqual(a(), "expected_result")
         self.assertEqual(self.count, 1)
 
     def test_success_two_tries(self):
-        @retry(2)
+        @retry(retries=1)
         def a():
             self.count += 1
             return "expected_result"
         self.assertEqual(a(), "expected_result")
         self.assertEqual(self.count, 1)
 
     def test_failure_two_tries(self):
-        @retry(2)
+        @retry(retries=1)
         def a():
             self.count += 1
             raise Exception()
@@ -48,7 +48,7 @@ def a():
             self.assertEqual(self.count, 2)
 
     def test_success_after_third_try(self):
-        @retry(5)
+        @retry(retries=5)
         def a():
             self.count += 1
             if self.count == 3:
@@ -75,7 +75,7 @@ def a():
         self.assertGreaterEqual(end-start, t_delay)
 
     def test_debug_log_level(self):
-        @retry(1)
+        @retry(retries=0)
         def debug():
             pass
 
@@ -88,7 +88,7 @@ def debug():
 
     def test_info_log_level(self):
         """only debug and info messages if we have just BTLEDisconnectError and BTLEInternalError"""
-        @retry(2)
+        @retry(retries=1)
         def info(_e):
             if self.count == 0:
                 self.count += 1
@@ -107,7 +107,7 @@ def info(_e):
 
     def test_warning_log_level(self):
         """Make sure that we have warnings for exception, but have no critical if all goes well finally"""
-        @retry(2)
+        @retry(retries=1)
         def warning():
             if self.count == 0:
                 self.count += 1
@@ -122,7 +122,7 @@ def warning():
 
     def test_critical_log_level(self):
         """Make sure that we have message at critical level if all goes bas"""
-        @retry(1)
+        @retry(retries=0)
         def critical():
             raise Exception
 
@@ -134,7 +134,7 @@ def critical():
             log_mock.critical.assert_called()
 
     def test_MaxTriesExceededError(self):
-        @retry(1)
+        @retry(retries=0)
         def e():
             raise Exception
 
diff --git a/tion_btle/tion.py b/tion_btle/tion.py
@@ -14,10 +14,10 @@ class MaxTriesExceededError(Exception):
     pass
 
 
-def retry(retries: int = 3, delay: int = 0):
+def retry(retries: int = 2, delay: int = 0):
     def decor(f: Callable):
         def wrapper(*args, **kwargs):
-            for i in range(retries):
+            for i in range(retries+1):
                 try:
                     _LOGGER.debug("Trying %d/%d: %s(args=%s,kwargs=%s)", i, retries, f.__name__, args, kwargs)
                     return f(*args, **kwargs)
