Merge branch 'release-0.7'

COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

README.rst

@@ -6,6 +6,8 @@
 .. _asyncio: https://docs.python.org/3/library/asyncio.html
 __ https://code.google.com/p/tulip/
 
+.. remember to update the feature list in the docs
+
 Features
 ========
 
@@ -126,5 +128,5 @@ Change log
 
 The `change log`_ is included in the `official documentation`__.
 
-.. _change log: http://docs.zombofant.net/aioxmpp/devel/api/changelog.html
-__ http://docs.zombofant.net/aioxmpp/0.6/
+.. _change log: https://docs.zombofant.net/aioxmpp/0.7/api/changelog.html
+__ https://docs.zombofant.net/aioxmpp/0.7/

aioxmpp/__init__.py

@@ -1,3 +1,24 @@
+########################################################################
+# File name: __init__.py
+# This file is part of: aioxmpp
+#
+# LICENSE
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this program.  If not, see
+# <http://www.gnu.org/licenses/>.
+#
+########################################################################
 """
 Version information
 ###################
@@ -9,12 +30,21 @@
 
 .. data:: version
 
-   Is an alias to :data:`__version__`.
+   Alias of :data:`__version__`.
 
 .. autodata:: version_info
 
+Shorthands
+##########
+
+.. function:: make_security_layer
+
+   Alias of :func:`aioxmpp.security_layer.make`.
+
 """
 
+from .version import version_info, __version__, version
+
 #: The imported :mod:`aioxmpp` version as a tuple.
 #:
 #: The components of the tuple are, in order: `major version`, `minor version`,
@@ -23,7 +53,7 @@
 #: .. seealso::
 #:
 #:    :ref:`api-stability`
-version_info = (0, 6, 1, None)
+version_info = version_info
 
 #: The imported :mod:`aioxmpp` version as a string.
 #:
@@ -33,7 +63,40 @@
 #: .. seealso::
 #:
 #:    :ref:`api-stability`
-__version__ = ".".join(map(str, version_info[:3])) + ("-"+version_info[3] if
-                                                      version_info[3] else "")
+__version__ = __version__
+
+# XXX: ^ this is a hack to make Sphinx find the docs. We could also be using
+# .. data instead of .. autodata, but that has the downside that the actual
+# version number isn’t printed in the docs (without additional maintenance
+# cost).
+
+from .errors import ( # NOQA
+    XMPPAuthError,
+    XMPPCancelError,
+    XMPPContinueError,
+    XMPPModifyError,
+    XMPPWaitError,
+)
+from .node import PresenceManagedClient  # NOQA
+from .stanza import Presence, IQ, Message  # NOQA
+from .structs import (  # NOQA
+    JID,
+    PresenceState,
+    MessageType,
+    PresenceType,
+    IQType,
+    ErrorType,
+)
+from .security_layer import make as make_security_layer  # NOQA
+
 
-version = __version__
+def set_strict_mode():
+    from .stanza import Error
+    from .stream import StanzaStream
+    from . import structs
+    Message.type_.type_.allow_coerce = False
+    IQ.type_.type_.allow_coerce = False
+    Error.type_.type_.allow_coerce = False
+    Presence.type_.type_.allow_coerce = False
+    StanzaStream._ALLOW_ENUM_COERCION = False
+    structs._USE_COMPAT_ENUM = False

aioxmpp/_ssl_transport.py

@@ -1,3 +1,24 @@
+########################################################################
+# File name: _ssl_transport.py
+# This file is part of: aioxmpp
+#
+# LICENSE
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this program.  If not, see
+# <http://www.gnu.org/licenses/>.
+#
+########################################################################
 # This specific file can be used under the conditions of the Apache 2.0
 # license. The full license can be found in COPYING.apache20 in the root of
 # this software repository.

aioxmpp/callbacks.py

@@ -1,3 +1,24 @@
+########################################################################
+# File name: callbacks.py
+# This file is part of: aioxmpp
+#
+# LICENSE
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this program.  If not, see
+# <http://www.gnu.org/licenses/>.
+#
+########################################################################
 """
 :mod:`~aioxmpp.callbacks` -- Synchronous and asynchronous callbacks
 ###################################################################
@@ -76,6 +97,19 @@ def handler():
 logger = logging.getLogger(__name__)
 
 
+def log_spawned(logger, fut):
+    try:
+        result = fut.result()
+    except asyncio.CancelledError:
+        logger.debug("spawned task was cancelled")
+    except:
+        logger.warning("spawned task raised exception", exc_info=True)
+    else:
+        if result is not None:
+            logger.info("value returned by spawned task was ignored: %r",
+                        result)
+
+
 class TagListener:
     def __init__(self, ondata, onerror=None):
         self._ondata = ondata
@@ -308,6 +342,13 @@ class AdHocSignal(AbstractAdHocSignal):
        Connections using this mode are never removed automatically from the
        signals connection list. You have to use :meth:`disconnect` explicitly.
 
+       If the spawned coroutine returns with an exception or a non-:data:`None`
+       return value, a message is logged, with the following log levels:
+
+       * Return with non-:data:`None` value: :data:`logging.INFO`
+       * Raises :class:`asyncio.CancelledError`: :data:`logging.DEBUG`
+       * Raises any other exception: :data:`logging.WARNING`
+
        .. versionadded:: 0.6
 
     .. automethod:: disconnect
@@ -373,7 +414,13 @@ def spawn(f):
                 raise TypeError("must be coroutine, got {!r}".format(f))
 
             def wrapper(args, kwargs):
-                asyncio.async(f(*args, **kwargs), loop=loop)
+                task = asyncio.async(f(*args, **kwargs), loop=loop)
+                task.add_done_callback(
+                    functools.partial(
+                        log_spawned,
+                        logger,
+                    )
+                )
                 return True
 
             return wrapper