Place MediaType in a dedicated file

Author: paulnoirel

examples/basics/projects.ipynb

@@ -2,15 +2,16 @@
     "cells": [
         {
             "cell_type": "markdown",
+            "metadata": {},
             "source": [
                 "<td>\n",
                 "   <a target=\"_blank\" href=\"https://labelbox.com\" ><img src=\"https://labelbox.com/blog/content/images/2021/02/logo-v4.svg\" width=256/></a>\n",
                 "</td>"
-            ],
-            "metadata": {}
+            ]
         },
         {
             "cell_type": "markdown",
+            "metadata": {},
             "source": [
                 "<td>\n",
                 "<a href=\"https://colab.research.google.com/github/Labelbox/labelbox-python/blob/develop/examples/basics/projects.ipynb\" target=\"_blank\"><img\n",
@@ -21,18 +22,18 @@
                 "<a href=\"https://github.com/Labelbox/labelbox-python/tree/develop/examples/basics/projects.ipynb\" target=\"_blank\"><img\n",
                 "src=\"https://img.shields.io/badge/GitHub-100000?logo=github&logoColor=white\" alt=\"GitHub\"></a>\n",
                 "</td>"
-            ],
-            "metadata": {}
+            ]
         },
         {
             "cell_type": "markdown",
+            "metadata": {},
             "source": [
                 "# Projects"
-            ],
-            "metadata": {}
+            ]
         },
         {
             "cell_type": "markdown",
+            "metadata": {},
             "source": [
                 "* A project can be thought of as a specific labeling task on a set of labels\n",
                 "* That set of labels is defined by the datasets attached to the project\n",
@@ -41,123 +42,129 @@
                 "\n",
                 "** Note that there is a lot of advanced usage that is not covered in this notebook. See project_setup for those functions.\n",
                 "* Also note that deprecated functions are not explained here."
-            ],
-            "metadata": {}
+            ]
         },
         {
             "cell_type": "code",
             "execution_count": 1,
+            "metadata": {},
+            "outputs": [],
             "source": [
                 "!pip install labelbox"
-            ],
-            "outputs": [],
-            "metadata": {}
+            ]
         },
         {
             "cell_type": "code",
             "execution_count": 2,
+            "metadata": {},
+            "outputs": [],
             "source": [
                 "from labelbox import Client\n",
+                "from labelbox.schema.media_type import MediaType\n",
                 "import os"
-            ],
-            "outputs": [],
-            "metadata": {}
+            ]
         },
         {
             "cell_type": "markdown",
+            "metadata": {},
             "source": [
                 "# API Key and Client\n",
                 "Provide a valid api key below in order to properly connect to the Labelbox Client."
-            ],
-            "metadata": {}
+            ]
         },
         {
             "cell_type": "code",
             "execution_count": 5,
+            "metadata": {},
+            "outputs": [],
             "source": [
                 "# Add your api key\n",
                 "API_KEY = None\n",
                 "client = Client(api_key=API_KEY)"
-            ],
-            "outputs": [],
-            "metadata": {}
+            ]
         },
         {
             "cell_type": "markdown",
+            "metadata": {},
             "source": [
                 "### Create\n"
-            ],
-            "metadata": {}
+            ]
         },
         {
             "cell_type": "code",
             "execution_count": 6,
+            "metadata": {},
+            "outputs": [],
             "source": [
-                "# Creates an empty project\n",
+                "# Creates an empty project without a media type\n",
                 "project = client.create_project(name=\"my-test-project\",\n",
-                "                                description=\"a description\")"
-            ],
-            "outputs": [],
-            "metadata": {}
+                "                                description=\"a description\")\n",
+                "\n",
+                "# Creates an empty project a media type\n",
+                "project = client.create_project(name=\"my-test-project\",\n",
+                "                                description=\"a description\",\n",
+                "                                media_type=MediaType.Image)"
+            ]
         },
         {
             "cell_type": "markdown",
+            "metadata": {},
             "source": [
                 "### Read"
-            ],
-            "metadata": {}
+            ]
         },
         {
             "cell_type": "code",
             "execution_count": null,
+            "metadata": {},
+            "outputs": [],
             "source": [
                 "# Note the project is not setup (so a lot of these fiels are empty). Follow the project setup workflow\n",
                 "print(\"Project is not setup yet:\", project.setup_complete is None)\n",
                 "print(\"Project name:\", project.name)\n",
                 "print(\"Project description:\", project.description)\n",
+                "print(\"Media Type:\", project.media_type)\n",
                 "print(\"Dataset:\", list(project.datasets()))\n",
                 "print(\"Ontology:\", project.ontology().normalized)\n",
                 "print(\"Benchmarks:\", project.benchmarks())"
-            ],
-            "outputs": [],
-            "metadata": {}
+            ]
         },
         {
             "cell_type": "markdown",
+            "metadata": {},
             "source": [
                 "### Update\n",
                 "\n"
-            ],
-            "metadata": {}
+            ]
         },
         {
             "cell_type": "code",
             "execution_count": null,
+            "metadata": {},
+            "outputs": [],
             "source": [
                 "# Attach dataset\n",
                 "ds = client.create_dataset(name=\"test-ds\")\n",
                 "project.datasets.connect(ds)\n",
                 "print([ds.name for ds in project.datasets()])\n",
                 "ds.delete()"
-            ],
-            "outputs": [],
-            "metadata": {}
+            ]
         },
         {
             "cell_type": "markdown",
+            "metadata": {},
             "source": [
                 "### Delete"
-            ],
-            "metadata": {}
+            ]
         },
         {
             "cell_type": "code",
             "execution_count": 9,
+            "metadata": {},
+            "outputs": [],
             "source": [
                 "project.delete()"
-            ],
-            "outputs": [],
-            "metadata": {}
+            ]
         }
     ],
     "metadata": {
@@ -181,4 +188,4 @@
     },
     "nbformat": 4,
     "nbformat_minor": 5
