Merge pull request #1156 from mikelambert/master

Add a demo app for appengine (and fix one more bug)

.gitignore

@@ -19,6 +19,7 @@ __pycache__
 examples/sqla-inline/static
 examples/file/files
 examples/forms/files
+examples/appengine/lib
 .DS_Store
 .idea/
 *.sqlite

examples/appengine/app.py

+
+from flask import Flask
+import flask_admin
+from flask_admin.contrib import appengine
+from google.appengine.ext import db
+from google.appengine.ext import ndb
+
+# Create application
+app = Flask(__name__)
+
+# Create dummy secrey key so we can use sessions
+app.config['SECRET_KEY'] = '123456790'
+
+admin = flask_admin.Admin(app, name="Admin")
+
+# Flask views
+@app.route('/')
+def index():
+    return '<a href="/admin/">Click me to get to Admin!</a>'
+
+class Car(db.Model):
+    owner = db.StringProperty()
+    make_model = db.StringProperty()
+    indexed_int = db.IntegerProperty()
+    unindexed_int = db.IntegerProperty(indexed=False)
+
+class Tire(db.Model):
+    car = db.ReferenceProperty(Car)
+    position = db.StringProperty()
+
+class House(ndb.Model):
+    address = db.StringProperty()
+    json_property = ndb.JsonProperty()
+    indexed_int = ndb.IntegerProperty()
+    unindexed_int = ndb.IntegerProperty(indexed=False)
+    text_property = ndb.TextProperty()
+    datetime_property = ndb.DateTimeProperty()
+
+class Room(ndb.Model):
+    house = ndb.KeyProperty(kind=House)
+    name = ndb.StringProperty()
+
+admin.add_view(appengine.ModelView(Car))
+admin.add_view(appengine.ModelView(Tire))
+admin.add_view(appengine.ModelView(House))
+admin.add_view(appengine.ModelView(Room))
+
+if __name__ == '__main__':
+
+    # Start app
+    app.run(debug=True)

examples/appengine/app.yaml

+runtime: python27
+threadsafe: true
+api_version: 1
+module: default
+
+handlers:
+- url: /admin.*
+  script: app.app

examples/appengine/appengine_config.py

+# This file gets imported as part of running dev_appserver.py
+import sys
+sys.path = ['lib'] + sys.path

examples/appengine/run.sh

+BASEDIR=$(dirname $0)
+# Install wtforms-admin to our lib/ directory, using our local source tree
+pip install -t $BASEDIR/lib/ $BASEDIR/../.. wtforms_appengine
+# Now run our server
+dev_appserver.py $BASEDIR/app.yaml

flask_admin/contrib/appengine/view.py

@@ -8,171 +8,172 @@ from google.appengine.ext import db
 from google.appengine.ext import ndb
 
 class NdbModelView(BaseModelView):
