# -*- coding: utf-8 -*-
###########################################################################
# Copyright (c), The AiiDA team. All rights reserved. #
# This file is part of the AiiDA code. #
# #
# The code is hosted on GitHub at https://github.com/aiidateam/aiida-core #
# For further information on the license, see the LICENSE.txt file #
# For further information please visit http://www.aiida.net #
###########################################################################
"""Base translator class"""
from aiida.common.exceptions import InputValidationError, InvalidOperation
from aiida.orm.querybuilder import QueryBuilder
from aiida.restapi.common.exceptions import RestInputValidationError, RestValidationError
from aiida.restapi.common.utils import PK_DBSYNONYM
[docs]
class BaseTranslator:
"""
Generic class for translator. It contains the methods
required to build a related QueryBuilder object
"""
# pylint: disable=too-many-instance-attributes,fixme
# A label associated to the present class
__label__ = None
# The AiiDA class one-to-one associated to the present class
_aiida_class = None
# The string name of the AiiDA class
_aiida_type = None
# If True (False) the corresponding AiiDA class has (no) uuid property
_has_uuid = None
_result_type = __label__
_default = _default_projections = ['**']
_is_qb_initialized = False
_is_id_query = None
_total_count = None
[docs]
def __init__(self, **kwargs):
"""
Initialise the parameters.
Create the basic query_help
keyword Class (default None but becomes this class): is the class
from which one takes the initial values of the attributes. By default
is this class so that class atributes are translated into object
attributes. In case of inheritance one cane use the
same constructore but pass the inheriting class to pass its attributes.
"""
# Basic filter (dict) to set the identity of the uuid. None if
# no specific node is requested
self._id_filter = None
# basic query_help object
self._query_help = {
'path': [{
'cls': self._aiida_class,
'tag': self.__label__
}],
'filters': {},
'project': {},
'order_by': {}
}
# query_builder object (No initialization)
self.qbobj = QueryBuilder()
self.limit_default = kwargs['LIMIT_DEFAULT']
self.schema = None
[docs]
def __repr__(self):
"""
This function is required for the caching system to be able to compare
two NodeTranslator objects. Comparison is done on the value returned by __repr__
:return: representation of NodeTranslator objects. Returns nothing
because the inputs of self.get_nodes are sufficient to determine the
identity of two queries.
"""
return ''
[docs]
@staticmethod
def get_projectable_properties():
"""
This method is extended in specific translators classes.
It returns a dict as follows:
dict(fields=projectable_properties, ordering=ordering)
where projectable_properties is a dict and ordering is a list
"""
return {}
[docs]
def init_qb(self):
"""
Initialize query builder object by means of _query_help
"""
self.qbobj.__init__(**self._query_help)
self._is_qb_initialized = True
[docs]
def count(self):
"""
Count the number of rows returned by the query and set total_count
"""
if self._is_qb_initialized:
self._total_count = self.qbobj.count()
else:
raise InvalidOperation('query builder object has not been initialized.')
# def caching_method(self):
# """
# class method for caching. It is a wrapper of the
# flask_cache memoize
# method. To be used as a decorator
# :return: the flask_cache memoize method with the timeout kwarg
# corrispondent to the class
# """
# return cache.memoize()
#
# @cache.memoize(timeout=CACHING_TIMEOUTS[self.__label__])
[docs]
def get_total_count(self):
"""
Returns the number of rows of the query.
:return: total_count
"""
## Count the results if needed
if not self._total_count:
self.count()
return self._total_count
[docs]
def set_filters(self, filters=None):
"""
Add filters in query_help.
:param filters: it is a dictionary where keys are the tag names
given in the path in query_help and their values are the dictionary
of filters want to add for that tag name. Format for the Filters
dictionary::
filters = {
"tag1" : {k1:v1, k2:v2},
"tag2" : {k1:v1, k2:v2},
}
:return: query_help dict including filters if any.
"""
if filters is None:
filters = {}
if isinstance(filters, dict): # pylint: disable=too-many-nested-blocks
if filters:
for tag, tag_filters in filters.items():
if tag_filters and isinstance(tag_filters, dict):
self._query_help['filters'][tag] = {}
for filter_key, filter_value in tag_filters.items():
if filter_key == 'pk':
filter_key = PK_DBSYNONYM
self._query_help['filters'][tag][filter_key] \
= filter_value
else:
raise InputValidationError(
'Pass data in dictionary format where '
'keys are the tag names given in the '
'path in query_help and and their values'
' are the dictionary of filters want '
'to add for that tag name.'
)
[docs]
def get_default_projections(self):
"""
method to get default projections of the node
:return: self._default_projections
"""
return self._default_projections
[docs]
def set_default_projections(self):
"""
It calls the set_projections() methods internally to add the
default projections in query_help
:return: None
"""
self.set_projections({self.__label__: self._default_projections})
[docs]
def set_projections(self, projections):
"""
add the projections in query_help
:param projections: it is a dictionary where keys are the tag names
given in the path in query_help and values are the list of the names
you want to project in the final output
:return: updated query_help with projections
"""
if isinstance(projections, dict):
if projections:
for project_key, project_list in projections.items():
self._query_help['project'][project_key] = project_list
else:
raise InputValidationError(
'Pass data in dictionary format where '
'keys are the tag names given in the '
'path in query_help and values are the '
'list of the names you want to project '
'in the final output'
)
[docs]
def set_order(self, orders):
"""
Add order_by clause in query_help
:param orders: dictionary of orders you want to apply on final
results
:return: None or exception if any.
"""
## Validate input
if not isinstance(orders, dict):
raise InputValidationError(
'orders has to be a dictionary'
"compatible with the 'order_by' section"
'of the query_help'
)
## Auxiliary_function to get the ordering cryterion
def def_order(columns):
"""
Takes a list of signed column names ex. ['id', '-ctime',
'+mtime']
and transforms it in a order_by compatible dictionary
:param columns: (list of strings)
:return: a dictionary
"""
from collections import OrderedDict
order_dict = OrderedDict()
for column in columns:
if column[0] == '-':
order_dict[column[1:]] = 'desc'
elif column[0] == '+':
order_dict[column[1:]] = 'asc'
else:
order_dict[column] = 'asc'
if 'pk' in order_dict:
order_dict[PK_DBSYNONYM] = order_dict.pop('pk')
return order_dict
## Assign orderby field query_help
if 'id' not in orders[self._result_type] and '-id' not in orders[self._result_type]:
orders[self._result_type].append('id')
for tag, columns in orders.items():
self._query_help['order_by'][tag] = def_order(columns)
[docs]
def set_query(
self,
filters=None,
orders=None,
projections=None,
query_type=None,
node_id=None,
attributes=None,
attributes_filter=None,
extras=None,
extras_filter=None
):
# pylint: disable=too-many-arguments,unused-argument,too-many-locals,too-many-branches
"""
Adds filters, default projections, order specs to the query_help,
and initializes the qb object
:param filters: dictionary with the filters
:param orders: dictionary with the order for each tag
:param projections: dictionary with the projection. It is discarded
if query_type=='attributes'/'extras'
:param query_type: (string) specify the result or the content ("attr")
:param id: (integer) id of a specific node
:param filename: name of the file to return its content
:param attributes: flag to show attributes in nodes endpoint
:param attributes_filter: list of node attributes to query
:param extras: flag to show attributes in nodes endpoint
:param extras_filter: list of node extras to query
"""
tagged_filters = {}
## Check if filters are well defined and construct an ad-hoc filter
# for id_query
if node_id is not None:
self._is_id_query = True
if self._result_type == self.__label__ and filters:
raise RestInputValidationError('selecting a specific id does not allow to specify filters')
try:
self._check_id_validity(node_id)
except RestValidationError as exc:
raise RestValidationError(str(exc))
else:
tagged_filters[self.__label__] = self._id_filter
if self._result_type is not self.__label__:
tagged_filters[self._result_type] = filters
else:
tagged_filters[self.__label__] = filters
## Add filters
self.set_filters(tagged_filters)
## Add projections
if projections is None:
if attributes is None and extras is None:
self.set_default_projections()
else:
default_projections = self.get_default_projections()
if attributes is True:
if attributes_filter is None:
default_projections.append('attributes')
else:
## Check if attributes_filter is not a list
if not isinstance(attributes_filter, list):
attributes_filter = [attributes_filter]
for attr in attributes_filter:
default_projections.append(f'attributes.{str(attr)}')
elif attributes is not None and attributes is not False:
raise RestValidationError('The attributes filter is false by default and can only be set to true.')
if extras is True:
if extras_filter is None:
default_projections.append('extras')
else:
## Check if extras_filter is not a list
if not isinstance(extras_filter, list):
extras_filter = [extras_filter]
for extra in extras_filter:
default_projections.append(f'extras.{str(extra)}')
elif extras is not None and extras is not False:
raise RestValidationError('The extras filter is false by default and can only be set to true.')
self.set_projections({self.__label__: default_projections})
else:
tagged_projections = {self._result_type: projections}
self.set_projections(tagged_projections)
##Add order_by
if orders is not None:
tagged_orders = {self._result_type: orders}
self.set_order(tagged_orders)
## Initialize the query_object
self.init_qb()
[docs]
def get_query_help(self):
"""
:return: return QB json dictionary
"""
return self._query_help
[docs]
def set_limit_offset(self, limit=None, offset=None):
"""
sets limits and offset directly to the query_builder object
:param limit:
:param offset:
:return:
"""
## mandatory params
# none
## non-mandatory params
if limit is not None:
try:
limit = int(limit)
except ValueError:
raise InputValidationError('Limit value must be an integer')
if limit > self.limit_default:
raise RestValidationError(f'Limit and perpage cannot be bigger than {self.limit_default}')
else:
limit = self.limit_default
if offset is not None:
try:
offset = int(offset)
except ValueError:
raise InputValidationError('Offset value must be an integer')
if self._is_qb_initialized:
if limit is not None:
self.qbobj.limit(limit)
else:
pass
if offset is not None:
self.qbobj.offset(offset)
else:
pass
else:
raise InvalidOperation('query builder object has not been initialized.')
[docs]
def get_results(self):
"""
Returns either list of nodes or details of single node from database.
:return: either list of nodes or details of single node from database
"""
## Check whether the querybuilder object has been initialized
if not self._is_qb_initialized:
raise InvalidOperation('query builder object has not been initialized.')
## Count the total number of rows returned by the query (if not
# already done)
if self._total_count is None:
self.count()
## Retrieve data
data = self.get_formatted_result(self._result_type)
return data
[docs]
def _check_id_validity(self, node_id):
"""
Checks whether id corresponds to an object of the expected type,
whenever type is a valid column of the database (ex. for nodes,
but not for users)
:param node_id: id (or id starting pattern)
:return: True if node_id valid, False if invalid. If True, sets the id
filter attribute correctly
:raise RestValidationError: if no node is found or id pattern does
not identify a unique node
"""
from aiida.common.exceptions import MultipleObjectsError, NotExistent
from aiida.orm.utils.loaders import IdentifierType, get_loader
loader = get_loader(self._aiida_class)
if self._has_uuid:
# For consistency check that id is a string
if not isinstance(node_id, str):
raise RestValidationError('parameter id has to be a string')
identifier_type = IdentifierType.UUID
qbobj, _ = loader.get_query_builder(node_id, identifier_type, sub_classes=(self._aiida_class,))
else:
# Similarly, check that id is an integer
if not isinstance(node_id, int):
raise RestValidationError('parameter id has to be an integer')
identifier_type = IdentifierType.ID
qbobj, _ = loader.get_query_builder(node_id, identifier_type, sub_classes=(self._aiida_class,))
# For efficiency I don't go further than two results
qbobj.limit(2)
try:
pk = qbobj.one()[0].pk
except MultipleObjectsError:
raise RestInputValidationError('More than one node found. Provide longer starting pattern for id.')
except NotExistent:
raise RestInputValidationError(
"either no object's id starts"
" with '{}' or the corresponding object"
' is not of type aiida.orm.{}'.format(node_id, self._aiida_type)
)
else:
# create a permanent filter
self._id_filter = {'id': {'==': pk}}
return True