-}
+}

labelbox/client.py

@@ -32,6 +32,8 @@
 from labelbox.schema.project import Project
 from labelbox.schema.role import Role
 
+from labelbox.schema.media_type import MediaType
+
 logger = logging.getLogger(__name__)
 
 _LABELBOX_API_KEY = "LABELBOX_API_KEY"
@@ -613,17 +615,12 @@ def create_project(self, **kwargs) -> Project:
         """
         media_type = kwargs.get("media_type")
         if media_type:
-            if isinstance(media_type, Project.MediaType
-                         ) and media_type is not Project.MediaType.Unknown:
+            if MediaType.is_accepted(media_type):
                 kwargs["media_type"] = media_type.value
             else:
-                media_types = [
-                    item for item in Project.MediaType.__members__
-                    if item != "Unknown"
-                ]
-                raise TypeError(
-                    f"{media_type} is not a supported type. Please use any of {media_types} from the {type(media_type).__name__} enumeration."
-                )
+                raise TypeError(f"{media_type} is not a valid media type. Use"
+                                f" any of {MediaType.get_accepted_members()}"
+                                " from MediaType. Example: MediaType.Image.")
 
         return self._create(Entity.Project, kwargs)
 

labelbox/schema/media_type.py

@@ -0,0 +1,46 @@
+from enum import Enum
+
+
+class MediaType(Enum):
+    """add DOCUMENT, GEOSPATIAL_TILE, SIMPLE_TILE to match the UI choices"""
+    Audio = "AUDIO"
+    Conversational = "CONVERSATIONAL"
+    Dicom = "DICOM"
+    Document = "PDF"
+    Geospatial_Tile = "TMS_GEO"
+    Image = "IMAGE"
+    Json = "JSON"
+    Pdf = "PDF"
+    Simple_Tile = "TMS_SIMPLE"
+    Text = "TEXT"
+    Tms_Geo = "TMS_GEO"
+    Tms_Simple = "TMS_SIMPLE"
+    Video = "VIDEO"
+    Unknown = "UNKNOWN"
+    Unsupported = "UNSUPPORTED"
+
+    @classmethod
+    def _missing_(cls, name):
+        """Handle missing null data types for projects 
+            created without setting allowedMediaType
+            Handle upper case names for compatibility with 
+            the GraphQL"""
+
+        if name is None:
+            return cls.Unknown
+
+        for member in cls.__members__:
+            if member.name == name.upper():
+                return member
+
+    @classmethod
+    def is_accepted(cls, value):
+        return isinstance(value,
+                          cls) and value not in [cls.Unknown, cls.Unsupported]
+
+    @classmethod
+    def get_accepted_members(cls):
+        return [
+            item for item in cls.__members__
+            if item not in ["Unknown", "Unsupported"]
+        ]

labelbox/schema/project.py

@@ -19,6 +19,7 @@
 from labelbox.orm.model import Entity, Field, Relationship
 from labelbox.pagination import PaginatedCollection
 from labelbox.schema.resource_tag import ResourceTag
+from labelbox.schema.media_type import MediaType
 
 if TYPE_CHECKING:
     from labelbox import BulkImportRequest
@@ -64,36 +65,6 @@ class Project(DbObject, Updateable, Deletable):
         ontology (Relationship): `ToOne` relationship to Ontology
     """
 
