Skip to content

F
flask-admin
Commit d851c420 authored by Serge S. Koval's avatar Serge S. Koval
Browse files
Options

Fixed #408 and #409. Refactored internal filter logic. Can customize URL with filters

parent 9b19fff4
Hide whitespace changes
Inline Side-by-side
Showing with 236 additions and 140 deletions
flask_admin/_compat.py
View file @ d851c420
......@@ -72,3 +72,22 @@ def with_metaclass(meta, *bases):
return type.__new__(cls, name, (), d)
return meta(name, bases, d)
return metaclass('temporary_class', None, {})
try:
from collections import OrderedDict
except ImportError:
# Bare-bones OrderedDict implementation for Python2.6 compatibility
class OrderedDict(dict):
def __init__(self, *args, **kwargs):
dict.__init__(self, *args, **kwargs)
self.ordered_keys = []
def __setitem__(self, key, value):
self.ordered_keys.append(key)
dict.__setitem__(self, key, value)
def __iter__(self):
return (k for k in self.ordered_keys)
def iteritems(self):
return ((k, self[k]) for k in self.ordered_keys)
def items(self):
return list(self.iteritems())
flask_admin/model/base.py
View file @ d851c420
import warnings
import re
from flask import request, url_for, redirect, flash, abort, json, Response
......@@ -13,11 +14,16 @@ from flask.ext.admin.actions import ActionsMixin
from flask.ext.admin.helpers import get_form_data, validate_form_on_submit, get_redirect_target
from flask.ext.admin.tools import rec_getattr
from flask.ext.admin._backwards import ObsoleteAttr
from flask.ext.admin._compat import iteritems, as_unicode
from flask.ext.admin._compat import iteritems, OrderedDict
from .helpers import prettify_name, get_mdict_item_or_list
from .ajax import AjaxModelLoader
# Used to generate filter query string name
filter_char_re = re.compile('[^a-z0-9 ]')
filter_compact_re = re.compile(' +')
class BaseModelView(BaseView, ActionsMixin):
"""
Base model view.
......@@ -252,6 +258,15 @@ class BaseModelView(BaseView, ActionsMixin):
column_filters = ('user', 'email')
"""
named_filter_urls = False
"""
Set to True to use human-readable names for filters in URL parameters.
False by default so as to be robust across translations.
Changing this parameter will break any existing URLs that have filters.
"""
column_display_pk = ObsoleteAttr('column_display_pk',
'list_display_pk',
False)
......@@ -543,26 +558,23 @@ class BaseModelView(BaseView, ActionsMixin):
if self.column_descriptions is None:
self.column_descriptions = dict()
# Group filters by field name
if self._filters:
self._filter_groups = []
self._filter_dict = dict()
for i, n in enumerate(self._filters):
if n.name not in self._filter_dict:
group = []
self._filter_dict[n.name] = group
self._filter_groups.append((n.name, group))
else:
group = self._filter_dict[n.name]
self._filter_groups = OrderedDict()
self._filter_args = {}
for i, flt in enumerate(self._filters):
if flt.name not in self._filter_groups:
self._filter_groups[flt.name] = []
group.append((i, n.operation()))
self._filter_groups[flt.name].append((i, flt))
self._filter_args[self.get_filter_arg(i, flt)] = (i, flt)
self._filter_types = dict((i, f.data_type)
for i, f in enumerate(self._filters)
if f.data_type)
self._filter_data = self._serialize_filter_args()
else:
self._filter_groups = None
self._filter_types = None
self._filter_data = None
self._filter_args = None
# Form rendering rules
if self.form_create_rules:
......@@ -671,6 +683,7 @@ class BaseModelView(BaseView, ActionsMixin):
"""
return False
# Filter helpers
def scaffold_filters(self, name):
"""
Generate filter object for the given name
......@@ -715,6 +728,52 @@ class BaseModelView(BaseView, ActionsMixin):
else:
return None
def get_filter_arg(self, index, flt):
"""
Given a filter `flt`, return a unique name for that filter in
this view.
Does not include the `flt[n]_` portion of the filter name.
:param index:
Filter index in _filters array
:param flt:
Filter instance
"""
if self.named_filter_urls:
name = ('%s %s' % (flt.name, flt.operation())).lower()
name = filter_char_re.sub('', name)
name = filter_compact_re.sub('_', name)
return name
else:
return str(index)
def _serialize_filter_args(self):
"""
Convert filter information into JSON-serializable object.
"""
if self._filters:
result = {}
for name, group in iteritems(self._filter_groups):
data = []
for idx, flt in group:
data.append({
'index': idx,
'arg': self.get_filter_arg(idx, flt),
'operation': flt.operation(),
'options': flt.get_options(self) or None,
'type': flt.data_type
})
result[name] = data
return result
return self._filters
# Form helpers
def scaffold_form(self):
"""
Create `form.BaseForm` inherited class from the model. Must be
......@@ -948,43 +1007,42 @@ class BaseModelView(BaseView, ActionsMixin):
def get_empty_list_message(self):
return gettext('There are no items in the table.')
# URL generation helper
def _get_extra_args(self):
"""
Return arguments from query string.
"""
page = request.args.get('page', 0, type=int)
sort = request.args.get('sort', None, type=int)
sort_desc = request.args.get('desc', None, type=int)
search = request.args.get('search', None)
# Gather filters
# URL generation helpers
def _get_list_filter_args(self):
if self._filters:
sfilters = []
filters = []
for n in request.args:
if n.startswith('flt'):
ofs = n.find('_')
if ofs == -1:
continue
if not n.startswith('flt'):
continue
try:
pos = int(n[3:ofs])
idx = int(n[ofs + 1:])
except ValueError:
continue
if '_' not in n:
continue
if idx >= 0 and idx < len(self._filters):
flt = self._filters[idx]
pos, key = n[3:].split('_', 1)
value = request.args[n]
if key in self._filter_args:
idx, flt = self._filter_args[key]
if flt.validate(value):
sfilters.append((pos, (idx, flt.clean(value))))
value = request.args[n]
filters = [v[1] for v in sorted(sfilters, key=lambda n: n[0])]
else:
filters = None
if flt.validate(value):
filters.append((pos, (idx, flt.clean(value))))
# Sort filters
return [v[1] for v in sorted(filters, key=lambda n: n[0])]
return None
def _get_list_extra_args(self):
"""
Return arguments from query string.
"""
page = request.args.get('page', 0, type=int)
sort = request.args.get('sort', None, type=int)
sort_desc = request.args.get('desc', None, type=int)
search = request.args.get('search', None)
filters = self._get_list_filter_args()
return page, sort, sort_desc, search, filters
......@@ -1016,9 +1074,11 @@ class BaseModelView(BaseView, ActionsMixin):
kwargs = dict(page=page, sort=sort, desc=sort_desc, search=search)
if filters:
for i, flt in enumerate(filters):
key = 'flt%d_%d' % (i, flt[0])
kwargs[key] = flt[1]
for i, pair in enumerate(filters):
idx, value = pair
key = 'flt%d_%s' % (i, self.get_filter_arg(idx, self._filters[idx]))
kwargs[key] = value
return url_for(view, **kwargs)
......@@ -1038,12 +1098,6 @@ class BaseModelView(BaseView, ActionsMixin):
"""
return rec_getattr(model, name)
def _get_filter_dict(self):
"""
Return flattened filter dictionary which can be JSON-serialized.
"""
return dict((as_unicode(k), v) for k, v in iteritems(self._filter_dict))
@contextfunction
def get_list_value(self, context, model, name):
"""
......@@ -1104,7 +1158,7 @@ class BaseModelView(BaseView, ActionsMixin):
List view
"""
# Grab parameters from URL
page, sort_idx, sort_desc, search, filters = self._get_extra_args()
page, sort_idx, sort_desc, search, filters = self._get_list_extra_args()
# Map column index to column name
sort_column = self._get_column_by_idx(sort_idx)
......@@ -1120,18 +1174,6 @@ class BaseModelView(BaseView, ActionsMixin):
if count % self.page_size != 0:
num_pages += 1
# Pregenerate filters
if self._filters:
filters_data = dict()
for idx, f in enumerate(self._filters):
flt_data = f.get_options(self)
if flt_data:
filters_data[idx] = flt_data
else:
filters_data = None
# Various URL generation helpers
def pager_url(p):
# Do not add page number if it is first page
......@@ -1186,9 +1228,7 @@ class BaseModelView(BaseView, ActionsMixin):
search=search,
# Filters
filters=self._filters,
filter_groups=self._filter_groups,
filter_types=self._filter_types,
filter_data=filters_data,
filter_groups=self._filter_data,
active_filters=filters,
# Actions
......
flask_admin/static/admin/js/filters.js
View file @ d851c420
var AdminFilters = function(element, filters_element, operations, options, types) {
var AdminFilters = function(element, filtersElement, filterGroups) {
var $root = $(element);
var $container = $('.filters', $root);
var lastCount = 0;
function getCount(name) {
var idx = name.indexOf('_');
return parseInt(name.substr(3, idx - 3));
if (idx === -1) {
return 0;
}
return parseInt(name.substr(3, idx - 3), 10);
}
function makeName(name) {
var result = 'flt' + lastCount + '_' + name;
lastCount += 1;
return result;
}
function changeOperation() {
......@@ -23,44 +34,44 @@ var AdminFilters = function(element, filters_element, operations, options, types
return false;
}
function addFilter(name, op) {
function addFilter(name, subfilters) {
var $el = $('<tr />').appendTo($container);
// Filter list
$el.append(
$('<td/>').append(
$('<a href="#" class="btn remove-filter" />')
.append($('<span class="close-icon">&times;</span>'))
.append('&nbsp;')
.append(name)
.click(removeFilter)
)
);
$('<td/>').append(
$('<a href="#" class="btn remove-filter" />')
.append($('<span class="close-icon">&times;</span>'))
.append('&nbsp;')
.append(name)
.click(removeFilter)
)
);
// Filter type
var $select = $('<select class="filter-op" />')
.change(changeOperation);
$(op).each(function() {
$select.append($('<option/>').attr('value', this[0]).text(this[1]));
$(subfilters).each(function() {
$select.append($('<option/>').attr('value', this.arg).text(this.operation));
});
$el.append(
$('<td/>').append($select)
);
$('<td/>').append($select)
);
$select.select2({width: 'resolve'});
// Input
var optId = op[0][0];
var filter = subfilters[0];
var $field;
if (optId in options) {
if (filter.options) {
$field = $('<select class="filter-val" />')
.attr('name', 'flt' + lastCount + '_' + optId);
.attr('name', makeName(filter.arg));
$(options[optId]).each(function() {
$(filter.options).each(function() {
$field.append($('<option/>')
.val(this[0]).text(this[1]));
});
......@@ -70,22 +81,20 @@ var AdminFilters = function(element, filters_element, operations, options, types
} else
{
$field = $('<input type="text" class="filter-val" />')
.attr('name', 'flt' + lastCount + '_' + optId);
.attr('name', makeName(filter.arg));
$el.append($('<td/>').append($field));
}
if (optId in types) {
$field.attr('data-role', types[optId]);
faForm.applyStyle($field, types[optId]);
if (filter.type) {
$field.attr('data-role', filter.type);
faForm.applyStyle($field, filter.type);
}
lastCount += 1;
}
$('a.filter', filters_element).click(function() {
$('a.filter', filtersElement).click(function() {
var name = $(this).text().trim();
addFilter(name, operations[name]);
addFilter(name, filterGroups[name]);
$('button', $root).show();
......
flask_admin/templates/admin/model/layout.html
View file @ d851c420
......@@ -5,7 +5,7 @@
<ul class="dropdown-menu field-filters">
{% for k in filter_groups %}
<li>
<a href="javascript:void(0)" class="filter" onclick="return false;">{{ k[0] }}</a>
<a href="javascript:void(0)" class="filter" onclick="return false;">{{ k }}</a>
</li>
{% endfor %}
</ul>
......@@ -21,31 +21,32 @@
</div>
<table class="filters">
{%- for i, flt in enumerate(active_filters) -%}
{%- for n, values in enumerate(active_filters) -%}
<tr>
{% set filter = admin_view._filters[flt[0]] %}
{% set idx, value = values %}
{% set filter = filters[idx] %}
{% set filter_arg = admin_view.get_filter_arg(idx, filter) %}
<td>
<a href="javascript:void(0)" class="btn remove-filter" title="{{ _gettext('Remove Filter') }}">
<span class="close-icon">&times;</span>&nbsp;{{ filters[flt[0]] }}
<span class="close-icon">&times;</span>&nbsp;{{ filter.name }}
</a>
</td>
<td>
<select class="filter-op" data-role="select2">
{% for op in admin_view._filter_dict[filter.name] %}
<option value="{{ op[0] }}"{% if flt[0] == op[0] %} selected="selected"{% endif %}>{{ op[1] }}</option>
{% for op in filter_groups[filter.name] %}
<option value="{{ op['arg'] }}"{% if idx == op['index'] %} selected="selected"{% endif %}>{{ op['operation'] }}</option>
{% endfor %}
</select>
</td>
<td>
{%- set data = filter_data.get(flt[0]) -%}
{%- if data -%}
<select name="flt{{ i }}_{{ flt[0] }}" class="filter-val" data-role="select2">
{%- for d in data %}
<option value="{{ d[0] }}"{% if flt[1] == d[0] %} selected{% endif %}>{{ d[1] }}</option>
{%- if filter.options -%}
<select name="flt{{n}}_{{ filter_arg }}" class="filter-val" data-role="select2">
{%- for d in filter.options %}
<option value="{{ d[0] }}"{% if value == d[0] %} selected{% endif %}>{{ d[1] }}</option>
{%- endfor %}
</select>
{%- else -%}
<input name="flt{{ i }}_{{ flt[0] }}" type="text" value="{{ flt[1] or '' }}" class="filter-val"{% if flt[0] in filter_types %} data-role="{{ filter_types[flt[0]] }}"{% endif %}></input>
<input name="flt{{n}}_{{ filter_arg }}" type="text" value="{{ value or '' }}" class="filter-val"{% if filter.data_type %} data-role="{{ filter.data_type }}"{% endif %}></input>
{%- endif -%}
</td>
</tr>
......
flask_admin/templates/admin/model/list.html
View file @ d851c420
......@@ -22,7 +22,7 @@
</li>
{% endif %}
{% if filter_groups %}
{% if filters %}
<li class="dropdown">
{{ model_layout.filter_options() }}
</li>
......@@ -42,7 +42,7 @@
</ul>
{% endblock %}
{% if filter_groups %}
{% if filters %}
{{ model_layout.filter_form() }}
<div class="clearfix"></div>
{% endif %}
......@@ -159,12 +159,10 @@
html: true,
placement: 'bottom'
});
{% if filter_groups is not none and filter_data is not none %}
{% if filter_groups %}
var filter = new AdminFilters(
'#filter_form', '.field-filters',
{{ admin_view._get_filter_dict()|tojson|safe }},
{{ filter_data|tojson|safe }},
{{ filter_types|tojson|safe }}
{{ filter_groups|tojson|safe }}
);
{% endif %}
})(jQuery);
......
flask_admin/tests/sqlamodel/test_basic.py
View file @ d851c420
......@@ -233,61 +233,71 @@ def test_column_filters():
eq_(len(view._filters), 4)
eq_(view._filter_dict, {
u'Test1': [
eq_([(f['index'], f['operation']) for f in view._filter_data[u'Test1']],
[
(0, u'equals'),
(1, u'not equal'),
(2, u'contains'),
(3, u'not contains')
]})
])
# Test filter that references property
view = CustomModelView(Model2, db.session,
column_filters=['model1'])
eq_(view._filter_dict, {
u'Model1 / Test1': [
eq_([(f['index'], f['operation']) for f in view._filter_data[u'Model1 / Test1']],
[
(0, u'equals'),
(1, u'not equal'),
(2, u'contains'),
(3, u'not contains')
],
'Model1 / Test2': [
])
eq_([(f['index'], f['operation']) for f in view._filter_data[u'Model1 / Test2']],
[
(4, 'equals'),
(5, 'not equal'),
(6, 'contains'),
(7, 'not contains')
],
u'Model1 / Test3': [
])
eq_([(f['index'], f['operation']) for f in view._filter_data[u'Model1 / Test3']],
[
(8, u'equals'),
(9, u'not equal'),
(10, u'contains'),
(11, u'not contains')
],
u'Model1 / Test4': [
])
eq_([(f['index'], f['operation']) for f in view._filter_data[u'Model1 / Test4']],
[
(12, u'equals'),
(13, u'not equal'),
(14, u'contains'),
(15, u'not contains')
],
u'Model1 / Bool Field': [
])
eq_([(f['index'], f['operation']) for f in view._filter_data[u'Model1 / Bool Field']],
[
(16, u'equals'),
(17, u'not equal'),
],
u'Model1 / Enum Field': [
])
eq_([(f['index'], f['operation']) for f in view._filter_data[u'Model1 / Enum Field']],
[
(18, u'equals'),
(19, u'not equal'),
]})
])
# Test filter with a dot
view = CustomModelView(Model2, db.session,
column_filters=['model1.bool_field'])
eq_(view._filter_dict, {
'Model1 / Bool Field': [
eq_([(f['index'], f['operation']) for f in view._filter_data[u'Model1 / Bool Field']],
[
(0, 'equals'),
(1, 'not equal'),
]})
])
# Fill DB
model1_obj1 = Model1('model1_obj1', bool_field=True)
......@@ -324,11 +334,15 @@ def test_column_filters():
column_filters=['int_field'])
admin.add_view(view)
eq_(view._filter_dict, {'Int Field': [(0, 'equals'), (1, 'not equal'),
(2, 'greater than'), (3, 'smaller than')]})
eq_([(f['index'], f['operation']) for f in view._filter_data[u'Int Field']],
[
(0, 'equals'),
(1, 'not equal'),
(2, 'greater than'),
(3, 'smaller than')
])
#Test filters to joined table field
# Test filters to joined table field
view = CustomModelView(
Model2, db.session,
endpoint='_model2',
......@@ -349,6 +363,21 @@ def test_column_filters():
ok_('model2_obj3' not in data)
ok_('model2_obj4' not in data)
# Test human readable URLs
view = CustomModelView(
Model1, db.session,
column_filters=['test1'],
endpoint='_model3',
named_filter_urls=True
)
admin.add_view(view)
rv = client.get('/admin/_model3/?flt1_test1_equals=model1_obj1')
eq_(rv.status_code, 200)
data = rv.data.decode('utf-8')
ok_('model1_obj1' in data)
ok_('model1_obj2' not in data)
def test_url_args():
app, db, admin = setup()
......
flask_admin/tests/test_model.py
View file @ d851c420
......@@ -302,8 +302,8 @@ def test_column_filters():
eq_(view._filters[0].name, 'col1')
eq_(view._filters[1].name, 'col2')
eq_(view._filter_dict, {'col1': [(0, 'test')],
'col2': [(1, 'test')]})
eq_([(f['index'], f['operation']) for f in view._filter_data[u'col1']], [(0, 'test')])
eq_([(f['index'], f['operation']) for f in view._filter_data[u'col2']], [(1, 'test')])
# TODO: Make calls with filters
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment