Translator for node
aiida.restapi.translator.nodes.node.
NodeTranslator
Bases: aiida.restapi.translator.base.BaseTranslator
aiida.restapi.translator.base.BaseTranslator
Translator relative to resource ‘nodes’ and aiida class Node
__annotations__
__init__
Initialise the parameters. Create the basic query_help
__label__
__module__
_aiida_class
alias of aiida.orm.nodes.node.Node
aiida.orm.nodes.node.Node
_aiida_type
_attributes_filter
_content_type
_download
_download_format
_extras_filter
_filename
_get_content
Used by get_results() in case of endpoint include “content” option :return: data: a dictionary containing the results obtained by running the query
_get_subclasses
Import all submodules of the package containing the present class. Includes subpackages recursively, if specified.
parent – package/class. If package looks for the classes in submodules. If class, first looks for the package where it is contained
parent_class – class of which to look for subclasses
recursive – True/False (go recursively into submodules)
_has_uuid
_result_type
get_all_download_formats
returns dict of possible node formats for all available node types
get_comments
node – node object
node comments
get_derived_properties
Generic function to get the derived properties of the node. Actual definition is in child classes as the content to be returned depends on the plugin specific to the resource
node – node object that has to be visualized
derived properties of the node
If this method is called by Node resource it will look for the type of object and invoke the correct method in the lowest-compatible subclass
get_downloadable_data
Generic function to download file in specified format. Actual definition is in child classes as the content to be returned and its format depends on the download plugin specific to the resource
download_format – file extension format
data in selected format to download
If this method is called for a Data node resource it will invoke the get_downloadable_data method in the Data transaltor. Otherwise it raises RestFeatureNotAvailable exception
get_file_content
It reads the file from directory and returns its content.
Instead of using “send_from_directory” from flask, this method is written because in next aiida releases the file can be stored locally or in object storage.
node – aiida folderData node which contains file
file_name – name of the file to return its contents
get_formatted_result
Runs the query and retrieves results tagged as “label”.
label (str) – the tag of the results to be extracted out of the query rows.
a list of the query results
get_io_tree
json data to display nodes in tree format :param uuid_pattern: main node uuid :return: json data to display node tree
get_namespace
return full_types of the nodes
get_projectable_properties
Get projectable properties specific for Node :return: dict of projectable properties and column_order list
get_repo_contents
Every node in AiiDA is having repo folder. This function returns the metadata using get_object() method :param node: node object :param filename: folder or file name (optional) :return: file content in bytes to download
get_repo_list
Every node in AiiDA is having repo folder. This function returns the metadata using list_objects() method :param node: node object :param filename: folder name (optional) :return: folder list
get_results
Returns either a list of nodes or details of single node from database
either a list of nodes or the details of single node from the database
get_statistics
Return statistics for a given node
set_query
Adds filters, default projections, order specs to the query_help, and initializes the qb object
filters – dictionary with the filters
orders – dictionary with the order for each tag
projections – dictionary with the projection. It is discarded if query_type==’attributes’/’extras’
query_type – (string) specify the result or the content (“attr”)
id – (integer) id of a specific node
download_format – file format to download e.g. cif, xyz
filename – name of the file to return its content
attributes – flag to show attributes for nodes
attributes_filter – list of attributes to query
extras – flag to show extras for nodes
extras_filter – list of extras to query
set_query_type
sets one of the mutually exclusive values for self._result_type and self._content_type.
:param query_type:(string) the value assigned to either variable.