l.b.e.g.IGitHubRateLimit(Interface) : interface documentation

Part of lp.bugs.externalbugtracker.github View In Hierarchy

Interface for rate-limit tracking for the GitHub Issues API.
Method checkLimit A context manager that checks the remote host's rate limit.
Method clearCache Forget any cached rate limits.
def checkLimit(url, token=None):
A context manager that checks the remote host's rate limit.
ParametersurlThe URL being requested.
tokenIf not None, an OAuth token to use as authentication to the remote host when asking it for the current rate limit.
ReturnsA suitable Authorization header (from the context manager's __enter__ method).
RaisesGitHubExceededRateLimitif the rate limit was exceeded.
def clearCache():
Forget any cached rate limits.
API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.