Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexferl/justbackoff
Simple backoff algorithm in Python
https://github.com/alexferl/justbackoff
backoff backoff-algorithm exponential-backoff
Last synced: 3 months ago
JSON representation
Simple backoff algorithm in Python
- Host: GitHub
- URL: https://github.com/alexferl/justbackoff
- Owner: alexferl
- License: mit
- Created: 2016-05-26T00:52:20.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-07T03:27:16.000Z (8 months ago)
- Last Synced: 2024-10-05T01:05:56.525Z (3 months ago)
- Topics: backoff, backoff-algorithm, exponential-backoff
- Language: Python
- Homepage:
- Size: 26.4 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# justbackoff [](https://travis-ci.com/alexferl/justbackoff) [](https://codecov.io/gh/alexferl/justbackoff)
A simple backoff algorithm for Python 3.7+.
### Install
```shell script
$ pip install justbackoff
```
### Usage
Backoff is a counter. It starts at `min_ms`. After every call to `duration()`,
it is multiplied by `factor`. It is capped at `max_ms`.
It returns to `min_ms` on every call to `reset()`.
`jitter` adds randomness ([see below](#example-using-jitter)).
---
#### Simple example
``` python
from justbackoff import Backoff
b = Backoff(min_ms=100, max_ms=10000, factor=2, jitter=False)
print(b.duration())
print(b.duration())
print(b.duration())
print("Reset!")
b.reset()
print(b.duration())
```
``` shell script
0.1
0.2
0.4
Reset!
0.1
```
---
#### Example using `socket` package
``` python
import socket
import time
from justbackoff import Backoff
sock = socket.socket()
b = Backoff()
while True:
try:
sock.connect(("127.0.0.1", 1337))
except Exception as e:
d = b.duration()
print("{}, reconnecting in {} seconds".format(e, d))
time.sleep(d)
continue
b.reset()
sock.send("Hello, world!")
sock.close()
```
---
#### Example using `jitter`
Enabling `jitter` adds some randomization to the backoff durations.
[See Amazon's writeup of performance gains using jitter](http://www.awsarchitectureblog.com/2015/03/backoff.html).
Seeding is not necessary but doing so gives repeatable results.
```python
import random
from justbackoff import Backoff
b = Backoff(min_ms=100, max_ms=10000, factor=2, jitter=True)
random.seed(42)
print(b.duration())
print(b.duration())
print(b.duration())
print("Reset!")
b.reset()
print(b.duration())
print(b.duration())
print(b.duration())
```
``` shell script
0.1
0.102501075522
0.182508795511
Reset!
0.1
0.173647121416
0.303009846227
```
#### Credits
Ported from Go [backoff](https://github.com/jpillora/backoff)