Use a 'leaky bucket' rate limiting algorithm using aiolimiter.AsyncLimiter.#14
Open
xprl-gjf wants to merge 1 commit intoFilipByren:mainfrom
Open
Use a 'leaky bucket' rate limiting algorithm using aiolimiter.AsyncLimiter.#14xprl-gjf wants to merge 1 commit intoFilipByren:mainfrom
xprl-gjf wants to merge 1 commit intoFilipByren:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The current implementation introduces a delay between each request irrespective of whether or not the rate limit has been reached.
A more efficient algorithm is the 'leaky bucket' implementation of aiolimiter.AsyncLimiter. This supports "bursting' where the rate limiter has no effect until the limit has been reached. Only then are subsequent requests delayed.
Note that the existing functionality - a regular delay between all requests - can still be achieved by applying a rate limiter with a count of 1, e.g.
client = OctopusApi(limiter=AsyncLimiter(1, 1/requests_per_second))A further advantage of this code is that the same
AsyncLimiterinstance can be shared across multiple OctopusApi sessions, ensuring consistent application of rate limiting if a series of calls are made to various URLs on the same API service, using multiple OctopusApi sessions.