`pubsub` — Publish-Subscribe support (XEP-0060)¶

This subpackage provides client-side support for XEP-0060 publish-subscribe services.

New in version 0.6.

Using Publish-Subscribe¶

To start using PubSub services in your application, you have to load the PubSubClient into the client, using summon().

class aioxmpp.PubSubClient(client, **kwargs)¶

Client service implementing a Publish-Subscribe client. By loading it into a client, it is possible to subscribe to, publish to and otherwise interact with Publish-Subscribe nodes.

Note

Signal handlers attached to any of the signals below must accept arbitrary keyword arguments for forward compatibility. If any of the arguments is listed as positional in the signal signature, it is always present and handed as positional argument.

Subscriber use cases:

`get_default_config`(jid[, node])	Request the default configuration of a node.
`get_items`(jid, node, *[, max_items])	Request the most recent items from a node.
`get_items_by_id`(jid, node, ids)	Request specific items by their IDs from a node.
`get_subscription_config`(jid[, node, ...])	Request the current configuration of a subscription.
`get_subscriptions`(jid[, node])	Return all subscriptions of the local entity to a node.
`set_subscription_config`(jid, data[, node, ...])	Update the configuration of a subscription.
`subscribe`(jid[, node, subscription_jid, config])	Subscribe to a node.
`unsubscribe`(jid[, node, subscription_jid, subid])	Unsubscribe from a node.
`on_affiliation_update`	Fires when the affiliation with a node is updated.
`on_item_published`	Fires when a new item is published to a node to which we have a subscription.
`on_item_retracted`	Fires when an item is retracted from a node to which we have a subscription.
`on_node_deleted`	Fires when a node is deleted.
`on_subscription_update`	Fires when the subscription state is updated.

Publisher use cases:

`notify`(jid, node)	Notify all subscribers of a node without publishing an item.
`publish`(jid, node, payload, *[, id_])	Publish an item to a node.
`retract`(jid, node, id_, *[, notify])	Retract a previously published item from a node.

Owner use cases:

`change_node_affiliations`(jid, node, ...)	Update the affiliations at a node.
`change_node_subscriptions`(jid, node, ...)	Update the subscriptions at a node.
`create`(jid[, node])	Create a new node at a service.
`delete`(jid, node, *[, redirect_uri])	Delete an existing node.
`get_nodes`(jid[, node])	Request all nodes at a service or collection node.
`get_node_affiliations`(jid, node)	Return the affiliations of other jids at a node.
`get_node_subscriptions`(jid, node)	Return the subscriptions of other jids with a node.
`purge`(jid, node)	Delete all items from a node.

Meta-information about the service:

coroutine get_features(jid)¶

Return the features supported by a service.

Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service to query.
Returns:	Set of supported features
Return type:	set containing `Feature` enumeration members.

This simply uses service discovery to obtain the set of features and converts the features to Feature enumeration members. To get the full feature information, resort to using DiscoClient.query_info() directly on jid.

Features returned by the peer which are not valid pubsub features are not returned.

Subscribing, unsubscribing and listing subscriptions:

coroutine get_subscriptions(jid, node=None)¶

Return all subscriptions of the local entity to a node.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. node (`str`) – Name of the PubSub node to query.
	as returned by the service
