Source code for allensdk.api.queries.rma_template

# Allen Institute Software License - This software license is the 2-clause BSD
# license plus a third clause that prohibits redistribution for commercial
# purposes without further permission.
#
# Copyright 2017. Allen Institute. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# 3. Redistributions for commercial purposes are not permitted without the
# Allen Institute's written permission.
# For purposes of this license, commercial purposes is the incorporation of the
# Allen Institute's software into anything for which you will charge fees or
# other compensation. Contact terms@alleninstitute.org for commercial licensing
# opportunities.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
from .rma_api import RmaApi
from jinja2 import Template


[docs]class RmaTemplate(RmaApi): ''' See: `Atlas Drawings and Ontologies <http://help.brain-map.org/display/api/Atlas+Drawings+and+Ontologies>`_ ''' def __init__(self, base_uri=None, query_manifest=None): super(RmaTemplate, self).__init__(base_uri) self.templates = query_manifest
[docs] def to_filter_rhs(self, rhs): if type(rhs) == list: return ','.join(str(r) for r in rhs) return rhs
[docs] def template_query(self, template_name, entry_name, **kwargs): cb = self.templates[template_name] templates = [e for e in cb if e['name'] == entry_name] if len(templates) > 0: template = templates[0] else: raise Exception('Entry %s not found.' % (entry_name)) query_args = {'model': template['model']} if 'criteria' in template: criteria_template = Template(template['criteria']) if 'criteria_params' in template: criteria_params = {key: self.to_filter_rhs(kwargs.get(key)) for key in template['criteria_params'] if key in kwargs and kwargs.get(key) is not None} else: criteria_params = {} criteria_str = str(criteria_template.render(**criteria_params)) if criteria_str: query_args['criteria'] = criteria_str if 'include' in template: include_template = Template(template['include']) if 'include_params' in template: include_params = {key: self.to_filter_rhs(kwargs.get(key)) for key in template['include_params'] if key in kwargs and kwargs.get(key) is not None} else: include_params = {} include_str = str(include_template.render(**include_params)) if include_str: query_args['include'] = include_str if 'only' in kwargs: if kwargs.get('only') is not None: query_args['only'] = [self.quote_string( ','.join(kwargs.get('only')))] elif 'only' in template: query_args['only'] = [ self.quote_string(','.join(template['only']))] if 'except' in kwargs: if kwargs.get('except') is not None: query_args['except'] = [self.quote_string( ','.join(kwargs.get('except')))] elif 'except' in template: query_args['except'] = template['except'] if 'start_row' in kwargs: query_args['start_row'] = kwargs.get('start_row') elif 'start_row' in template: query_args['start_row'] = template['start_row'] if 'num_rows' in kwargs: query_args['num_rows'] = kwargs.get('num_rows') elif 'num_rows' in template: query_args['num_rows'] = template['num_rows'] if 'count' in kwargs: query_args['count'] = kwargs.get('count') elif 'count' in template: query_args['count'] = template['count'] if 'order' in kwargs: query_args['order'] = kwargs.get('order') elif 'order' in template: query_args['order'] = template['order'] query_args.update(kwargs) data = self.model_query(**query_args) return data