XEP-0363: HTTP File Upload

class slixmpp.plugins.xep_0363.XEP_0363(xmpp, config=None)[source]

XEP-0363: HTTP File Upload

async find_upload_service(domain=None, **iqkwargs)[source]

Find an upload service on a domain (our own by default).

Parameters

domain (Optional[JID]) – Domain to disco to find a service.

Return type

Optional[Iq]

request_slot(jid, filename, size, content_type=None, *, ifrom=None, **iqkwargs)[source]

Request an HTTP upload slot from a service.

Parameters
  • jid (JID) – Service to request the slot from.

  • filename (str) – Name of the file that will be uploaded.

  • size (int) – size of the file in bytes.

  • content_type (Optional[str]) – Type of the file that will be uploaded.

Return type

Future

async upload_file(filename, size=None, content_type=None, *, input_file=None, domain=None, **iqkwargs)[source]

Helper function which does all of the uploading discovery and process.

Parameters
  • filename (str) – Path to the file to upload (or only the name if input_file is provided.

  • size (Optional[int]) – size of the file in bytes.

  • content_type (Optional[str]) – Type of the file that will be uploaded.

  • input_file (Optional[IO[bytes]]) – Binary file stream on the file.

  • domain (Optional[JID]) – Domain to query to find an HTTP upload service.

Raises
  • UploadServiceNotFound – If slixmpp is unable to find an an available upload service.

  • FileTooBig – If the filesize is above what is accepted by the service.

  • HTTPError – If there is an error in the HTTP operation.

Return type

str

Returns

The URL of the uploaded file.

class slixmpp.plugins.xep_0363.UploadServiceNotFound[source]

Raised if no upload service can be found.

class slixmpp.plugins.xep_0363.FileTooBig[source]

Raised if the file size is above advertised server limits.

args:

  • size of the file

  • max file size allowed

class slixmpp.plugins.xep_0363.HTTPError[source]

Raised when we receive an HTTP error response during upload.

args:

  • HTTP Error code

  • Content of the HTTP response

Stanza elements

class slixmpp.plugins.xep_0363.stanza.Get(xml=None, parent=None)[source]
interfaces: ClassVar[Set[str]] = {'url'}

The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the plugin_attrib value of any registered stanza plugins.

iterables: List[ElementBase]

A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]
name: ClassVar[str] = 'get'

The XML tag name of the element, not including any namespace prefixes. For example, an ElementBase object for <message /> would use name = 'message'.

namespace: str = 'urn:xmpp:http:upload:0'

The XML namespace for the element. Given <foo xmlns="bar" />, then namespace = "bar" should be used. The default namespace is jabber:client since this is being used in an XMPP library.

parent: Optional[ReferenceType[ElementBase]]

A weakref.weakref to the parent stanza, if there is one. If not, then parent is None.

plugin_attrib: ClassVar[str] = 'get'

For ElementBase subclasses which are intended to be used as plugins, the plugin_attrib value defines the plugin name. Plugins may be accessed by using the plugin_attrib value as the interface. An example using plugin_attrib = 'foo':

register_stanza_plugin(Message, FooPlugin)
msg = Message()
msg['foo']['an_interface_from_the_foo_plugin']
plugins: Dict[Tuple[str, Optional[str]], ElementBase]

An ordered dictionary of plugin stanzas, mapped by their plugin_attrib value.

tag: str

The name of the tag for the stanza’s root element. It is the same as calling tag_name() and is formatted as '{namespace}elementname'.

xml: ET.Element

The underlying XML object for the stanza. It is a standard xml.etree.ElementTree object.

class slixmpp.plugins.xep_0363.stanza.Header(xml=None, parent=None)[source]
del_value()[source]
get_value()[source]
interfaces: ClassVar[Set[str]] = {'name', 'value'}

The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the plugin_attrib value of any registered stanza plugins.

iterables: List[ElementBase]

A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]
name: ClassVar[str] = 'header'

The XML tag name of the element, not including any namespace prefixes. For example, an ElementBase object for <message /> would use name = 'message'.

namespace: str = 'urn:xmpp:http:upload:0'

The XML namespace for the element. Given <foo xmlns="bar" />, then namespace = "bar" should be used. The default namespace is jabber:client since this is being used in an XMPP library.

parent: Optional[ReferenceType[ElementBase]]

A weakref.weakref to the parent stanza, if there is one. If not, then parent is None.

plugin_attrib: ClassVar[str] = 'header'

For ElementBase subclasses which are intended to be used as plugins, the plugin_attrib value defines the plugin name. Plugins may be accessed by using the plugin_attrib value as the interface. An example using plugin_attrib = 'foo':

register_stanza_plugin(Message, FooPlugin)
msg = Message()
msg['foo']['an_interface_from_the_foo_plugin']
plugin_multi_attrib: ClassVar[str] = 'headers'

For ElementBase subclasses that are intended to be an iterable group of items, the plugin_multi_attrib value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:

