pyyeti.cla.DR_Def.amend

DR_Def.amend(*, name, overwrite_drms=False, **kwargs)[source]

Amend a category

Parameters:

  • name (string) – Name of category to amend, eg: ‘SC_atm’. Must already exist (if it doesn’t, just use add() to create it as desired).

  • overwrite_drms (bool; optional) – Allow replacement of original drms and nondrms. This can be dangerous, since multiplie categories can use the same drms and nondrms; use with caution.

  • **kwargs (dict; optional) – Any inputs to add() that are to be amended. Any unrecognized entries are quietly ignored.

Returns:

None

Notes

This routine collects all original settings for category name, replaces any of them by whatever is specified in **kwargs, and calls add() to add the category to a temporary DR_Def instance. If there are no errors, the old category is replaced with the new one. Original data recovery order is maintained in case that is important.