API: unique_ids stub on base metadata object

Author: wasade

qiita_db/metadata_template/base_metadata_template.py

@@ -470,6 +470,8 @@ class MetadataTemplate(qdb.base.QiitaObject):
     # forbidden_words not defined for base class. Please redefine for
     # sub-classes.
     _forbidden_words = {}
+    # qiita-unique integer identifier mapping table
+    _id_map_table = None
 
     @classmethod
     def _check_id(cls, id_):
@@ -936,6 +938,21 @@ def _common_extend_steps(self, md_template):
 
         return new_samples, new_cols
 
+    def unique_ids(self):
+        r"""Return a stable mapping of sample_name to integers
+
+        Obtain a map from a sample_name to an integer. The association is
+        unique Qiita-wide and 1-1.
+
+        This method is idempotent.
+
+        Returns
+        ------
+        dict
+            {sample_name: integer_index}
+        """
+        raise IncompetentQiitaDeveloperError()
+
     @classmethod
     def exists(cls, obj_id):
         r"""Checks if already exists a MetadataTemplate for the provided object

qiita_db/metadata_template/test/test_base_metadata_template.py

@@ -41,7 +41,14 @@ def test_init(self):
         with self.assertRaises(IncompetentQiitaDeveloperError):
             MT(1)
 
-    def test_exist(self):
+    def test_unique_ids(self):
+        """Unique IDs raises an error because it's not called from a subclass
+        """
+        MT = qdb.metadata_template.base_metadata_template.MetadataTemplate
+        with self.assertRaises(IncompetentQiitaDeveloperError):
+            MT.unique_ids(self.study)
+
+    def test_exists(self):
         """Exists raises an error because it's not called from a subclass"""
         MT = qdb.metadata_template.base_metadata_template.MetadataTemplate
         with self.assertRaises(IncompetentQiitaDeveloperError):