12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394 |
- from sqlalchemy import or_, and_
- from flask_admin._compat import as_unicode, string_types
- from flask_admin.model.ajax import AjaxModelLoader, DEFAULT_PAGE_SIZE
- from .tools import get_primary_key, has_multiple_pks, is_relationship, is_association_proxy
- class QueryAjaxModelLoader(AjaxModelLoader):
- def __init__(self, name, session, model, **options):
- """
- Constructor.
- :param fields:
- Fields to run query against
- :param filters:
- Additional filters to apply to the loader
- """
- super(QueryAjaxModelLoader, self).__init__(name, options)
- self.session = session
- self.model = model
- self.fields = options.get('fields')
- self.order_by = options.get('order_by')
- self.filters = options.get('filters')
- if not self.fields:
- raise ValueError('AJAX loading requires `fields` to be specified for %s.%s' % (model, self.name))
- self._cached_fields = self._process_fields()
- if has_multiple_pks(model):
- raise NotImplementedError('Flask-Admin does not support multi-pk AJAX model loading.')
- self.pk = get_primary_key(model)
- def _process_fields(self):
- remote_fields = []
- for field in self.fields:
- if isinstance(field, string_types):
- attr = getattr(self.model, field, None)
- if not attr:
- raise ValueError('%s.%s does not exist.' % (self.model, field))
- remote_fields.append(attr)
- else:
- # TODO: Figure out if it is valid SQLAlchemy property?
- remote_fields.append(field)
- return remote_fields
- def format(self, model):
- if not model:
- return None
- return (getattr(model, self.pk), as_unicode(model))
- def get_one(self, pk):
- # prevent autoflush from occuring during populate_obj
- with self.session.no_autoflush:
- return self.session.query(self.model).get(pk)
- def get_list(self, term, offset=0, limit=DEFAULT_PAGE_SIZE):
- query = self.session.query(self.model)
- filters = (field.ilike(u'%%%s%%' % term) for field in self._cached_fields)
- query = query.filter(or_(*filters))
- if self.filters:
- filters = ["%s.%s" % (self.model.__name__.lower(), value) for value in self.filters]
- query = query.filter(and_(*filters))
- if self.order_by:
- query = query.order_by(self.order_by)
- return query.offset(offset).limit(limit).all()
- def create_ajax_loader(model, session, name, field_name, options):
- attr = getattr(model, field_name, None)
- if attr is None:
- raise ValueError('Model %s does not have field %s.' % (model, field_name))
- if not is_relationship(attr) and not is_association_proxy(attr):
- raise ValueError('%s.%s is not a relation.' % (model, field_name))
- if is_association_proxy(attr):
- attr = attr.remote_attr
- remote_model = attr.prop.mapper.class_
- return QueryAjaxModelLoader(name, session, remote_model, **options)
|