musicbrainzngs.musicbrainz._rate_limit Class Reference

Inheritance diagram for musicbrainzngs.musicbrainz._rate_limit:

Collaboration diagram for musicbrainzngs.musicbrainz._rate_limit:

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

__call__()

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

Definition at line 380 of file musicbrainz.py.

_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__().

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

Definition at line 358 of file musicbrainz.py.

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

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

Definition at line 360 of file musicbrainz.py.

Referenced by musicbrainzngs.musicbrainz._rate_limit.__call__(), and musicbrainzngs.musicbrainz._rate_limit._update_remaining().

---

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

• mythtv/programs/scripts/metadata/Music/musicbrainzngs/musicbrainz.py