yowsup_celery package

Submodules

yowsup_celery.celery module

class yowsup_celery.celery.YowCelery(*args, **kwargs)

Bases: celery.app.base.Celery

yowsup_celery.exceptions module

exception yowsup_celery.exceptions.AuthenticationError

Bases: yowsup_celery.exceptions.YowsupCeleryError

Raised when YowsupStack cannot authenticate with the whatsapp. This means the password for number is incorrect. Check if registration was correct

exception yowsup_celery.exceptions.ConfigurationError

Bases: yowsup_celery.exceptions.YowsupCeleryError

Raised when YowsupStack detects and error in configurations

exception yowsup_celery.exceptions.ConnectionError

Bases: yowsup_celery.exceptions.YowsupCeleryError

Raised when CeleryLayer tries to perform an action which requires to be connected to WhatsApp

exception yowsup_celery.exceptions.UnexpectedError

Bases: yowsup_celery.exceptions.YowsupCeleryError

Raised for unknown or unexpected errors.

exception yowsup_celery.exceptions.YowsupCeleryError

Bases: exceptions.Exception

yowsup_celery.layer module

class yowsup_celery.layer.CeleryLayer

Bases: yowsup.layers.interface.interface.YowInterfaceLayer

Layer to be on the top of the Yowsup Stack. :ivar bool connected: connected or not connected to whatsapp :ivar YowLayerInterface interface: layer interface

connect()

disconnect(*args, **kwargs)

do_send_audio(file_path, url, to, ip=None, caption=None)

do_send_image(file_path, url, to, ip=None, caption=None)

normalize_jid(number)

on_ack(*args, **kwargs)

Callback function when receiving an ack for a sent message from whatsapp

on_disconnected(*args, **kwargs)

Callback function when receiving a disconnection event

on_failure(entity)

Callback function when there is a failure in a connection to whatsapp server

on_message(*args, **kwargs)

Callback function when receiving message from whatsapp server

on_receipt(*args, **kwargs)

Callback function when receiving receipt message from whatsapp

on_request_upload_result(jid, path, result_request_upload_iq_protocol_entity, request_upload_iq_protocol_entity, caption=None)

on_success(success_protocol_entity)

Callback when there is a successful connection to whatsapp server

on_upload_error(file_path, jid, url)

on_upload_progress(file_path, jid, url, progress)

send_audio(*args, **kwargs)

Send audio message :param str number: phone number with cc (country code) :param str path: audio file path

send_image(*args, **kwargs)

Send image message :param str number: phone number with cc (country code) :param str path: image file path

send_location(*args, **kwargs)

Send location message :param str number: phone number with cc (country code) :param str name: indentifier for the location :param str url: location url :param str longitude: location longitude :param str latitude: location latitude

send_message(*args, **kwargs)

Send message :param str number: phone number with cc (country code) :param str content: body text of the message

send_vcard(*args, **kwargs)

Send location message :param str number: phone number with cc (country code) :param str name: indentifier for the location :param str data: vcard format i.e. BEGIN:VCARD VERSION:3.0 N:;Home;;; FN:Home item1.TEL:+34 911234567 item1.X-ABLabel:Home END:VCARD

yowsup_celery.layer.connection_required(f)

yowsup_celery.layer_interface module

class yowsup_celery.layer_interface.CeleryLayerInterface(layer)

Bases: yowsup.layers.YowLayerInterface

connect()

connected()

disconnect()

send_audio(number, path)

send_image(number, path)

send_location(number, name, url, latitude, longitude)

send_message(number, content)

send_vcard(number, name, data)

yowsup_celery.stack module

class yowsup_celery.stack.YowsupStack(credentials, encryption=False, top_layers=None)

Bases: yowsup.stacks.yowstack.YowStack

Gateway for Yowsup in a client API way

Variables:

• listening (bool) – asyncore loop task in execution
• detached_queue (Queue) – Queue with callbacks to execute after

:ivar YowLayerInterface facade:layer interface on top of stack disconnection

asynloop(auto_connect=False, timeout=10, detached_delay=0.2)

Non-blocking event loop consuming messages until connection is lost,

or shutdown is requested.

Parameters:

• timeout (int) – number of secs for asyncore timeout
• detached_delay (float) – float secs to sleep when exiting asyncore loop and execution detached queue callbacks

cleanup()

execDetached(fn)

yowsup_celery.steps module

class yowsup_celery.steps.YowsupStep(worker, login, config, unmoxie, **kwargs)

Bases: celery.bootsteps.StartStopStep

name = u'yowsup_celery.steps.YowsupStep'

stop(worker)

yowsup_celery.tasks module

class yowsup_celery.tasks.YowsupTask

Bases: celery.app.task.Task

abstract = True

default_retry_delay = 0.5

facade

stack

yowsup_celery.tasks.listening_required(f)

yowsup_celery.utils module

yowsup_celery.utils.import_string(dotted_path)

Import a dotted module path and return the attribute/class designated by the last name in the path. Raise ImportError if the import failed.

Module contents