added many features to baseviews, mainly ability to dynamically add default routes to future views, also added better automatic imports for installed views and models

Author: jstacoder

flask_xxl/apps/admin/__init__.py

@@ -7,4 +7,3 @@
                  url_prefix='/admin')
 
 
-from views import *

flask_xxl/apps/admin/models.py

@@ -1,7 +1,11 @@
 import sqlalchemy as sa
 from ...basemodels import BaseMixin
 from LoginUtils import check_password, encrypt_password
-print 'importing flask_xxl.apps.admin.models as ',__name__
+from ...baseviews import is_verbose
+
+
+if is_verbose():
+    print 'importing flask_xxl.apps.admin.models as ',__name__
 
 
 class Setting(BaseMixin):
@@ -22,11 +26,10 @@ def widget(self):
 
 class Type(BaseMixin):
 
-
     name = sa.Column(sa.String(255),nullable=False)
     widgets = sa.orm.relationship('Widget',backref=sa.orm.backref(
         'type'),lazy='dynamic')
-    html = sa.orm.Column(sa.orm.Text)
+    html = sa.Column(sa.Text)
     field_type = sa.Column(sa.String(255))
     required = sa.Column(sa.Boolean,default=False)
     data_type = sa.Column(sa.String(255))

flask_xxl/apps/page/__init__.py

@@ -9,21 +9,6 @@
                 static_url_path='/_page_static/',
                 static_folder=os.path.abspath(os.path.dirname(__file__)),
                 url_prefix='/page')
