improve support for tornado

Author: rande

ioc/component.py

@@ -236,6 +236,9 @@ def build_container(self, container):
                 'container_builder': self
             })
 
+        for extension in extensions:
+            extension.start(container)
+
         return container
 
     def create_definition(self, id):

ioc/extra/tornado/__init__.py

@@ -0,0 +1 @@
+__author__ = 'rande'

ioc/extra/tornado/di.py

@@ -0,0 +1,41 @@
+import ioc
+import os
+from ioc.extra.tornado.handler import RouterHandler
+from tornado.web import StaticFileHandler
+
+class Extension(ioc.component.Extension):
+    def load(self, config, container_builder):
+        path = os.path.dirname(os.path.abspath(__file__))
+
+        loader = ioc.loader.YamlLoader()
+        loader.load("%s/resources/config/services.yml" % path, container_builder)
+
+        container_builder.parameters.set('ioc.extra.tornado.port',               config.get('port', 8888))
+        container_builder.parameters.set('ioc.extra.tornado.static_folder',      config.get('static_folder', '%project.root_folder%/resources/static'))
+        container_builder.parameters.set('ioc.extra.tornado.static_public_path', config.get('static_public_path', '/static'))
+
+    def post_load(self, container_builder):
+        if not container_builder.has('ioc.extra.jinja2'):
+            return
+
+        definition = container_builder.get('ioc.extra.tornado.router')
+        definition.add_tag('jinja2.global', {'name': 'url_for', 'method': 'generate'})
+
+        definition = container_builder.get('ioc.extra.tornado.asset_helper')
+        definition.add_tag('jinja2.global', {'name': 'asset', 'method': 'generate_asset'})
+
+    def start(self, container):
+        application = container.get('ioc.extra.tornado.application')
+        application.add_handlers(".*$", [
+            ("/.*", RouterHandler, {
+                "router":           container.get('ioc.extra.tornado.router'),
+                "event_dispatcher": container.get('ioc.extra.event_dispatcher'),
+                "logger":           container.get('element.logger')
+            })
+        ])
+
+        application.add_handlers(".*$", [
+            (container.parameters.get("ioc.extra.tornado.static_public_path") + "/(.*)", StaticFileHandler, {
+                "path": container.parameters.get("ioc.extra.tornado.static_folder")
+            })
+        ])

ioc/extra/tornado/handler.py

@@ -2,6 +2,7 @@
 
 import tornado.web
 import tornado.httpclient
+import mimetypes
 
 class BaseHandler(tornado.web.RequestHandler):
     def dispatch(self):
@@ -25,51 +26,98 @@ def head(self):
     def options(self):
         return self.dispatch()
 
+    def is_finish(self):
+        return self._finished
+
+    def get_header(self, name):
+        return self._headers.get(name)
+
 class RouterHandler(BaseHandler):
-    def initialize(self, router, event_dispatcher):
+    def initialize(self, router, event_dispatcher, logger=None):
         self.router = router
         self.event_dispatcher = event_dispatcher
+        self.logger = logger
 
     def dispatch(self):
         try:
-            self.event_dispatcher.dispatch('handler.request', {'handler': self})
+            self.event_dispatcher.dispatch('handler.request', {
+                'request_handler': self,
+                'request': self.request
+            })
+
+            if self.is_finish():
+                return
 
             name, parameters, callback = self.router.match(path_info=self.request.path, method=self.request.method)
 
+            if self.logger:
+                self.logger.debug("[ioc.extra.tornado.RouterHandler] Match name:%s with parameters:%s (%s)" % (name, parameters, callback))
+
             event = self.event_dispatcher.dispatch('handler.callback', {
-                'handler': self,
+                'request_handler': self,
+                'request': self.request,
                 'name': name,
                 'callback': callback,
                 'parameters': parameters
             })
 
+            if self.is_finish():
+                return
+
             event.get('callback')(self, **event.get('parameters'))
 
+            if self.is_finish():
+                return
+
         except NotFound:
             self.set_status(404)
             self.write("Not Found")
 
             self.event_dispatcher.dispatch('handler.not_found', {
-                'handler': self,
+                'request_handler': self,
+                'request': self.request,
             })
         except Exception, e:
             self.set_status(500)
             self.write("An unexpected error occurred")
 
             import traceback
