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

Alphabetize docstring.

Browse source
This commit is contained in:
voussoir 2022-01-09 16:55:15 -08:00
parent c914d4236e
commit e5114ecf2c
No known key found for this signature in database
GPG key ID: 5F7554F8C26DACCB
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
voussoirkit/ratelimiter.py
View file

@ -20,14 +20,6 @@ class Ratelimiter:
allowance:
Our spending balance per `period` seconds.
period:
The number of seconds over which we can perform `allowance`
operations.
operation_cost:
The default amount to remove from our balance after each operation.
Pass a `cost` parameter to `self.limit` to use a nondefault value.
mode:
'sleep':
If we do not have the balance for an operation, sleep until we
@ -37,6 +29,14 @@ class Ratelimiter:
If we do not have the balance for an operation, do nothing and
return False. Otherwise subtract the cost and return True.
operation_cost:
The default amount to remove from our balance after each operation.
Pass a `cost` parameter to `self.limit` to use a nondefault value.
period:
The number of seconds over which we can perform `allowance`
operations.
Although (allowance=1, period=1) and (allowance=30, period=30) can both
be described as "once per second", the latter allows for much greater
burstiness of operation. You could spend the whole allowance in a