-    class MediaType(Enum):
-        """add DOCUMENT, GEOSPATIAL_TILE, SIMPLE_TILE to match the UI choices"""
-        Audio = "AUDIO"
-        Conversational = "CONVERSATIONAL"
-        Dicom = "DICOM"
-        Document = "PDF"
-        Geospatial_Tile = "TMS_GEO"
-        Image = "IMAGE"
-        Json = "JSON"
-        Pdf = "PDF"
-        Simple_Tile = "TMS_SIMPLE"
-        Text = "TEXT"
-        Tms_Geo = "TMS_GEO"
-        Tms_Simple = "TMS_SIMPLE"
-        Video = "VIDEO"
-        Unknown = "UNKNOWN"
-
-        @classmethod
-        def _missing_(cls, name):
-            """Handle missing null data types for projects 
-            created without setting allowedMediaType"""
-            # return Project.MediaType.UNKNOWN
-
-            if name is None:
-                return cls.Unknown
-
-            for member in cls.__members__:
-                if member.name == name.upper():
-                    return member
-
     name = Field.String("name")
     description = Field.String("description")
     updated_at = Field.DateTime("updated_at")
@@ -129,17 +100,12 @@ def update(self, **kwargs):
 
         media_type = kwargs.get("media_type")
         if media_type:
-            if isinstance(media_type, Project.MediaType
-                         ) and media_type != Project.MediaType.Unknown:
+            if MediaType.is_accepted(media_type):
                 kwargs["media_type"] = media_type.value
             else:
-                media_types = [
-                    item for item in Project.MediaType.__members__
-                    if item != "Unknown"
-                ]
-                raise TypeError(
-                    f"{media_type} is not a supported type. Please use any of {media_types} from the {type(media_type).__name__} enumeration."
-                )
+                raise TypeError(f"{media_type} is not a valid media type. Use"
+                                f" any of {MediaType.get_accepted_members()}"
+                                " from MediaType. Example: MediaType.Image.")
 
         return super().update(**kwargs)
 

tests/integration/test_project.py

@@ -6,6 +6,7 @@
 
 from labelbox import Project, LabelingFrontend
 from labelbox.exceptions import InvalidQueryError
+from labelbox.schema.media_type import MediaType
 
 
 def test_project(client, rand_gen):
@@ -204,22 +205,18 @@ def test_queue_mode(configured_project: Project):
 
 
 def test_media_type(client, configured_project: Project, rand_gen):
-    # Existing project
-    assert configured_project.media_type is None or isinstance(
-        configured_project.media_type, Project.MediaType)
+    # Existing project with no media_type
+    assert isinstance(configured_project.media_type, MediaType)
 
-    # No media_type
+    # Update test
     project = client.create_project(name=rand_gen(str))
-    assert project.media_type == Project.MediaType.Unknown
-    project.update(media_type=Project.MediaType.Image)
-    assert project.media_type == Project.MediaType.Image
+    project.update(media_type=MediaType.Image)
+    assert project.media_type == MediaType.Image
     project.delete()
 
-    for media_type in Project.MediaType:
-        if media_type == Project.MediaType.Unknown:
-            continue
+    for media_type in MediaType.get_accepted_members():
 
         project = client.create_project(name=rand_gen(str),
-                                        media_type=media_type)
-        assert project.media_type == media_type
+                                        media_type=MediaType[media_type])
+        assert project.media_type == MediaType[media_type]
         project.delete()