Merge pull request #804 from Labelbox/AL-4435-improve-metadata-get-by-name-method

add get_by_name method to metadata ontology

Author: apollonin

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+# Version 3.34.0 (...)
+### Added
+* Added `get_by_name()` method to MetadataOntology object to access both custom and reserved metadata by name.
+
 # Version 3.33.1 (2022-12-14)
 ### Fixed
 * Fixed where batch creation limit was still limiting # of data rows. SDK should now support creating batches with up to 100k data rows

labelbox/schema/data_row_metadata.py

@@ -147,6 +147,31 @@ def _build_ontology(self):
             str, DataRowMetadataSchema] = self._make_normalized_name_index(
                 self.custom_fields)
 
+    def get_by_name(
+        self, name: str
+    ) -> Union[DataRowMetadataSchema, Dict[str, DataRowMetadataSchema]]:
+        """ Get metadata by name
+
+        >>> mdo.get_by_name(name)
+
+        Args:
+            name (str): Name of metadata schema
+
+        Returns:
+            Metadata schema as `DataRowMetadataSchema` or dict, in case of Enum metadata
+
+        Raises:
+            KeyError: When provided name is not presented in neither reserved nor custom metadata list
+        """
+
+        # search through reserved names first
+        if name in self.reserved_by_name:
+            return self.reserved_by_name[name]
+        elif name in self.custom_by_name:
+            return self.custom_by_name[name]
+        else:
+            raise KeyError(f"There is no metadata with name {name}")
+
     @staticmethod
     def _make_name_index(
         fields: List[DataRowMetadataSchema]
@@ -224,7 +249,7 @@ def _parse_ontology(raw_ontology) -> List[DataRowMetadataSchema]:
         return fields
 
     def refresh_ontology(self):
-        """ Update the `DataRowMetadataOntology` instance with the latest 
+        """ Update the `DataRowMetadataOntology` instance with the latest
             metadata ontology schemas
         """
         self._raw_ontology = self._get_ontology()
@@ -279,7 +304,7 @@ def update_schema(self, name: str, new_name: str) -> DataRowMetadataSchema:
 
         Returns:
             Updated metadata schema as `DataRowMetadataSchema`
-        
+
         Raises:
             KeyError: When provided name is not a valid custom metadata
         """