Consolidate unique keys of objects to use UUID

bp / resqpy

Python API for working with RESQML models

https://resqpy.readthedocs.io/en/latest/

MIT License

52 stars 13 forks source link

Consolidate unique keys of objects to use UUID #17

Closed connortann closed 3 years ago

connortann commented 3 years ago

An idea for a refactoring

Objects have a few different unique keys that are used throughout the code:

UUID
Part name (name of .xml file when unzipped)
XML node

Would be good to standardise on using UUID

andy-beer commented 3 years ago

The main change here is for resqpy classes to accept uuid as the primary key when instantiating from existing RESQML objects (ie. from xml). Use of the xml root node arg then triggers a deprecated warning. For backward compatibility, it is preferable for the new uuid arg to come after the existing root_node (or equivalent) arg.