Merge pull request #465 from Labelbox/jt/dropdowndoc

[AL-1688] Dropdown Deprecation Changelog Update

Author: jtsodapop

CHANGELOG.md

@@ -1,3 +1,12 @@
+# Changelog
+# Version X.XX.X (2022-03-XX)
+## Updated
+* Deprecation: Creating Dropdowns will no longer be supported after 2022-03-31
+    - This includes creating/adding Dropdowns to an ontology
+    - This includes creating/adding Dropdown Annotation Type
+    - For the same functionality, use Radio 
+    - This will not affect existing Dropdowns
+
 # Changelog
 # Version 3.15.0 (2022-02-28) 
 ## Added 

labelbox/data/annotation_types/classification/classification.py

@@ -1,4 +1,5 @@
 from typing import Any, Dict, List, Union, Optional
+import warnings
 
 try:
     from typing import Literal
@@ -72,6 +73,15 @@ class Dropdown(_TempName):
     """
     - A classification with many selected options allowed .
     - This is not currently compatible with MAL.
+
+    Deprecation Notice: Dropdown classification is deprecated and will be
+        removed in a future release. Dropdown will also
+        no longer be able to be created in the Editor on 3/31/2022.    
     """
     name: Literal["dropdown"] = "dropdown"
     answer: List[ClassificationAnswer]
+
+    def __init__(self, **data: Any):
+        warnings.warn("Dropdown classification is deprecated and will be "
+                      "removed in a future release")
+        super().__init__(**data)

labelbox/schema/ontology.py

@@ -4,6 +4,7 @@
 from dataclasses import dataclass, field
 from enum import Enum
 from typing import Any, Dict, List, Optional, Union, Type
+import warnings
 
 from pydantic import constr
 
@@ -82,6 +83,11 @@ def add_option(self, option: 'Classification') -> None:
 @dataclass
 class Classification:
     """
+
+    Deprecation Notice: Dropdown classification is deprecated and will be
+        removed in a future release. Dropdown will also
+        no longer be able to be created in the Editor on 3/31/2022.
+            
     A classfication to be added to a Project's ontology. The
     classification is dependent on the Classification Type.
 
@@ -127,6 +133,13 @@ class Type(Enum):
     schema_id: Optional[str] = None
     feature_schema_id: Optional[str] = None
 
+    def __post_init__(self):
+        if self.class_type == Classification.Type.DROPDOWN:
+            warnings.warn(
+                "Dropdown classification is deprecated and will be "
+                "removed in a future release. Dropdown will also "
+                "no longer be able to be created in the Editor on 3/31/2022.")
+
     @property
     def name(self) -> str:
         return self.instructions