microdot 2.3.5__tar.gz → 2.4.0__tar.gz

{microdot-2.3.5/src/microdot.egg-info → microdot-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microdot
-Version: 2.3.5
+Version: 2.4.0
 Summary: The impossibly small web framework for MicroPython
 Author-email: Miguel Grinberg <miguel.grinberg@gmail.com>
 Project-URL: Homepage, https://github.com/miguelgrinberg/microdot

{microdot-2.3.5 → microdot-2.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "microdot"
-version = "2.3.5"
+version = "2.4.0"
 authors = [
     { name = "Miguel Grinberg", email = "miguel.grinberg@gmail.com" },
 ]

{microdot-2.3.5 → microdot-2.4.0}/src/microdot/__init__.py

@@ -1,2 +1,4 @@
 from microdot.microdot import Microdot, Request, Response, abort, redirect, \
     send_file, URLPattern, AsyncBytesIO, iscoroutine  # noqa: F401
+
+__version__ = '2.4.0'

{microdot-2.3.5 → microdot-2.4.0}/src/microdot/microdot.py

@@ -632,9 +632,13 @@ class Response:
         """Delete a cookie.
 
         :param cookie: The cookie's name.
-        :param kwargs: Any cookie opens and flags supported by
-                       ``set_cookie()`` except ``expires`` and ``max_age``.
+        :param kwargs: Any cookie options and flags supported by
+                       :meth:`set_cookie() <microdot.Response.set_cookie>`.
+                       Values given for ``expires`` and ``max_age`` are
+                       ignored.
         """
+        kwargs.pop('expires', None)
+        kwargs.pop('max_age', None)
         self.set_cookie(cookie, '', expires='Thu, 01 Jan 1970 00:00:01 GMT',
                         max_age=0, **kwargs)
 
@@ -1367,6 +1371,11 @@ class Microdot:
         try:
             req = await Request.create(self, reader, writer,
                                        writer.get_extra_info('peername'))
+        except OSError as exc:  # pragma: no cover
+            if exc.errno in MUTED_SOCKET_ERRORS:
+                pass
+            else:
+                raise
         except Exception as exc:  # pragma: no cover
             print_exception(exc)
 

{microdot-2.3.5 → microdot-2.4.0}/src/microdot/session.py

@@ -25,7 +25,10 @@ class SessionDict(dict):
 class Session:
     """
     :param app: The application instance.
-    :param key: The secret key, as a string or bytes object.
+    :param secret_key: The secret key, as a string or bytes object.
+    :param cookie_options: A dictionary with cookie options to pass as
+                           arguments to :meth:`Response.set_cookie()
+                           <microdot.Response.set_cookie>`.
     """
     secret_key = None
 

{microdot-2.3.5 → microdot-2.4.0}/src/microdot/sse.py

@@ -17,7 +17,8 @@ class SSE:
         self.event = asyncio.Event()
         self.queue = []
 
-    async def send(self, data, event=None, event_id=None):
+    async def send(self, data, event=None, event_id=None, retry=None,
+                   comment=False):
         """Send an event to the client.
 
         :param data: the data to send. It can be given as a string, bytes, dict
@@ -27,6 +28,12 @@ class SSE:
                       given, it must be a string.
         :param event_id: an optional event id, to send along with the data. If
                       given, it must be a string.
+        :param retry: an optional reconnection time (in seconds) that the
+                      client should use when the connection is lost.
+        :param comment: when set to ``True``, the data is sent as a comment
+                        line, and all other parameters are ignored. This is
+                        useful as a heartbeat mechanism that keeps the
+                        connection alive.
         """
         if isinstance(data, (dict, list)):
             data = json.dumps(data)
@@ -34,11 +41,17 @@ class SSE:
             data = data.encode()
         elif not isinstance(data, bytes):
             data = str(data).encode()
-        data = b'data: ' + data + b'\n\n'
-        if event_id:
-            data = b'id: ' + event_id.encode() + b'\n' + data
-        if event:
-            data = b'event: ' + event.encode() + b'\n' + data
+        if comment:
+            data = b': ' + data + b'\n\n'
+        else:
+            data = b'data: ' + data + b'\n\n'
+            if event_id:
+                data = b'id: ' + event_id.encode() + b'\n' + data
+            if event:
+                data = b'event: ' + event.encode() + b'\n' + data
+            if retry:
+                data = b'retry: ' + str(int(retry * 1000)).encode() + b'\n' + \
+                    data
         self.queue.append(data)
         self.event.set()
 

{microdot-2.3.5 → microdot-2.4.0}/src/microdot/test_client.py

@@ -78,6 +78,7 @@ class TestResponse:
                     data = None
                     event = None
                     event_id = None
+                    retry = None
                     for line in sse_event.split(b'\n'):
                         if line.startswith(b'data:'):
                             data = line[5:].strip()
@@ -85,6 +86,8 @@ class TestResponse:
                             event = line[6:].strip().decode()
                         elif line.startswith(b'id:'):
                             event_id = line[3:].strip().decode()
+                        elif line.startswith(b'retry:'):
+                            retry = int(line[7:].strip()) / 1000
                     if data:
                         data_json = None
                         try:
@@ -92,8 +95,9 @@ class TestResponse:
                         except ValueError:
                             pass
                         self.events.append({
-                            "data": data, "data_json": data_json,
-                            "event": event, "event_id": event_id})
+                            'data': data, 'data_json': data_json,
+                            'event': event, 'event_id': event_id,
+                            'retry': retry})
 
     @classmethod
     async def create(cls, res):