-	"""
-	AppEngine NDB model scaffolding.
-	"""
-
-	def get_pk_value(self, model):
-		return model.key.urlsafe()
-
-	def scaffold_list_columns(self):
-		return sorted([k for (k, v) in self.model.__dict__.iteritems() if isinstance(v, ndb.Property)])
-
-	def scaffold_sortable_columns(self):
-		return [k for (k, v) in self.model.__dict__.iteritems() if isinstance(v, ndb.Property) and v._indexed]
-
-	def init_search(self):
-		return None
-
-	def is_valid_filter(self):
-		pass
-
-	def scaffold_filters(self):
-		#TODO: implement
-		pass
-
-	def scaffold_form(self):
-		return wt_ndb.model_form(self.model())
-
-	def get_list(self, page, sort_field, sort_desc, search, filters):
-		#TODO: implement filters (don't think search can work here)
-
-		q = self.model.query()
-
-		if sort_field:
-			order_field = getattr(self.model, sort_field)
-			if sort_desc:
-				order_field = -order_field
-			q = q.order(order_field)
-
-		results = q.fetch(self.page_size, offset=page*self.page_size)
-		return q.count(), results
-
-	def get_one(self, urlsafe_key):
-		return ndb.Key(urlsafe=urlsafe_key).get()
-
-	def create_model(self, form):
-		try:
-			model = self.model()
-			form.populate_obj(model)
-			model.put()
-			return model
-		except Exception as ex:
-			if not self.handle_view_exception(ex):
-				#flash(gettext('Failed to create record. %(error)s',
-				#	error=ex), 'error')
-				logging.exception('Failed to create record.')
-			return False
-
-	def update_model(self, form, model):
-		try:
-			form.populate_obj(model)
-			model.put()
-			return True
-		except Exception as ex:
-			if not self.handle_view_exception(ex):
-				#flash(gettext('Failed to update record. %(error)s',
-				#	error=ex), 'error')
-				logging.exception('Failed to update record.')
-			return False
-
-	def delete_model(self,  model):
-		try:
-			model.key.delete()
-			return True
-		except Exception as ex:
-			if not self.handle_view_exception(ex):
-				#flash(gettext('Failed to delete record. %(error)s',
-				#	error=ex),
-				#	'error')
-				logging.exception('Failed to delete record.')
-		return False
+    """
+    AppEngine NDB model scaffolding.
+    """
+
+    def get_pk_value(self, model):
+        return model.key.urlsafe()
+
+    def scaffold_list_columns(self):
+        return sorted([k for (k, v) in self.model.__dict__.iteritems() if isinstance(v, ndb.Property)])
+
+    def scaffold_sortable_columns(self):
+        return [k for (k, v) in self.model.__dict__.iteritems() if isinstance(v, ndb.Property) and v._indexed]
+
+    def init_search(self):
+        return None
+
+    def is_valid_filter(self):
+        pass
+
+    def scaffold_filters(self):
+        #TODO: implement
+        pass
+
+    def scaffold_form(self):
+        return wt_ndb.model_form(self.model())
+
+    def get_list(self, page, sort_field, sort_desc, search, filters):
+        #TODO: implement filters (don't think search can work here)
+
+        q = self.model.query()
+
+        if sort_field:
+            order_field = getattr(self.model, sort_field)
+            if sort_desc:
+                order_field = -order_field
+            q = q.order(order_field)
+
+        results = q.fetch(self.page_size, offset=page*self.page_size)
+        return q.count(), results
+
+    def get_one(self, urlsafe_key):
+        return ndb.Key(urlsafe=urlsafe_key).get()
+
+    def create_model(self, form):
+        try:
+            model = self.model()
+            form.populate_obj(model)
+            model.put()
+            return model
+        except Exception as ex:
+            if not self.handle_view_exception(ex):
+                #flash(gettext('Failed to create record. %(error)s',
+                #    error=ex), 'error')
+                logging.exception('Failed to create record.')
+            return False
+
+    def update_model(self, form, model):
+        try:
+            form.populate_obj(model)
+            model.put()
+            return True
+        except Exception as ex:
+            if not self.handle_view_exception(ex):
+                #flash(gettext('Failed to update record. %(error)s',
+                #    error=ex), 'error')
+                logging.exception('Failed to update record.')
+            return False
+
+    def delete_model(self,  model):
+        try:
+            model.key.delete()
+            return True
+        except Exception as ex:
+            if not self.handle_view_exception(ex):
+                #flash(gettext('Failed to delete record. %(error)s',
+                #    error=ex),
+                #    'error')
+                logging.exception('Failed to delete record.')
+        return False
 
 
 class DbModelView(BaseModelView):
