simpa icon indicating copy to clipboard operation
simpa copied to clipboard

Consistent Tags

Open kdreher opened this issue 3 years ago • 2 comments

Make sure that all tags are consistent according to their definition:

Every Tag that is intended to be used as a key in the settings dictionary is represented by a tuple. The first element of the tuple is a string that corresponds to the name of the Tag. The second element of the tuple is a data type or a tuple of data types. The values that are assigned to the keys in the settings should match these data types. Their usage within the SIMPA package is divided in "SIMPA package", "module X", "adapter Y", "class Z". If a Tag is not intended to be used as a keys in the settings, then the usage should be "naming convention".

kdreher avatar Aug 16 '22 17:08 kdreher

note:

if you convert a tag that was previously a string "name" into a tuple ("name", (datatype1, datatype2, ...)), everywhere in the code where the tag was previously used as a string (for example as a key from a dictionary), the tag must be converted back as a string. otherwise you can get errors (for example KeyErrors in the mentioned example)

cbender98 avatar Aug 16 '22 17:08 cbender98

We should also clean up the tags and add an __eq__ function

kdreher avatar Jun 17 '24 14:06 kdreher