{microdot-2.3.5 → microdot-2.4.0/src/microdot.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microdot
-Version: 2.3.5
+Version: 2.4.0
 Summary: The impossibly small web framework for MicroPython
 Author-email: Miguel Grinberg <miguel.grinberg@gmail.com>
 Project-URL: Homepage, https://github.com/miguelgrinberg/microdot

{microdot-2.3.5 → microdot-2.4.0}/src/microdot.egg-info/SOURCES.txt

@@ -22,7 +22,6 @@ src/microdot/jinja.py
 src/microdot/login.py
 src/microdot/microdot.py
 src/microdot/multipart.py
-src/microdot/pubsub.py
 src/microdot/session.py
 src/microdot/sse.py
 src/microdot/test_client.py

{microdot-2.3.5 → microdot-2.4.0}/tests/test_microdot.py

@@ -204,9 +204,10 @@ class TestMicrodot(unittest.TestCase):
             res.set_cookie('four', '4')
             res.delete_cookie('two', path='/')
             res.delete_cookie('one', path='/bad')
+            res.delete_cookie('five', max_age=123, expires='foo')
             return res
 
-        client = TestClient(app, cookies={'one': '1', 'two': '2'})
+        client = TestClient(app, cookies={'one': '1', 'two': '2', 'five': '5'})
         res = self._run(client.get('/', headers={'Cookie': 'three=3'}))
         self.assertEqual(res.status_code, 200)
         self.assertEqual(res.headers['Content-Type'],

{microdot-2.3.5 → microdot-2.4.0}/tests/test_sse.py

@@ -25,7 +25,9 @@ class TestWebSocket(unittest.TestCase):
             await sse.send('bar', event='test')
             await sse.send('bar', event='test', event_id='id42')
             await sse.send('bar', event_id='id42')
+            await sse.send('bar', retry=2.5)
             await sse.send({'foo': 'bar'})
+            await sse.send('ping', comment=True)
             await sse.send([42, 'foo', 'bar'])
             await sse.send(ValueError('foo'))
             await sse.send(b'foo')
@@ -38,35 +40,40 @@ class TestWebSocket(unittest.TestCase):
                                          'event: test\ndata: bar\n\n'
                                          'event: test\nid: id42\ndata: bar\n\n'
                                          'id: id42\ndata: bar\n\n'
+                                         'retry: 2500\ndata: bar\n\n'
                                          'data: {"foo": "bar"}\n\n'
+                                         ': ping\n\n'
                                          'data: [42, "foo", "bar"]\n\n'
                                          'data: foo\n\n'
                                          'data: foo\n\n'))
-        self.assertEqual(len(response.events), 8)
+        self.assertEqual(len(response.events), 9)
         self.assertEqual(response.events[0], {
             'data': b'foo', 'data_json': None, 'event': None,
-            'event_id': None})
+            'event_id': None, "retry": None})
         self.assertEqual(response.events[1], {
             'data': b'bar', 'data_json': None, 'event': 'test',
-            'event_id': None})
+            'event_id': None, "retry": None})
         self.assertEqual(response.events[2], {
             'data': b'bar', 'data_json': None, 'event': 'test',
-            'event_id': 'id42'})
+            'event_id': 'id42', "retry": None})
         self.assertEqual(response.events[3], {
             'data': b'bar', 'data_json': None, 'event': None,
-            'event_id': 'id42'})
+            'event_id': 'id42', "retry": None})
         self.assertEqual(response.events[4], {
-            'data': b'{"foo": "bar"}', 'data_json': {'foo': 'bar'},
-            'event': None, 'event_id': None})
+            'data': b'bar', 'data_json': None, 'event': None, 'event_id': None,
+            'retry': 2.5})
         self.assertEqual(response.events[5], {
-            'data': b'[42, "foo", "bar"]', 'data_json': [42, 'foo', 'bar'],
-            'event': None, 'event_id': None})
+            'data': b'{"foo": "bar"}', 'data_json': {'foo': 'bar'},
+            'event': None, 'event_id': None, "retry": None})
         self.assertEqual(response.events[6], {
-            'data': b'foo', 'data_json': None, 'event': None,
-            'event_id': None})
+            'data': b'[42, "foo", "bar"]', 'data_json': [42, 'foo', 'bar'],
+            'event': None, 'event_id': None, "retry": None})
         self.assertEqual(response.events[7], {
             'data': b'foo', 'data_json': None, 'event': None,
-            'event_id': None})
+            'event_id': None, "retry": None})
+        self.assertEqual(response.events[8], {
+            'data': b'foo', 'data_json': None, 'event': None,
+            'event_id': None, "retry": None})
 
     def test_sse_exception(self):
         app = Microdot()

microdot-2.3.5/src/microdot/pubsub.py

@@ -1,21 +0,0 @@
-class PubSub:
-    subscriptions = {}
-
-    def subscribe(self, observer, topic):
-        if topic not in self.subscriptions:
-            self.subscriptions[topic] = []
-        self.subscriptions[topic].append(observer)
-
-    def unsubscribe(self, observer, topic):
-        if topic in self.subscriptions:
-            try:
-                self.subscriptions[topic].remove(observer)
-                if not self.subscriptions[topic]:
-                    del self.subscriptions[topic]
-            except (ValueError, IndexError):
-                pass
-
-    @classmethod
-    async def publish(cls, topic, data):
-        for observer in cls.subscriptions.get(topic, []):
-            await observer.send(data, event=topic)