MythTV  master
Public Member Functions | Public Attributes | Private Member Functions | List of all members
musicbrainzngs.musicbrainz._rate_limit Class Reference
Inheritance diagram for musicbrainzngs.musicbrainz._rate_limit:
Inheritance graph
[legend]
Collaboration diagram for musicbrainzngs.musicbrainz._rate_limit:
Collaboration graph
[legend]

Public Member Functions

def __init__ (self, fun)
 
def __call__ (self, *args, **kwargs)
 

Public Attributes

 fun
 
 last_call
 
 lock
 
 remaining_requests
 

Private Member Functions

def _update_remaining (self)
 

Detailed Description

A decorator that limits the rate at which the function may be
called. The rate is controlled by the `limit_interval` and
`limit_requests` global variables.  The limiting is thread-safe;
only one thread may be in the function at a time (acts like a
monitor in this sense). The globals must be set before the first
call to the limited function.

Definition at line 348 of file musicbrainz.py.

Constructor & Destructor Documentation

◆ __init__()

def musicbrainzngs.musicbrainz._rate_limit.__init__ (   self,
  fun 
)

Definition at line 356 of file musicbrainz.py.

Member Function Documentation

◆ _update_remaining()

def musicbrainzngs.musicbrainz._rate_limit._update_remaining (   self)
private
Update remaining requests based on the elapsed time since
they were last calculated.

Definition at line 362 of file musicbrainz.py.

Referenced by musicbrainzngs.musicbrainz._rate_limit.__call__().

◆ __call__()

def musicbrainzngs.musicbrainz._rate_limit.__call__ (   self,
args,
**  kwargs 
)

Definition at line 380 of file musicbrainz.py.

Member Data Documentation

◆ fun

musicbrainzngs.musicbrainz._rate_limit.fun

Definition at line 357 of file musicbrainz.py.

Referenced by musicbrainzngs.musicbrainz._rate_limit.__call__().

◆ last_call

musicbrainzngs.musicbrainz._rate_limit.last_call

◆ lock

musicbrainzngs.musicbrainz._rate_limit.lock

Definition at line 359 of file musicbrainz.py.

Referenced by musicbrainzngs.musicbrainz._rate_limit.__call__().

◆ remaining_requests

musicbrainzngs.musicbrainz._rate_limit.remaining_requests

The documentation for this class was generated from the following file: