voussoir/voussoirkit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add docstrings to Backoff class's methods.

Browse source
This commit is contained in:
voussoir 2021-05-03 18:32:18 -07:00
parent 60abcbc8e3
commit 12a0c81819
No known key found for this signature in database
GPG key ID: 5F7554F8C26DACCB
1 changed files with 16 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
voussoirkit/backoff.py
View file

@ -26,22 +26,35 @@ class Backoff:
self.max = max self.max = max
def current(self): def current(self):
'''
Return the current backoff value without advancing.
'''
y = self._calc() y = self._calc()
if self.max is not None: if self.max is not None:
y = min(y, self.max) y = min(y, self.max)
return y return y
def next(self): def next(self):
'''
Return the current backoff value, then advance x.
'''
y = self.current() y = self.current()
self.x += 1 self.x += 1
return y return y
def rewind(self, steps):
self.x = max(0, self.x - steps)
def reset(self): def reset(self):
'''
Reset x to 0.
'''
self.x = 0 self.x = 0
def rewind(self, steps):
'''
Subtract this many steps from x, to ease up the backoff without
entirely resetting.
'''
self.x = max(0, self.x - steps)
#################################################################################################### ####################################################################################################
class Exponential(Backoff): class Exponential(Backoff):