Shutdown function for ensuring it's possible to unsubscribe before cl…

…osing event loops (#186)

examples/example_async.py

@@ -155,5 +155,7 @@ def observe_err_callback(err):
     print("Try altering any light in the app, and watch the events!")
     yield from asyncio.sleep(120)
 
+    yield from api.shutdown()
+
 
 asyncio.get_event_loop().run_until_complete(run())

examples/example_socket_async.py

@@ -133,5 +133,7 @@ def observe_err_callback(err):
     print("Waiting for observation to end (10 secs)")
     yield from asyncio.sleep(10)
 
+    yield from api.shutdown()
+
 
 asyncio.get_event_loop().run_until_complete(run())

pytradfri/api/aiocoap_api.py

@@ -1,4 +1,4 @@
-"""Coap implementation using aiocoap."""
+"""COAP implementation using aiocoap."""
 import asyncio
 import json
 import logging
@@ -15,7 +15,8 @@
 
 
 class PatchedDTLSSecurityStore:
-    """Patched DTLS store in lieu of impl."""
+    """Patched DTLS store in lieu of a credentials framework.
+       https://github.com/chrysn/aiocoap/issues/97"""
 
     IDENTITY = None
     KEY = None
@@ -72,8 +73,7 @@ def _get_protocol(self):
 
     @asyncio.coroutine
     def _reset_protocol(self, exc=None):
-        """Reset the protocol if an error occurs.
-           This can be removed when chrysn/aiocoap#79 is closed."""
+        """Reset the protocol if an error occurs."""
         # Be responsible and clean up.
         protocol = yield from self._get_protocol()
         yield from protocol.shutdown()
@@ -83,6 +83,12 @@ def _reset_protocol(self, exc=None):
             ob_error(exc)
         self._observations_err_callbacks.clear()
 
+    @asyncio.coroutine
+    def shutdown(self, exc=None):
+        """Shutdown the API events.
+           This should be called before closing the event loop."""
+        yield from self._reset_protocol(exc)
+
     @asyncio.coroutine
     def _get_response(self, msg):
         """Perform the request, get the response."""
@@ -184,9 +190,7 @@ def error_callback(ex):
 
     @asyncio.coroutine
     def generate_psk(self, security_key):
-        """
-        Generate and set a psk from the security key.
-        """
+        """Generate and set a psk from the security key."""
         if not self._psk:
             PatchedDTLSSecurityStore.IDENTITY = 'Client_identity'.encode(
                 'utf-8')

setup.py

@@ -13,7 +13,7 @@
 with open(path.join(here, 'README.md'), encoding='utf-8') as f:
     long_description = f.read()
 
-VERSION = "5.6.0"
+VERSION = "5.6.1"
 DOWNLOAD_URL = \
     'https://github.com/ggravlingen/pytradfri/archive/{}.zip'.format(VERSION)