Start showing CLI deprecation warnings (e.g. “warning: after [date] you will no longer be able to use x.”)

Author: jtsodapop

labelbox/schema/data_row_metadata.py

@@ -32,6 +32,10 @@ class DataRowMetadataSchema(BaseModel):
 
     @property
     def id(self):
+        """
+        "DataRowMetadataSchema.id is being deprecated after version 3.9 
+            in favor of DataRowMetadataSchema.uid"
+        """
         warnings.warn("`id` is being deprecated in favor of `uid`")
         return self.uid
 
@@ -43,7 +47,6 @@ def id(self):
 
 
 class _CamelCaseMixin(BaseModel):
-
     class Config:
         allow_population_by_field_name = True
         alias_generator = camel_case
@@ -109,7 +112,6 @@ class DataRowMetadataOntology:
     >>> mdo = client.get_data_row_metadata_ontology()
 
     """
-
     def __init__(self, client):
 
         self._client = client
@@ -129,8 +131,8 @@ def _build_ontology(self):
         ]
         self.reserved_by_id = self._make_id_index(self.reserved_fields)
         self.reserved_by_name: Dict[
-            str,
-            DataRowMetadataSchema] = self._make_name_index(self.reserved_fields)
+            str, DataRowMetadataSchema] = self._make_name_index(
+                self.reserved_fields)
 
         # custom fields
         self.custom_fields: List[DataRowMetadataSchema] = [
@@ -206,9 +208,8 @@ def _parse_ontology(raw_ontology) -> List[DataRowMetadataSchema]:
         return fields
 
     def parse_metadata(
-        self, unparsed: List[Dict[str,
-                                  List[Union[str,
-                                             Dict]]]]) -> List[DataRowMetadata]:
+        self, unparsed: List[Dict[str, List[Union[str, Dict]]]]
+    ) -> List[DataRowMetadata]:
         """ Parse metadata responses
 
         >>> mdo.parse_metadata([metdata])
@@ -301,8 +302,8 @@ def _batch_upsert(
                     data_row_id=m.data_row_id,
                     fields=list(
                         chain.from_iterable(
-                            self._parse_upsert(m) for m in m.fields))).dict(
-                                by_alias=True))
+                            self._parse_upsert(m)
+                            for m in m.fields))).dict(by_alias=True))
 
         res = _batch_operations(_batch_upsert, items, self._batch_size)
         return res
@@ -468,11 +469,12 @@ def _batch_operations(
 
 
 def _validate_parse_embedding(
-        field: DataRowMetadataField
+    field: DataRowMetadataField
 ) -> List[Dict[str, Union[SchemaId, Embedding]]]:
 
     if isinstance(field.value, list):
-        if not (Embedding.min_items <= len(field.value) <= Embedding.max_items):
+        if not (Embedding.min_items <= len(field.value) <=
+                Embedding.max_items):
             raise ValueError(
                 "Embedding length invalid. "
                 "Must have length within the interval "

labelbox/schema/model_run.py

@@ -123,8 +123,8 @@ def add_predictions(
                 return MEAPredictionImport.create_from_file(
                     path=str(predictions), **kwargs)
             else:
-                return MEAPredictionImport.create_from_url(url=str(predictions),
-                                                           **kwargs)
+                return MEAPredictionImport.create_from_url(
+                    url=str(predictions), **kwargs)
         elif isinstance(predictions, Iterable):
             return MEAPredictionImport.create_from_objects(
                 predictions=predictions, **kwargs)
@@ -145,6 +145,10 @@ def model_run_data_rows(self):
             ['annotationGroups', 'pageInfo', 'endCursor'])
 
     def annotation_groups(self):
+        """
+        "ModelRun.annotation_groups is being deprecated after version 3.9 
+            in favor of ModelRun.model_run_data_rows"
+        """
         warnings.warn(
             "`ModelRun.annotation_groups` is being deprecated in favor of `ModelRun.model_run_data_rows`"
         )
@@ -181,6 +185,10 @@ def delete_model_run_data_rows(self, data_row_ids):
         })
 
     def delete_annotation_groups(self, data_row_ids):
+        """
+        "ModelRun.delete_annotation_groups is being deprecated after version 3.9 
+            in favor of ModelRun.delete_model_run_data_rows"
+        """
         warnings.warn(
             "`ModelRun.delete_annotation_groups` is being deprecated in favor of `ModelRun.delete_model_run_data_rows`"
         )