mistercrunch commented on a change in pull request #5524: A tagging system for
dashboards, charts and queries
URL:
https://github.com/apache/incubator-superset/pull/5524#discussion_r207066033
##########
File path: superset/views/tags.py
##########
@@ -0,0 +1,197 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=C,R,W
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+from __future__ import unicode_literals
+
+from flask import request, Response
+from flask_appbuilder import expose
+from jinja2.sandbox import SandboxedEnvironment
+import simplejson as json
+from sqlalchemy import and_, func
+from werkzeug.routing import BaseConverter
+
+from superset import app, appbuilder, db, utils
+from superset.jinja_context import current_user_id, current_username
+import superset.models.core
+from superset.models.sql_lab import SavedQuery
+from superset.models.tags import ObjectTypes, Tag, TaggedObject, TagTypes
+from .base import BaseSupersetView
+
+
+class ObjectTypeConverter(BaseConverter):
+
+ """Validate that object_type is indeed an object type."""
+
+ def to_python(self, object_type):
+ return ObjectTypes[object_type]
+
+ def to_url(self, object_type):
+ return object_type.name
+
+
+def process_template(content):
+ env = SandboxedEnvironment()
+ template = env.from_string(content)
+ context = {
+ 'current_user_id': current_user_id,
+ 'current_username': current_username,
+ }
+ return template.render(context)
+
+
+def get_name(obj):
+ if obj.Dashboard:
+ return obj.Dashboard.dashboard_title
+ elif obj.Slice:
+ return obj.Slice.slice_name
+ elif obj.SavedQuery:
+ return obj.SavedQuery.label
+
+
+def get_creator(obj):
+ if obj.Dashboard:
+ return obj.Dashboard.creator()
+ elif obj.Slice:
+ return obj.Slice.creator()
+ elif obj.SavedQuery:
+ return obj.SavedQuery.creator()
+
+
+def get_attribute(obj, attr):
+ if obj.Dashboard:
+ return getattr(obj.Dashboard, attr)
+ elif obj.Slice:
+ return getattr(obj.Slice, attr)
+ elif obj.SavedQuery:
+ return getattr(obj.SavedQuery, attr)
+
+
+class TagView(BaseSupersetView):
+
+ @expose('/tags/suggestions/', methods=['GET'])
+ def suggestions(self):
+ query = db.session.query(
+ TaggedObject,
+ ).group_by(TaggedObject.tag_id).order_by(func.count().desc()).all()
+ tags = json.dumps([
+ {'id': obj.tag.id, 'name': obj.tag.name} for obj in query])
+
+ return Response(tags, status=200, content_type='application/json')
+
+ @expose('/tags/<object_type:object_type>/<int:object_id>/',
methods=['GET'])
+ def get(self, object_type, object_id):
+ """List all tags a given object has."""
+ query = db.session.query(TaggedObject).filter(and_(
+ TaggedObject.object_type == object_type,
+ TaggedObject.object_id == object_id))
+ tags = json.dumps([
+ {'id': obj.tag.id, 'name': obj.tag.name} for obj in query])
+
+ return Response(tags, status=200, content_type='application/json')
+
+ @expose('/tags/<object_type:object_type>/<int:object_id>/',
methods=['POST'])
+ def post(self, object_type, object_id):
+ """Add new tags to an object."""
+ tagged_objects = []
+ for name in request.get_json(force=True):
+ if ':' in name:
+ type_name = name.split(':', 1)[0]
+ type_ = TagTypes[type_name]
+ else:
+ type_ = TagTypes.custom
+
+ tag = db.session.query(Tag).filter_by(name=name,
type=type_).first()
+ if not tag:
+ tag = Tag(name=name, type=type_)
+
+ tagged_objects.append(
+ TaggedObject(
+ object_id=object_id,
+ object_type=object_type,
+ tag=tag,
+ ),
+ )
+
+ db.session.add_all(tagged_objects)
+ db.session.commit()
+
+ return Response(status=201) # 201 CREATED
+
+ @expose('/tags/<object_type:object_type>/<int:object_id>/',
methods=['DELETE'])
+ def delete(self, object_type, object_id):
+ """Remove tags from an object."""
+ tag_names = request.get_json(force=True)
+ if not tag_names:
+ return Response(status=403)
+
+ db.session.query(TaggedObject).filter(and_(
+ TaggedObject.object_type == object_type,
+ TaggedObject.object_id == object_id),
+ TaggedObject.tag.has(Tag.name.in_(tag_names)),
+ ).delete(synchronize_session=False)
+ db.session.commit()
+
+ return Response(status=204) # 204 NO CONTENT
+
+ @expose('/tagged_objects/', methods=['GET', 'POST'])
+ def tagged_objects(self):
+ query = db.session.query(
+ TaggedObject,
+ superset.models.core.Dashboard,
+ superset.models.core.Slice,
+ SavedQuery,
+ ).join(Tag)
+
+ tags = request.args.get('tags')
+ if not tags:
+ return Response(
+ json.dumps([]), status=200, content_type='application/json')
+
+ tags = [process_template(tag) for tag in tags.split(',')]
+ query = query.filter(Tag.name.in_(tags))
+
+ # filter types
+ types = request.args.get('types')
+ if types:
+ query =
query.filter(TaggedObject.object_type.in_(types.split(',')))
+
+ # get names
+ query = query.outerjoin(
+ superset.models.core.Dashboard,
+ and_(
+ TaggedObject.object_id == superset.models.core.Dashboard.id,
+ TaggedObject.object_type == ObjectTypes.dashboard,
+ ),
+ ).outerjoin(
+ superset.models.core.Slice,
+ and_(
+ TaggedObject.object_id == superset.models.core.Slice.id,
+ TaggedObject.object_type == ObjectTypes.chart,
+ ),
+ ).outerjoin(
+ SavedQuery,
+ and_(
+ TaggedObject.object_id == SavedQuery.id,
+ TaggedObject.object_type == ObjectTypes.query,
+ ),
+ ).group_by(TaggedObject.object_id, TaggedObject.object_type)
Review comment:
Trying to understand what kind of SQL will come out of that query object...
Is the group_by needed?
Also you may be able to parameterize the ObjectTypes as in:
```python
tagged_models = [Slice, Dashboard, Query]
for tm in tagged_models:
query = query.outerjoin(tm, {...})
```
It would make it easier to add more tagged models in the future but may make
the code more opaque.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