-
-
-
-for module in ['views','models','admin']:
-    if exists(module):
-        _module = __import__(module,globals(),locals(),['.'])
-        for attr in dir(_module):
-            if not attr.startswith('_'):
-                globals()[attr] = getattr(_module,attr)
-
-                
-#from .views import *
-#from .models import *
-#from .admin import *
-
 '''
 @page.before_app_request
 def add_pages():

flask_xxl/apps/page/views.py

@@ -1,9 +1,12 @@
-from flask_xxl.baseviews import BaseView
+from flask_xxl.baseviews import BaseView,ModelAPIView
 import flask
 from . import page
 from .forms import TestForm,ContactUsForm
+from .models import Page
 
 
+class TestView(ModelAPIView):
+    _model = Page
 
 class ContactFormView(BaseView):
     _template = 'contact.html'

flask_xxl/basemodels.py

@@ -43,6 +43,9 @@ class ModelDeclarativeMeta(_BoundDeclarativeMeta):
 
 @as_declarative(name='BaseMixin',metaclass=ModelDeclarativeMeta)
 class BaseMixin(object):
+    __table_args__ = {
+        'extend_existing':True
+    }
     __abstract__ = True
     _session = None
     _e = None

flask_xxl/baseviews.py

@@ -1,16 +1,49 @@
+import os
 from flask.views import MethodView
 from flask.templating import render_template
 from flask.helpers import url_for
 from flask import redirect, flash
 from wtforms.form import FormMeta
+from .basemodels import classproperty
 
-class BaseView(MethodView):
+
+is_verbose = lambda: os.environ.get('VERBOSE') and True or False
+
+class Flasher(object):
+    DEFAULT_CATEGORY = 'warning'
+
+    def flash(self,msg,cat=None):
+        cat = cat or self.DEFAULT_CATEGORY
+        flash(msg,cat)
+
+    def add_warning(self,*args,**kwargs):
+        self.flash(*args,**kwargs)
+
+    def add_error(self,msg):
+        self.flash(msg=msg,cat='danger')
+
+    def add_info(self,msg):
+        self.flash(msg,'info')
+
+    def add_success(self,msg):
+        self.flash(msg,'success')
+
+class BaseView(MethodView,Flasher):
     _template = None
     _form = None
     _context = {}
     _form_obj = None
     _obj_id = None
     _form_args = {}
+    _default_view_routes = {}
+
+    @classmethod
+    def _add_default_routes(cls,app=None):        
+        for route,endpoint in cls._default_view_routes.items():
+            if is_verbose():
+                print 'attaching',route,'to view func',endpoint
+            app.add_url_rule(route,endpoint,view_func=cls.as_view(endpoint))
+
 
     def render(self,**kwargs):
         if self._template is None:
@@ -35,6 +68,7 @@ def render(self,**kwargs):
                         inner_field = getattr(getattr(field,field.__name__),getattr(fiels.__name__))
                         if hasattr(inner_field,'choices'):
                             setattr(inner_field,'choices',choices)
+                # the 6 lines above replace the line below, delete it once we verify it works
                 #self._context['form'].template.template.choices = choices
             for f,v in self._form_args.items():
                 self._form.__dict__[f].data = v
@@ -45,12 +79,6 @@ def redirect(self,endpoint,**kwargs):
             return redirect(url_for(endpoint,**kwargs))
         return redirect(endpoint,**kwargs)
 
-
-    def flash(self,*args,**kwargs):
-        if not 'category' in kwargs:
-            kwargs['category'] = 'warning'
-        flash(*args,**kwargs)
-
     def form_validated(self):
         if self._form:
             return self._form().validate()
@@ -74,6 +102,14 @@ def get_env(self):
 
 
 class ModelView(BaseView):
+    # ModelView is an abstract class
+    # just an interface really
+    # to use the ModelView create your own view class
+    # and use this as the parent class, and 
+    # set its _model class attr to the class to wrap ie:
+    # 
+    # class UserModelView(ModelView):
+    #   _model = User
     _model = None
 
     def render(self,**kwargs):
@@ -110,3 +146,28 @@ def update(self,model_id,**kwargs):
     def get_by_id(self,model_id):
         tmp = self._model.get_by_id(model_id)
         return tmp
+
+
+class ModelAPIView(ModelView):
+    __abstract__ = True
+
+    @classproperty
+    def _default_view_routes(cls):
+        if cls is ModelAPIView:
+            return {}
+        name = cls.__name__.lower()
+        _default_view_routes = {
+                '/{}/list'.format(name):'{}-list'.format(name),
+                '/{}/detail'.format(name):'{}-detail'.format(name),
+                '/{}/edit'.format(name):'{}-edit'.format(name),
+        }
+        return _default_view_routes
+
+
+    def render(self,**kwargs):
+        old_rtn = super(ModelAPIView,self).render(**kwargs)
+        rtn = make_response(json.dumps(self._context))
+        rtn.headers['Content-Type'] = 'application/json'
+        return rtn
+    
+    

flask_xxl/main.py

@@ -8,9 +8,11 @@
 import jinja2_highlight
 import sys
 import os
-from flask import Flask
+from flask import Flask,views
 from werkzeug.utils import import_string,find_modules
 import jinja2_highlight
+from .baseviews import is_verbose
+
 
 class MyFlask(Flask):
         jinja_options = dict(Flask.jinja_options)
@@ -43,6 +45,7 @@ def get_app(self, app_module_name, **kwargs):
         self.app = MyFlask(app_module_name, **kwargs)
         self.app.config.from_object(self.app_config)
         self.app.config.from_envvar(self.app_envvar, silent=True)
+        self.app.config['VERBOSE'] = is_verbose()
 
 
         self._set_path()
@@ -60,20 +63,37 @@ def get_app(self, app_module_name, **kwargs):
     def _set_path(self):
         sys.path.append(self.app.config.get('ROOT_PATH',''))
 
+    def _is_public_attr(self,name):
+        return not name.startswith('_')
+
     def _get_imported_stuff_by_path(self, path):
         module_name, object_name = path.rsplit('.', 1)
         module = import_string(module_name)
-
         return module, object_name
 
     def _load_resource(self,typename):
         for blueprint_path in self.app.config.get('BLUEPRINTS', []):
             module_name, object_name = blueprint_path.rsplit('.', 1)
+            blueprint_module, bp_name = self._get_imported_stuff_by_path(blueprint_path)
+            blueprint = getattr(blueprint_module,bp_name)
             modules = find_modules(module_name)
             for module in modules:
                 if typename in module:
-                    print module
-                    import_string(module)
+                    mod = import_string(module)
+                    for itm in dir(mod):
+                        cls = getattr(mod,itm)
+                        if self._is_public_attr(itm) and\
+                                itm[0] == str(itm[0]).upper() and\
+                                'class' in str(cls) and\
+                                'view' in str(itm).lower():
+
+                            if hasattr(cls,'_add_default_routes') and\
+                                    getattr(cls,'_default_view_routes'):
+                                if is_verbose():
+                                    print 'getting default routes for ',cls.__name__
+                                getattr(cls,'_add_default_routes')(app=blueprint or self.app)
+
+
 
     def _load_views(self):
         return self._load_resource('views')

requirements.txt

@@ -17,7 +17,7 @@ alembic==0.6.7
 argparse==1.2.1
 blinker==1.3
 flask-codemirror==0.0.3
-flask-xxl==0.6.6
+flask-xxl==0.7.11
 itsdangerous==0.24
 jinja2-highlight==0.6.1
 mr.bob2==0.2.3