Files
superset2/superset/views/annotations.py

124 lines
3.8 KiB
Python

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
# pylint: disable=C,R,W
from flask_appbuilder.models.sqla.interface import SQLAInterface
from flask_babel import gettext as __
from flask_babel import lazy_gettext as _
from wtforms.validators import StopValidation
from superset import appbuilder
from superset.models.annotations import Annotation, AnnotationLayer
from .base import DeleteMixin, SupersetModelView
class StartEndDttmValidator(object):
"""
Validates dttm fields.
"""
def __call__(self, form, field):
if not form['start_dttm'].data and not form['end_dttm'].data:
raise StopValidation(
_('annotation start time or end time is required.'),
)
elif (form['end_dttm'].data and
form['start_dttm'].data and
form['end_dttm'].data < form['start_dttm'].data):
raise StopValidation(
_('Annotation end time must be no earlier than start time.'),
)
class AnnotationModelView(SupersetModelView, DeleteMixin): # noqa
datamodel = SQLAInterface(Annotation)
list_title = _('List Annotation')
show_title = _('Show Annotation')
add_title = _('Add Annotation')
edit_title = _('Edit Annotation')
list_columns = ['layer', 'short_descr', 'start_dttm', 'end_dttm']
edit_columns = [
'layer', 'short_descr', 'long_descr', 'start_dttm', 'end_dttm',
'json_metadata']
add_columns = edit_columns
label_columns = {
'layer': _('Layer'),
'short_descr': _('Short Descr'),
'start_dttm': _('Start Dttm'),
'end_dttm': _('End Dttm'),
'long_descr': _('Long Descr'),
'json_metadata': _('JSON Metadata'),
}
description_columns = {
'json_metadata': 'This JSON represents any additional metadata this \
annotation needs to add more context.',
}
validators_columns = {
'start_dttm': [
StartEndDttmValidator(),
],
}
def pre_add(self, obj):
if not obj.start_dttm:
obj.start_dttm = obj.end_dttm
elif not obj.end_dttm:
obj.end_dttm = obj.start_dttm
def pre_update(self, obj):
self.pre_add(obj)
class AnnotationLayerModelView(SupersetModelView, DeleteMixin):
datamodel = SQLAInterface(AnnotationLayer)
list_title = _('List Annotation Layer')
show_title = _('Show Annotation Layer')
add_title = _('Add Annotation Layer')
edit_title = _('Edit Annotation Layer')
list_columns = ['id', 'name']
edit_columns = ['name', 'descr']
add_columns = edit_columns
label_columns = {
'name': _('Name'),
'descr': _('Description'),
}
appbuilder.add_view(
AnnotationLayerModelView,
'Annotation Layers',
label=__('Annotation Layers'),
icon='fa-comment',
category='Manage',
category_label=__('Manage'),
category_icon='')
appbuilder.add_view(
AnnotationModelView,
'Annotations',
label=__('Annotations'),
icon='fa-comments',
category='Manage',
category_label=__('Manage'),
category_icon='')