# -*- coding: utf-8 -*-
"""
Data types provided by plugin
Register data types via the "aiida.data" entry point in setup.json.
"""
# You can directly use or subclass aiida.orm.data.Data
# or any other data type listed under 'verdi data'
from aiida.orm import Dict
from voluptuous import Schema, Optional
# A subset of diff's command line options
cmdline_options = {
Optional('ignore-case'): bool,
Optional('ignore-file-name-case'): bool,
Optional('ignore-tab-expansion'): bool,
Optional('ignore-space-change'): bool,
Optional('ignore-all-space'): bool,
}
[docs]class DiffParameters(Dict):
"""
Command line options for diff.
This class represents a python dictionary used to
pass command line options to the executable.
"""
# "voluptuous" schema to add automatic validation
schema = Schema(cmdline_options)
# pylint: disable=redefined-builtin
[docs] def __init__(self, dict=None, **kwargs):
"""
Constructor for the data class
Usage: ``DiffParameters(dict{'ignore-case': True})``
:param parameters_dict: dictionary with commandline parameters
:param type parameters_dict: dict
"""
dict = self.validate(dict)
super(DiffParameters, self).__init__(dict=dict, **kwargs)
[docs] def validate(self, parameters_dict):
"""Validate command line options.
Uses the voluptuous package for validation. Find out about allowed keys using::
print(DiffParameters).schema.schema
:param parameters_dict: dictionary with commandline parameters
:param type parameters_dict: dict
:returns: validated dictionary
"""
return DiffParameters.schema(parameters_dict)
[docs] def cmdline_params(self, file1_name, file2_name):
"""Synthesize command line parameters.
e.g. [ '--ignore-case', 'filename1', 'filename2']
:param file_name1: Name of first file
:param type file_name1: str
:param file_name2: Name of second file
:param type file_name2: str
"""
parameters = []
pm_dict = self.get_dict()
for k in pm_dict.keys():
if pm_dict[k]:
parameters += ['--' + k]
parameters += [file1_name, file2_name]
return [str(p) for p in parameters]
[docs] def __str__(self):
"""String representation of node.
Append values of dictionary to usual representation. E.g.::
uuid: b416cbee-24e8-47a8-8c11-6d668770158b (pk: 590)
{'ignore-case': True}
"""
string = super(DiffParameters, self).__str__()
string += "\n" + str(self.get_dict())
return string