"""Define the OptionsDictionary class."""
import contextlib
from openmdao.utils.om_warnings import warn_deprecation
from openmdao.utils.notebook_utils import notebook
from openmdao.visualization.tables.table_builder import generate_table
from openmdao.core.constants import _UNDEFINED
#
# Template for `check_valid` function
#
[docs]def check_valid(name, value):
"""
Check the validity of value for the option with name.
Parameters
----------
name : str
Name of the option.
value : any
Value for the option.
Raises
------
ValueError
If value is not valid for option.
"""
raise ValueError(f"Option '{name}' with value {value} is not valid.")
[docs]class OptionsDictionary(object):
"""
Dictionary with pre-declaration of keys for value-checking and default values.
This class is instantiated for:
1. the options attribute in solvers, drivers, and processor allocators
2. the supports attribute in drivers
3. the options attribute in systems
Parameters
----------
parent_name : str
Name or class name of System that owns this OptionsDictionary.
read_only : bool
If True, setting (via __setitem__ or update) is not permitted.
Attributes
----------
_dict : dict of dict
Dictionary of entries. Each entry is a dictionary consisting of value, values,
types, desc, lower, and upper.
_parent_name : str or None
If defined, prepend this name to beginning of all exceptions.
_read_only : bool
If True, no options can be set after declaration.
_all_recordable : bool
Flag to determine if all options in UserOptions are recordable.
_context_cache : dict
A dictionary to store cached option/value pairs when using the
OptionsDictionary as a context manager.
"""
[docs] def __init__(self, parent_name=None, read_only=False):
"""
Initialize all attributes.
"""
self._dict = {}
self._parent_name = parent_name
self._read_only = read_only
self._all_recordable = True
self._context_cache = {}
def __getstate__(self):
"""
Return state as a dict.
Returns
-------
dict
State to get.
"""
if self._all_recordable:
return self.__dict__
else:
state = self.__dict__.copy()
state['_dict'] = {key: val for key, val in state['_dict'].items() if val['recordable']}
return state
def __repr__(self):
"""
Return a dictionary representation of the options.
Returns
-------
dict
The options dictionary.
"""
return self._dict.__repr__()
def _repr_pretty_(self, p, cycle):
if not cycle and notebook:
try:
from openmdao.visualization.options_widget import OptionsWidget
return OptionsWidget(self)
except Exception:
pass
return repr(self)
def __rst__(self):
"""
Generate reStructuredText view of the options table.
Returns
-------
str
A rendition of the options as an rST table.
"""
return self.to_table(fmt='rst', display=False)
[docs] def to_table(self, fmt='github', missingval='N/A', max_width=None, display=True):
"""
Get a table representation of this OptionsDictionary as a table in the requested format.
Parameters
----------
fmt : str
The formatting of the requested table. Options are
['github', 'rst', 'text', 'html', 'tabulator'] and several 'grid' and 'outline'
formats that mimic those found in the python 'tabulate' library.
Default value of 'github' produces a table in GitHub-flavored markdown.
'html' and 'tabulator' produce output viewable in a browser.
missingval : str
The value to be displayed in place of None.
max_width : int or None
If not None, try to limit the total width of the table to this value.
display : bool
If True, display the table, typically by writing it to stdout or opening a
browser.
Returns
-------
str
A string representation of the table in the requested format.
"""
hdrs = ['Option', 'Default', 'Acceptable Values', 'Acceptable Types', 'Description']
rows = []
deprecations = False
for meta in self._dict.values():
if meta['deprecation'] is not None:
deprecations = True
hdrs.append('Deprecation')
break
for key in sorted(self._dict.keys()):
option = self._dict[key]
default = option['val'] if option['val'] is not _UNDEFINED else '**Required**'
default_str = str(default)
# if the default is an object instance, replace with the (unqualified) object type
idx = default_str.find(' object at ')
if idx >= 0 and default_str[0] == '<':
parts = default_str[:idx].split('.')
default = parts[-1]
acceptable_values = option['values']
if acceptable_values is not None:
if not isinstance(acceptable_values, (set, tuple, list)):
acceptable_values = (acceptable_values,)
acceptable_values = [value for value in acceptable_values]
acceptable_types = option['types']
if acceptable_types is not None:
if not isinstance(acceptable_types, (set, tuple, list)):
acceptable_types = (acceptable_types,)
acceptable_types = [type_.__name__ for type_ in acceptable_types]
desc = option['desc']
deprecation = option['deprecation']
if deprecation is not None:
deprecation = deprecation[0]
if deprecations:
rows.append([key, default, acceptable_values, acceptable_types, desc,
deprecation])
else:
rows.append([key, default, acceptable_values, acceptable_types, desc])
kwargs = {
'tablefmt': fmt,
'headers': hdrs,
'missing_val': missingval,
'max_width': max_width,
}
if fmt == 'tabulator':
kwargs['filter'] = False
kwargs['sort'] = False
tab = generate_table(rows, **kwargs)
if display:
tab.display()
return str(tab)
def __str__(self, width=100):
"""
Generate text string representation of the options table.
Parameters
----------
width : int
The maximum allowed width of the text.
Returns
-------
str
A text representation of the options table.
"""
return self.to_table(fmt='rst', max_width=width, display=False)
def _raise(self, msg, exc_type=RuntimeError):
"""
Raise the given exception type, with parent's name prepended to the message.
Parameters
----------
msg : str
The error message.
exc_type : class
The type of the exception to be raised.
"""
if self._parent_name is None:
full_msg = msg
else:
full_msg = '{}: {}'.format(self._parent_name, msg)
raise exc_type(full_msg)
def _assert_valid(self, name, value):
"""
Check whether the given value is valid, where the key has already been declared.
The optional checks consist of ensuring: the value is one of a list of acceptable values,
the type of value is one of a list of acceptable types, value is not less than lower,
value is not greater than upper, and value satisfies check_valid.
Parameters
----------
name : str
The key for the declared option.
value : object
The default or user-set value to check for value, type, lower, and upper.
"""
meta = self._dict[name]
values = meta['values']
types = meta['types']
lower = meta['lower']
upper = meta['upper']
if not (value is None and meta['allow_none']):
# If only values is declared
if values is not None:
check_vals = [value] if types is not list else value
for val in check_vals:
if val not in values:
if isinstance(value, str):
value = f"'{value}'"
self._raise(f"Value ({value}) of option '{name}' is not one of {values}.",
ValueError)
# If only types is declared
elif types is not None:
if not isinstance(value, types):
vtype = type(value).__name__
if isinstance(value, str):
value = "'{}'".format(value)
if isinstance(types, (set, tuple, list)):
typs = tuple([type_.__name__ for type_ in types])
self._raise("Value ({}) of option '{}' has type '{}', but one of "
"types {} was expected.".format(value, name, vtype, typs),
exc_type=TypeError)
else:
self._raise("Value ({}) of option '{}' has type '{}', but type '{}' "
"was expected.".format(value, name, vtype, types.__name__),
exc_type=TypeError)
if upper is not None:
if value > upper:
self._raise("Value ({}) of option '{}' "
"exceeds maximum allowed value of {}.".format(value, name, upper),
exc_type=ValueError)
if lower is not None:
if value < lower:
self._raise("Value ({}) of option '{}' "
"is less than minimum allowed value of {}.".format(value, name,
lower),
exc_type=ValueError)
# General function test
if meta['check_valid'] is not None:
meta['check_valid'](name, value)
[docs] def set(self, **kwargs):
"""
Set one or more options in the options dictionary simultaneously.
Parameters
----------
**kwargs
Keyword arguments where the option names in the OptionsDictionary are the keywords
and the associated values are the values for those options.
"""
for option, val in kwargs.items():
self[option] = val
[docs] @contextlib.contextmanager
def temporary(self, **kwargs):
"""
Provide a context manager for temporary option values within the context.
Parameters
----------
**kwargs
Keyword arguments where the option names in the OptionsDictionary are the keywords
and the associated values are the temporary values for those options.
"""
for option, val in kwargs.items():
if option not in self._context_cache:
self._context_cache[option] = []
self._context_cache[option].append(self[option])
self[option] = val
yield
for option in kwargs:
self[option] = self._context_cache[option].pop()
if len(self._context_cache[option]) == 0:
self._context_cache.pop(option)
[docs] def declare(self, name, default=_UNDEFINED, values=None, types=None, desc='',
upper=None, lower=None, check_valid=None, allow_none=False, recordable=True,
set_function=None, deprecation=None):
r"""
Declare an option.
The value of the option must satisfy the following:
1. If values only was given when declaring, value must be in values.
2. If types only was given when declaring, value must satisfy isinstance(value, types).
3. It is an error if both values and types are given.
Parameters
----------
name : str
Name of the option.
default : object or Null
Optional default value that must be valid under the above 3 conditions.
values : set or list or tuple or None
Optional list of acceptable option values.
types : type or tuple of types or None
Optional type or list of acceptable option types.
desc : str
Optional description of the option.
upper : float or None
Maximum allowable value.
lower : float or None
Minimum allowable value.
check_valid : function or None
User-supplied function with arguments (name, value) that raises an exception
if the value is not valid.
allow_none : bool
If True, allow None as a value regardless of values or types.
recordable : bool
If True, add to recorder.
set_function : None or function
User-supplied function with arguments (Options metadata, value) that pre-processes
value and returns a new value.
deprecation : str or tuple or None
If None, it is not deprecated. If a str, use as a DeprecationWarning
during __setitem__ and __getitem__. If a tuple of the form (msg, new_name),
display msg as with str, and forward any __setitem__/__getitem__ to new_name.
"""
if values is not None and not isinstance(values, (set, list, tuple)):
self._raise(f"In declaration of option '{name}', the 'values' arg must be of type None,"
f" list, or tuple - not {values}.", exc_type=TypeError)
if types is not None and not isinstance(types, (type, set, list, tuple)):
self._raise(f"In declaration of option '{name}', the 'types' arg must be None, a type "
f"or a tuple - not {types}.", exc_type=TypeError)
if types is not None and types is not list and values is not None:
self._raise(f"'types' and 'values' were both specified for option '{name}'.")
if types is bool:
values = (True, False)
if not recordable:
self._all_recordable = False
default_provided = default is not _UNDEFINED
if default_provided and default is None:
# specifying default=None implies allow_none
allow_none = True
alias = None
if deprecation is not None:
if isinstance(deprecation, (list, tuple)):
if len(deprecation) != 2:
self._raise("deprecation must be None, str, or a tuple or list containing "
"(str, str).", RuntimeError)
dep, alias = deprecation
# [message, alias, display warning (becomes False after first display)]
deprecation = [dep, alias, True]
else:
deprecation = [deprecation, None, True]
self._dict[name] = {
'val': default,
'values': values,
'types': types,
'desc': desc,
'upper': upper,
'lower': lower,
'check_valid': check_valid,
'has_been_set': default_provided,
'allow_none': allow_none,
'recordable': recordable,
'set_function': set_function,
'deprecation': deprecation,
}
# If a default is given, check for validity
if default_provided:
self._assert_valid(name, default)
[docs] def undeclare(self, name):
"""
Remove entry from the OptionsDictionary, for classes that don't use that option.
Parameters
----------
name : str
The name of a key, the entry of which will be removed from the internal dictionary.
"""
if name in self._dict:
del self._dict[name]
[docs] def update(self, in_dict):
"""
Update the internal dictionary with the given one.
Parameters
----------
in_dict : dict
The incoming dictionary to add to the internal one.
"""
for name in in_dict:
self[name] = in_dict[name]
[docs] def __iter__(self):
"""
Provide an iterator.
Returns
-------
iterable
iterator over the keys in the dictionary.
"""
return iter(self._dict)
[docs] def __contains__(self, key):
"""
Check if the key is in the local dictionary.
Parameters
----------
key : str
name of the option.
Returns
-------
bool
whether key is in the local dict.
"""
return key in self._dict
[docs] def __setitem__(self, name, value):
"""
Set an option in the local dictionary.
Parameters
----------
name : str
name of the option.
value : -
value of the option to be value- and type-checked if declared.
"""
try:
meta = self._dict[name]
except KeyError:
# The key must not have been declared.
self._raise(f"Option '{name}' cannot be set because it has not been declared.",
exc_type=KeyError)
if self._read_only:
self._raise(f"Tried to set read-only option '{name}'.", exc_type=KeyError)
if meta['deprecation'] is not None:
name, meta = self._handle_deprecation(name, meta)
self._assert_valid(name, value)
# General function test
if meta['set_function'] is not None:
value = meta['set_function'](meta, value)
meta['val'] = value
meta['has_been_set'] = True
[docs] def __getitem__(self, name):
"""
Get an option from the dict or declared default.
Parameters
----------
name : str
name of the option.
Returns
-------
value : -
value of the option.
"""
# If the option has been set in this system, return the set value
try:
meta = self._dict[name]
except KeyError:
self._raise(f"Option '{name}' has not been declared.", exc_type=KeyError)
if meta['deprecation'] is not None:
name, meta = self._handle_deprecation(name, meta)
if meta['has_been_set']:
return meta['val']
else:
self._raise(f"Option '{name}' is required but has not been set.")
[docs] def items(self, recordable_only=False):
"""
Yield name and value of options.
Parameters
----------
recordable_only : bool
If True, return only recordable options.
Yields
------
key : str
Name of option.
value : int or bool or float or string
Value of the option.
"""
for key, val in self._dict.items():
if not recordable_only or val['recordable']:
try:
yield key, val['val']
except KeyError:
yield key, val['value']
def _handle_deprecation(self, name, meta):
"""
Update the warning counter and do name translation of deprecated variable if needed.
Parameters
----------
name : str
Name of the deprecated variable.
meta : dict
Metadata dictionary corresponding to the deprecated variable.
Returns
-------
str
The variable name, updated to the non-deprecated name if found.
dict
Metadata dictionary corresponding to either the original variable or to the
non-deprecated varsion if found.
"""
msg, alias, show_warn = meta['deprecation']
if show_warn:
warn_deprecation(msg)
meta['deprecation'][2] = False # turn off future warnings for this variable
if alias:
try:
meta = self._dict[alias]
except KeyError:
msg = f"Can't find aliased option '{alias}' for deprecated option '{name}'."
self._raise(msg, exc_type=KeyError)
name = alias
return name, meta