-            traceback.print_exc()
+            self.write("<pre>" + traceback.format_exc() + "</pre>")
 
+            print traceback.print_exc()
 
             self.event_dispatcher.dispatch('handler.exception', {
-                'handler': self,
+                'request_handler': self,
+                'request': self.request,
             })
 
+        if self.is_finish():
+            return
+
         self.event_dispatcher.dispatch('handler.response', {
-            'handler': self,
+            'request_handler': self,
+            'request': self.request,
         })
 
-        self.finish()
+        if not self.is_finish():
+            self.finish()
 
         self.event_dispatcher.dispatch('handler.terminate', {
-            'handler': self,
+            'request_handler': self,
+            'request': self.request,
         })
+
+
+    def send_file(self, file):
+        """
+        Send a file to the client, it is a convenient method to avoid duplicated code
+        """
+        mime_type, encoding = mimetypes.guess_type(file)
+
+        if mime_type:
+            self.set_header('Content-Type', mime_type)
+
+        fp = open(file, 'r')
+        self.write(fp.read())
+
+        fp.close()

ioc/extra/tornado/resources/config/services.yml

@@ -0,0 +1,20 @@
+services:
+    ioc.extra.tornado.router:
+        class: ioc.extra.tornado.router.Router
+
+    ioc.extra.tornado.application:
+        class: tornado.web.Application
+        arguments: []
+        kwargs:
+            debug:                   True
+            autoreload:              True
+            compiled_template_cache: True
+            static_hash_cache:       True
+            serve_traceback:         True
+            gzip:                    True
+            cookie_secret:           MySecret
+
+    ioc.extra.tornado.asset_helper:
+        class: ioc.extra.tornado.router.AssetHelper
+        arguments: [ "%ioc.extra.tornado.static_public_path%", '@ioc.extra.tornado.router', 'element.static']
+

ioc/extra/tornado/router.py

@@ -1,4 +1,54 @@
 from werkzeug.routing import Map, Rule
+import time
+
+class AssetHelper(object):
+    def __init__(self, static, router, route_name, version=None):
+        self.static = static
+        self.version = version or int(time.time())
+        self.router = router
+        self.route_name = route_name
+
+    def generate_asset(self, path, module=None):
+        if not module:
+            return self.generate_static(path)
+
+        return self.router.generate(self.route_name, filename=path, module=module, v=self.version)
+
+    def generate_static(self, path):
+        """
+        This method generates a valid path to the public folder of the running project
+        """
+        if not path:
+            return ""
+
+        if path[0] == '/':
+            return "%s?v=%s" % (path, self.version)
+
+        return "%s/%s?v=%s" % (self.static, path, self.version)
+
+class TornadoMultiDict(object):
+    """
+    This code make the RequestHandler.arguments compatible with WTForm module
+    """
+    def __init__(self, handler):
+        self.handler = handler
+
+    def __iter__(self):
+        return iter(self.handler.request.arguments)
+
+    def __len__(self):
+        return len(self.handler.request.arguments)
+
+    def __contains__(self, name):
+        # We use request.arguments because get_arguments always returns a
+        # value regardless of the existence of the key.
+        return (name in self.handler.request.arguments)
+
+    def getlist(self, name):
+        # get_arguments by default strips whitespace from the input data,
+        # so we pass strip=False to stop that in case we need to validate
+        # on whitespace.
+        return self.handler.get_arguments(name, strip=False)
 
 class Router(object):
     def __init__(self, url_map=None):

requirements.txt

@@ -1,5 +1,4 @@
 PyYAML
 coverage
 nose
-jinja2
-Sphinx
+jinja2

requirements_python2.txt

@@ -1,2 +1,3 @@
 -r requirements.txt
 unittest2
+Sphinx===2.7

requirements_python3.txt

@@ -1,2 +1,3 @@
 -r requirements.txt
-unittest2py3k
+unittest2py3k
+Sphinx===2.6

setup.py

@@ -15,4 +15,4 @@
     packages = find_packages(),
     install_requires=["pyyaml"],
     platforms='any',
-)
+)