Returns:	The subscriptions response from the service.
Return type:	:class:`.xso.Subscriptions.

If node is None, subscriptions on all nodes of the entity jid are listed.

coroutine subscribe(jid, node=None, *, subscription_jid=None, config=None)¶

Subscribe to a node.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. node (`str`) – Name of the PubSub node to subscribe to. subscription_jid (`aioxmpp.JID`) – The address to subscribe to the service. config (`Data`) – Optional configuration of the subscription
	as returned by the service
Returns:	The response from the server.
Return type:	`xso.Request`

By default, the subscription request will be for the bare JID of the client. It can be specified explicitly using the subscription_jid argument.

If the service requires it or if it makes sense for other reasons, the subscription configuration Data form can be passed using the config argument.

On success, the whole xso.Request object returned by the server is returned. It contains a xso.Subscription payload which has information on the nature of the subscription (it may be "pending" or "unconfigured") and the subid which may be required for other operations.

On failure, the corresponding XMPPError is raised.

coroutine unsubscribe(jid, node=None, *, subscription_jid=None, subid=None)¶

Unsubscribe from a node.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. node (`str`) – Name of the PubSub node to unsubscribe from. subscription_jid (`aioxmpp.JID`) – The address to subscribe from the service. subid (`str`) – Unique ID of the subscription to remove.
	as returned by the service

By default, the unsubscribe request will be for the bare JID of the client. It can be specified explicitly using the subscription_jid argument.

If available, the subid should also be specified.

If an error occurs, the corresponding XMPPError is raised.

Configuring subscriptions:

coroutine get_default_config(jid, node=None)¶

Request the default configuration of a node.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. node (`str`) – Name of the PubSub node to query.
	as returned by the service
Returns:	The default configuration of subscriptions at the node.
Return type:	`Data`

On success, the Data form is returned.

If an error occurs, the corresponding XMPPError is raised.

coroutine get_subscription_config(jid, node=None, *, subscription_jid=None, subid=None)¶

Request the current configuration of a subscription.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. node (`str`) – Name of the PubSub node to query. subscription_jid (`aioxmpp.JID`) – The address to query the configuration for. subid (`str`) – Unique ID of the subscription to query.
	as returned by the service
Returns:	The current configuration of the subscription.
Return type:	`Data`

By default, the request will be on behalf of the bare JID of the client. It can be overriden using the subscription_jid argument.

If available, the subid should also be specified.

On success, the Data form is returned.

If an error occurs, the corresponding XMPPError is raised.

coroutine set_subscription_config(jid, data, node=None, *, subscription_jid=None, subid=None)¶

Update the configuration of a subscription.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. data (`Data`) – The new configuration of the subscription. node (`str`) – Name of the PubSub node to modify. subscription_jid (`aioxmpp.JID`) – The address to modify the configuration for. subid (`str`) – Unique ID of the subscription to modify.
	as returned by the service

By default, the request will be on behalf of the bare JID of the client. It can be overriden using the subscription_jid argument.

If available, the subid should also be specified.

The configuration must be given as data as a Data instance.

If an error occurs, the corresponding XMPPError is raised.

Retrieving items:

coroutine get_items(jid, node, *, max_items=None)¶

Request the most recent items from a node.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. node (`str`) – Name of the PubSub node to query. max_items (`int` or `None`) – Number of items to return at most.
	as returned by the service
Returns:	The response from the server.
Return type:	`xso.Request`.

By default, as many as possible items are requested. If max_items is given, it must be a positive integer specifying the maximum number of items which is to be returned by the server.

Return the xso.Request object, which has a Items payload.

coroutine get_items_by_id(jid, node, ids)¶

Request specific items by their IDs from a node.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. node (`str`) – Name of the PubSub node to query. ids (`Iterable` of `str`) – The item IDs to return.
	as returned by the service
Returns:	The response from the service
Return type:	`xso.Request`

ids must be an iterable of str of the IDs of the items to request from the pubsub node. If the iterable is empty, ValueError is raised (as otherwise, the request would be identical to calling get_items() without max_items).

Return the xso.Request object, which has a Items payload.

Publishing and retracting items:

coroutine notify(jid, node)¶

Notify all subscribers of a node without publishing an item.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. node (`str`) – Name of the PubSub node to send a notify from.
	as returned by the service

“Publish” to the node at jid without any item. This merely fans out a notification. The exact semantics can be checked in XEP-0060.

coroutine publish(jid, node, payload, *, id_=None)¶

Publish an item to a node.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. node (`str`) – Name of the PubSub node to publish to. payload (`aioxmpp.xso.XSO`) – Registered payload to publish. id (`str` or `None`.) – Item ID to use for the item.
	as returned by the service
Returns:	The Item ID which was used to publish the item.
Return type:	`str` or `None`

Publish the given payload (which must be a aioxmpp.xso.XSO registered with xso.Item.registered_payload).

The item is published to node at jid. If id_ is given, it is used as the ID for the item. If an item with the same ID already exists at the node, it is replaced. If no ID is given, a ID is generated by the server.

Return the ID of the item as published (or None if the server does not inform us; this is unfortunately common).

coroutine retract(jid, node, id_, *, notify=False)¶

Retract a previously published item from a node.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. node (`str`) – Name of the PubSub node to send a notify from. id (`str`) – The ID of the item to retract. notify (`bool`) – Flag indicating whether subscribers shall be notified about the retraction.
	as returned by the service

Retract an item previously published to node at jid. id_ must be the ItemID of the item to retract.

If notify is set to true, notifications will be generated (by setting the notify attribute on the retraction request).

Manage nodes:

coroutine change_node_affiliations(jid, node, affiliations_to_set)¶

Update the affiliations at a node.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. node (`str`) – Name of the node to modify affiliations_to_set (`Iterable` of tuples consisting of the JID to affiliate and the affiliation to use.) – The affiliations to set at the node.
	as returned by the service

affiliations_to_set must be an iterable of pairs (jid, affiliation), where the jid indicates the JID for which the affiliation is to be set.

coroutine change_node_subscriptions(jid, node, subscriptions_to_set)¶

Update the subscriptions at a node.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. node (`str`) – Name of the node to modify subscriptions_to_set (`Iterable` of tuples consisting of the JID to (un)subscribe and the subscription level to use.) – The subscriptions to set at the node.
	as returned by the service

subscriptions_to_set must be an iterable of pairs (jid, subscription), where the jid indicates the JID for which the subscription is to be set.

coroutine create(jid, node=None)¶

Create a new node at a service.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. node (`str` or `None`) – Name of the PubSub node to create.
	as returned by the service
Returns:	The name of the created node.
Return type:	`str`

If node is None, an instant node is created (see XEP-0060). The server may not support or allow the creation of instant nodes.

Return the actual node identifier.

coroutine delete(jid, node, *, redirect_uri=None)¶

Delete an existing node.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. node (`str` or `None`) – Name of the PubSub node to delete. redirect_uri (`str` or `None`) – A URI to send to subscribers to indicate a replacement for the deleted node.
	as returned by the service

Optionally, a redirect_uri can be given. The redirect_uri will be sent to subscribers in the message notifying them about the node deletion.

coroutine get_nodes(jid, node=None)¶

Request all nodes at a service or collection node.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. node (`str` or `None`) – Name of the collection node to query
	as returned by the service
Returns:	The list of nodes at the service or collection node.
Return type:	`Sequence` of tuples consisting of the node name and its description.

Request the nodes available at jid. If node is not None, the request returns the children of the XEP-0248 collection node node. Make sure to check for the appropriate server feature first.

Return a list of tuples consisting of the node names and their description (if available, otherwise None). If more information is needed, use DiscoClient.get_items() directly.

Only nodes whose jid match the jid are returned.

coroutine get_node_affiliations(jid, node)¶

Return the affiliations of other jids at a node.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. node (`str`) – Name of the node to query
	as returned by the service
Returns:	The response from the service.
Return type:	`xso.OwnerRequest`

The affiliations are returned as xso.OwnerRequest instance whose payload is a xso.OwnerAffiliations instance.

coroutine get_node_subscriptions(jid, node)¶

Return the subscriptions of other jids with a node.

Raises aioxmpp.errors.XMPPError:
Parameters:	jid (`aioxmpp.JID`) – Address of the PubSub service. node (`str`) – Name of the node to query
	as returned by the service
Returns:	The response from the service.
Return type:	`xso.OwnerRequest`

The subscriptions are returned as xso.OwnerRequest instance whose payload is a xso.OwnerSubscriptions instance.

coroutine purge(jid, node)¶

Delete all items from a node.

Parameters:	jid – JID of the PubSub service node (`str`) – Name of the PubSub node

Requires xso.Feature.PURGE.

Receiving notifications:

signal on_item_published(jid, node, item, *, message=None)¶

Fires when a new item is published to a node to which we have a subscription.

The node at which the item has been published is identified by jid and node. item is the xso.EventItem payload.

message is the Message which carried the notification. If a notification message contains more than one published item, the event is fired for each of the items, and message is passed to all of them.

signal on_item_retracted(jid, node, id_, *, message=None)¶

Fires when an item is retracted from a node to which we have a subscription.

The node at which the item has been retracted is identified by jid and node. id_ is the ID of the item which has been retract.

message is the Message which carried the notification. If a notification message contains more than one retracted item, the event is fired for each of the items, and message is passed to all of them.

signal on_node_deleted(jid, node, *, redirect_uri=None, message=None)¶

Fires when a node is deleted. jid and node identify the node.

If the notification included a redirection URI, it is passed as redirect_uri. Otherwise, None is passed for redirect_uri.

message is the Message which carried the notification.

signal on_affiliation_update(jid, node, affiliation, *, message=None)¶

Fires when the affiliation with a node is updated.

jid and node identify the node for which the affiliation was updated. affiliation is the new affiliaton.

message is the Message which carried the notification.

signal on_subscription_update(jid, node, state, *, subid=None, message=None)¶

Fires when the subscription state is updated.

jid and node identify the node for which the subscription was updated. subid is optional and if it is not None it is the affected subscription id. state is the new subscription state.

This event can happen in several cases, for example when a subscription request is approved by the node owner or when a subscription is cancelled.

message is the Message which carried the notification.s

Changed in version 0.8: This class was formerly known as aioxmpp.pubsub.Service. It is still available under that name, but the alias will be removed in 1.0.

class aioxmpp.pubsub.Service¶: Alias of PubSubClient.

Deprecated since version 0.8: The alias will be removed in 1.0.

XSOs¶

Registering payloads¶

PubSub payloads are must be registered at several places, so there is a short-hand function to handle that:

aioxmpp.pubsub.xso.as_payload_class(cls)[source]¶

Register the given class cls as Publish-Subscribe payload on both Item and EventItem.

Return the class, to allow this to be used as decorator.

Features¶

class aioxmpp.pubsub.xso.Feature[source]¶

Generic namespace¶

The top-level XSO is Request. Below that, several different XSOs are allowed, which are listed below the documentation of Request in alphabetical order.

class aioxmpp.pubsub.xso.Request(payload=None)[source]¶

This XSO represents the <pubsub/> IQ payload from the generic pubsub namespace (http://jabber.org/protocol/pubsub). It can carry different types of payload.

payload¶

This is the generic payload attribute. It supports the following classes:

`Affiliations`([affiliations, node])
`Create`(args, *kwargs)
`Default`(*[, node, data])
`Items`(node[, subid, max_items])
`Publish`(args, *kwargs)
`Retract`(args, *kwargs)
`Subscribe`(jid[, node])
`Subscription`(jid[, node, subid, subscription])
`Subscriptions`(*[, subscriptions, node])
`Unsubscribe`(jid[, node, subid])

options¶

As Options may both be used independently and along with another payload, they have their own attribute.

Independent of their use, Options objects are always available here. If they are used without another payload, the payload attribute is None.

configure¶

As Configure may both be used independently and along with another payload, it has its own attribute.

Independent of their use, Configure objects are always available here. If they are used without another payload, the payload attribute is None.

class aioxmpp.pubsub.xso.Affiliation(affiliation, node=None)[source]¶

class aioxmpp.pubsub.xso.Affiliations(affiliations=[], node=None)[source]¶

class aioxmpp.pubsub.xso.Configure(*args, **kwargs)[source]¶

class aioxmpp.pubsub.xso.Create(*args, **kwargs)[source]¶

class aioxmpp.pubsub.xso.Default(*, node=None, data=None)[source]¶

class aioxmpp.pubsub.xso.Item(id_=None)[source]¶

class aioxmpp.pubsub.xso.Items(node, subid=None, max_items=None)[source]¶

class aioxmpp.pubsub.xso.Options(jid, node=None, subid=None)[source]¶

class aioxmpp.pubsub.xso.Publish(*args, **kwargs)[source]¶

class aioxmpp.pubsub.xso.Retract(*args, **kwargs)[source]¶

class aioxmpp.pubsub.xso.Subscribe(jid, node=None)[source]¶

class aioxmpp.pubsub.xso.SubscribeOptions(*args, **kwargs)[source]¶

class aioxmpp.pubsub.xso.Subscription(jid, node=None, subid=None, *, subscription=None)[source]¶

class aioxmpp.pubsub.xso.Subscriptions(*, subscriptions=[], node=None)[source]¶

class aioxmpp.pubsub.xso.Unsubscribe(jid, node=None, subid=None)[source]¶

Owner namespace¶

The top-level XSO is OwnerRequest. Below that, several different XSOs are allowed, which are listed below the documentation of OwnerRequest in alphabetical order.

class aioxmpp.pubsub.xso.OwnerRequest(payload)[source]¶

class aioxmpp.pubsub.xso.OwnerAffiliation(jid, affiliation)[source]¶

class aioxmpp.pubsub.xso.OwnerAffiliations(node, *, affiliations=[])[source]¶

class aioxmpp.pubsub.xso.OwnerConfigure(*args, **kwargs)[source]¶

class aioxmpp.pubsub.xso.OwnerDefault(*args, **kwargs)[source]¶

class aioxmpp.pubsub.xso.OwnerDelete(node, *, redirect_uri=None)[source]¶

class aioxmpp.pubsub.xso.OwnerPurge(node)[source]¶

class aioxmpp.pubsub.xso.OwnerRedirect(uri)[source]¶

class aioxmpp.pubsub.xso.OwnerSubscription(jid, subscription)[source]¶

class aioxmpp.pubsub.xso.OwnerSubscriptions(node, *, subscriptions=[])[source]¶

Application-condition error XSOs¶

Application-condition XSOs for use in stanza.Error.application_condition are also defined for the error conditions specified by XEP-0060. They are listed in alphabetical order below:

class aioxmpp.pubsub.xso.ClosedNode¶

class aioxmpp.pubsub.xso.ConfigurationRequired¶

class aioxmpp.pubsub.xso.InvalidJID¶

class aioxmpp.pubsub.xso.InvalidOptions¶

class aioxmpp.pubsub.xso.InvalidPayload¶

class aioxmpp.pubsub.xso.InvalidSubID¶

class aioxmpp.pubsub.xso.ItemForbidden¶

class aioxmpp.pubsub.xso.ItemRequired¶

class aioxmpp.pubsub.xso.JIDRequired¶

class aioxmpp.pubsub.xso.MaxItemsExceeded¶

class aioxmpp.pubsub.xso.MaxNodesExceeded¶

class aioxmpp.pubsub.xso.NodeIDRequired¶

class aioxmpp.pubsub.xso.NotInRosterGroup¶

class aioxmpp.pubsub.xso.NotSubscribed¶

class aioxmpp.pubsub.xso.PayloadTooBig¶

class aioxmpp.pubsub.xso.PayloadRequired¶

class aioxmpp.pubsub.xso.PendingSubscription¶

class aioxmpp.pubsub.xso.PresenceSubscriptionRequired¶

class aioxmpp.pubsub.xso.SubIDRequired¶

class aioxmpp.pubsub.xso.TooManySubscriptions¶

class aioxmpp.pubsub.xso.Unsupported[source]¶

aioxmpp

Table Of Contents

Navigation

Related Topics

pubsub — Publish-Subscribe support (XEP-0060)¶

Using Publish-Subscribe¶

XSOs¶

Registering payloads¶

Features¶

Generic namespace¶

Owner namespace¶

Application-condition error XSOs¶

aioxmpp

Table Of Contents

Navigation

Related Topics

Quick search

`pubsub` — Publish-Subscribe support (XEP-0060)¶