Reference

beanstalkc - A beanstalkd Client Library for Python

Core Classes

class beanstalkc.Connection(host='localhost', port=11300, parse_yaml=True, connect_timeout=None)

bury(jid, priority=2147483648)

Bury a job, by job id.

close()

Close connection to server.

connect()

Connect to beanstalkd server.

delete(jid)

Delete a job, by job id.

ignore(name)

Stop watching a given tube.

kick(bound=1)

Kick at most bound jobs into the ready queue.

pause_tube(name, delay)

Pause a tube for a given delay time, in seconds.

peek(jid)

Peek at a job. Returns a Job, or None.

peek_buried()

Peek at next buried job. Returns a Job, or None.

peek_delayed()

Peek at next delayed job. Returns a Job, or None.

peek_ready()

Peek at next ready job. Returns a Job, or None.

put(body, priority=2147483648, delay=0, ttr=120)

Put a job into the current tube. Returns job id.

release(jid, priority=2147483648, delay=0)

Release a reserved job back into the ready queue.

reserve(timeout=None)

Reserve a job from one of the watched tubes, with optional timeout in seconds. Returns a Job object, or None if the request times out.

stats()

Return a dict of beanstalkd statistics.

stats_job(jid)

Return a dict of stats about a job, by job id.

stats_tube(name)

Return a dict of stats about a given tube.

touch(jid)

Touch a job, by job id, requesting more time to work on a reserved job before it expires.

tubes()

Return a list of all existing tubes.

use(name)

Use a given tube.

using()

Return a list of all tubes currently being used.

watch(name)

Watch a given tube.

watching()

Return a list of all tubes being watched.

class beanstalkc.Job(conn, jid, body, reserved=True)

bury(priority=None)

Bury this job.

delete()

Delete this job.

release(priority=None, delay=0)

Release this job back into the ready queue.

stats()

Return a dict of stats about this job.

touch()

Touch this reserved job, requesting more time to work on it before it expires.

Exceptions

class beanstalkc.BeanstalkcException

class beanstalkc.UnexpectedResponse

class beanstalkc.CommandFailed

class beanstalkc.DeadlineSoon

class beanstalkc.SocketError