Study.from_title (#3161)

Author: antgonza

qiita_db/study.py

@@ -87,6 +87,39 @@ def _lock_non_sandbox(self):
             raise qdb.exceptions.QiitaDBStatusError(
                 "Illegal operation on non-sandbox study!")
 
+    @classmethod
+    def from_title(cls, title):
+        """Instantiate Study from title
+
+        Parameters
+        ----------
+        title : str
+            Tht title to search for
+
+        Returns
+        -------
+        Study
+            The study with the given title
+
+        Raises
+        ------
+        QiitaDBUnknownIDError
+            If the title doesn't exist
+        """
+        with qdb.sql_connection.TRN:
+            sql = """SELECT study_id
+                     FROM qiita.{}
+                     WHERE study_title = %s""".format(cls._table)
+
+            qdb.sql_connection.TRN.add(sql, [title])
+            sid = qdb.sql_connection.TRN.execute_fetchflatten()
+
+        if not sid:
+            raise qdb.exceptions.QiitaDBUnknownIDError(
+                cls._table, f'"{title}" does not exist')
+
+        return qdb.study.Study(sid[0])
+
     @classmethod
     def iter(cls):
         """Iterate over all studies in the database

qiita_db/test/test_study.py

@@ -207,6 +207,14 @@ def _change_processed_data_status(self, new_status):
         qdb.sql_connection.perform_as_transaction(
             "UPDATE qiita.artifact SET visibility_id = %s", (id_status,))
 
+    def test_from_title(self):
+        study = qdb.study.Study.from_title(
+            'Identification of the Microbiomes for Cannabis Soils')
+        self.assertEqual(study, qdb.study.Study(1))
+
+        with self.assertRaises(qdb.exceptions.QiitaDBUnknownIDError):
+            qdb.study.Study.from_title('Study title')
+
     def test_get_info(self):
         # Test get all info for single study
         qiita_config.portal = 'QIITA'