-	"""
-	AppEngine DB model scaffolding.
-	"""
-
-	def get_pk_value(self, model):
-		return str(model.key())
-
-	def scaffold_list_columns(self):
-		return sorted([k for (k, v) in self.model.__dict__.iteritems() if isinstance(v, db.Property)])
-
-	def scaffold_sortable_columns(self):
-		return [k for (k, v) in self.model.__dict__.iteritems() if isinstance(v, db.Property) and v.indexed]
-
-	def init_search(self):
-		return None
-
-	def is_valid_filter(self):
-		pass
-
-	def scaffold_filters(self):
-		#TODO: implement
-		pass
-
-	def scaffold_form(self):
-		return wt_db.model_form(self.model())
-
-	def get_list(self, page, sort_field, sort_desc, search, filters):
-		#TODO: implement filters (don't think search can work here)
-
-		q = self.model.all()
-
-		if sort_field:
-			if sort_desc:
-				sort_field = "-" + sort_field
-			q.order(sort_field)
-
-		results = q.fetch(self.page_size, offset=page*self.page_size)
-		return q.count(), results
-
-	def get_one(self, encoded_key):
-		return db.get(db.Key(encoded=encoded_key))
-
-	def create_model(self, form):
-		try:
-			model = self.model()
-			form.populate_obj(model)
-			model.put()
-			return model
-		except Exception as ex:
-			if not self.handle_view_exception(ex):
-				#flash(gettext('Failed to create record. %(error)s',
-				#	error=ex), 'error')
-				logging.exception('Failed to create record.')
-			return False
-
-	def update_model(self, form, model):
-		try:
-			form.populate_obj(model)
-			model.put()
-			return True
-		except Exception as ex:
-			if not self.handle_view_exception(ex):
-				#flash(gettext('Failed to update record. %(error)s',
-				#	error=ex), 'error')
-				logging.exception('Failed to update record.')
-			return False
-
-	def delete_model(self,  model):
-		try:
-			model.delete()
-			return True
-		except Exception as ex:
-			if not self.handle_view_exception(ex):
-				#flash(gettext('Failed to delete record. %(error)s',
-				#	error=ex),
-				#	'error')
-				logging.exception('Failed to delete record.')
-		return False
+    """
+    AppEngine DB model scaffolding.
+    """
+
+    def get_pk_value(self, model):
+        return str(model.key())
+
+    def scaffold_list_columns(self):
+        return sorted([k for (k, v) in self.model.__dict__.iteritems() if isinstance(v, db.Property)])
+
+    def scaffold_sortable_columns(self):
+        # We use getattr() because ReferenceProperty does not specify a 'indexed' field
+        return [k for (k, v) in self.model.__dict__.iteritems() if isinstance(v, db.Property) and getattr(v, 'indexed', None)]
+
+    def init_search(self):
+        return None
+
+    def is_valid_filter(self):
+        pass
+
+    def scaffold_filters(self):
+        #TODO: implement
+        pass
+
+    def scaffold_form(self):
+        return wt_db.model_form(self.model())
+
+    def get_list(self, page, sort_field, sort_desc, search, filters):
+        #TODO: implement filters (don't think search can work here)
+
+        q = self.model.all()
+
+        if sort_field:
+            if sort_desc:
+                sort_field = "-" + sort_field
+            q.order(sort_field)
+
+        results = q.fetch(self.page_size, offset=page*self.page_size)
+        return q.count(), results
+
+    def get_one(self, encoded_key):
+        return db.get(db.Key(encoded=encoded_key))
+
+    def create_model(self, form):
+        try:
+            model = self.model()
+            form.populate_obj(model)
+            model.put()
+            return model
+        except Exception as ex:
+            if not self.handle_view_exception(ex):
+                #flash(gettext('Failed to create record. %(error)s',
+                #    error=ex), 'error')
+                logging.exception('Failed to create record.')
+            return False
+
+    def update_model(self, form, model):
+        try:
+            form.populate_obj(model)
+            model.put()
+            return True
+        except Exception as ex:
+            if not self.handle_view_exception(ex):
+                #flash(gettext('Failed to update record. %(error)s',
+                #    error=ex), 'error')
+                logging.exception('Failed to update record.')
+            return False
+
+    def delete_model(self,  model):
+        try:
+            model.delete()
+            return True
+        except Exception as ex:
+            if not self.handle_view_exception(ex):
+                #flash(gettext('Failed to delete record. %(error)s',
+                #    error=ex),
+                #    'error')
+                logging.exception('Failed to delete record.')
+        return False
 
 def ModelView(model):
-	if issubclass(model, ndb.Model):
-		return NdbModelView(model)
-	elif issubclass(model, db.Model):
-		return DbModelView(model)
-	else:
-		raise ValueError("Unsupported model: %s" % model)
+    if issubclass(model, ndb.Model):
+        return NdbModelView(model)
+    elif issubclass(model, db.Model):
+        return DbModelView(model)
+    else:
+        raise ValueError("Unsupported model: %s" % model)