Merge pull request #88 from guokr/falcon

添加falcon 支持

Author: jizhouli

README.md

@@ -1,10 +1,10 @@
-# Flask/Tornado RESTful Application Code Generator
+# Flask/Tornado/Falcon RESTful Application Code Generator
 
 [![Build Status][travis-image]][travis-url] [![PyPi Version][pypi-image]][pypi-url]
 
 ## Overview
 
-Generate Flask/Tornado-RESTful application code from a Swagger Specification doc.
+Generate Flask/Tornado/Falcon-RESTful application code from a Swagger Specification doc.
 
 **Alpha version for now, it can not handle all validation properly.**
 
@@ -32,7 +32,7 @@ Command Options:
 	--spec, --specification         Generate online specification json response.
 	--ui                            Generate swagger ui.
 	-j, --jobs INTEGER              Parallel jobs for processing.
-	-tlp, --templates               gen flask/tornado templates,default flask.
+	-tlp, --templates               gen flask/tornado/falcon templates, default flask.
 	--version                       Show current version.
 	--help                          Show this message and exit.
 
@@ -65,7 +65,7 @@ Generate example-app from [apis.yml](https://github.com/guokr/swagger-py-codegen
 	   |     |__ validators.py
 	   |__ requirements.txt
 
-	$ swagger_py_codegen -s  docs/panel.yml  example-app -p demo -tlp=tornado
+	$ swagger_py_codegen -s  api.yml  example-app -p demo -tlp=tornado
     $ tree (tornado-demo)
 	.
 	|__ api.yml
@@ -88,6 +88,28 @@ Generate example-app from [apis.yml](https://github.com/guokr/swagger-py-codegen
 	   |     |__ validators.py
 	   |__ requirements.txt
 
+    $ swagger_py_codegen -s  api.yml  example-app -p demo -tlp=falcon
+    $ tree (falcon-demo)
+	.
+	|__ api.yml
+	|__ example-app
+	   |__ demo
+	   |  |__ __init__.py
+	   |  |__ v1
+	   |     |__ api
+	   |     |  |__ __init__.py
+	   |     |  |__ oauth_auth_approach_approach.py
+	   |     |  |__ oauth_auth_approach.py
+	   |     |  |__ users_token.py
+	   |     |  |__ users_current.py
+	   |     |  |__ users.py
+	   |     |__ __init__.py
+	   |     |__ routes.py
+	   |     |__ schemas.py
+	   |     |__ validators.py
+	   |__ requirements.txt
+
+
 Install example-app requirements:
 
     $ cd example-app

swagger_py_codegen/command.py

@@ -14,6 +14,7 @@
 from ._version import __version__
 from .flask import FlaskGenerator
 from .tornado import TornadoGenerator
+from .falcon import FalconGenerator
 from .parser import Swagger
 from .base import Template
 
@@ -96,6 +97,8 @@ def generate(destination, swagger_doc, force=False, package=None,
     swagger = Swagger(data, pool)
     if templates == 'tornado':
         generator = TornadoGenerator(swagger)
+    elif templates == 'falcon':
+        generator = FalconGenerator(swagger)
     else:
         generator = FlaskGenerator(swagger)
     generator.with_spec = specification

swagger_py_codegen/falcon.py

@@ -0,0 +1,237 @@
+from __future__ import absolute_import, print_function
+import re
+from collections import OrderedDict
+
+from .base import Code, CodeGenerator
+from .jsonschema import Schema, SchemaGenerator, build_default
+import six
+
+SUPPORT_METHODS = ['get', 'post', 'put', 'delete', 'patch', 'options', 'head']
+
+
+class Router(Code):
+
+    template = 'falcon/routers.tpl'
+    dest_template = '%(package)s/%(module)s/routes.py'
+    override = True
+
+
+class View(Code):
+
+    template = 'falcon/view.tpl'
+    dest_template = '%(package)s/%(module)s/api/%(view)s.py'
+    override = False
+
+
+class Specification(Code):
+
+    template = 'falcon/specification.tpl'
+    dest_template = '%(package)s/static/%(module)s/swagger.json'
+    override = True
+
+
+class Validator(Code):
+
+    template = 'falcon/validators.tpl'
+    dest_template = '%(package)s/%(module)s/validators.py'
+    override = True
+
+
+class Api(Code):
+
+    template = 'falcon/api.tpl'
+    dest_template = '%(package)s/%(module)s/api/__init__.py'
+
+
+class Blueprint(Code):
+
+    template = 'falcon/blueprint.tpl'
+    dest_template = '%(package)s/%(module)s/__init__.py'
+
+
+class App(Code):
+
+    template = 'falcon/app.tpl'
+    dest_template = '%(package)s/__init__.py'
+
+
+class Requirements(Code):
+
+    template = 'falcon/requirements.tpl'
+    dest_template = 'requirements.txt'
+
+
+class UIIndex(Code):
+
+    template = 'ui/index.html'
+    dest_template = '%(package)s/static/swagger-ui/index.html'
+
+
+def _swagger_to_falcon_url(url, swagger_path_node):
+    types = {
+        'integer': 'int',
+        'long': 'int',
+        'float': 'float',
+        'double': 'float'
+    }
+    node = swagger_path_node
+    params = re.findall(r'\{([^\}]+?)\}', url)
+    url = re.sub(r'{(.*?)}', '{\\1}', url)
+
+    def _type(parameters):
+        for p in parameters:
+            if p.get('in') != 'path':
+                continue
+            t = p.get('type', 'string')
+            if t in types:
+                yield '{%s}' % p['name'], '{%s}' % p['name']
+
+    for old, new in _type(node.get('parameters', [])):
+        url = url.replace(old, new)
+
+    for k in SUPPORT_METHODS:
+        if k in node:
+            for old, new in _type(node[k].get('parameters', [])):
+                url = url.replace(old, new)
+
+    return url, params
+
+if six.PY3:
+    def _remove_characters(text, deletechars):
+        return text.translate({ord(x): None for x in deletechars})
+else:
+    def _remove_characters(text, deletechars):
+        return text.translate(None, deletechars)
+
+def _path_to_endpoint(swagger_path):
+    return _remove_characters(
+        swagger_path.strip('/').replace('/', '_').replace('-', '_'),
+        '{}')
+
+
+def _path_to_resource_name(swagger_path):
+    return _remove_characters(swagger_path.title(), '{}/_-')
+
+
+def _location(swagger_location):
+    location_map = {
+        'body': 'json',
+        'formData': 'form',
+        'header': 'headers',
+        'query': 'params'
+    }
+    return location_map.get(swagger_location)
+
+
+class FalconGenerator(CodeGenerator):
+
+    dependencies = [SchemaGenerator]
+
+    def __init__(self, swagger):
+        super(FalconGenerator, self).__init__(swagger)
+        self.with_spec = False
+        self.with_ui = False
+
+    def _dependence_callback(self, code):
+        if not isinstance(code, Schema):
+            return code
+        schemas = code
+        # schemas default key likes `('/some/path/{param}', 'method')`
+        # use falcon endpoint to replace default validator's key,
+        # example: `('some_path_param', 'method')`
+        validators = OrderedDict()
+        for k, v in six.iteritems(schemas.data['validators']):
+            locations = {_location(loc): val for loc, val in six.iteritems(v)}
+            validators[(_path_to_endpoint(k[0]), k[1])] = locations
+
+        # filters
+        filters = OrderedDict()
+        for k, v in six.iteritems(schemas.data['filters']):
+            filters[(_path_to_endpoint(k[0]), k[1])] = v
+
+        # scopes
+        scopes = OrderedDict()
+        for k, v in six.iteritems(schemas.data['scopes']):
+            scopes[(_path_to_endpoint(k[0]), k[1])] = v
+
+        schemas.data['validators'] = validators
+        schemas.data['filters'] = filters
+        schemas.data['scopes'] = scopes
+        self.schemas = schemas
+        self.validators = validators
+        self.filters = filters
+        return schemas
+
+    def _process_data(self):
+
+        views = []  # [{'endpoint':, 'name':, url: '', params: [], methods: {'get': {'requests': [], 'response'}}}, ..]
+
+        for paths, data in self.swagger.search(['paths', '*']):
+            swagger_path = paths[-1]
+            url, params = _swagger_to_falcon_url(swagger_path, data)
+            endpoint = _path_to_endpoint(swagger_path)
+            name = _path_to_resource_name(swagger_path)
+
+            methods = OrderedDict()
+            for method in SUPPORT_METHODS:
+                if method not in data:
+                    continue
+                methods[method] = {}
+                validator = self.validators.get((endpoint, method.upper()))
+                if validator:
+                    methods[method]['requests'] = list(validator.keys())
+
+                for status, res_data in six.iteritems(data[method].get('responses', {})):
+                    if isinstance(status, int) or status.isdigit():
+                        example = res_data.get('examples', {}).get('application/json')
+
+                        if not example:
+                            example = build_default(res_data.get('schema'))
+                        response = example, 'falcon.HTTP_%s' % int(status), build_default(res_data.get('headers')) or {}
+                        methods[method]['response'] = response
+                        break
+
+            views.append(dict(
+                url=url,
+                params=params,
+                methods=methods,
+                endpoint=endpoint,
+                name=name
+            ))
+
+        return views
+
+    def _get_oauth_scopes(self):
+        for path, scopes in self.swagger.search(('securityDefinitions', '*', 'scopes')):
+            return scopes
+        return None
+
+    def _process(self):
+        views = self._process_data()
+        yield Router(dict(views=views))
+        for view in views:
+            yield View(view, dist_env=dict(view=view['endpoint']))
+        if self.with_spec:
+            try:
+                import simplejson as json
+            except ImportError:
+                import json
+            swagger = {}
+            swagger.update(self.swagger.origin_data)
+            swagger.pop('host', None)
+            swagger.pop('schemes', None)
+            yield Specification(dict(swagger=json.dumps(swagger, indent=2)))
+
+        yield Validator()
+
+        yield Api()
+
+        yield Blueprint(dict(scopes_supported=self.swagger.scopes_supported,
+                             blueprint=self.swagger.module_name))
+        yield App(dict(blueprint=self.swagger.module_name,
+                       base_path=self.swagger.base_path))
+
+        yield Requirements()
+
+        if self.with_ui:
+            yield UIIndex(dict(spec_path='/static/%s/swagger.json' % self.swagger.module_name))

swagger_py_codegen/jsonschema.py

@@ -96,6 +96,7 @@ def build_data(swagger):
         validators=validators,
         filters=filters,
         scopes=scopes,
+        base_path=swagger.base_path,
         merge_default=getsource(merge_default),
         normalize=getsource(normalize)
     )

swagger_py_codegen/templates/falcon/api.tpl

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+from __future__ import absolute_import, print_function
+
+from six import with_metaclass
+import six
+import falcon
+
+from ..validators import  request_validate, response_filter
+
+import inspect
+
+before_decorators = [request_validate]
+after_decorators = [response_filter]
+
+
+if six.PY3:
+    ismethod = inspect.isfunction
+else:
+    ismethod = inspect.ismethod
+
+
+def add_before_decorators(model_class):
+    for name, m in inspect.getmembers(model_class, ismethod):
+        if name in ['on_get', 'on_post', 'on_put', 'on_delete']:
+            setattr(model_class, name, falcon.before(*before_decorators)(m))
+
+
+def add_after_decorators(model_class):
+    for name, m in inspect.getmembers(model_class, ismethod):
+        if name in ['on_get', 'on_post', 'on_put', 'on_delete']:
+            setattr(model_class, name, falcon.after(*after_decorators)(m))
+
+
+class APIMetaclass(type):
+    """
+    Metaclass of the Model.
+    """
+    def __init__(cls, name, bases, attrs):
+        super(APIMetaclass, cls).__init__(name, bases, attrs)
+        add_before_decorators(cls)
+        add_after_decorators(cls)
+
+class Resource(with_metaclass(APIMetaclass, object)):
+
+    pass