# Given stanza class Foo, with plugin_multi_attrib = 'foos'
parent['foos']
filter(isinstance(item, Foo), parent['substanzas'])
plugins: Dict[Tuple[str, Optional[str]], ElementBase]

An ordered dictionary of plugin stanzas, mapped by their plugin_attrib value.

set_value(value)[source]
tag: str

The name of the tag for the stanza’s root element. It is the same as calling tag_name() and is formatted as '{namespace}elementname'.

xml: ET.Element

The underlying XML object for the stanza. It is a standard xml.etree.ElementTree object.

class slixmpp.plugins.xep_0363.stanza.Put(xml=None, parent=None)[source]
interfaces: ClassVar[Set[str]] = {'url'}

The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the plugin_attrib value of any registered stanza plugins.

iterables: List[ElementBase]

A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]
name: ClassVar[str] = 'put'

The XML tag name of the element, not including any namespace prefixes. For example, an ElementBase object for <message /> would use name = 'message'.

namespace: str = 'urn:xmpp:http:upload:0'

The XML namespace for the element. Given <foo xmlns="bar" />, then namespace = "bar" should be used. The default namespace is jabber:client since this is being used in an XMPP library.

parent: Optional[ReferenceType[ElementBase]]

A weakref.weakref to the parent stanza, if there is one. If not, then parent is None.

plugin_attrib: ClassVar[str] = 'put'

For ElementBase subclasses which are intended to be used as plugins, the plugin_attrib value defines the plugin name. Plugins may be accessed by using the plugin_attrib value as the interface. An example using plugin_attrib = 'foo':

register_stanza_plugin(Message, FooPlugin)
msg = Message()
msg['foo']['an_interface_from_the_foo_plugin']
plugins: Dict[Tuple[str, Optional[str]], ElementBase]

An ordered dictionary of plugin stanzas, mapped by their plugin_attrib value.

tag: str

The name of the tag for the stanza’s root element. It is the same as calling tag_name() and is formatted as '{namespace}elementname'.

xml: ET.Element

The underlying XML object for the stanza. It is a standard xml.etree.ElementTree object.

class slixmpp.plugins.xep_0363.stanza.Request(xml=None, parent=None)[source]
interfaces: ClassVar[Set[str]] = {'content-type', 'filename', 'size'}

The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the plugin_attrib value of any registered stanza plugins.

iterables: List[ElementBase]

A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]
name: ClassVar[str] = 'request'

The XML tag name of the element, not including any namespace prefixes. For example, an ElementBase object for <message /> would use name = 'message'.

namespace: str = 'urn:xmpp:http:upload:0'

The XML namespace for the element. Given <foo xmlns="bar" />, then namespace = "bar" should be used. The default namespace is jabber:client since this is being used in an XMPP library.

parent: Optional[ReferenceType[ElementBase]]

A weakref.weakref to the parent stanza, if there is one. If not, then parent is None.

plugin_attrib: ClassVar[str] = 'http_upload_request'

For ElementBase subclasses which are intended to be used as plugins, the plugin_attrib value defines the plugin name. Plugins may be accessed by using the plugin_attrib value as the interface. An example using plugin_attrib = 'foo':

register_stanza_plugin(Message, FooPlugin)
msg = Message()
msg['foo']['an_interface_from_the_foo_plugin']
plugins: Dict[Tuple[str, Optional[str]], ElementBase]

An ordered dictionary of plugin stanzas, mapped by their plugin_attrib value.

tag: str

The name of the tag for the stanza’s root element. It is the same as calling tag_name() and is formatted as '{namespace}elementname'.

xml: ET.Element

The underlying XML object for the stanza. It is a standard xml.etree.ElementTree object.

class slixmpp.plugins.xep_0363.stanza.Slot(xml=None, parent=None)[source]
iterables: List[ElementBase]

A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]
name: ClassVar[str] = 'slot'

The XML tag name of the element, not including any namespace prefixes. For example, an ElementBase object for <message /> would use name = 'message'.

namespace: str = 'urn:xmpp:http:upload:0'

The XML namespace for the element. Given <foo xmlns="bar" />, then namespace = "bar" should be used. The default namespace is jabber:client since this is being used in an XMPP library.

parent: Optional[ReferenceType[ElementBase]]

A weakref.weakref to the parent stanza, if there is one. If not, then parent is None.

plugin_attrib: ClassVar[str] = 'http_upload_slot'

For ElementBase subclasses which are intended to be used as plugins, the plugin_attrib value defines the plugin name. Plugins may be accessed by using the plugin_attrib value as the interface. An example using plugin_attrib = 'foo':

register_stanza_plugin(Message, FooPlugin)
msg = Message()
msg['foo']['an_interface_from_the_foo_plugin']
plugins: Dict[Tuple[str, Optional[str]], ElementBase]

An ordered dictionary of plugin stanzas, mapped by their plugin_attrib value.

tag: str

The name of the tag for the stanza’s root element. It is the same as calling tag_name() and is formatted as '{namespace}elementname'.

xml: ET.Element

The underlying XML object for the stanza. It is a standard xml.etree.ElementTree object.