repository_name stringlengths 5 67 | func_path_in_repository stringlengths 4 234 | func_name stringlengths 0 314 | whole_func_string stringlengths 52 3.87M | language stringclasses 6
values | func_code_string stringlengths 52 3.87M | func_code_tokens listlengths 15 672k | func_documentation_string stringlengths 1 47.2k | func_documentation_tokens listlengths 1 3.92k | split_name stringclasses 1
value | func_code_url stringlengths 85 339 |
|---|---|---|---|---|---|---|---|---|---|---|
horazont/aioxmpp | aioxmpp/hashes.py | algo_of_hash | def algo_of_hash(h):
"""
Return a :xep:`300` `algo` from a given :mod:`hashlib` hash.
:param h: Hash object from :mod:`hashlib`.
:raises ValueError: if `h` does not have a defined `algo` value.
:raises ValueError: if the hash function MUST NOT be supported.
:return: The `algo` value for the giv... | python | def algo_of_hash(h):
"""
Return a :xep:`300` `algo` from a given :mod:`hashlib` hash.
:param h: Hash object from :mod:`hashlib`.
:raises ValueError: if `h` does not have a defined `algo` value.
:raises ValueError: if the hash function MUST NOT be supported.
:return: The `algo` value for the giv... | [
"def",
"algo_of_hash",
"(",
"h",
")",
":",
"try",
":",
"enabled",
",",
"algo",
"=",
"_HASH_ALGO_REVERSE_MAP",
"[",
"h",
".",
"name",
"]",
"except",
"KeyError",
":",
"pass",
"else",
":",
"if",
"not",
"enabled",
":",
"raise",
"ValueError",
"(",
"\"support ... | Return a :xep:`300` `algo` from a given :mod:`hashlib` hash.
:param h: Hash object from :mod:`hashlib`.
:raises ValueError: if `h` does not have a defined `algo` value.
:raises ValueError: if the hash function MUST NOT be supported.
:return: The `algo` value for the given hash.
:rtype: :class:`str`... | [
"Return",
"a",
":",
"xep",
":",
"300",
"algo",
"from",
"a",
"given",
":",
"mod",
":",
"hashlib",
"hash",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/hashes.py#L178-L216 |
horazont/aioxmpp | aioxmpp/hashes.py | HashService.select_common_hashes | def select_common_hashes(self, other_entity):
"""
Return the list of algos supported by us and `other_entity`. The
algorithms are represented by their :xep:`300` URNs
(`urn:xmpp:hash-function-text-names:...`).
:param other_entity: the address of another entity
:type othe... | python | def select_common_hashes(self, other_entity):
"""
Return the list of algos supported by us and `other_entity`. The
algorithms are represented by their :xep:`300` URNs
(`urn:xmpp:hash-function-text-names:...`).
:param other_entity: the address of another entity
:type othe... | [
"def",
"select_common_hashes",
"(",
"self",
",",
"other_entity",
")",
":",
"disco_info",
"=",
"yield",
"from",
"self",
".",
"_disco_client",
".",
"query_info",
"(",
"other_entity",
")",
"intersection",
"=",
"disco_info",
".",
"features",
"&",
"SUPPORTED_HASH_FEATU... | Return the list of algos supported by us and `other_entity`. The
algorithms are represented by their :xep:`300` URNs
(`urn:xmpp:hash-function-text-names:...`).
:param other_entity: the address of another entity
:type other_entity: :class:`aioxmpp.JID`
:returns: the identifiers o... | [
"Return",
"the",
"list",
"of",
"algos",
"supported",
"by",
"us",
"and",
"other_entity",
".",
"The",
"algorithms",
"are",
"represented",
"by",
"their",
":",
"xep",
":",
"300",
"URNs",
"(",
"urn",
":",
"xmpp",
":",
"hash",
"-",
"function",
"-",
"text",
"... | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/hashes.py#L377-L402 |
horazont/aioxmpp | aioxmpp/callbacks.py | first_signal | def first_signal(*signals):
"""
Connect to multiple signals and wait for the first to emit.
:param signals: Signals to connect to.
:type signals: :class:`AdHocSignal`
:return: An awaitable for the first signal to emit.
The awaitable returns the first argument passed to the signal. If the first... | python | def first_signal(*signals):
"""
Connect to multiple signals and wait for the first to emit.
:param signals: Signals to connect to.
:type signals: :class:`AdHocSignal`
:return: An awaitable for the first signal to emit.
The awaitable returns the first argument passed to the signal. If the first... | [
"def",
"first_signal",
"(",
"*",
"signals",
")",
":",
"fut",
"=",
"asyncio",
".",
"Future",
"(",
")",
"for",
"signal",
"in",
"signals",
":",
"signal",
".",
"connect",
"(",
"fut",
",",
"signal",
".",
"AUTO_FUTURE",
")",
"return",
"fut"
] | Connect to multiple signals and wait for the first to emit.
:param signals: Signals to connect to.
:type signals: :class:`AdHocSignal`
:return: An awaitable for the first signal to emit.
The awaitable returns the first argument passed to the signal. If the first
argument is an exception, the excep... | [
"Connect",
"to",
"multiple",
"signals",
"and",
"wait",
"for",
"the",
"first",
"to",
"emit",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/callbacks.py#L853-L898 |
horazont/aioxmpp | aioxmpp/callbacks.py | AdHocSignal.connect | def connect(self, f, mode=None):
"""
Connect an object `f` to the signal. The type the object needs to have
depends on `mode`, but usually it needs to be a callable.
:meth:`connect` returns an opaque token which can be used with
:meth:`disconnect` to disconnect the object from t... | python | def connect(self, f, mode=None):
"""
Connect an object `f` to the signal. The type the object needs to have
depends on `mode`, but usually it needs to be a callable.
:meth:`connect` returns an opaque token which can be used with
:meth:`disconnect` to disconnect the object from t... | [
"def",
"connect",
"(",
"self",
",",
"f",
",",
"mode",
"=",
"None",
")",
":",
"mode",
"=",
"mode",
"or",
"self",
".",
"STRONG",
"self",
".",
"logger",
".",
"debug",
"(",
"\"connecting %r with mode %r\"",
",",
"f",
",",
"mode",
")",
"return",
"self",
"... | Connect an object `f` to the signal. The type the object needs to have
depends on `mode`, but usually it needs to be a callable.
:meth:`connect` returns an opaque token which can be used with
:meth:`disconnect` to disconnect the object from the signal.
The default value for `mode` is :... | [
"Connect",
"an",
"object",
"f",
"to",
"the",
"signal",
".",
"The",
"type",
"the",
"object",
"needs",
"to",
"have",
"depends",
"on",
"mode",
"but",
"usually",
"it",
"needs",
"to",
"be",
"a",
"callable",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/callbacks.py#L472-L503 |
horazont/aioxmpp | aioxmpp/callbacks.py | AdHocSignal.fire | def fire(self, *args, **kwargs):
"""
Emit the signal, calling all connected objects in-line with the given
arguments and in the order they were registered.
:class:`AdHocSignal` provides full isolation with respect to
exceptions. If a connected listener raises an exception, the o... | python | def fire(self, *args, **kwargs):
"""
Emit the signal, calling all connected objects in-line with the given
arguments and in the order they were registered.
:class:`AdHocSignal` provides full isolation with respect to
exceptions. If a connected listener raises an exception, the o... | [
"def",
"fire",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"for",
"token",
",",
"wrapper",
"in",
"list",
"(",
"self",
".",
"_connections",
".",
"items",
"(",
")",
")",
":",
"try",
":",
"keep",
"=",
"wrapper",
"(",
"args",
... | Emit the signal, calling all connected objects in-line with the given
arguments and in the order they were registered.
:class:`AdHocSignal` provides full isolation with respect to
exceptions. If a connected listener raises an exception, the other
listeners are executed as normal, but th... | [
"Emit",
"the",
"signal",
"calling",
"all",
"connected",
"objects",
"in",
"-",
"line",
"with",
"the",
"given",
"arguments",
"and",
"in",
"the",
"order",
"they",
"were",
"registered",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/callbacks.py#L520-L541 |
horazont/aioxmpp | aioxmpp/callbacks.py | AdHocSignal.future | def future(self):
"""
Return a :class:`asyncio.Future` which has been :meth:`connect`\\ -ed
using :attr:`AUTO_FUTURE`.
The token returned by :meth:`connect` is not returned; to remove the
future from the signal, just cancel it.
"""
fut = asyncio.Future()
... | python | def future(self):
"""
Return a :class:`asyncio.Future` which has been :meth:`connect`\\ -ed
using :attr:`AUTO_FUTURE`.
The token returned by :meth:`connect` is not returned; to remove the
future from the signal, just cancel it.
"""
fut = asyncio.Future()
... | [
"def",
"future",
"(",
"self",
")",
":",
"fut",
"=",
"asyncio",
".",
"Future",
"(",
")",
"self",
".",
"connect",
"(",
"fut",
",",
"self",
".",
"AUTO_FUTURE",
")",
"return",
"fut"
] | Return a :class:`asyncio.Future` which has been :meth:`connect`\\ -ed
using :attr:`AUTO_FUTURE`.
The token returned by :meth:`connect` is not returned; to remove the
future from the signal, just cancel it. | [
"Return",
"a",
":",
"class",
":",
"asyncio",
".",
"Future",
"which",
"has",
"been",
":",
"meth",
":",
"connect",
"\\\\",
"-",
"ed",
"using",
":",
"attr",
":",
"AUTO_FUTURE",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/callbacks.py#L543-L553 |
horazont/aioxmpp | aioxmpp/callbacks.py | SyncAdHocSignal.connect | def connect(self, coro):
"""
The coroutine `coro` is connected to the signal. The coroutine must
return a true value, unless it wants to be disconnected from the
signal.
.. note::
This is different from the return value convention with
:attr:`AdHocSignal.S... | python | def connect(self, coro):
"""
The coroutine `coro` is connected to the signal. The coroutine must
return a true value, unless it wants to be disconnected from the
signal.
.. note::
This is different from the return value convention with
:attr:`AdHocSignal.S... | [
"def",
"connect",
"(",
"self",
",",
"coro",
")",
":",
"self",
".",
"logger",
".",
"debug",
"(",
"\"connecting %r\"",
",",
"coro",
")",
"return",
"self",
".",
"_connect",
"(",
"coro",
")"
] | The coroutine `coro` is connected to the signal. The coroutine must
return a true value, unless it wants to be disconnected from the
signal.
.. note::
This is different from the return value convention with
:attr:`AdHocSignal.STRONG` and :attr:`AdHocSignal.WEAK`.
... | [
"The",
"coroutine",
"coro",
"is",
"connected",
"to",
"the",
"signal",
".",
"The",
"coroutine",
"must",
"return",
"a",
"true",
"value",
"unless",
"it",
"wants",
"to",
"be",
"disconnected",
"from",
"the",
"signal",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/callbacks.py#L572-L587 |
horazont/aioxmpp | aioxmpp/callbacks.py | SyncAdHocSignal.fire | def fire(self, *args, **kwargs):
"""
Emit the signal, calling all coroutines in-line with the given
arguments and in the order they were registered.
This is obviously a coroutine.
Instead of calling :meth:`fire` explicitly, the ad-hoc signal object
itself can be called,... | python | def fire(self, *args, **kwargs):
"""
Emit the signal, calling all coroutines in-line with the given
arguments and in the order they were registered.
This is obviously a coroutine.
Instead of calling :meth:`fire` explicitly, the ad-hoc signal object
itself can be called,... | [
"def",
"fire",
"(",
"self",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"for",
"token",
",",
"coro",
"in",
"list",
"(",
"self",
".",
"_connections",
".",
"items",
"(",
")",
")",
":",
"keep",
"=",
"yield",
"from",
"coro",
"(",
"*",
"arg... | Emit the signal, calling all coroutines in-line with the given
arguments and in the order they were registered.
This is obviously a coroutine.
Instead of calling :meth:`fire` explicitly, the ad-hoc signal object
itself can be called, too. | [
"Emit",
"the",
"signal",
"calling",
"all",
"coroutines",
"in",
"-",
"line",
"with",
"the",
"given",
"arguments",
"and",
"in",
"the",
"order",
"they",
"were",
"registered",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/callbacks.py#L605-L618 |
horazont/aioxmpp | aioxmpp/callbacks.py | Filter.register | def register(self, func, order):
"""
Add a function to the filter chain.
:param func: A callable which is to be added to the filter chain.
:param order: An object indicating the ordering of the function
relative to the others.
:return: Token representing th... | python | def register(self, func, order):
"""
Add a function to the filter chain.
:param func: A callable which is to be added to the filter chain.
:param order: An object indicating the ordering of the function
relative to the others.
:return: Token representing th... | [
"def",
"register",
"(",
"self",
",",
"func",
",",
"order",
")",
":",
"token",
"=",
"self",
".",
"Token",
"(",
")",
"self",
".",
"_filter_order",
".",
"append",
"(",
"(",
"order",
",",
"token",
",",
"func",
")",
")",
"self",
".",
"_filter_order",
".... | Add a function to the filter chain.
:param func: A callable which is to be added to the filter chain.
:param order: An object indicating the ordering of the function
relative to the others.
:return: Token representing the registration.
Register the function `func`... | [
"Add",
"a",
"function",
"to",
"the",
"filter",
"chain",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/callbacks.py#L758-L788 |
horazont/aioxmpp | aioxmpp/callbacks.py | Filter.filter | def filter(self, obj, *args, **kwargs):
"""
Filter the given object through the filter chain.
:param obj: The object to filter
:param args: Additional arguments to pass to each filter function.
:param kwargs: Additional keyword arguments to pass to each filter
... | python | def filter(self, obj, *args, **kwargs):
"""
Filter the given object through the filter chain.
:param obj: The object to filter
:param args: Additional arguments to pass to each filter function.
:param kwargs: Additional keyword arguments to pass to each filter
... | [
"def",
"filter",
"(",
"self",
",",
"obj",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"for",
"_",
",",
"_",
",",
"func",
"in",
"self",
".",
"_filter_order",
":",
"obj",
"=",
"func",
"(",
"obj",
",",
"*",
"args",
",",
"*",
"*",
"kwarg... | Filter the given object through the filter chain.
:param obj: The object to filter
:param args: Additional arguments to pass to each filter function.
:param kwargs: Additional keyword arguments to pass to each filter
function.
:return: The filtered object or :data... | [
"Filter",
"the",
"given",
"object",
"through",
"the",
"filter",
"chain",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/callbacks.py#L790-L809 |
horazont/aioxmpp | aioxmpp/callbacks.py | Filter.unregister | def unregister(self, token_to_remove):
"""
Unregister a filter function.
:param token_to_remove: The token as returned by :meth:`register`.
Unregister a function from the filter chain using the token returned by
:meth:`register`.
"""
for i, (_, token, _) in enum... | python | def unregister(self, token_to_remove):
"""
Unregister a filter function.
:param token_to_remove: The token as returned by :meth:`register`.
Unregister a function from the filter chain using the token returned by
:meth:`register`.
"""
for i, (_, token, _) in enum... | [
"def",
"unregister",
"(",
"self",
",",
"token_to_remove",
")",
":",
"for",
"i",
",",
"(",
"_",
",",
"token",
",",
"_",
")",
"in",
"enumerate",
"(",
"self",
".",
"_filter_order",
")",
":",
"if",
"token",
"==",
"token_to_remove",
":",
"break",
"else",
... | Unregister a filter function.
:param token_to_remove: The token as returned by :meth:`register`.
Unregister a function from the filter chain using the token returned by
:meth:`register`. | [
"Unregister",
"a",
"filter",
"function",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/callbacks.py#L811-L826 |
horazont/aioxmpp | aioxmpp/callbacks.py | Filter.context_register | def context_register(self, func, *args):
"""
:term:`Context manager <context manager>` which temporarily registers a
filter function.
:param func: The filter function to register.
:param order: The sorting key for the filter function.
:rtype: :term:`context manager`
... | python | def context_register(self, func, *args):
"""
:term:`Context manager <context manager>` which temporarily registers a
filter function.
:param func: The filter function to register.
:param order: The sorting key for the filter function.
:rtype: :term:`context manager`
... | [
"def",
"context_register",
"(",
"self",
",",
"func",
",",
"*",
"args",
")",
":",
"token",
"=",
"self",
".",
"register",
"(",
"func",
",",
"*",
"args",
")",
"try",
":",
"yield",
"finally",
":",
"self",
".",
"unregister",
"(",
"token",
")"
] | :term:`Context manager <context manager>` which temporarily registers a
filter function.
:param func: The filter function to register.
:param order: The sorting key for the filter function.
:rtype: :term:`context manager`
:return: Context manager which temporarily registers the ... | [
":",
"term",
":",
"Context",
"manager",
"<context",
"manager",
">",
"which",
"temporarily",
"registers",
"a",
"filter",
"function",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/callbacks.py#L829-L850 |
horazont/aioxmpp | aioxmpp/tracking.py | MessageTracker.set_timeout | def set_timeout(self, timeout):
"""
Automatically close the tracker after `timeout` has elapsed.
:param timeout: The timeout after which the tracker is closed
automatically.
:type timeout: :class:`numbers.Real` or :class:`datetime.timedelta`
If the `time... | python | def set_timeout(self, timeout):
"""
Automatically close the tracker after `timeout` has elapsed.
:param timeout: The timeout after which the tracker is closed
automatically.
:type timeout: :class:`numbers.Real` or :class:`datetime.timedelta`
If the `time... | [
"def",
"set_timeout",
"(",
"self",
",",
"timeout",
")",
":",
"loop",
"=",
"asyncio",
".",
"get_event_loop",
"(",
")",
"if",
"isinstance",
"(",
"timeout",
",",
"timedelta",
")",
":",
"timeout",
"=",
"timeout",
".",
"total_seconds",
"(",
")",
"loop",
".",
... | Automatically close the tracker after `timeout` has elapsed.
:param timeout: The timeout after which the tracker is closed
automatically.
:type timeout: :class:`numbers.Real` or :class:`datetime.timedelta`
If the `timeout` is not a :class:`datetime.timedelta` instance, ... | [
"Automatically",
"close",
"the",
"tracker",
"after",
"timeout",
"has",
"elapsed",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/tracking.py#L269-L288 |
horazont/aioxmpp | aioxmpp/tracking.py | MessageTracker._set_state | def _set_state(self, new_state, response=None):
"""
Set the state of the tracker.
:param new_state: The new state of the tracker.
:type new_state: :class:`~.MessageState` member
:param response: A stanza related to the new state.
:type response: :class:`~.StanzaBase` or ... | python | def _set_state(self, new_state, response=None):
"""
Set the state of the tracker.
:param new_state: The new state of the tracker.
:type new_state: :class:`~.MessageState` member
:param response: A stanza related to the new state.
:type response: :class:`~.StanzaBase` or ... | [
"def",
"_set_state",
"(",
"self",
",",
"new_state",
",",
"response",
"=",
"None",
")",
":",
"if",
"self",
".",
"_closed",
":",
"raise",
"RuntimeError",
"(",
"\"message tracker is closed\"",
")",
"# reject some transitions as documented",
"if",
"(",
"self",
".",
... | Set the state of the tracker.
:param new_state: The new state of the tracker.
:type new_state: :class:`~.MessageState` member
:param response: A stanza related to the new state.
:type response: :class:`~.StanzaBase` or :data:`None`
:raise ValueError: if a forbidden state transit... | [
"Set",
"the",
"state",
"of",
"the",
"tracker",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/tracking.py#L292-L352 |
horazont/aioxmpp | aioxmpp/tracking.py | BasicTrackingService.send_tracked | def send_tracked(self, stanza, tracker):
"""
Send a message stanza with tracking.
:param stanza: Message stanza to send.
:type stanza: :class:`aioxmpp.Message`
:param tracker: Message tracker to use.
:type tracker: :class:`~.MessageTracker`
:rtype: :class:`~.Stan... | python | def send_tracked(self, stanza, tracker):
"""
Send a message stanza with tracking.
:param stanza: Message stanza to send.
:type stanza: :class:`aioxmpp.Message`
:param tracker: Message tracker to use.
:type tracker: :class:`~.MessageTracker`
:rtype: :class:`~.Stan... | [
"def",
"send_tracked",
"(",
"self",
",",
"stanza",
",",
"tracker",
")",
":",
"token",
"=",
"self",
".",
"client",
".",
"enqueue",
"(",
"stanza",
")",
"self",
".",
"attach_tracker",
"(",
"stanza",
",",
"tracker",
",",
"token",
")",
"return",
"token"
] | Send a message stanza with tracking.
:param stanza: Message stanza to send.
:type stanza: :class:`aioxmpp.Message`
:param tracker: Message tracker to use.
:type tracker: :class:`~.MessageTracker`
:rtype: :class:`~.StanzaToken`
:return: The token used to send the stanza.
... | [
"Send",
"a",
"message",
"stanza",
"with",
"tracking",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/tracking.py#L425-L451 |
horazont/aioxmpp | aioxmpp/tracking.py | BasicTrackingService.attach_tracker | def attach_tracker(self, stanza, tracker=None, token=None):
"""
Configure tracking for a stanza without sending it.
:param stanza: Message stanza to send.
:type stanza: :class:`aioxmpp.Message`
:param tracker: Message tracker to use.
:type tracker: :class:`~.MessageTrack... | python | def attach_tracker(self, stanza, tracker=None, token=None):
"""
Configure tracking for a stanza without sending it.
:param stanza: Message stanza to send.
:type stanza: :class:`aioxmpp.Message`
:param tracker: Message tracker to use.
:type tracker: :class:`~.MessageTrack... | [
"def",
"attach_tracker",
"(",
"self",
",",
"stanza",
",",
"tracker",
"=",
"None",
",",
"token",
"=",
"None",
")",
":",
"if",
"tracker",
"is",
"None",
":",
"tracker",
"=",
"MessageTracker",
"(",
")",
"stanza",
".",
"autoset_id",
"(",
")",
"key",
"=",
... | Configure tracking for a stanza without sending it.
:param stanza: Message stanza to send.
:type stanza: :class:`aioxmpp.Message`
:param tracker: Message tracker to use.
:type tracker: :class:`~.MessageTracker` or :data:`None`
:param token: Optional stanza token for more fine-gr... | [
"Configure",
"tracking",
"for",
"a",
"stanza",
"without",
"sending",
"it",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/tracking.py#L453-L497 |
horazont/aioxmpp | aioxmpp/muc/self_ping.py | MUCPinger.start | def start(self):
"""
Start the pinging coroutine using the client and event loop which was
passed to the constructor.
:meth:`start` always behaves as if :meth:`stop` was called right before
it.
"""
self.stop()
self._task = asyncio.ensure_future(self._ping... | python | def start(self):
"""
Start the pinging coroutine using the client and event loop which was
passed to the constructor.
:meth:`start` always behaves as if :meth:`stop` was called right before
it.
"""
self.stop()
self._task = asyncio.ensure_future(self._ping... | [
"def",
"start",
"(",
"self",
")",
":",
"self",
".",
"stop",
"(",
")",
"self",
".",
"_task",
"=",
"asyncio",
".",
"ensure_future",
"(",
"self",
".",
"_pinger",
"(",
")",
",",
"loop",
"=",
"self",
".",
"_loop",
")"
] | Start the pinging coroutine using the client and event loop which was
passed to the constructor.
:meth:`start` always behaves as if :meth:`stop` was called right before
it. | [
"Start",
"the",
"pinging",
"coroutine",
"using",
"the",
"client",
"and",
"event",
"loop",
"which",
"was",
"passed",
"to",
"the",
"constructor",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/muc/self_ping.py#L131-L140 |
horazont/aioxmpp | aioxmpp/muc/self_ping.py | MUCPinger._interpret_result | def _interpret_result(self, task):
"""
Interpret the result of a ping.
:param task: The pinger task.
The result or exception of the `task` is interpreted as follows:
* :data:`None` result: *positive*
* :class:`aioxmpp.errors.XMPPError`, ``service-unavailable``:
... | python | def _interpret_result(self, task):
"""
Interpret the result of a ping.
:param task: The pinger task.
The result or exception of the `task` is interpreted as follows:
* :data:`None` result: *positive*
* :class:`aioxmpp.errors.XMPPError`, ``service-unavailable``:
... | [
"def",
"_interpret_result",
"(",
"self",
",",
"task",
")",
":",
"if",
"task",
".",
"exception",
"(",
")",
"is",
"None",
":",
"self",
".",
"_on_fresh",
"(",
")",
"return",
"exc",
"=",
"task",
".",
"exception",
"(",
")",
"if",
"isinstance",
"(",
"exc",... | Interpret the result of a ping.
:param task: The pinger task.
The result or exception of the `task` is interpreted as follows:
* :data:`None` result: *positive*
* :class:`aioxmpp.errors.XMPPError`, ``service-unavailable``:
*positive*
* :class:`aioxmpp.errors.XMPPErro... | [
"Interpret",
"the",
"result",
"of",
"a",
"ping",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/muc/self_ping.py#L156-L189 |
horazont/aioxmpp | aioxmpp/muc/self_ping.py | MUCMonitor.reset | def reset(self):
"""
Reset the monitor.
Reset the aliveness timeouts. Clear the stale state. Cancel and stop
pinging.
Call `on_fresh` if the stale state was set.
"""
self._monitor.notify_received()
self._pinger.stop()
self._mark_fresh() | python | def reset(self):
"""
Reset the monitor.
Reset the aliveness timeouts. Clear the stale state. Cancel and stop
pinging.
Call `on_fresh` if the stale state was set.
"""
self._monitor.notify_received()
self._pinger.stop()
self._mark_fresh() | [
"def",
"reset",
"(",
"self",
")",
":",
"self",
".",
"_monitor",
".",
"notify_received",
"(",
")",
"self",
".",
"_pinger",
".",
"stop",
"(",
")",
"self",
".",
"_mark_fresh",
"(",
")"
] | Reset the monitor.
Reset the aliveness timeouts. Clear the stale state. Cancel and stop
pinging.
Call `on_fresh` if the stale state was set. | [
"Reset",
"the",
"monitor",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/muc/self_ping.py#L378-L389 |
horazont/aioxmpp | aioxmpp/mdr/service.py | compose_receipt | def compose_receipt(message):
"""
Compose a :xep:`184` delivery receipt for a :class:`~aioxmpp.Message`.
:param message: The message to compose the receipt for.
:type message: :class:`~aioxmpp.Message`
:raises ValueError: if the input message is of type
:attr:`~aioxmpp.MessageType.ERROR`
... | python | def compose_receipt(message):
"""
Compose a :xep:`184` delivery receipt for a :class:`~aioxmpp.Message`.
:param message: The message to compose the receipt for.
:type message: :class:`~aioxmpp.Message`
:raises ValueError: if the input message is of type
:attr:`~aioxmpp.MessageType.ERROR`
... | [
"def",
"compose_receipt",
"(",
"message",
")",
":",
"if",
"message",
".",
"type_",
"==",
"aioxmpp",
".",
"MessageType",
".",
"ERROR",
":",
"raise",
"ValueError",
"(",
"\"receipts cannot be generated for error messages\"",
")",
"if",
"message",
".",
"xep0184_received... | Compose a :xep:`184` delivery receipt for a :class:`~aioxmpp.Message`.
:param message: The message to compose the receipt for.
:type message: :class:`~aioxmpp.Message`
:raises ValueError: if the input message is of type
:attr:`~aioxmpp.MessageType.ERROR`
:raises ValueError: if the input message... | [
"Compose",
"a",
":",
"xep",
":",
"184",
"delivery",
"receipt",
"for",
"a",
":",
"class",
":",
"~aioxmpp",
".",
"Message",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/mdr/service.py#L115-L138 |
horazont/aioxmpp | aioxmpp/mdr/service.py | DeliveryReceiptsService.attach_tracker | def attach_tracker(self, stanza, tracker=None):
"""
Return a new tracker or modify one to track the stanza.
:param stanza: Stanza to track.
:type stanza: :class:`aioxmpp.Message`
:param tracker: Existing tracker to attach to.
:type tracker: :class:`.tracking.MessageTrack... | python | def attach_tracker(self, stanza, tracker=None):
"""
Return a new tracker or modify one to track the stanza.
:param stanza: Stanza to track.
:type stanza: :class:`aioxmpp.Message`
:param tracker: Existing tracker to attach to.
:type tracker: :class:`.tracking.MessageTrack... | [
"def",
"attach_tracker",
"(",
"self",
",",
"stanza",
",",
"tracker",
"=",
"None",
")",
":",
"if",
"stanza",
".",
"xep0184_received",
"is",
"not",
"None",
":",
"raise",
"ValueError",
"(",
"\"requesting delivery receipts for delivery receipts is not \"",
"\"allowed\"",
... | Return a new tracker or modify one to track the stanza.
:param stanza: Stanza to track.
:type stanza: :class:`aioxmpp.Message`
:param tracker: Existing tracker to attach to.
:type tracker: :class:`.tracking.MessageTracker`
:raises ValueError: if the stanza is of type
... | [
"Return",
"a",
"new",
"tracker",
"or",
"modify",
"one",
"to",
"track",
"the",
"stanza",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/mdr/service.py#L73-L112 |
horazont/aioxmpp | aioxmpp/private_xml/service.py | PrivateXMLService.get_private_xml | def get_private_xml(self, query_xso):
"""
Get the private XML data for the element `query_xso` from the
server.
:param query_xso: the object to retrieve.
:returns: the stored private XML data.
`query_xso` *must* serialize to an empty XML node of the
wanted names... | python | def get_private_xml(self, query_xso):
"""
Get the private XML data for the element `query_xso` from the
server.
:param query_xso: the object to retrieve.
:returns: the stored private XML data.
`query_xso` *must* serialize to an empty XML node of the
wanted names... | [
"def",
"get_private_xml",
"(",
"self",
",",
"query_xso",
")",
":",
"iq",
"=",
"aioxmpp",
".",
"IQ",
"(",
"type_",
"=",
"aioxmpp",
".",
"IQType",
".",
"GET",
",",
"payload",
"=",
"private_xml_xso",
".",
"Query",
"(",
"query_xso",
")",
")",
"return",
"("... | Get the private XML data for the element `query_xso` from the
server.
:param query_xso: the object to retrieve.
:returns: the stored private XML data.
`query_xso` *must* serialize to an empty XML node of the
wanted namespace and type and *must* be registered as private
... | [
"Get",
"the",
"private",
"XML",
"data",
"for",
"the",
"element",
"query_xso",
"from",
"the",
"server",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/private_xml/service.py#L43-L60 |
horazont/aioxmpp | aioxmpp/private_xml/service.py | PrivateXMLService.set_private_xml | def set_private_xml(self, xso):
"""
Store the serialization of `xso` on the server as the private XML
data for the namespace of `xso`.
:param xso: the XSO whose serialization is send as private XML data.
"""
iq = aioxmpp.IQ(
type_=aioxmpp.IQType.SET,
... | python | def set_private_xml(self, xso):
"""
Store the serialization of `xso` on the server as the private XML
data for the namespace of `xso`.
:param xso: the XSO whose serialization is send as private XML data.
"""
iq = aioxmpp.IQ(
type_=aioxmpp.IQType.SET,
... | [
"def",
"set_private_xml",
"(",
"self",
",",
"xso",
")",
":",
"iq",
"=",
"aioxmpp",
".",
"IQ",
"(",
"type_",
"=",
"aioxmpp",
".",
"IQType",
".",
"SET",
",",
"payload",
"=",
"private_xml_xso",
".",
"Query",
"(",
"xso",
")",
")",
"yield",
"from",
"self"... | Store the serialization of `xso` on the server as the private XML
data for the namespace of `xso`.
:param xso: the XSO whose serialization is send as private XML data. | [
"Store",
"the",
"serialization",
"of",
"xso",
"on",
"the",
"server",
"as",
"the",
"private",
"XML",
"data",
"for",
"the",
"namespace",
"of",
"xso",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/private_xml/service.py#L63-L74 |
horazont/aioxmpp | aioxmpp/utils.py | gather_reraise_multi | def gather_reraise_multi(*fut_or_coros, message="gather_reraise_multi"):
"""
Wrap all the arguments `fut_or_coros` in futures with
:func:`asyncio.ensure_future` and wait until all of them are finish or
fail.
:param fut_or_coros: the futures or coroutines to wait for
:type fut_or_coros: future o... | python | def gather_reraise_multi(*fut_or_coros, message="gather_reraise_multi"):
"""
Wrap all the arguments `fut_or_coros` in futures with
:func:`asyncio.ensure_future` and wait until all of them are finish or
fail.
:param fut_or_coros: the futures or coroutines to wait for
:type fut_or_coros: future o... | [
"def",
"gather_reraise_multi",
"(",
"*",
"fut_or_coros",
",",
"message",
"=",
"\"gather_reraise_multi\"",
")",
":",
"todo",
"=",
"[",
"asyncio",
".",
"ensure_future",
"(",
"fut_or_coro",
")",
"for",
"fut_or_coro",
"in",
"fut_or_coros",
"]",
"if",
"not",
"todo",
... | Wrap all the arguments `fut_or_coros` in futures with
:func:`asyncio.ensure_future` and wait until all of them are finish or
fail.
:param fut_or_coros: the futures or coroutines to wait for
:type fut_or_coros: future or coroutine
:param message: the message included with the raised
:class:`... | [
"Wrap",
"all",
"the",
"arguments",
"fut_or_coros",
"in",
"futures",
"with",
":",
"func",
":",
"asyncio",
".",
"ensure_future",
"and",
"wait",
"until",
"all",
"of",
"them",
"are",
"finish",
"or",
"fail",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/utils.py#L269-L318 |
horazont/aioxmpp | aioxmpp/utils.py | to_nmtoken | def to_nmtoken(rand_token):
"""
Convert a (random) token given as raw :class:`bytes` or
:class:`int` to a valid NMTOKEN
<https://www.w3.org/TR/xml/#NT-Nmtoken>.
The encoding as a valid nmtoken is injective, ensuring that two
different inputs cannot yield the same token. Nevertheless, it is
... | python | def to_nmtoken(rand_token):
"""
Convert a (random) token given as raw :class:`bytes` or
:class:`int` to a valid NMTOKEN
<https://www.w3.org/TR/xml/#NT-Nmtoken>.
The encoding as a valid nmtoken is injective, ensuring that two
different inputs cannot yield the same token. Nevertheless, it is
... | [
"def",
"to_nmtoken",
"(",
"rand_token",
")",
":",
"if",
"isinstance",
"(",
"rand_token",
",",
"int",
")",
":",
"rand_token",
"=",
"rand_token",
".",
"to_bytes",
"(",
"(",
"rand_token",
".",
"bit_length",
"(",
")",
"+",
"7",
")",
"//",
"8",
",",
"\"litt... | Convert a (random) token given as raw :class:`bytes` or
:class:`int` to a valid NMTOKEN
<https://www.w3.org/TR/xml/#NT-Nmtoken>.
The encoding as a valid nmtoken is injective, ensuring that two
different inputs cannot yield the same token. Nevertheless, it is
recommended to only use one kind of inpu... | [
"Convert",
"a",
"(",
"random",
")",
"token",
"given",
"as",
"raw",
":",
"class",
":",
"bytes",
"or",
":",
"class",
":",
"int",
"to",
"a",
"valid",
"NMTOKEN",
"<https",
":",
"//",
"www",
".",
"w3",
".",
"org",
"/",
"TR",
"/",
"xml",
"/",
"#NT",
... | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/utils.py#L321-L347 |
horazont/aioxmpp | aioxmpp/errors.py | UserError.localize | def localize(self, formatter, translator):
"""
Return a localized version of the `localizable_string` passed to the
consturctor. It is formatted using the `formatter` with the `args` and
`kwargs` passed to the constructor of :class:`UserError`.
"""
return self.localizable... | python | def localize(self, formatter, translator):
"""
Return a localized version of the `localizable_string` passed to the
consturctor. It is formatted using the `formatter` with the `args` and
`kwargs` passed to the constructor of :class:`UserError`.
"""
return self.localizable... | [
"def",
"localize",
"(",
"self",
",",
"formatter",
",",
"translator",
")",
":",
"return",
"self",
".",
"localizable_string",
".",
"localize",
"(",
"formatter",
",",
"translator",
",",
"*",
"self",
".",
"args",
",",
"*",
"*",
"self",
".",
"kwargs",
")"
] | Return a localized version of the `localizable_string` passed to the
consturctor. It is formatted using the `formatter` with the `args` and
`kwargs` passed to the constructor of :class:`UserError`. | [
"Return",
"a",
"localized",
"version",
"of",
"the",
"localizable_string",
"passed",
"to",
"the",
"consturctor",
".",
"It",
"is",
"formatted",
"using",
"the",
"formatter",
"with",
"the",
"args",
"and",
"kwargs",
"passed",
"to",
"the",
"constructor",
"of",
":",
... | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/errors.py#L575-L586 |
horazont/aioxmpp | aioxmpp/bookmarks/service.py | BookmarkClient._get_bookmarks | def _get_bookmarks(self):
"""
Get the stored bookmarks from the server.
:returns: a list of bookmarks
"""
res = yield from self._private_xml.get_private_xml(
bookmark_xso.Storage()
)
return res.registered_payload.bookmarks | python | def _get_bookmarks(self):
"""
Get the stored bookmarks from the server.
:returns: a list of bookmarks
"""
res = yield from self._private_xml.get_private_xml(
bookmark_xso.Storage()
)
return res.registered_payload.bookmarks | [
"def",
"_get_bookmarks",
"(",
"self",
")",
":",
"res",
"=",
"yield",
"from",
"self",
".",
"_private_xml",
".",
"get_private_xml",
"(",
"bookmark_xso",
".",
"Storage",
"(",
")",
")",
"return",
"res",
".",
"registered_payload",
".",
"bookmarks"
] | Get the stored bookmarks from the server.
:returns: a list of bookmarks | [
"Get",
"the",
"stored",
"bookmarks",
"from",
"the",
"server",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/bookmarks/service.py#L120-L130 |
horazont/aioxmpp | aioxmpp/bookmarks/service.py | BookmarkClient._set_bookmarks | def _set_bookmarks(self, bookmarks):
"""
Set the bookmarks stored on the server.
"""
storage = bookmark_xso.Storage()
storage.bookmarks[:] = bookmarks
yield from self._private_xml.set_private_xml(storage) | python | def _set_bookmarks(self, bookmarks):
"""
Set the bookmarks stored on the server.
"""
storage = bookmark_xso.Storage()
storage.bookmarks[:] = bookmarks
yield from self._private_xml.set_private_xml(storage) | [
"def",
"_set_bookmarks",
"(",
"self",
",",
"bookmarks",
")",
":",
"storage",
"=",
"bookmark_xso",
".",
"Storage",
"(",
")",
"storage",
".",
"bookmarks",
"[",
":",
"]",
"=",
"bookmarks",
"yield",
"from",
"self",
".",
"_private_xml",
".",
"set_private_xml",
... | Set the bookmarks stored on the server. | [
"Set",
"the",
"bookmarks",
"stored",
"on",
"the",
"server",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/bookmarks/service.py#L133-L139 |
horazont/aioxmpp | aioxmpp/bookmarks/service.py | BookmarkClient._diff_emit_update | def _diff_emit_update(self, new_bookmarks):
"""
Diff the bookmark cache and the new bookmark state, emit signals as
needed and set the bookmark cache to the new data.
"""
self.logger.debug("diffing %s, %s", self._bookmark_cache,
new_bookmarks)
... | python | def _diff_emit_update(self, new_bookmarks):
"""
Diff the bookmark cache and the new bookmark state, emit signals as
needed and set the bookmark cache to the new data.
"""
self.logger.debug("diffing %s, %s", self._bookmark_cache,
new_bookmarks)
... | [
"def",
"_diff_emit_update",
"(",
"self",
",",
"new_bookmarks",
")",
":",
"self",
".",
"logger",
".",
"debug",
"(",
"\"diffing %s, %s\"",
",",
"self",
".",
"_bookmark_cache",
",",
"new_bookmarks",
")",
"def",
"subdivide",
"(",
"level",
",",
"old",
",",
"new",... | Diff the bookmark cache and the new bookmark state, emit signals as
needed and set the bookmark cache to the new data. | [
"Diff",
"the",
"bookmark",
"cache",
"and",
"the",
"new",
"bookmark",
"state",
"emit",
"signals",
"as",
"needed",
"and",
"set",
"the",
"bookmark",
"cache",
"to",
"the",
"new",
"data",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/bookmarks/service.py#L141-L265 |
horazont/aioxmpp | aioxmpp/bookmarks/service.py | BookmarkClient.get_bookmarks | def get_bookmarks(self):
"""
Get the stored bookmarks from the server. Causes signals to be
fired to reflect the changes.
:returns: a list of bookmarks
"""
with (yield from self._lock):
bookmarks = yield from self._get_bookmarks()
self._diff_emit_... | python | def get_bookmarks(self):
"""
Get the stored bookmarks from the server. Causes signals to be
fired to reflect the changes.
:returns: a list of bookmarks
"""
with (yield from self._lock):
bookmarks = yield from self._get_bookmarks()
self._diff_emit_... | [
"def",
"get_bookmarks",
"(",
"self",
")",
":",
"with",
"(",
"yield",
"from",
"self",
".",
"_lock",
")",
":",
"bookmarks",
"=",
"yield",
"from",
"self",
".",
"_get_bookmarks",
"(",
")",
"self",
".",
"_diff_emit_update",
"(",
"bookmarks",
")",
"return",
"b... | Get the stored bookmarks from the server. Causes signals to be
fired to reflect the changes.
:returns: a list of bookmarks | [
"Get",
"the",
"stored",
"bookmarks",
"from",
"the",
"server",
".",
"Causes",
"signals",
"to",
"be",
"fired",
"to",
"reflect",
"the",
"changes",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/bookmarks/service.py#L268-L278 |
horazont/aioxmpp | aioxmpp/bookmarks/service.py | BookmarkClient.set_bookmarks | def set_bookmarks(self, bookmarks):
"""
Store the sequence of bookmarks `bookmarks`.
Causes signals to be fired to reflect the changes.
.. note:: This should normally not be used. It does not
mitigate the race condition between clients
concurrently m... | python | def set_bookmarks(self, bookmarks):
"""
Store the sequence of bookmarks `bookmarks`.
Causes signals to be fired to reflect the changes.
.. note:: This should normally not be used. It does not
mitigate the race condition between clients
concurrently m... | [
"def",
"set_bookmarks",
"(",
"self",
",",
"bookmarks",
")",
":",
"with",
"(",
"yield",
"from",
"self",
".",
"_lock",
")",
":",
"yield",
"from",
"self",
".",
"_set_bookmarks",
"(",
"bookmarks",
")",
"self",
".",
"_diff_emit_update",
"(",
"bookmarks",
")"
] | Store the sequence of bookmarks `bookmarks`.
Causes signals to be fired to reflect the changes.
.. note:: This should normally not be used. It does not
mitigate the race condition between clients
concurrently modifying the bookmarks and may lead to
... | [
"Store",
"the",
"sequence",
"of",
"bookmarks",
"bookmarks",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/bookmarks/service.py#L281-L298 |
horazont/aioxmpp | aioxmpp/bookmarks/service.py | BookmarkClient.add_bookmark | def add_bookmark(self, new_bookmark, *, max_retries=3):
"""
Add a bookmark and check whether it was successfully added to the
bookmark list. Already existant bookmarks are not added twice.
:param new_bookmark: the bookmark to add
:type new_bookmark: an instance of :class:`~bookm... | python | def add_bookmark(self, new_bookmark, *, max_retries=3):
"""
Add a bookmark and check whether it was successfully added to the
bookmark list. Already existant bookmarks are not added twice.
:param new_bookmark: the bookmark to add
:type new_bookmark: an instance of :class:`~bookm... | [
"def",
"add_bookmark",
"(",
"self",
",",
"new_bookmark",
",",
"*",
",",
"max_retries",
"=",
"3",
")",
":",
"with",
"(",
"yield",
"from",
"self",
".",
"_lock",
")",
":",
"bookmarks",
"=",
"yield",
"from",
"self",
".",
"_get_bookmarks",
"(",
")",
"try",
... | Add a bookmark and check whether it was successfully added to the
bookmark list. Already existant bookmarks are not added twice.
:param new_bookmark: the bookmark to add
:type new_bookmark: an instance of :class:`~bookmark_xso.Bookmark`
:param max_retries: the number of retries if setti... | [
"Add",
"a",
"bookmark",
"and",
"check",
"whether",
"it",
"was",
"successfully",
"added",
"to",
"the",
"bookmark",
"list",
".",
"Already",
"existant",
"bookmarks",
"are",
"not",
"added",
"twice",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/bookmarks/service.py#L312-L356 |
horazont/aioxmpp | aioxmpp/bookmarks/service.py | BookmarkClient.discard_bookmark | def discard_bookmark(self, bookmark_to_remove, *, max_retries=3):
"""
Remove a bookmark and check it has been removed.
:param bookmark_to_remove: the bookmark to remove
:type bookmark_to_remove: a :class:`~bookmark_xso.Bookmark` subclass.
:param max_retries: the number of retrie... | python | def discard_bookmark(self, bookmark_to_remove, *, max_retries=3):
"""
Remove a bookmark and check it has been removed.
:param bookmark_to_remove: the bookmark to remove
:type bookmark_to_remove: a :class:`~bookmark_xso.Bookmark` subclass.
:param max_retries: the number of retrie... | [
"def",
"discard_bookmark",
"(",
"self",
",",
"bookmark_to_remove",
",",
"*",
",",
"max_retries",
"=",
"3",
")",
":",
"with",
"(",
"yield",
"from",
"self",
".",
"_lock",
")",
":",
"bookmarks",
"=",
"yield",
"from",
"self",
".",
"_get_bookmarks",
"(",
")",... | Remove a bookmark and check it has been removed.
:param bookmark_to_remove: the bookmark to remove
:type bookmark_to_remove: a :class:`~bookmark_xso.Bookmark` subclass.
:param max_retries: the number of retries of removing the bookmark
fails.
:type max_retrie... | [
"Remove",
"a",
"bookmark",
"and",
"check",
"it",
"has",
"been",
"removed",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/bookmarks/service.py#L359-L413 |
horazont/aioxmpp | aioxmpp/bookmarks/service.py | BookmarkClient.update_bookmark | def update_bookmark(self, old, new, *, max_retries=3):
"""
Update a bookmark and check it was successful.
The bookmark matches an existing bookmark `old` according to
bookmark equalitiy and replaces it by `new`. The bookmark
`new` is added if no bookmark matching `old` exists.
... | python | def update_bookmark(self, old, new, *, max_retries=3):
"""
Update a bookmark and check it was successful.
The bookmark matches an existing bookmark `old` according to
bookmark equalitiy and replaces it by `new`. The bookmark
`new` is added if no bookmark matching `old` exists.
... | [
"def",
"update_bookmark",
"(",
"self",
",",
"old",
",",
"new",
",",
"*",
",",
"max_retries",
"=",
"3",
")",
":",
"def",
"replace_bookmark",
"(",
"bookmarks",
",",
"old",
",",
"new",
")",
":",
"modified_bookmarks",
"=",
"list",
"(",
"bookmarks",
")",
"t... | Update a bookmark and check it was successful.
The bookmark matches an existing bookmark `old` according to
bookmark equalitiy and replaces it by `new`. The bookmark
`new` is added if no bookmark matching `old` exists.
:param old: the bookmark to replace
:type bookmark_to_remov... | [
"Update",
"a",
"bookmark",
"and",
"check",
"it",
"was",
"successful",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/bookmarks/service.py#L416-L479 |
horazont/aioxmpp | aioxmpp/disco/service.py | Node.iter_identities | def iter_identities(self, stanza=None):
"""
Return an iterator of tuples describing the identities of the node.
:param stanza: The IQ request stanza
:type stanza: :class:`~aioxmpp.IQ` or :data:`None`
:rtype: iterable of (:class:`str`, :class:`str`, :class:`str` or
:d... | python | def iter_identities(self, stanza=None):
"""
Return an iterator of tuples describing the identities of the node.
:param stanza: The IQ request stanza
:type stanza: :class:`~aioxmpp.IQ` or :data:`None`
:rtype: iterable of (:class:`str`, :class:`str`, :class:`str` or
:d... | [
"def",
"iter_identities",
"(",
"self",
",",
"stanza",
"=",
"None",
")",
":",
"for",
"(",
"category",
",",
"type_",
")",
",",
"names",
"in",
"self",
".",
"_identities",
".",
"items",
"(",
")",
":",
"for",
"lang",
",",
"name",
"in",
"names",
".",
"it... | Return an iterator of tuples describing the identities of the node.
:param stanza: The IQ request stanza
:type stanza: :class:`~aioxmpp.IQ` or :data:`None`
:rtype: iterable of (:class:`str`, :class:`str`, :class:`str` or
:data:`None`, :class:`str` or :data:`None`) tuples
:re... | [
"Return",
"an",
"iterator",
"of",
"tuples",
"describing",
"the",
"identities",
"of",
"the",
"node",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/disco/service.py#L98-L133 |
horazont/aioxmpp | aioxmpp/disco/service.py | Node.iter_features | def iter_features(self, stanza=None):
"""
Return an iterator which yields the features of the node.
:param stanza: The IQ request stanza
:type stanza: :class:`~aioxmpp.IQ`
:rtype: iterable of :class:`str`
:return: :xep:`30` features of this node
`stanza` is the ... | python | def iter_features(self, stanza=None):
"""
Return an iterator which yields the features of the node.
:param stanza: The IQ request stanza
:type stanza: :class:`~aioxmpp.IQ`
:rtype: iterable of :class:`str`
:return: :xep:`30` features of this node
`stanza` is the ... | [
"def",
"iter_features",
"(",
"self",
",",
"stanza",
"=",
"None",
")",
":",
"return",
"itertools",
".",
"chain",
"(",
"iter",
"(",
"self",
".",
"STATIC_FEATURES",
")",
",",
"iter",
"(",
"self",
".",
"_features",
")",
")"
] | Return an iterator which yields the features of the node.
:param stanza: The IQ request stanza
:type stanza: :class:`~aioxmpp.IQ`
:rtype: iterable of :class:`str`
:return: :xep:`30` features of this node
`stanza` is the :class:`aioxmpp.IQ` stanza of the request. This can be
... | [
"Return",
"an",
"iterator",
"which",
"yields",
"the",
"features",
"of",
"the",
"node",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/disco/service.py#L135-L163 |
horazont/aioxmpp | aioxmpp/disco/service.py | Node.register_feature | def register_feature(self, var):
"""
Register a feature with the namespace variable `var`.
If the feature is already registered or part of the default :xep:`30`
features, a :class:`ValueError` is raised.
"""
if var in self._features or var in self.STATIC_FEATURES:
... | python | def register_feature(self, var):
"""
Register a feature with the namespace variable `var`.
If the feature is already registered or part of the default :xep:`30`
features, a :class:`ValueError` is raised.
"""
if var in self._features or var in self.STATIC_FEATURES:
... | [
"def",
"register_feature",
"(",
"self",
",",
"var",
")",
":",
"if",
"var",
"in",
"self",
".",
"_features",
"or",
"var",
"in",
"self",
".",
"STATIC_FEATURES",
":",
"raise",
"ValueError",
"(",
"\"feature already claimed: {!r}\"",
".",
"format",
"(",
"var",
")"... | Register a feature with the namespace variable `var`.
If the feature is already registered or part of the default :xep:`30`
features, a :class:`ValueError` is raised. | [
"Register",
"a",
"feature",
"with",
"the",
"namespace",
"variable",
"var",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/disco/service.py#L192-L202 |
horazont/aioxmpp | aioxmpp/disco/service.py | Node.register_identity | def register_identity(self, category, type_, *, names={}):
"""
Register an identity with the given `category` and `type_`.
If there is already a registered identity with the same `category` and
`type_`, :class:`ValueError` is raised.
`names` may be a mapping which maps :class:`... | python | def register_identity(self, category, type_, *, names={}):
"""
Register an identity with the given `category` and `type_`.
If there is already a registered identity with the same `category` and
`type_`, :class:`ValueError` is raised.
`names` may be a mapping which maps :class:`... | [
"def",
"register_identity",
"(",
"self",
",",
"category",
",",
"type_",
",",
"*",
",",
"names",
"=",
"{",
"}",
")",
":",
"key",
"=",
"category",
",",
"type_",
"if",
"key",
"in",
"self",
".",
"_identities",
":",
"raise",
"ValueError",
"(",
"\"identity a... | Register an identity with the given `category` and `type_`.
If there is already a registered identity with the same `category` and
`type_`, :class:`ValueError` is raised.
`names` may be a mapping which maps :class:`.structs.LanguageTag`
instances to strings. This mapping will be used t... | [
"Register",
"an",
"identity",
"with",
"the",
"given",
"category",
"and",
"type_",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/disco/service.py#L204-L220 |
horazont/aioxmpp | aioxmpp/disco/service.py | Node.unregister_identity | def unregister_identity(self, category, type_):
"""
Unregister an identity previously registered using
:meth:`register_identity`.
If no identity with the given `category` and `type_` has been
registered before, :class:`KeyError` is raised.
If the identity to remove is t... | python | def unregister_identity(self, category, type_):
"""
Unregister an identity previously registered using
:meth:`register_identity`.
If no identity with the given `category` and `type_` has been
registered before, :class:`KeyError` is raised.
If the identity to remove is t... | [
"def",
"unregister_identity",
"(",
"self",
",",
"category",
",",
"type_",
")",
":",
"key",
"=",
"category",
",",
"type_",
"if",
"key",
"not",
"in",
"self",
".",
"_identities",
":",
"raise",
"KeyError",
"(",
"key",
")",
"if",
"len",
"(",
"self",
".",
... | Unregister an identity previously registered using
:meth:`register_identity`.
If no identity with the given `category` and `type_` has been
registered before, :class:`KeyError` is raised.
If the identity to remove is the last identity of the :class:`Node`,
:class:`ValueError` i... | [
"Unregister",
"an",
"identity",
"previously",
"registered",
"using",
":",
"meth",
":",
"register_identity",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/disco/service.py#L261-L279 |
horazont/aioxmpp | aioxmpp/disco/service.py | Node.as_info_xso | def as_info_xso(self, stanza=None):
"""
Construct a :class:`~.disco.xso.InfoQuery` response object for this
node.
:param stanza: The IQ request stanza
:type stanza: :class:`~aioxmpp.IQ`
:rtype: iterable of :class:`~.disco.xso.InfoQuery`
:return: The disco#info re... | python | def as_info_xso(self, stanza=None):
"""
Construct a :class:`~.disco.xso.InfoQuery` response object for this
node.
:param stanza: The IQ request stanza
:type stanza: :class:`~aioxmpp.IQ`
:rtype: iterable of :class:`~.disco.xso.InfoQuery`
:return: The disco#info re... | [
"def",
"as_info_xso",
"(",
"self",
",",
"stanza",
"=",
"None",
")",
":",
"result",
"=",
"disco_xso",
".",
"InfoQuery",
"(",
")",
"result",
".",
"features",
".",
"update",
"(",
"self",
".",
"iter_features",
"(",
"stanza",
")",
")",
"result",
".",
"ident... | Construct a :class:`~.disco.xso.InfoQuery` response object for this
node.
:param stanza: The IQ request stanza
:type stanza: :class:`~aioxmpp.IQ`
:rtype: iterable of :class:`~.disco.xso.InfoQuery`
:return: The disco#info response for this node.
The resulting :class:`~.d... | [
"Construct",
"a",
":",
"class",
":",
"~",
".",
"disco",
".",
"xso",
".",
"InfoQuery",
"response",
"object",
"for",
"this",
"node",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/disco/service.py#L281-L315 |
horazont/aioxmpp | aioxmpp/disco/service.py | StaticNode.clone | def clone(cls, other_node):
"""
Clone another :class:`Node` and return as :class:`StaticNode`.
:param other_node: The node which shall be cloned
:type other_node: :class:`Node`
:rtype: :class:`StaticNode`
:return: A static node which has the exact same features, identiti... | python | def clone(cls, other_node):
"""
Clone another :class:`Node` and return as :class:`StaticNode`.
:param other_node: The node which shall be cloned
:type other_node: :class:`Node`
:rtype: :class:`StaticNode`
:return: A static node which has the exact same features, identiti... | [
"def",
"clone",
"(",
"cls",
",",
"other_node",
")",
":",
"result",
"=",
"cls",
"(",
")",
"result",
".",
"_features",
"=",
"{",
"feature",
"for",
"feature",
"in",
"other_node",
".",
"iter_features",
"(",
")",
"if",
"feature",
"not",
"in",
"cls",
".",
... | Clone another :class:`Node` and return as :class:`StaticNode`.
:param other_node: The node which shall be cloned
:type other_node: :class:`Node`
:rtype: :class:`StaticNode`
:return: A static node which has the exact same features, identities
and items as `other_node`.
... | [
"Clone",
"another",
":",
"class",
":",
"Node",
"and",
"return",
"as",
":",
"class",
":",
"StaticNode",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/disco/service.py#L342-L372 |
horazont/aioxmpp | aioxmpp/disco/service.py | DiscoClient.query_info | def query_info(self, jid, *,
node=None, require_fresh=False, timeout=None,
no_cache=False):
"""
Query the features and identities of the specified entity.
:param jid: The entity to query.
:type jid: :class:`aioxmpp.JID`
:param node: The node... | python | def query_info(self, jid, *,
node=None, require_fresh=False, timeout=None,
no_cache=False):
"""
Query the features and identities of the specified entity.
:param jid: The entity to query.
:type jid: :class:`aioxmpp.JID`
:param node: The node... | [
"def",
"query_info",
"(",
"self",
",",
"jid",
",",
"*",
",",
"node",
"=",
"None",
",",
"require_fresh",
"=",
"False",
",",
"timeout",
"=",
"None",
",",
"no_cache",
"=",
"False",
")",
":",
"key",
"=",
"jid",
",",
"node",
"if",
"not",
"require_fresh",
... | Query the features and identities of the specified entity.
:param jid: The entity to query.
:type jid: :class:`aioxmpp.JID`
:param node: The node to query.
:type node: :class:`str` or :data:`None`
:param require_fresh: Boolean flag to discard previous caches.
:type requi... | [
"Query",
"the",
"features",
"and",
"identities",
"of",
"the",
"specified",
"entity",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/disco/service.py#L644-L746 |
horazont/aioxmpp | aioxmpp/disco/service.py | DiscoClient.query_items | def query_items(self, jid, *,
node=None, require_fresh=False, timeout=None):
"""
Query the items of the specified entity.
:param jid: The entity to query.
:type jid: :class:`aioxmpp.JID`
:param node: The node to query.
:type node: :class:`str` or :dat... | python | def query_items(self, jid, *,
node=None, require_fresh=False, timeout=None):
"""
Query the items of the specified entity.
:param jid: The entity to query.
:type jid: :class:`aioxmpp.JID`
:param node: The node to query.
:type node: :class:`str` or :dat... | [
"def",
"query_items",
"(",
"self",
",",
"jid",
",",
"*",
",",
"node",
"=",
"None",
",",
"require_fresh",
"=",
"False",
",",
"timeout",
"=",
"None",
")",
":",
"key",
"=",
"jid",
",",
"node",
"if",
"not",
"require_fresh",
":",
"try",
":",
"request",
... | Query the items of the specified entity.
:param jid: The entity to query.
:type jid: :class:`aioxmpp.JID`
:param node: The node to query.
:type node: :class:`str` or :data:`None`
:param require_fresh: Boolean flag to discard previous caches.
:type require_fresh: :class:`... | [
"Query",
"the",
"items",
"of",
"the",
"specified",
"entity",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/disco/service.py#L749-L810 |
horazont/aioxmpp | aioxmpp/disco/service.py | DiscoClient.set_info_cache | def set_info_cache(self, jid, node, info):
"""
This is a wrapper around :meth:`set_info_future` which creates a future
and immediately assigns `info` as its result.
.. versionadded:: 0.5
"""
fut = asyncio.Future()
fut.set_result(info)
self.set_info_future... | python | def set_info_cache(self, jid, node, info):
"""
This is a wrapper around :meth:`set_info_future` which creates a future
and immediately assigns `info` as its result.
.. versionadded:: 0.5
"""
fut = asyncio.Future()
fut.set_result(info)
self.set_info_future... | [
"def",
"set_info_cache",
"(",
"self",
",",
"jid",
",",
"node",
",",
"info",
")",
":",
"fut",
"=",
"asyncio",
".",
"Future",
"(",
")",
"fut",
".",
"set_result",
"(",
"info",
")",
"self",
".",
"set_info_future",
"(",
"jid",
",",
"node",
",",
"fut",
"... | This is a wrapper around :meth:`set_info_future` which creates a future
and immediately assigns `info` as its result.
.. versionadded:: 0.5 | [
"This",
"is",
"a",
"wrapper",
"around",
":",
"meth",
":",
"set_info_future",
"which",
"creates",
"a",
"future",
"and",
"immediately",
"assigns",
"info",
"as",
"its",
"result",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/disco/service.py#L812-L821 |
horazont/aioxmpp | aioxmpp/disco/service.py | DiscoClient.set_info_future | def set_info_future(self, jid, node, fut):
"""
Override the cache entry (if one exists) for :meth:`query_info` of the
`jid` and `node` combination with the given :class:`asyncio.Future`
fut.
The future must receive a :class:`dict` compatible to the output of
:meth:`.xso.... | python | def set_info_future(self, jid, node, fut):
"""
Override the cache entry (if one exists) for :meth:`query_info` of the
`jid` and `node` combination with the given :class:`asyncio.Future`
fut.
The future must receive a :class:`dict` compatible to the output of
:meth:`.xso.... | [
"def",
"set_info_future",
"(",
"self",
",",
"jid",
",",
"node",
",",
"fut",
")",
":",
"self",
".",
"_info_pending",
"[",
"jid",
",",
"node",
"]",
"=",
"fut"
] | Override the cache entry (if one exists) for :meth:`query_info` of the
`jid` and `node` combination with the given :class:`asyncio.Future`
fut.
The future must receive a :class:`dict` compatible to the output of
:meth:`.xso.InfoQuery.to_dict`.
As usual, the cache can be bypasse... | [
"Override",
"the",
"cache",
"entry",
"(",
"if",
"one",
"exists",
")",
"for",
":",
"meth",
":",
"query_info",
"of",
"the",
"jid",
"and",
"node",
"combination",
"with",
"the",
"given",
":",
"class",
":",
"asyncio",
".",
"Future",
"fut",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/disco/service.py#L823-L850 |
horazont/aioxmpp | aioxmpp/i18n.py | LocalizableString.localize | def localize(self, formatter, translator, *args, **kwargs):
"""
Localize and format the string using the given `formatter` and
`translator`. The remaining args are passed to the
:meth:`~LocalizingFormatter.format` method of the `formatter`.
The `translator` must be an object sup... | python | def localize(self, formatter, translator, *args, **kwargs):
"""
Localize and format the string using the given `formatter` and
`translator`. The remaining args are passed to the
:meth:`~LocalizingFormatter.format` method of the `formatter`.
The `translator` must be an object sup... | [
"def",
"localize",
"(",
"self",
",",
"formatter",
",",
"translator",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"self",
".",
"plural",
"is",
"not",
"None",
":",
"n",
",",
"_",
"=",
"formatter",
".",
"get_field",
"(",
"self",
".",
... | Localize and format the string using the given `formatter` and
`translator`. The remaining args are passed to the
:meth:`~LocalizingFormatter.format` method of the `formatter`.
The `translator` must be an object supporting the
:class:`gettext.NullTranslations` interface.
If :at... | [
"Localize",
"and",
"format",
"the",
"string",
"using",
"the",
"given",
"formatter",
"and",
"translator",
".",
"The",
"remaining",
"args",
"are",
"passed",
"to",
"the",
":",
"meth",
":",
"~LocalizingFormatter",
".",
"format",
"method",
"of",
"the",
"formatter",... | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/i18n.py#L261-L297 |
horazont/aioxmpp | aioxmpp/roster/service.py | Item.update_from_xso_item | def update_from_xso_item(self, xso_item):
"""
Update the attributes (except :attr:`jid`) with the values obtained
from the gixen `xso_item`.
`xso_item` must be a valid :class:`.xso.Item` instance.
"""
self.subscription = xso_item.subscription
self.approved = xso_... | python | def update_from_xso_item(self, xso_item):
"""
Update the attributes (except :attr:`jid`) with the values obtained
from the gixen `xso_item`.
`xso_item` must be a valid :class:`.xso.Item` instance.
"""
self.subscription = xso_item.subscription
self.approved = xso_... | [
"def",
"update_from_xso_item",
"(",
"self",
",",
"xso_item",
")",
":",
"self",
".",
"subscription",
"=",
"xso_item",
".",
"subscription",
"self",
".",
"approved",
"=",
"xso_item",
".",
"approved",
"self",
".",
"ask",
"=",
"xso_item",
".",
"ask",
"self",
".... | Update the attributes (except :attr:`jid`) with the values obtained
from the gixen `xso_item`.
`xso_item` must be a valid :class:`.xso.Item` instance. | [
"Update",
"the",
"attributes",
"(",
"except",
":",
"attr",
":",
"jid",
")",
"with",
"the",
"values",
"obtained",
"from",
"the",
"gixen",
"xso_item",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/roster/service.py#L108-L119 |
horazont/aioxmpp | aioxmpp/roster/service.py | Item.from_xso_item | def from_xso_item(cls, xso_item):
"""
Create a :class:`Item` with the :attr:`jid` set to the
:attr:`.xso.Item.jid` obtained from `xso_item`. Then update that
instance with `xso_item` using :meth:`update_from_xso_item` and return
it.
"""
item = cls(xso_item.jid)
... | python | def from_xso_item(cls, xso_item):
"""
Create a :class:`Item` with the :attr:`jid` set to the
:attr:`.xso.Item.jid` obtained from `xso_item`. Then update that
instance with `xso_item` using :meth:`update_from_xso_item` and return
it.
"""
item = cls(xso_item.jid)
... | [
"def",
"from_xso_item",
"(",
"cls",
",",
"xso_item",
")",
":",
"item",
"=",
"cls",
"(",
"xso_item",
".",
"jid",
")",
"item",
".",
"update_from_xso_item",
"(",
"xso_item",
")",
"return",
"item"
] | Create a :class:`Item` with the :attr:`jid` set to the
:attr:`.xso.Item.jid` obtained from `xso_item`. Then update that
instance with `xso_item` using :meth:`update_from_xso_item` and return
it. | [
"Create",
"a",
":",
"class",
":",
"Item",
"with",
"the",
":",
"attr",
":",
"jid",
"set",
"to",
"the",
":",
"attr",
":",
".",
"xso",
".",
"Item",
".",
"jid",
"obtained",
"from",
"xso_item",
".",
"Then",
"update",
"that",
"instance",
"with",
"xso_item"... | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/roster/service.py#L122-L131 |
horazont/aioxmpp | aioxmpp/roster/service.py | Item.export_as_json | def export_as_json(self):
"""
Return a :mod:`json`-compatible dictionary which contains the
attributes of this :class:`Item` except its JID.
"""
result = {
"subscription": self.subscription,
}
if self.name:
result["name"] = self.name
... | python | def export_as_json(self):
"""
Return a :mod:`json`-compatible dictionary which contains the
attributes of this :class:`Item` except its JID.
"""
result = {
"subscription": self.subscription,
}
if self.name:
result["name"] = self.name
... | [
"def",
"export_as_json",
"(",
"self",
")",
":",
"result",
"=",
"{",
"\"subscription\"",
":",
"self",
".",
"subscription",
",",
"}",
"if",
"self",
".",
"name",
":",
"result",
"[",
"\"name\"",
"]",
"=",
"self",
".",
"name",
"if",
"self",
".",
"ask",
"i... | Return a :mod:`json`-compatible dictionary which contains the
attributes of this :class:`Item` except its JID. | [
"Return",
"a",
":",
"mod",
":",
"json",
"-",
"compatible",
"dictionary",
"which",
"contains",
"the",
"attributes",
"of",
"this",
":",
"class",
":",
"Item",
"except",
"its",
"JID",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/roster/service.py#L133-L154 |
horazont/aioxmpp | aioxmpp/roster/service.py | Item.update_from_json | def update_from_json(self, data):
"""
Update the attributes of this :class:`Item` using the values obtained
from the dictionary `data`.
The format of `data` should be the same as the format returned by
:meth:`export_as_json`.
"""
self.subscription = data.get("sub... | python | def update_from_json(self, data):
"""
Update the attributes of this :class:`Item` using the values obtained
from the dictionary `data`.
The format of `data` should be the same as the format returned by
:meth:`export_as_json`.
"""
self.subscription = data.get("sub... | [
"def",
"update_from_json",
"(",
"self",
",",
"data",
")",
":",
"self",
".",
"subscription",
"=",
"data",
".",
"get",
"(",
"\"subscription\"",
",",
"\"none\"",
")",
"self",
".",
"approved",
"=",
"bool",
"(",
"data",
".",
"get",
"(",
"\"approved\"",
",",
... | Update the attributes of this :class:`Item` using the values obtained
from the dictionary `data`.
The format of `data` should be the same as the format returned by
:meth:`export_as_json`. | [
"Update",
"the",
"attributes",
"of",
"this",
":",
"class",
":",
"Item",
"using",
"the",
"values",
"obtained",
"from",
"the",
"dictionary",
"data",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/roster/service.py#L156-L168 |
horazont/aioxmpp | aioxmpp/roster/service.py | RosterClient.export_as_json | def export_as_json(self):
"""
Export the whole roster as currently stored on the client side into a
JSON-compatible dictionary and return that dictionary.
"""
return {
"items": {
str(jid): item.export_as_json()
for jid, item in self.ite... | python | def export_as_json(self):
"""
Export the whole roster as currently stored on the client side into a
JSON-compatible dictionary and return that dictionary.
"""
return {
"items": {
str(jid): item.export_as_json()
for jid, item in self.ite... | [
"def",
"export_as_json",
"(",
"self",
")",
":",
"return",
"{",
"\"items\"",
":",
"{",
"str",
"(",
"jid",
")",
":",
"item",
".",
"export_as_json",
"(",
")",
"for",
"jid",
",",
"item",
"in",
"self",
".",
"items",
".",
"items",
"(",
")",
"}",
",",
"... | Export the whole roster as currently stored on the client side into a
JSON-compatible dictionary and return that dictionary. | [
"Export",
"the",
"whole",
"roster",
"as",
"currently",
"stored",
"on",
"the",
"client",
"side",
"into",
"a",
"JSON",
"-",
"compatible",
"dictionary",
"and",
"return",
"that",
"dictionary",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/roster/service.py#L574-L585 |
horazont/aioxmpp | aioxmpp/roster/service.py | RosterClient.import_from_json | def import_from_json(self, data):
"""
Replace the current roster with the :meth:`export_as_json`-compatible
dictionary in `data`.
No events are fired during this activity. After this method completes,
the whole roster contents are exchanged with the contents from `data`.
... | python | def import_from_json(self, data):
"""
Replace the current roster with the :meth:`export_as_json`-compatible
dictionary in `data`.
No events are fired during this activity. After this method completes,
the whole roster contents are exchanged with the contents from `data`.
... | [
"def",
"import_from_json",
"(",
"self",
",",
"data",
")",
":",
"self",
".",
"version",
"=",
"data",
".",
"get",
"(",
"\"ver\"",
",",
"None",
")",
"self",
".",
"items",
".",
"clear",
"(",
")",
"self",
".",
"groups",
".",
"clear",
"(",
")",
"for",
... | Replace the current roster with the :meth:`export_as_json`-compatible
dictionary in `data`.
No events are fired during this activity. After this method completes,
the whole roster contents are exchanged with the contents from `data`.
Also, no data is transferred to the server; this met... | [
"Replace",
"the",
"current",
"roster",
"with",
"the",
":",
"meth",
":",
"export_as_json",
"-",
"compatible",
"dictionary",
"in",
"data",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/roster/service.py#L587-L609 |
horazont/aioxmpp | aioxmpp/roster/service.py | RosterClient.set_entry | def set_entry(self, jid, *,
name=_Sentinel,
add_to_groups=frozenset(),
remove_from_groups=frozenset(),
timeout=None):
"""
Set properties of a roster entry or add a new roster entry. The roster
entry is identified by its bare... | python | def set_entry(self, jid, *,
name=_Sentinel,
add_to_groups=frozenset(),
remove_from_groups=frozenset(),
timeout=None):
"""
Set properties of a roster entry or add a new roster entry. The roster
entry is identified by its bare... | [
"def",
"set_entry",
"(",
"self",
",",
"jid",
",",
"*",
",",
"name",
"=",
"_Sentinel",
",",
"add_to_groups",
"=",
"frozenset",
"(",
")",
",",
"remove_from_groups",
"=",
"frozenset",
"(",
")",
",",
"timeout",
"=",
"None",
")",
":",
"existing",
"=",
"self... | Set properties of a roster entry or add a new roster entry. The roster
entry is identified by its bare `jid`.
If an entry already exists, all values default to those stored in the
existing entry. For example, if no `name` is given, the current name of
the entry is re-used, if any.
... | [
"Set",
"properties",
"of",
"a",
"roster",
"entry",
"or",
"add",
"a",
"new",
"roster",
"entry",
".",
"The",
"roster",
"entry",
"is",
"identified",
"by",
"its",
"bare",
"jid",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/roster/service.py#L612-L668 |
horazont/aioxmpp | aioxmpp/roster/service.py | RosterClient.remove_entry | def remove_entry(self, jid, *, timeout=None):
"""
Request removal of the roster entry identified by the given bare
`jid`. If the entry currently has any subscription state, the server
will send the corresponding unsubscribing presence stanzas.
`timeout` is the maximum time in se... | python | def remove_entry(self, jid, *, timeout=None):
"""
Request removal of the roster entry identified by the given bare
`jid`. If the entry currently has any subscription state, the server
will send the corresponding unsubscribing presence stanzas.
`timeout` is the maximum time in se... | [
"def",
"remove_entry",
"(",
"self",
",",
"jid",
",",
"*",
",",
"timeout",
"=",
"None",
")",
":",
"yield",
"from",
"self",
".",
"client",
".",
"send",
"(",
"stanza",
".",
"IQ",
"(",
"structs",
".",
"IQType",
".",
"SET",
",",
"payload",
"=",
"roster_... | Request removal of the roster entry identified by the given bare
`jid`. If the entry currently has any subscription state, the server
will send the corresponding unsubscribing presence stanzas.
`timeout` is the maximum time in seconds to wait for a reply from the
server.
This m... | [
"Request",
"removal",
"of",
"the",
"roster",
"entry",
"identified",
"by",
"the",
"given",
"bare",
"jid",
".",
"If",
"the",
"entry",
"currently",
"has",
"any",
"subscription",
"state",
"the",
"server",
"will",
"send",
"the",
"corresponding",
"unsubscribing",
"p... | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/roster/service.py#L671-L695 |
horazont/aioxmpp | aioxmpp/roster/service.py | RosterClient.approve | def approve(self, peer_jid):
"""
(Pre-)approve a subscription request from `peer_jid`.
:param peer_jid: The peer to (pre-)approve.
This sends a ``"subscribed"`` presence to the peer; if the peer has
previously asked for a subscription, this will seal the deal and create
... | python | def approve(self, peer_jid):
"""
(Pre-)approve a subscription request from `peer_jid`.
:param peer_jid: The peer to (pre-)approve.
This sends a ``"subscribed"`` presence to the peer; if the peer has
previously asked for a subscription, this will seal the deal and create
... | [
"def",
"approve",
"(",
"self",
",",
"peer_jid",
")",
":",
"self",
".",
"client",
".",
"enqueue",
"(",
"stanza",
".",
"Presence",
"(",
"type_",
"=",
"structs",
".",
"PresenceType",
".",
"SUBSCRIBED",
",",
"to",
"=",
"peer_jid",
")",
")"
] | (Pre-)approve a subscription request from `peer_jid`.
:param peer_jid: The peer to (pre-)approve.
This sends a ``"subscribed"`` presence to the peer; if the peer has
previously asked for a subscription, this will seal the deal and create
the subscription.
If the peer has not r... | [
"(",
"Pre",
"-",
")",
"approve",
"a",
"subscription",
"request",
"from",
"peer_jid",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/roster/service.py#L697-L719 |
horazont/aioxmpp | aioxmpp/roster/service.py | RosterClient.subscribe | def subscribe(self, peer_jid):
"""
Request presence subscription with the given `peer_jid`.
This is deliberately not a coroutine; we don’t know whether the peer is
online (usually) and they may defer the confirmation very long, if they
confirm at all. Use :meth:`on_subscribed` t... | python | def subscribe(self, peer_jid):
"""
Request presence subscription with the given `peer_jid`.
This is deliberately not a coroutine; we don’t know whether the peer is
online (usually) and they may defer the confirmation very long, if they
confirm at all. Use :meth:`on_subscribed` t... | [
"def",
"subscribe",
"(",
"self",
",",
"peer_jid",
")",
":",
"self",
".",
"client",
".",
"enqueue",
"(",
"stanza",
".",
"Presence",
"(",
"type_",
"=",
"structs",
".",
"PresenceType",
".",
"SUBSCRIBE",
",",
"to",
"=",
"peer_jid",
")",
")"
] | Request presence subscription with the given `peer_jid`.
This is deliberately not a coroutine; we don’t know whether the peer is
online (usually) and they may defer the confirmation very long, if they
confirm at all. Use :meth:`on_subscribed` to get notified when a peer
accepted a subsc... | [
"Request",
"presence",
"subscription",
"with",
"the",
"given",
"peer_jid",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/roster/service.py#L721-L733 |
horazont/aioxmpp | aioxmpp/roster/service.py | RosterClient.unsubscribe | def unsubscribe(self, peer_jid):
"""
Unsubscribe from the presence of the given `peer_jid`.
"""
self.client.enqueue(
stanza.Presence(type_=structs.PresenceType.UNSUBSCRIBE,
to=peer_jid)
) | python | def unsubscribe(self, peer_jid):
"""
Unsubscribe from the presence of the given `peer_jid`.
"""
self.client.enqueue(
stanza.Presence(type_=structs.PresenceType.UNSUBSCRIBE,
to=peer_jid)
) | [
"def",
"unsubscribe",
"(",
"self",
",",
"peer_jid",
")",
":",
"self",
".",
"client",
".",
"enqueue",
"(",
"stanza",
".",
"Presence",
"(",
"type_",
"=",
"structs",
".",
"PresenceType",
".",
"UNSUBSCRIBE",
",",
"to",
"=",
"peer_jid",
")",
")"
] | Unsubscribe from the presence of the given `peer_jid`. | [
"Unsubscribe",
"from",
"the",
"presence",
"of",
"the",
"given",
"peer_jid",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/roster/service.py#L735-L742 |
horazont/aioxmpp | aioxmpp/dispatcher.py | message_handler | def message_handler(type_, from_):
"""
Register the decorated function as message handler.
:param type_: Message type to listen for
:type type_: :class:`~.MessageType`
:param from_: Sender JIDs to listen for
:type from_: :class:`aioxmpp.JID` or :data:`None`
:raise TypeError: if the decorate... | python | def message_handler(type_, from_):
"""
Register the decorated function as message handler.
:param type_: Message type to listen for
:type type_: :class:`~.MessageType`
:param from_: Sender JIDs to listen for
:type from_: :class:`aioxmpp.JID` or :data:`None`
:raise TypeError: if the decorate... | [
"def",
"message_handler",
"(",
"type_",
",",
"from_",
")",
":",
"def",
"decorator",
"(",
"f",
")",
":",
"if",
"asyncio",
".",
"iscoroutinefunction",
"(",
"f",
")",
":",
"raise",
"TypeError",
"(",
"\"message_handler must not be a coroutine function\"",
")",
"aiox... | Register the decorated function as message handler.
:param type_: Message type to listen for
:type type_: :class:`~.MessageType`
:param from_: Sender JIDs to listen for
:type from_: :class:`aioxmpp.JID` or :data:`None`
:raise TypeError: if the decorated object is a coroutine function
.. seeals... | [
"Register",
"the",
"decorated",
"function",
"as",
"message",
"handler",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/dispatcher.py#L338-L373 |
horazont/aioxmpp | aioxmpp/dispatcher.py | presence_handler | def presence_handler(type_, from_):
"""
Register the decorated function as presence stanza handler.
:param type_: Presence type to listen for
:type type_: :class:`~.PresenceType`
:param from_: Sender JIDs to listen for
:type from_: :class:`aioxmpp.JID` or :data:`None`
:raise TypeError: if t... | python | def presence_handler(type_, from_):
"""
Register the decorated function as presence stanza handler.
:param type_: Presence type to listen for
:type type_: :class:`~.PresenceType`
:param from_: Sender JIDs to listen for
:type from_: :class:`aioxmpp.JID` or :data:`None`
:raise TypeError: if t... | [
"def",
"presence_handler",
"(",
"type_",
",",
"from_",
")",
":",
"def",
"decorator",
"(",
"f",
")",
":",
"if",
"asyncio",
".",
"iscoroutinefunction",
"(",
"f",
")",
":",
"raise",
"TypeError",
"(",
"\"presence_handler must not be a coroutine function\"",
")",
"ai... | Register the decorated function as presence stanza handler.
:param type_: Presence type to listen for
:type type_: :class:`~.PresenceType`
:param from_: Sender JIDs to listen for
:type from_: :class:`aioxmpp.JID` or :data:`None`
:raise TypeError: if the decorated object is a coroutine function
... | [
"Register",
"the",
"decorated",
"function",
"as",
"presence",
"stanza",
"handler",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/dispatcher.py#L376-L413 |
horazont/aioxmpp | aioxmpp/dispatcher.py | is_message_handler | def is_message_handler(type_, from_, cb):
"""
Return true if `cb` has been decorated with :func:`message_handler` for the
given `type_` and `from_`.
"""
try:
handlers = aioxmpp.service.get_magic_attr(cb)
except AttributeError:
return False
return aioxmpp.service.HandlerSpec... | python | def is_message_handler(type_, from_, cb):
"""
Return true if `cb` has been decorated with :func:`message_handler` for the
given `type_` and `from_`.
"""
try:
handlers = aioxmpp.service.get_magic_attr(cb)
except AttributeError:
return False
return aioxmpp.service.HandlerSpec... | [
"def",
"is_message_handler",
"(",
"type_",
",",
"from_",
",",
"cb",
")",
":",
"try",
":",
"handlers",
"=",
"aioxmpp",
".",
"service",
".",
"get_magic_attr",
"(",
"cb",
")",
"except",
"AttributeError",
":",
"return",
"False",
"return",
"aioxmpp",
".",
"serv... | Return true if `cb` has been decorated with :func:`message_handler` for the
given `type_` and `from_`. | [
"Return",
"true",
"if",
"cb",
"has",
"been",
"decorated",
"with",
":",
"func",
":",
"message_handler",
"for",
"the",
"given",
"type_",
"and",
"from_",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/dispatcher.py#L416-L432 |
horazont/aioxmpp | aioxmpp/dispatcher.py | is_presence_handler | def is_presence_handler(type_, from_, cb):
"""
Return true if `cb` has been decorated with :func:`presence_handler` for
the given `type_` and `from_`.
"""
try:
handlers = aioxmpp.service.get_magic_attr(cb)
except AttributeError:
return False
return aioxmpp.service.HandlerSp... | python | def is_presence_handler(type_, from_, cb):
"""
Return true if `cb` has been decorated with :func:`presence_handler` for
the given `type_` and `from_`.
"""
try:
handlers = aioxmpp.service.get_magic_attr(cb)
except AttributeError:
return False
return aioxmpp.service.HandlerSp... | [
"def",
"is_presence_handler",
"(",
"type_",
",",
"from_",
",",
"cb",
")",
":",
"try",
":",
"handlers",
"=",
"aioxmpp",
".",
"service",
".",
"get_magic_attr",
"(",
"cb",
")",
"except",
"AttributeError",
":",
"return",
"False",
"return",
"aioxmpp",
".",
"ser... | Return true if `cb` has been decorated with :func:`presence_handler` for
the given `type_` and `from_`. | [
"Return",
"true",
"if",
"cb",
"has",
"been",
"decorated",
"with",
":",
"func",
":",
"presence_handler",
"for",
"the",
"given",
"type_",
"and",
"from_",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/dispatcher.py#L435-L451 |
horazont/aioxmpp | aioxmpp/dispatcher.py | SimpleStanzaDispatcher._feed | def _feed(self, stanza):
"""
Dispatch the given `stanza`.
:param stanza: Stanza to dispatch
:type stanza: :class:`~.StanzaBase`
:rtype: :class:`bool`
:return: true if the stanza was dispatched, false otherwise.
Dispatch the stanza to up to one handler registered... | python | def _feed(self, stanza):
"""
Dispatch the given `stanza`.
:param stanza: Stanza to dispatch
:type stanza: :class:`~.StanzaBase`
:rtype: :class:`bool`
:return: true if the stanza was dispatched, false otherwise.
Dispatch the stanza to up to one handler registered... | [
"def",
"_feed",
"(",
"self",
",",
"stanza",
")",
":",
"from_",
"=",
"stanza",
".",
"from_",
"if",
"from_",
"is",
"None",
":",
"from_",
"=",
"self",
".",
"local_jid",
"keys",
"=",
"[",
"(",
"stanza",
".",
"type_",
",",
"from_",
",",
"False",
")",
... | Dispatch the given `stanza`.
:param stanza: Stanza to dispatch
:type stanza: :class:`~.StanzaBase`
:rtype: :class:`bool`
:return: true if the stanza was dispatched, false otherwise.
Dispatch the stanza to up to one handler registered on the dispatcher.
If no handler is ... | [
"Dispatch",
"the",
"given",
"stanza",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/dispatcher.py#L103-L136 |
horazont/aioxmpp | aioxmpp/dispatcher.py | SimpleStanzaDispatcher.register_callback | def register_callback(self, type_, from_, cb, *,
wildcard_resource=True):
"""
Register a callback function.
:param type_: Stanza type to listen for, or :data:`None` for a
wildcard match.
:param from_: Sender to listen for, or :data:`None` ... | python | def register_callback(self, type_, from_, cb, *,
wildcard_resource=True):
"""
Register a callback function.
:param type_: Stanza type to listen for, or :data:`None` for a
wildcard match.
:param from_: Sender to listen for, or :data:`None` ... | [
"def",
"register_callback",
"(",
"self",
",",
"type_",
",",
"from_",
",",
"cb",
",",
"*",
",",
"wildcard_resource",
"=",
"True",
")",
":",
"# NOQA: E501",
"if",
"from_",
"is",
"None",
"or",
"not",
"from_",
".",
"is_bare",
":",
"wildcard_resource",
"=",
"... | Register a callback function.
:param type_: Stanza type to listen for, or :data:`None` for a
wildcard match.
:param from_: Sender to listen for, or :data:`None` for a full wildcard
match.
:type from_: :class:`aioxmpp.JID` or :data:`None`
:para... | [
"Register",
"a",
"callback",
"function",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/dispatcher.py#L138-L211 |
horazont/aioxmpp | aioxmpp/dispatcher.py | SimpleStanzaDispatcher.unregister_callback | def unregister_callback(self, type_, from_, *,
wildcard_resource=True):
"""
Unregister a callback function.
:param type_: Stanza type to listen for, or :data:`None` for a
wildcard match.
:param from_: Sender to listen for, or :data:`None... | python | def unregister_callback(self, type_, from_, *,
wildcard_resource=True):
"""
Unregister a callback function.
:param type_: Stanza type to listen for, or :data:`None` for a
wildcard match.
:param from_: Sender to listen for, or :data:`None... | [
"def",
"unregister_callback",
"(",
"self",
",",
"type_",
",",
"from_",
",",
"*",
",",
"wildcard_resource",
"=",
"True",
")",
":",
"if",
"from_",
"is",
"None",
"or",
"not",
"from_",
".",
"is_bare",
":",
"wildcard_resource",
"=",
"False",
"self",
".",
"_ma... | Unregister a callback function.
:param type_: Stanza type to listen for, or :data:`None` for a
wildcard match.
:param from_: Sender to listen for, or :data:`None` for a full wildcard
match.
:type from_: :class:`aioxmpp.JID` or :data:`None`
:pa... | [
"Unregister",
"a",
"callback",
"function",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/dispatcher.py#L213-L233 |
horazont/aioxmpp | aioxmpp/dispatcher.py | SimpleStanzaDispatcher.handler_context | def handler_context(self, type_, from_, cb, *, wildcard_resource=True):
"""
Context manager which temporarily registers a callback.
The arguments are the same as for :meth:`register_callback`.
When the context is entered, the callback `cb` is registered. When the
context is exi... | python | def handler_context(self, type_, from_, cb, *, wildcard_resource=True):
"""
Context manager which temporarily registers a callback.
The arguments are the same as for :meth:`register_callback`.
When the context is entered, the callback `cb` is registered. When the
context is exi... | [
"def",
"handler_context",
"(",
"self",
",",
"type_",
",",
"from_",
",",
"cb",
",",
"*",
",",
"wildcard_resource",
"=",
"True",
")",
":",
"self",
".",
"register_callback",
"(",
"type_",
",",
"from_",
",",
"cb",
",",
"wildcard_resource",
"=",
"wildcard_resou... | Context manager which temporarily registers a callback.
The arguments are the same as for :meth:`register_callback`.
When the context is entered, the callback `cb` is registered. When the
context is exited, no matter if an exception is raised or not, the
callback is unregistered. | [
"Context",
"manager",
"which",
"temporarily",
"registers",
"a",
"callback",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/dispatcher.py#L236-L256 |
horazont/aioxmpp | aioxmpp/forms/fields.py | BoundField.clone_for | def clone_for(self, other_instance, memo=None):
"""
Clone this bound field for another instance, possibly during a
:func:`~copy.deepcopy` operation.
:param other_instance: Another form instance to which the newly created
bound field shall be bound.
... | python | def clone_for(self, other_instance, memo=None):
"""
Clone this bound field for another instance, possibly during a
:func:`~copy.deepcopy` operation.
:param other_instance: Another form instance to which the newly created
bound field shall be bound.
... | [
"def",
"clone_for",
"(",
"self",
",",
"other_instance",
",",
"memo",
"=",
"None",
")",
":",
"if",
"memo",
"is",
"None",
":",
"result",
"=",
"copy",
".",
"deepcopy",
"(",
"self",
")",
"else",
":",
"result",
"=",
"copy",
".",
"deepcopy",
"(",
"self",
... | Clone this bound field for another instance, possibly during a
:func:`~copy.deepcopy` operation.
:param other_instance: Another form instance to which the newly created
bound field shall be bound.
:type other_instance: :class:`object`
:param memo: Optional... | [
"Clone",
"this",
"bound",
"field",
"for",
"another",
"instance",
"possibly",
"during",
"a",
":",
"func",
":",
"~copy",
".",
"deepcopy",
"operation",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/forms/fields.py#L184-L205 |
horazont/aioxmpp | aioxmpp/forms/fields.py | BoundField.load | def load(self, field_xso):
"""
Load the field information from a data field.
:param field_xso: XSO describing the field.
:type field_xso: :class:`~.Field`
This loads the current value, description, label and possibly options
from the `field_xso`, shadowing the informati... | python | def load(self, field_xso):
"""
Load the field information from a data field.
:param field_xso: XSO describing the field.
:type field_xso: :class:`~.Field`
This loads the current value, description, label and possibly options
from the `field_xso`, shadowing the informati... | [
"def",
"load",
"(",
"self",
",",
"field_xso",
")",
":",
"if",
"field_xso",
".",
"desc",
":",
"self",
".",
"_desc",
"=",
"field_xso",
".",
"desc",
"if",
"field_xso",
".",
"label",
":",
"self",
".",
"_label",
"=",
"field_xso",
".",
"label",
"self",
"."... | Load the field information from a data field.
:param field_xso: XSO describing the field.
:type field_xso: :class:`~.Field`
This loads the current value, description, label and possibly options
from the `field_xso`, shadowing the information from the declaration of
the field on... | [
"Load",
"the",
"field",
"information",
"from",
"a",
"data",
"field",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/forms/fields.py#L208-L232 |
horazont/aioxmpp | aioxmpp/forms/fields.py | BoundField.render | def render(self, *, use_local_metadata=True):
"""
Return a :class:`~.Field` containing the values and metadata set in the
field.
:param use_local_metadata: if true, the description, label and required
metadata can be sourced from the field
... | python | def render(self, *, use_local_metadata=True):
"""
Return a :class:`~.Field` containing the values and metadata set in the
field.
:param use_local_metadata: if true, the description, label and required
metadata can be sourced from the field
... | [
"def",
"render",
"(",
"self",
",",
"*",
",",
"use_local_metadata",
"=",
"True",
")",
":",
"result",
"=",
"forms_xso",
".",
"Field",
"(",
"var",
"=",
"self",
".",
"field",
".",
"var",
",",
"type_",
"=",
"self",
".",
"field",
".",
"FIELD_TYPE",
",",
... | Return a :class:`~.Field` containing the values and metadata set in the
field.
:param use_local_metadata: if true, the description, label and required
metadata can be sourced from the field
descriptor associated with this bound field... | [
"Return",
"a",
":",
"class",
":",
"~",
".",
"Field",
"containing",
"the",
"values",
"and",
"metadata",
"set",
"in",
"the",
"field",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/forms/fields.py#L235-L288 |
horazont/aioxmpp | aioxmpp/forms/fields.py | BoundMultiValueField.value | def value(self):
"""
A tuple of values. This attribute can be set with any iterable; the
iterable is then evaluated into a tuple and stored at the bound field.
Whenever values are written to this attribute, they are passed through
the :meth:`~.AbstractCDataType.coerce` method of... | python | def value(self):
"""
A tuple of values. This attribute can be set with any iterable; the
iterable is then evaluated into a tuple and stored at the bound field.
Whenever values are written to this attribute, they are passed through
the :meth:`~.AbstractCDataType.coerce` method of... | [
"def",
"value",
"(",
"self",
")",
":",
"try",
":",
"return",
"self",
".",
"_value",
"except",
"AttributeError",
":",
"self",
".",
"value",
"=",
"self",
".",
"_field",
".",
"default",
"(",
")",
"return",
"self",
".",
"_value"
] | A tuple of values. This attribute can be set with any iterable; the
iterable is then evaluated into a tuple and stored at the bound field.
Whenever values are written to this attribute, they are passed through
the :meth:`~.AbstractCDataType.coerce` method of the
:attr:`~.AbstractField.t... | [
"A",
"tuple",
"of",
"values",
".",
"This",
"attribute",
"can",
"be",
"set",
"with",
"any",
"iterable",
";",
"the",
"iterable",
"is",
"then",
"evaluated",
"into",
"a",
"tuple",
"and",
"stored",
"at",
"the",
"bound",
"field",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/forms/fields.py#L384-L398 |
horazont/aioxmpp | aioxmpp/forms/fields.py | BoundSelectField.value | def value(self):
"""
The current value of the field. If no value is set when this attribute
is accessed for reading, the :meth:`default` of the field is invoked
and the result is set and returned as value.
Only values contained in the :attr:`~.BoundOptionsField.options` can be
... | python | def value(self):
"""
The current value of the field. If no value is set when this attribute
is accessed for reading, the :meth:`default` of the field is invoked
and the result is set and returned as value.
Only values contained in the :attr:`~.BoundOptionsField.options` can be
... | [
"def",
"value",
"(",
"self",
")",
":",
"try",
":",
"return",
"self",
".",
"_value",
"except",
"AttributeError",
":",
"self",
".",
"_value",
"=",
"self",
".",
"field",
".",
"default",
"(",
")",
"return",
"self",
".",
"_value"
] | The current value of the field. If no value is set when this attribute
is accessed for reading, the :meth:`default` of the field is invoked
and the result is set and returned as value.
Only values contained in the :attr:`~.BoundOptionsField.options` can be
set, other values are rejected... | [
"The",
"current",
"value",
"of",
"the",
"field",
".",
"If",
"no",
"value",
"is",
"set",
"when",
"this",
"attribute",
"is",
"accessed",
"for",
"reading",
"the",
":",
"meth",
":",
"default",
"of",
"the",
"field",
"is",
"invoked",
"and",
"the",
"result",
... | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/forms/fields.py#L548-L563 |
horazont/aioxmpp | aioxmpp/forms/fields.py | AbstractField.make_bound | def make_bound(self, for_instance):
"""
Create a new :ref:`bound field class <api-aioxmpp.forms-bound-fields>`
or return an existing one for the given form object.
:param for_instance: The form instance to which the bound field should
be bound.
If n... | python | def make_bound(self, for_instance):
"""
Create a new :ref:`bound field class <api-aioxmpp.forms-bound-fields>`
or return an existing one for the given form object.
:param for_instance: The form instance to which the bound field should
be bound.
If n... | [
"def",
"make_bound",
"(",
"self",
",",
"for_instance",
")",
":",
"try",
":",
"return",
"for_instance",
".",
"_descriptor_data",
"[",
"self",
"]",
"except",
"KeyError",
":",
"bound",
"=",
"self",
".",
"create_bound",
"(",
"for_instance",
")",
"for_instance",
... | Create a new :ref:`bound field class <api-aioxmpp.forms-bound-fields>`
or return an existing one for the given form object.
:param for_instance: The form instance to which the bound field should
be bound.
If no bound field can be found on the given `for_instance` f... | [
"Create",
"a",
"new",
":",
"ref",
":",
"bound",
"field",
"class",
"<api",
"-",
"aioxmpp",
".",
"forms",
"-",
"bound",
"-",
"fields",
">",
"or",
"return",
"an",
"existing",
"one",
"for",
"the",
"given",
"form",
"object",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/forms/fields.py#L851-L875 |
horazont/aioxmpp | aioxmpp/xml.py | make_parser | def make_parser():
"""
Create a parser which is suitably configured for parsing an XMPP XML
stream. It comes equipped with :class:`XMPPLexicalHandler`.
"""
p = xml.sax.make_parser()
p.setFeature(xml.sax.handler.feature_namespaces, True)
p.setFeature(xml.sax.handler.feature_external_ges, Fals... | python | def make_parser():
"""
Create a parser which is suitably configured for parsing an XMPP XML
stream. It comes equipped with :class:`XMPPLexicalHandler`.
"""
p = xml.sax.make_parser()
p.setFeature(xml.sax.handler.feature_namespaces, True)
p.setFeature(xml.sax.handler.feature_external_ges, Fals... | [
"def",
"make_parser",
"(",
")",
":",
"p",
"=",
"xml",
".",
"sax",
".",
"make_parser",
"(",
")",
"p",
".",
"setFeature",
"(",
"xml",
".",
"sax",
".",
"handler",
".",
"feature_namespaces",
",",
"True",
")",
"p",
".",
"setFeature",
"(",
"xml",
".",
"s... | Create a parser which is suitably configured for parsing an XMPP XML
stream. It comes equipped with :class:`XMPPLexicalHandler`. | [
"Create",
"a",
"parser",
"which",
"is",
"suitably",
"configured",
"for",
"parsing",
"an",
"XMPP",
"XML",
"stream",
".",
"It",
"comes",
"equipped",
"with",
":",
"class",
":",
"XMPPLexicalHandler",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/xml.py#L1085-L1095 |
horazont/aioxmpp | aioxmpp/xml.py | serialize_single_xso | def serialize_single_xso(x):
"""
Serialize a single XSO `x` to a string. This is potentially very slow and
should only be used for debugging purposes. It is generally more efficient
to use a :class:`XMPPXMLGenerator` to stream elements.
"""
buf = io.BytesIO()
gen = XMPPXMLGenerator(buf,
... | python | def serialize_single_xso(x):
"""
Serialize a single XSO `x` to a string. This is potentially very slow and
should only be used for debugging purposes. It is generally more efficient
to use a :class:`XMPPXMLGenerator` to stream elements.
"""
buf = io.BytesIO()
gen = XMPPXMLGenerator(buf,
... | [
"def",
"serialize_single_xso",
"(",
"x",
")",
":",
"buf",
"=",
"io",
".",
"BytesIO",
"(",
")",
"gen",
"=",
"XMPPXMLGenerator",
"(",
"buf",
",",
"short_empty_elements",
"=",
"True",
",",
"sorted_attributes",
"=",
"True",
")",
"x",
".",
"unparse_to_sax",
"("... | Serialize a single XSO `x` to a string. This is potentially very slow and
should only be used for debugging purposes. It is generally more efficient
to use a :class:`XMPPXMLGenerator` to stream elements. | [
"Serialize",
"a",
"single",
"XSO",
"x",
"to",
"a",
"string",
".",
"This",
"is",
"potentially",
"very",
"slow",
"and",
"should",
"only",
"be",
"used",
"for",
"debugging",
"purposes",
".",
"It",
"is",
"generally",
"more",
"efficient",
"to",
"use",
"a",
":"... | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/xml.py#L1098-L1109 |
horazont/aioxmpp | aioxmpp/xml.py | write_single_xso | def write_single_xso(x, dest):
"""
Write a single XSO `x` to a binary file-like object `dest`.
"""
gen = XMPPXMLGenerator(dest,
short_empty_elements=True,
sorted_attributes=True)
x.unparse_to_sax(gen) | python | def write_single_xso(x, dest):
"""
Write a single XSO `x` to a binary file-like object `dest`.
"""
gen = XMPPXMLGenerator(dest,
short_empty_elements=True,
sorted_attributes=True)
x.unparse_to_sax(gen) | [
"def",
"write_single_xso",
"(",
"x",
",",
"dest",
")",
":",
"gen",
"=",
"XMPPXMLGenerator",
"(",
"dest",
",",
"short_empty_elements",
"=",
"True",
",",
"sorted_attributes",
"=",
"True",
")",
"x",
".",
"unparse_to_sax",
"(",
"gen",
")"
] | Write a single XSO `x` to a binary file-like object `dest`. | [
"Write",
"a",
"single",
"XSO",
"x",
"to",
"a",
"binary",
"file",
"-",
"like",
"object",
"dest",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/xml.py#L1112-L1119 |
horazont/aioxmpp | aioxmpp/xml.py | read_xso | def read_xso(src, xsomap):
"""
Read a single XSO from a binary file-like input `src` containing an XML
document.
`xsomap` must be a mapping which maps :class:`~.XSO` subclasses
to callables. These will be registered at a newly created
:class:`.xso.XSOParser` instance which will be used to parse... | python | def read_xso(src, xsomap):
"""
Read a single XSO from a binary file-like input `src` containing an XML
document.
`xsomap` must be a mapping which maps :class:`~.XSO` subclasses
to callables. These will be registered at a newly created
:class:`.xso.XSOParser` instance which will be used to parse... | [
"def",
"read_xso",
"(",
"src",
",",
"xsomap",
")",
":",
"xso_parser",
"=",
"xso",
".",
"XSOParser",
"(",
")",
"for",
"class_",
",",
"cb",
"in",
"xsomap",
".",
"items",
"(",
")",
":",
"xso_parser",
".",
"add_class",
"(",
"class_",
",",
"cb",
")",
"d... | Read a single XSO from a binary file-like input `src` containing an XML
document.
`xsomap` must be a mapping which maps :class:`~.XSO` subclasses
to callables. These will be registered at a newly created
:class:`.xso.XSOParser` instance which will be used to parse the document
in `src`.
The `... | [
"Read",
"a",
"single",
"XSO",
"from",
"a",
"binary",
"file",
"-",
"like",
"input",
"src",
"containing",
"an",
"XML",
"document",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/xml.py#L1122-L1152 |
horazont/aioxmpp | aioxmpp/xml.py | read_single_xso | def read_single_xso(src, type_):
"""
Read a single :class:`~.XSO` of the given `type_` from the binary file-like
input `src` and return the instance.
"""
result = None
def cb(instance):
nonlocal result
result = instance
read_xso(src, {type_: cb})
return result | python | def read_single_xso(src, type_):
"""
Read a single :class:`~.XSO` of the given `type_` from the binary file-like
input `src` and return the instance.
"""
result = None
def cb(instance):
nonlocal result
result = instance
read_xso(src, {type_: cb})
return result | [
"def",
"read_single_xso",
"(",
"src",
",",
"type_",
")",
":",
"result",
"=",
"None",
"def",
"cb",
"(",
"instance",
")",
":",
"nonlocal",
"result",
"result",
"=",
"instance",
"read_xso",
"(",
"src",
",",
"{",
"type_",
":",
"cb",
"}",
")",
"return",
"r... | Read a single :class:`~.XSO` of the given `type_` from the binary file-like
input `src` and return the instance. | [
"Read",
"a",
"single",
":",
"class",
":",
"~",
".",
"XSO",
"of",
"the",
"given",
"type_",
"from",
"the",
"binary",
"file",
"-",
"like",
"input",
"src",
"and",
"return",
"the",
"instance",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/xml.py#L1155-L1169 |
horazont/aioxmpp | aioxmpp/xml.py | XMPPXMLGenerator.startPrefixMapping | def startPrefixMapping(self, prefix, uri, *, auto=False):
"""
Start a prefix mapping which maps the given `prefix` to the given
`uri`.
Note that prefix mappings are handled transactional. All announcements
of prefix mappings are collected until the next call to
:meth:`st... | python | def startPrefixMapping(self, prefix, uri, *, auto=False):
"""
Start a prefix mapping which maps the given `prefix` to the given
`uri`.
Note that prefix mappings are handled transactional. All announcements
of prefix mappings are collected until the next call to
:meth:`st... | [
"def",
"startPrefixMapping",
"(",
"self",
",",
"prefix",
",",
"uri",
",",
"*",
",",
"auto",
"=",
"False",
")",
":",
"if",
"(",
"prefix",
"is",
"not",
"None",
"and",
"(",
"prefix",
"==",
"\"xml\"",
"or",
"prefix",
"==",
"\"xmlns\"",
"or",
"not",
"xmlV... | Start a prefix mapping which maps the given `prefix` to the given
`uri`.
Note that prefix mappings are handled transactional. All announcements
of prefix mappings are collected until the next call to
:meth:`startElementNS`. At that point, the mappings are collected and
start to ... | [
"Start",
"a",
"prefix",
"mapping",
"which",
"maps",
"the",
"given",
"prefix",
"to",
"the",
"given",
"uri",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/xml.py#L348-L388 |
horazont/aioxmpp | aioxmpp/xml.py | XMPPXMLGenerator.startElementNS | def startElementNS(self, name, qname, attributes=None):
"""
Start a sub-element. `name` must be a tuple of ``(namespace_uri,
localname)`` and `qname` is ignored. `attributes` must be a dictionary
mapping attribute tag tuples (``(namespace_uri, attribute_name)``) to
string values.... | python | def startElementNS(self, name, qname, attributes=None):
"""
Start a sub-element. `name` must be a tuple of ``(namespace_uri,
localname)`` and `qname` is ignored. `attributes` must be a dictionary
mapping attribute tag tuples (``(namespace_uri, attribute_name)``) to
string values.... | [
"def",
"startElementNS",
"(",
"self",
",",
"name",
",",
"qname",
",",
"attributes",
"=",
"None",
")",
":",
"self",
".",
"_finish_pending_start_element",
"(",
")",
"old_counter",
"=",
"self",
".",
"_ns_counter",
"qname",
"=",
"self",
".",
"_qname",
"(",
"na... | Start a sub-element. `name` must be a tuple of ``(namespace_uri,
localname)`` and `qname` is ignored. `attributes` must be a dictionary
mapping attribute tag tuples (``(namespace_uri, attribute_name)``) to
string values. To use unnamespaced attributes, `namespace_uri` can be
false (e.g. ... | [
"Start",
"a",
"sub",
"-",
"element",
".",
"name",
"must",
"be",
"a",
"tuple",
"of",
"(",
"namespace_uri",
"localname",
")",
"and",
"qname",
"is",
"ignored",
".",
"attributes",
"must",
"be",
"a",
"dictionary",
"mapping",
"attribute",
"tag",
"tuples",
"(",
... | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/xml.py#L390-L457 |
horazont/aioxmpp | aioxmpp/xml.py | XMPPXMLGenerator.endElementNS | def endElementNS(self, name, qname):
"""
End a previously started element. `name` must be a ``(namespace_uri,
localname)`` tuple and `qname` is ignored.
"""
if self._ns_prefixes_floating_out:
raise RuntimeError("namespace prefix has not been closed")
if self.... | python | def endElementNS(self, name, qname):
"""
End a previously started element. `name` must be a ``(namespace_uri,
localname)`` tuple and `qname` is ignored.
"""
if self._ns_prefixes_floating_out:
raise RuntimeError("namespace prefix has not been closed")
if self.... | [
"def",
"endElementNS",
"(",
"self",
",",
"name",
",",
"qname",
")",
":",
"if",
"self",
".",
"_ns_prefixes_floating_out",
":",
"raise",
"RuntimeError",
"(",
"\"namespace prefix has not been closed\"",
")",
"if",
"self",
".",
"_pending_start_element",
"==",
"name",
... | End a previously started element. `name` must be a ``(namespace_uri,
localname)`` tuple and `qname` is ignored. | [
"End",
"a",
"previously",
"started",
"element",
".",
"name",
"must",
"be",
"a",
"(",
"namespace_uri",
"localname",
")",
"tuple",
"and",
"qname",
"is",
"ignored",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/xml.py#L459-L476 |
horazont/aioxmpp | aioxmpp/xml.py | XMPPXMLGenerator.characters | def characters(self, chars):
"""
Put character data in the currently open element. Special characters
(such as ``<``, ``>`` and ``&``) are escaped.
If `chars` contains any ASCII control character, :class:`ValueError` is
raised.
"""
self._finish_pending_start_elem... | python | def characters(self, chars):
"""
Put character data in the currently open element. Special characters
(such as ``<``, ``>`` and ``&``) are escaped.
If `chars` contains any ASCII control character, :class:`ValueError` is
raised.
"""
self._finish_pending_start_elem... | [
"def",
"characters",
"(",
"self",
",",
"chars",
")",
":",
"self",
".",
"_finish_pending_start_element",
"(",
")",
"if",
"not",
"is_valid_cdata_str",
"(",
"chars",
")",
":",
"raise",
"ValueError",
"(",
"\"control characters are not allowed in \"",
"\"well-formed XML\""... | Put character data in the currently open element. Special characters
(such as ``<``, ``>`` and ``&``) are escaped.
If `chars` contains any ASCII control character, :class:`ValueError` is
raised. | [
"Put",
"character",
"data",
"in",
"the",
"currently",
"open",
"element",
".",
"Special",
"characters",
"(",
"such",
"as",
"<",
">",
"and",
"&",
")",
"are",
"escaped",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/xml.py#L493-L508 |
horazont/aioxmpp | aioxmpp/xml.py | XMPPXMLGenerator._save_state | def _save_state(self):
"""
Helper context manager for :meth:`buffer` which saves the whole state.
This is broken out in a separate method for readability and tested
indirectly by testing :meth:`buffer`.
"""
ns_prefixes_floating_in = copy.copy(self._ns_prefixes_floating_i... | python | def _save_state(self):
"""
Helper context manager for :meth:`buffer` which saves the whole state.
This is broken out in a separate method for readability and tested
indirectly by testing :meth:`buffer`.
"""
ns_prefixes_floating_in = copy.copy(self._ns_prefixes_floating_i... | [
"def",
"_save_state",
"(",
"self",
")",
":",
"ns_prefixes_floating_in",
"=",
"copy",
".",
"copy",
"(",
"self",
".",
"_ns_prefixes_floating_in",
")",
"ns_prefixes_floating_out",
"=",
"copy",
".",
"copy",
"(",
"self",
".",
"_ns_prefixes_floating_out",
")",
"ns_decls... | Helper context manager for :meth:`buffer` which saves the whole state.
This is broken out in a separate method for readability and tested
indirectly by testing :meth:`buffer`. | [
"Helper",
"context",
"manager",
"for",
":",
"meth",
":",
"buffer",
"which",
"saves",
"the",
"whole",
"state",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/xml.py#L562-L591 |
horazont/aioxmpp | aioxmpp/xml.py | XMPPXMLGenerator.buffer | def buffer(self):
"""
Context manager to temporarily buffer the output.
:raise RuntimeError: If two :meth:`buffer` context managers are used
nestedly.
If the context manager is left without exception, the buffered output
is sent to the actual sink. ... | python | def buffer(self):
"""
Context manager to temporarily buffer the output.
:raise RuntimeError: If two :meth:`buffer` context managers are used
nestedly.
If the context manager is left without exception, the buffered output
is sent to the actual sink. ... | [
"def",
"buffer",
"(",
"self",
")",
":",
"if",
"self",
".",
"_buf_in_use",
":",
"raise",
"RuntimeError",
"(",
"\"nested use of buffer() is not supported\"",
")",
"self",
".",
"_buf_in_use",
"=",
"True",
"old_write",
"=",
"self",
".",
"_write",
"old_flush",
"=",
... | Context manager to temporarily buffer the output.
:raise RuntimeError: If two :meth:`buffer` context managers are used
nestedly.
If the context manager is left without exception, the buffered output
is sent to the actual sink. Otherwise, it is discarded.
I... | [
"Context",
"manager",
"to",
"temporarily",
"buffer",
"the",
"output",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/xml.py#L594-L644 |
horazont/aioxmpp | aioxmpp/xml.py | XMLStreamWriter.start | def start(self):
"""
Send the stream header as described above.
"""
attrs = {
(None, "to"): str(self._to),
(None, "version"): ".".join(map(str, self._version))
}
if self._from:
attrs[None, "from"] = str(self._from)
self._writer... | python | def start(self):
"""
Send the stream header as described above.
"""
attrs = {
(None, "to"): str(self._to),
(None, "version"): ".".join(map(str, self._version))
}
if self._from:
attrs[None, "from"] = str(self._from)
self._writer... | [
"def",
"start",
"(",
"self",
")",
":",
"attrs",
"=",
"{",
"(",
"None",
",",
"\"to\"",
")",
":",
"str",
"(",
"self",
".",
"_to",
")",
",",
"(",
"None",
",",
"\"version\"",
")",
":",
"\".\"",
".",
"join",
"(",
"map",
"(",
"str",
",",
"self",
".... | Send the stream header as described above. | [
"Send",
"the",
"stream",
"header",
"as",
"described",
"above",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/xml.py#L718-L736 |
horazont/aioxmpp | aioxmpp/xml.py | XMLStreamWriter.send | def send(self, xso):
"""
Send a single XML stream object.
:param xso: Object to serialise and send.
:type xso: :class:`aioxmpp.xso.XSO`
:raises Exception: from any serialisation errors, usually
:class:`ValueError`.
Serialise the `xso` and send... | python | def send(self, xso):
"""
Send a single XML stream object.
:param xso: Object to serialise and send.
:type xso: :class:`aioxmpp.xso.XSO`
:raises Exception: from any serialisation errors, usually
:class:`ValueError`.
Serialise the `xso` and send... | [
"def",
"send",
"(",
"self",
",",
"xso",
")",
":",
"with",
"self",
".",
"_writer",
".",
"buffer",
"(",
")",
":",
"xso",
".",
"unparse_to_sax",
"(",
"self",
".",
"_writer",
")"
] | Send a single XML stream object.
:param xso: Object to serialise and send.
:type xso: :class:`aioxmpp.xso.XSO`
:raises Exception: from any serialisation errors, usually
:class:`ValueError`.
Serialise the `xso` and send it over the stream. If any serialisation... | [
"Send",
"a",
"single",
"XML",
"stream",
"object",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/xml.py#L738-L759 |
horazont/aioxmpp | aioxmpp/xml.py | XMLStreamWriter.abort | def abort(self):
"""
Abort the stream.
The stream is flushed and the internal data structures are cleaned up.
No stream footer is sent. The stream is :attr:`closed` afterwards.
If the stream is already :attr:`closed`, this method does nothing.
"""
if self._close... | python | def abort(self):
"""
Abort the stream.
The stream is flushed and the internal data structures are cleaned up.
No stream footer is sent. The stream is :attr:`closed` afterwards.
If the stream is already :attr:`closed`, this method does nothing.
"""
if self._close... | [
"def",
"abort",
"(",
"self",
")",
":",
"if",
"self",
".",
"_closed",
":",
"return",
"self",
".",
"_closed",
"=",
"True",
"self",
".",
"_writer",
".",
"flush",
"(",
")",
"del",
"self",
".",
"_writer"
] | Abort the stream.
The stream is flushed and the internal data structures are cleaned up.
No stream footer is sent. The stream is :attr:`closed` afterwards.
If the stream is already :attr:`closed`, this method does nothing. | [
"Abort",
"the",
"stream",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/xml.py#L761-L774 |
horazont/aioxmpp | aioxmpp/xml.py | XMLStreamWriter.close | def close(self):
"""
Close the stream.
The stream footer is sent and the internal structures are cleaned up.
If the stream is already :attr:`closed`, this method does nothing.
"""
if self._closed:
return
self._closed = True
self._writer.endEl... | python | def close(self):
"""
Close the stream.
The stream footer is sent and the internal structures are cleaned up.
If the stream is already :attr:`closed`, this method does nothing.
"""
if self._closed:
return
self._closed = True
self._writer.endEl... | [
"def",
"close",
"(",
"self",
")",
":",
"if",
"self",
".",
"_closed",
":",
"return",
"self",
".",
"_closed",
"=",
"True",
"self",
".",
"_writer",
".",
"endElementNS",
"(",
"(",
"namespaces",
".",
"xmlstream",
",",
"\"stream\"",
")",
",",
"None",
")",
... | Close the stream.
The stream footer is sent and the internal structures are cleaned up.
If the stream is already :attr:`closed`, this method does nothing. | [
"Close",
"the",
"stream",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/xml.py#L776-L791 |
horazont/aioxmpp | aioxmpp/rsm/xso.py | ResultSetMetadata.fetch_page | def fetch_page(cls, index, max_=None):
"""
Return a query set which requests a specific page.
:param index: Index of the first element of the page to fetch.
:type index: :class:`int`
:param max_: Maximum number of elements to fetch
:type max_: :class:`int` or :data:`None... | python | def fetch_page(cls, index, max_=None):
"""
Return a query set which requests a specific page.
:param index: Index of the first element of the page to fetch.
:type index: :class:`int`
:param max_: Maximum number of elements to fetch
:type max_: :class:`int` or :data:`None... | [
"def",
"fetch_page",
"(",
"cls",
",",
"index",
",",
"max_",
"=",
"None",
")",
":",
"result",
"=",
"cls",
"(",
")",
"result",
".",
"index",
"=",
"index",
"result",
".",
"max_",
"=",
"max_",
"return",
"result"
] | Return a query set which requests a specific page.
:param index: Index of the first element of the page to fetch.
:type index: :class:`int`
:param max_: Maximum number of elements to fetch
:type max_: :class:`int` or :data:`None`
:rtype: :class:`ResultSetMetadata`
:retur... | [
"Return",
"a",
"query",
"set",
"which",
"requests",
"a",
"specific",
"page",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/rsm/xso.py#L193-L214 |
horazont/aioxmpp | aioxmpp/rsm/xso.py | ResultSetMetadata.limit | def limit(self, max_):
"""
Limit the result set to a given number of items.
:param max_: Maximum number of items to return.
:type max_: :class:`int` or :data:`None`
:rtype: :class:`ResultSetMetadata`
:return: A new request set up to request at most `max_` items.
... | python | def limit(self, max_):
"""
Limit the result set to a given number of items.
:param max_: Maximum number of items to return.
:type max_: :class:`int` or :data:`None`
:rtype: :class:`ResultSetMetadata`
:return: A new request set up to request at most `max_` items.
... | [
"def",
"limit",
"(",
"self",
",",
"max_",
")",
":",
"if",
"isinstance",
"(",
"self",
",",
"type",
")",
":",
"result",
"=",
"self",
"(",
")",
"else",
":",
"result",
"=",
"copy",
".",
"deepcopy",
"(",
"self",
")",
"result",
".",
"max_",
"=",
"max_"... | Limit the result set to a given number of items.
:param max_: Maximum number of items to return.
:type max_: :class:`int` or :data:`None`
:rtype: :class:`ResultSetMetadata`
:return: A new request set up to request at most `max_` items.
This method can be called on the class and... | [
"Limit",
"the",
"result",
"set",
"to",
"a",
"given",
"number",
"of",
"items",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/rsm/xso.py#L217-L237 |
horazont/aioxmpp | aioxmpp/rsm/xso.py | ResultSetMetadata.next_page | def next_page(self, max_=None):
"""
Return a query set which requests the page after this response.
:param max_: Maximum number of items to return.
:type max_: :class:`int` or :data:`None`
:rtype: :class:`ResultSetMetadata`
:return: A new request set up to request the ne... | python | def next_page(self, max_=None):
"""
Return a query set which requests the page after this response.
:param max_: Maximum number of items to return.
:type max_: :class:`int` or :data:`None`
:rtype: :class:`ResultSetMetadata`
:return: A new request set up to request the ne... | [
"def",
"next_page",
"(",
"self",
",",
"max_",
"=",
"None",
")",
":",
"result",
"=",
"type",
"(",
"self",
")",
"(",
")",
"result",
".",
"after",
"=",
"After",
"(",
"self",
".",
"last",
".",
"value",
")",
"result",
".",
"max_",
"=",
"max_",
"return... | Return a query set which requests the page after this response.
:param max_: Maximum number of items to return.
:type max_: :class:`int` or :data:`None`
:rtype: :class:`ResultSetMetadata`
:return: A new request set up to request the next page.
Must be called on a result set whi... | [
"Return",
"a",
"query",
"set",
"which",
"requests",
"the",
"page",
"after",
"this",
"response",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/rsm/xso.py#L239-L254 |
horazont/aioxmpp | aioxmpp/rsm/xso.py | ResultSetMetadata.previous_page | def previous_page(self, max_=None):
"""
Return a query set which requests the page before this response.
:param max_: Maximum number of items to return.
:type max_: :class:`int` or :data:`None`
:rtype: :class:`ResultSetMetadata`
:return: A new request set up to request t... | python | def previous_page(self, max_=None):
"""
Return a query set which requests the page before this response.
:param max_: Maximum number of items to return.
:type max_: :class:`int` or :data:`None`
:rtype: :class:`ResultSetMetadata`
:return: A new request set up to request t... | [
"def",
"previous_page",
"(",
"self",
",",
"max_",
"=",
"None",
")",
":",
"result",
"=",
"type",
"(",
"self",
")",
"(",
")",
"result",
".",
"before",
"=",
"Before",
"(",
"self",
".",
"first",
".",
"value",
")",
"result",
".",
"max_",
"=",
"max_",
... | Return a query set which requests the page before this response.
:param max_: Maximum number of items to return.
:type max_: :class:`int` or :data:`None`
:rtype: :class:`ResultSetMetadata`
:return: A new request set up to request the previous page.
Must be called on a result se... | [
"Return",
"a",
"query",
"set",
"which",
"requests",
"the",
"page",
"before",
"this",
"response",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/rsm/xso.py#L256-L271 |
horazont/aioxmpp | aioxmpp/rsm/xso.py | ResultSetMetadata.last_page | def last_page(self_or_cls, max_=None):
"""
Return a query set which requests the last page.
:param max_: Maximum number of items to return.
:type max_: :class:`int` or :data:`None`
:rtype: :class:`ResultSetMetadata`
:return: A new request set up to request the last page.... | python | def last_page(self_or_cls, max_=None):
"""
Return a query set which requests the last page.
:param max_: Maximum number of items to return.
:type max_: :class:`int` or :data:`None`
:rtype: :class:`ResultSetMetadata`
:return: A new request set up to request the last page.... | [
"def",
"last_page",
"(",
"self_or_cls",
",",
"max_",
"=",
"None",
")",
":",
"result",
"=",
"self_or_cls",
"(",
")",
"result",
".",
"before",
"=",
"Before",
"(",
")",
"result",
".",
"max_",
"=",
"max_",
"return",
"result"
] | Return a query set which requests the last page.
:param max_: Maximum number of items to return.
:type max_: :class:`int` or :data:`None`
:rtype: :class:`ResultSetMetadata`
:return: A new request set up to request the last page. | [
"Return",
"a",
"query",
"set",
"which",
"requests",
"the",
"last",
"page",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/rsm/xso.py#L274-L286 |
horazont/aioxmpp | aioxmpp/forms/xso.py | FieldType.allow_upcast | def allow_upcast(self, to):
"""
Return true if the field type may be upcast to the other field type
`to`.
This relation specifies when it is safe to transfer data from this
field type to the given other field type `to`.
This is the case if any of the following holds tru... | python | def allow_upcast(self, to):
"""
Return true if the field type may be upcast to the other field type
`to`.
This relation specifies when it is safe to transfer data from this
field type to the given other field type `to`.
This is the case if any of the following holds tru... | [
"def",
"allow_upcast",
"(",
"self",
",",
"to",
")",
":",
"if",
"self",
"==",
"to",
":",
"return",
"True",
"if",
"self",
"==",
"FieldType",
".",
"TEXT_SINGLE",
"and",
"to",
"==",
"FieldType",
".",
"TEXT_PRIVATE",
":",
"return",
"True",
"return",
"False"
] | Return true if the field type may be upcast to the other field type
`to`.
This relation specifies when it is safe to transfer data from this
field type to the given other field type `to`.
This is the case if any of the following holds true:
* `to` is equal to this type
... | [
"Return",
"true",
"if",
"the",
"field",
"type",
"may",
"be",
"upcast",
"to",
"the",
"other",
"field",
"type",
"to",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/forms/xso.py#L252-L270 |
horazont/aioxmpp | aioxmpp/forms/xso.py | Data.get_form_type | def get_form_type(self):
"""
Extract the ``FORM_TYPE`` from the fields.
:return: ``FORM_TYPE`` value or :data:`None`
:rtype: :class:`str` or :data:`None`
Return :data:`None` if no well-formed ``FORM_TYPE`` field is found in
the list of fields.
.. versionadded::... | python | def get_form_type(self):
"""
Extract the ``FORM_TYPE`` from the fields.
:return: ``FORM_TYPE`` value or :data:`None`
:rtype: :class:`str` or :data:`None`
Return :data:`None` if no well-formed ``FORM_TYPE`` field is found in
the list of fields.
.. versionadded::... | [
"def",
"get_form_type",
"(",
"self",
")",
":",
"for",
"field",
"in",
"self",
".",
"fields",
":",
"if",
"field",
".",
"var",
"==",
"\"FORM_TYPE\"",
"and",
"field",
".",
"type_",
"==",
"FieldType",
".",
"HIDDEN",
":",
"if",
"len",
"(",
"field",
".",
"v... | Extract the ``FORM_TYPE`` from the fields.
:return: ``FORM_TYPE`` value or :data:`None`
:rtype: :class:`str` or :data:`None`
Return :data:`None` if no well-formed ``FORM_TYPE`` field is found in
the list of fields.
.. versionadded:: 0.8 | [
"Extract",
"the",
"FORM_TYPE",
"from",
"the",
"fields",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/forms/xso.py#L623-L640 |
horazont/aioxmpp | aioxmpp/ibr/service.py | get_registration_fields | def get_registration_fields(xmlstream,
timeout=60,
):
"""
A query is sent to the server to obtain the fields that need to be
filled to register with the server.
:param xmlstream: Specifies the stream connected to the server where
... | python | def get_registration_fields(xmlstream,
timeout=60,
):
"""
A query is sent to the server to obtain the fields that need to be
filled to register with the server.
:param xmlstream: Specifies the stream connected to the server where
... | [
"def",
"get_registration_fields",
"(",
"xmlstream",
",",
"timeout",
"=",
"60",
",",
")",
":",
"iq",
"=",
"aioxmpp",
".",
"IQ",
"(",
"to",
"=",
"aioxmpp",
".",
"JID",
".",
"fromstr",
"(",
"xmlstream",
".",
"_to",
")",
",",
"type_",
"=",
"aioxmpp",
"."... | A query is sent to the server to obtain the fields that need to be
filled to register with the server.
:param xmlstream: Specifies the stream connected to the server where
the account will be created.
:type xmlstream: :class:`aioxmpp.protocol.XMLStream`
:param timeout: Maximum ti... | [
"A",
"query",
"is",
"sent",
"to",
"the",
"server",
"to",
"obtain",
"the",
"fields",
"that",
"need",
"to",
"be",
"filled",
"to",
"register",
"with",
"the",
"server",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/ibr/service.py#L34-L63 |
horazont/aioxmpp | aioxmpp/ibr/service.py | register | def register(xmlstream,
query_xso,
timeout=60,
):
"""
Create a new account on the server.
:param query_xso: XSO with the information needed for the registration.
:type query_xso: :class:`~aioxmpp.ibr.Query`
:param xmlstream: Specifies the stream connected to ... | python | def register(xmlstream,
query_xso,
timeout=60,
):
"""
Create a new account on the server.
:param query_xso: XSO with the information needed for the registration.
:type query_xso: :class:`~aioxmpp.ibr.Query`
:param xmlstream: Specifies the stream connected to ... | [
"def",
"register",
"(",
"xmlstream",
",",
"query_xso",
",",
"timeout",
"=",
"60",
",",
")",
":",
"iq",
"=",
"aioxmpp",
".",
"IQ",
"(",
"to",
"=",
"aioxmpp",
".",
"JID",
".",
"fromstr",
"(",
"xmlstream",
".",
"_to",
")",
",",
"type_",
"=",
"aioxmpp"... | Create a new account on the server.
:param query_xso: XSO with the information needed for the registration.
:type query_xso: :class:`~aioxmpp.ibr.Query`
:param xmlstream: Specifies the stream connected to the server where
the account will be created.
:type xmlstream: :class:`aiox... | [
"Create",
"a",
"new",
"account",
"on",
"the",
"server",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/ibr/service.py#L67-L95 |
horazont/aioxmpp | aioxmpp/ibr/service.py | get_used_fields | def get_used_fields(payload):
"""
Get a list containing the names of the fields that are used in the
xso.Query.
:param payload: Query object o be
:type payload: :class:`~aioxmpp.ibr.Query`
:return: :attr:`list`
"""
return [
tag
for tag, descriptor in payload.CHILD_MAP.it... | python | def get_used_fields(payload):
"""
Get a list containing the names of the fields that are used in the
xso.Query.
:param payload: Query object o be
:type payload: :class:`~aioxmpp.ibr.Query`
:return: :attr:`list`
"""
return [
tag
for tag, descriptor in payload.CHILD_MAP.it... | [
"def",
"get_used_fields",
"(",
"payload",
")",
":",
"return",
"[",
"tag",
"for",
"tag",
",",
"descriptor",
"in",
"payload",
".",
"CHILD_MAP",
".",
"items",
"(",
")",
"if",
"descriptor",
".",
"__get__",
"(",
"payload",
",",
"type",
"(",
"payload",
")",
... | Get a list containing the names of the fields that are used in the
xso.Query.
:param payload: Query object o be
:type payload: :class:`~aioxmpp.ibr.Query`
:return: :attr:`list` | [
"Get",
"a",
"list",
"containing",
"the",
"names",
"of",
"the",
"fields",
"that",
"are",
"used",
"in",
"the",
"xso",
".",
"Query",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/ibr/service.py#L98-L111 |
horazont/aioxmpp | aioxmpp/ibr/service.py | RegistrationService.get_client_info | def get_client_info(self):
"""
A query is sent to the server to obtain the client's data stored at the
server.
:return: :class:`~aioxmpp.ibr.Query`
"""
iq = aioxmpp.IQ(
to=self.client.local_jid.bare().replace(localpart=None),
type_=aioxmpp.IQType.... | python | def get_client_info(self):
"""
A query is sent to the server to obtain the client's data stored at the
server.
:return: :class:`~aioxmpp.ibr.Query`
"""
iq = aioxmpp.IQ(
to=self.client.local_jid.bare().replace(localpart=None),
type_=aioxmpp.IQType.... | [
"def",
"get_client_info",
"(",
"self",
")",
":",
"iq",
"=",
"aioxmpp",
".",
"IQ",
"(",
"to",
"=",
"self",
".",
"client",
".",
"local_jid",
".",
"bare",
"(",
")",
".",
"replace",
"(",
"localpart",
"=",
"None",
")",
",",
"type_",
"=",
"aioxmpp",
".",... | A query is sent to the server to obtain the client's data stored at the
server.
:return: :class:`~aioxmpp.ibr.Query` | [
"A",
"query",
"is",
"sent",
"to",
"the",
"server",
"to",
"obtain",
"the",
"client",
"s",
"data",
"stored",
"at",
"the",
"server",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/ibr/service.py#L132-L146 |
horazont/aioxmpp | aioxmpp/ibr/service.py | RegistrationService.change_pass | def change_pass(self,
new_pass):
"""
Change the client password for 'new_pass'.
:param new_pass: New password of the client.
:type new_pass: :class:`str`
:param old_pass: Old password of the client.
:type old_pass: :class:`str`
"""
i... | python | def change_pass(self,
new_pass):
"""
Change the client password for 'new_pass'.
:param new_pass: New password of the client.
:type new_pass: :class:`str`
:param old_pass: Old password of the client.
:type old_pass: :class:`str`
"""
i... | [
"def",
"change_pass",
"(",
"self",
",",
"new_pass",
")",
":",
"iq",
"=",
"aioxmpp",
".",
"IQ",
"(",
"to",
"=",
"self",
".",
"client",
".",
"local_jid",
".",
"bare",
"(",
")",
".",
"replace",
"(",
"localpart",
"=",
"None",
")",
",",
"type_",
"=",
... | Change the client password for 'new_pass'.
:param new_pass: New password of the client.
:type new_pass: :class:`str`
:param old_pass: Old password of the client.
:type old_pass: :class:`str` | [
"Change",
"the",
"client",
"password",
"for",
"new_pass",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/ibr/service.py#L149-L167 |
horazont/aioxmpp | aioxmpp/ibr/service.py | RegistrationService.cancel_registration | def cancel_registration(self):
"""
Cancels the currents client's account with the server.
Even if the cancelation is succesful, this method will raise an
exception due to he account no longer exists for the server, so the
client will fail.
To continue with the execution,... | python | def cancel_registration(self):
"""
Cancels the currents client's account with the server.
Even if the cancelation is succesful, this method will raise an
exception due to he account no longer exists for the server, so the
client will fail.
To continue with the execution,... | [
"def",
"cancel_registration",
"(",
"self",
")",
":",
"iq",
"=",
"aioxmpp",
".",
"IQ",
"(",
"to",
"=",
"self",
".",
"client",
".",
"local_jid",
".",
"bare",
"(",
")",
".",
"replace",
"(",
"localpart",
"=",
"None",
")",
",",
"type_",
"=",
"aioxmpp",
... | Cancels the currents client's account with the server.
Even if the cancelation is succesful, this method will raise an
exception due to he account no longer exists for the server, so the
client will fail.
To continue with the execution, this method should be surrounded by a
try/... | [
"Cancels",
"the",
"currents",
"client",
"s",
"account",
"with",
"the",
"server",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/ibr/service.py#L170-L187 |
horazont/aioxmpp | aioxmpp/node.py | discover_connectors | def discover_connectors(
domain: str,
loop=None,
logger=logger):
"""
Discover all connection options for a domain, in descending order of
preference.
This coroutine returns options discovered from SRV records, or if none are
found, the generic option using the domain name an... | python | def discover_connectors(
domain: str,
loop=None,
logger=logger):
"""
Discover all connection options for a domain, in descending order of
preference.
This coroutine returns options discovered from SRV records, or if none are
found, the generic option using the domain name an... | [
"def",
"discover_connectors",
"(",
"domain",
":",
"str",
",",
"loop",
"=",
"None",
",",
"logger",
"=",
"logger",
")",
":",
"domain_encoded",
"=",
"domain",
".",
"encode",
"(",
"\"idna\"",
")",
"+",
"b\".\"",
"starttls_srv_failed",
"=",
"False",
"tls_srv_fail... | Discover all connection options for a domain, in descending order of
preference.
This coroutine returns options discovered from SRV records, or if none are
found, the generic option using the domain name and the default XMPP client
port.
Each option is represented by a triple ``(host, port, connec... | [
"Discover",
"all",
"connection",
"options",
"for",
"a",
"domain",
"in",
"descending",
"order",
"of",
"preference",
"."
] | train | https://github.com/horazont/aioxmpp/blob/22a68e5e1d23f2a4dee470092adbd4672f9ef061/aioxmpp/node.py#L105-L231 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.