Add helper for poll/sleep loops with timeout

The Sleeper class is a helper that makes poll/sleep loops with timeout
easier to write. It takes care of edge cases and does not oversleep
timeout deadline.

Related: https://pagure.io/freeipa/issue/8521
Signed-off-by: Christian Heimes <cheimes@redhat.com>
Reviewed-By: Rob Crittenden <rcritten@redhat.com>
This commit is contained in:
Christian Heimes committed 2020-09-30 09:52:08 +02:00
1 parent 1684b0f2c3
commit aa67177f4c
2 files changed
+97

No files matched your search

+63
View File
@@ -1654,3 +1654,66 @@ def datetime_from_utctimestamp(t, units=1):
raise TypeError(t)
epoch = datetime.datetime(1970, 1, 1, tzinfo=datetime.timezone.utc)
return epoch + datetime.timedelta(seconds=v // units)
class Sleeper:
"""Helper for time.sleep() loop with timeout
A sleeper object sleeps *sleep* seconds when it is called. Close to its
deadline it sleeps shorter to not oversleep the *timeout* deadline. A
sleeper object is *True* and returns *True* before it reaches *timeout*
deadline. After its deadline a sleeper raises the exception object/class
in *raises*. If *raises* is not given, it returns False instead.
sleep = Sleeper(sleep=1, timeout=60, raises=TimeoutError)
while True:
do_something()
sleep()
sleep = Sleeper(sleep=0.5, timeout=60)
while True:
try:
do_something
except Exception:
# sleep duration can be extended
sleep(10)
else:
if not sleep():
log.info("timeout")
break
longsleep = Sleeper(sleep=1, timeout=sys.maxsize)
"""
multiplier = 2
def __init__(self, *, sleep, timeout, raises=None):
if timeout <= 0:
raise ValueError(f"invalid timeout {timeout}")
if sleep < 0.01:
raise ValueError(f"sleep duration {sleep} is too short.")
self.timeout = timeout
self.sleep = sleep
self.raises = raises
self.deadline = time.monotonic() + self.timeout
def __bool__(self):
return time.monotonic() < self.deadline
def __call__(self, extended_sleep=None):
now = time.monotonic()
if now >= self.deadline:
if self.raises is not None:
raise self.raises
else:
return False
# caller can instruct sleeper to sleep longer
dur = self.sleep if extended_sleep is None else extended_sleep
# but don't sleep over deadline
dur = min(self.deadline - now, dur)
time.sleep(dur)
return True
+34
View File
@@ -28,6 +28,7 @@ import socket
import sys
import tempfile
import textwrap
import time
import pytest
import six
@@ -604,3 +605,36 @@ def test_config_replace_variables(tempdir):
with open(conffile, 'r') as f:
newconf = f.read()
assert newconf == expected
def test_sleeper():
start = time.monotonic()
sleep = ipautil.Sleeper(sleep=0.020, timeout=0.200, raises=TimeoutError)
assert sleep
with pytest.raises(TimeoutError):
while True:
sleep()
dur = time.monotonic() - start
assert not sleep
assert dur >= 0.2
# should finish in 0.2, accept longer time in case the system is busy
assert dur < 1.
start = time.monotonic()
loops = 0
sleep = ipautil.Sleeper(sleep=0.020, timeout=0.200)
assert sleep
while True:
if not sleep():
break
loops += 1
dur = time.monotonic() - start
assert not sleep
assert dur >= 0.2
assert dur < 1.
# should be 10 loops, accept 9 for slow systems
assert loops in {9, 10}