tornado-eventsource

A simple EventSource handler for tornado. With a built-in client for testing.

EventSource on MDN

How to use

Install it(duh!):

pip install tornado_eventsource

Client/Server example

On your handler:

class MyAmazingHandler(EventSourceHandler):
    def check_connection(self):
        if youDontFitMyCondition:
            self.error(403, 'forbidden')
            return False
        return True

    def open(self):
        self.write_message('doge_source', 'much connection')

    def close(self):
        # Cleanup after close

Using the client for test:

from tornado_eventsource.event_source_client import eventsource_connect

...

def test_get_message_on_open(self):
    event_source = eventsource_connect(url=self.get_url('/'), callback=self.stop)
    self.wait()
    event = event_source.result().events[0]
    self.assertEqual(event.name, 'doge_source')
    self.assertEqual(event.data, 'much connection')

Another example:

import uuid

import tornado.ioloop
import tornado.web
import tornado_eventsource.handler


class MainHandler(tornado_eventsource.handler.EventSourceHandler):
    def open(self):
        self.heart_beat = tornado.ioloop.PeriodicCallback(self._simple_callback, 5000)
        self.heart_beat.start()
        self.write_message(msg="Wow much nameless", evt_id=uuid.uuid4())
        print('Connection open')

    def close(self):
        print('Connection closed')

    def _simple_callback(self):
        self.write_message(name="doge", msg="Wow much alive\nSuch message", evt_id=uuid.uuid4())
        self.write_message(msg="Wow much nameless", evt_id=uuid.uuid4())

application = tornado.web.Application([
    (r"/", MainHandler),
], debug=True)

if __name__ == "__main__":
    application.listen(8888)
    tornado.ioloop.IOLoop.instance().start()

Contribute

make setup

change things

make test

pull request ;)

License

The MIT License (MIT)

Copyright (c) 2014 Guilherme Souza, A.k.a.: Galinho

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.