Merge pull request #218 from Labelbox/ms/datarow-metadata-updates

datarow metadata updates

Author: msokoloff1

CONTRIB.md

@@ -27,15 +27,20 @@ following packages/modules:
 
 ## Testing
 
-Currently the SDK functionality is tested using integration tests. These tests
+Currently, the SDK functionality is tested using integration tests. These tests
 communicate with a Labelbox server (by default the staging server) and are in
-that sense not self-contained. Besides that they are organized like unit test
+that sense not self-contained. Besides, that they are organized like unit test
 and are based on the `pytest` library.
 
 To execute tests you will need to provide an API key for the server you're using
 for testing (staging by default) in the `LABELBOX_TEST_API_KEY` environment
-variable. For more info see [Labelbox API key
-docs](https://labelbox.helpdocs.io/docs/api/getting-started).
+variable. For more info see [Labelbox API key docs](https://labelbox.helpdocs.io/docs/api/getting-started).
+
+To pass tests, code must be formatted using the following command:
+
+```shell
+yapf labelbox -i --verbose --recursive --parallel --style "google"
+```
 
 ## Release Steps
 
@@ -47,10 +52,8 @@ Each release should follow the following steps:
 4. Merge `develop` to `master` (fast-forward only).
 5. Create a GitHub release.
 6. This will kick off a Github Actions workflow that will:
-  - Build the library in the [standard
-  way](https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives)
-  - Upload the distribution archives in the [standard
-  way](https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives)
+  - Build the library in the [standard way](https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives)
+  - Upload the distribution archives in the [standard way](https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives)
   with credentials for the `labelbox` PyPI user.
   - Run the `REPO_ROOT/tools/api_reference_generator.py` script to update
   [HelpDocs documentation](https://labelbox.helpdocs.io/docs/). You will need

labelbox/__init__.py

@@ -14,10 +14,10 @@
 from labelbox.schema.organization import Organization
 from labelbox.schema.task import Task
 from labelbox.schema.labeling_frontend import LabelingFrontend
-from labelbox.schema.asset_metadata import AssetMetadata
 from labelbox.schema.asset_attachment import AssetAttachment
 from labelbox.schema.webhook import Webhook
 from labelbox.schema.ontology import Ontology, OntologyBuilder, Classification, Option, Tool
 from labelbox.schema.role import Role, ProjectRole
 from labelbox.schema.invite import Invite, InviteLimit
+from labelbox.schema.data_row_metadata import DataRowMetadataOntology
 from labelbox.schema.model_run import ModelRun

labelbox/client.py

@@ -1,3 +1,4 @@
+# type: ignore
 from datetime import datetime, timezone
 import json
 import logging
@@ -15,9 +16,11 @@
 from labelbox.pagination import PaginatedCollection
 from labelbox.schema.project import Project
 from labelbox.schema.dataset import Dataset
+from labelbox.schema.data_row import DataRow
 from labelbox.schema.model import Model
 from labelbox.schema.user import User
 from labelbox.schema.organization import Organization
+from labelbox.schema.data_row_metadata import DataRowMetadataOntology
 from labelbox.schema.labeling_frontend import LabelingFrontend
 from labelbox.schema import role
 from labelbox import __version__ as SDK_VERSION
@@ -45,7 +48,6 @@ def __init__(self,
         Logging is defaulted to level WARNING. To receive more verbose
         output to console, update `logging.level` to the appropriate level.
 
-        >>> import logger
         >>> logging.basicConfig(level = logging.INFO)
         >>> client = Client("<APIKEY>")
 
@@ -541,6 +543,24 @@ def get_roles(self):
         """
         return role.get_roles(self)
 
+    def get_data_row(self, data_row_id):
+        """
+
+        Returns:
+            DataRow: returns a single data row given the data row id
+        """
+
+        return self._get_single(DataRow, data_row_id)
+
+    def get_data_row_metadata_ontology(self):
+        """
+
+        Returns:
+            DataRowMetadataOntology: The ontology for Data Row Metadata for an organization
+
+        """
+        return DataRowMetadataOntology(self)
+
     def get_model(self, model_id):
         """ Gets a single Model with the given ID.
 

labelbox/schema/__init__.py

@@ -1,4 +1,3 @@
-import labelbox.schema.asset_metadata
 import labelbox.schema.asset_attachment
 import labelbox.schema.bulk_import_request
 import labelbox.schema.annotation_import
@@ -18,3 +17,4 @@
 import labelbox.schema.task
 import labelbox.schema.user
 import labelbox.schema.webhook
+import labelbox.schema.data_row_metadata

labelbox/schema/asset_metadata.py

@@ -1,4 +1,6 @@
 import logging
+from datetime import datetime
+from typing import List, Dict, Union
 
 from labelbox.orm import query
 from labelbox.orm.db_object import DbObject, Updateable, BulkDeletable
@@ -18,6 +20,7 @@ class DataRow(DbObject, Updateable, BulkDeletable):
         updated_at (datetime)
         created_at (datetime)
         media_attributes (dict): generated media attributes for the datarow
+        metadata (dict): uploaded metadata
 
         dataset (Relationship): `ToOne` relationship to Dataset
         created_by (Relationship): `ToOne` relationship to User
@@ -37,21 +40,45 @@ class DataRow(DbObject, Updateable, BulkDeletable):
     created_by = Relationship.ToOne("User", False, "created_by")
     organization = Relationship.ToOne("Organization", False)
     labels = Relationship.ToMany("Label", True)
-
-    metadata = Relationship.ToMany(
-        "AssetMetadata",
-        False,
-        "metadata",
-        deprecation_warning=
-        "`DataRow.metadata()` is deprecated. Use `DataRow.attachments()` instead."
-    )
     attachments = Relationship.ToMany("AssetAttachment", False, "attachments")
 
     supported_meta_types = supported_attachment_types = {
         attachment_type.value
         for attachment_type in AssetAttachment.AttachmentType
     }
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.attachments.supports_filtering = False
+        self.attachments.supports_sorting = False
+
+    @property
+    def metadata(self) -> Dict[str, Union[str, List[Dict]]]:
+        """Get metadata for datarow
+        """
+
+        query = """query GetDataRowMetadataBetaPyApi($dataRowID: ID!) {
+              dataRow(where: {id: $dataRowID}) {
+                customMetadata {
+                    value
+                    schemaId
+                }
+              }
+            }
+        """
+
+        metadata = self.client.execute(
+            query, {"dataRowID": self.uid})["dataRow"]["customMetadata"]
+
+        return {
+            "data_row_id":
+                self.uid,
+            "fields": [{
+                "schema_id": m["schemaId"],
+                "value": m["value"]
+            } for m in metadata]
+        }
+
     @staticmethod
     def bulk_delete(data_rows):
         """ Deletes all the given DataRows.
@@ -61,13 +88,6 @@ def bulk_delete(data_rows):
         """
         BulkDeletable._bulk_delete(data_rows, True)
 
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.metadata.supports_filtering = False
-        self.metadata.supports_sorting = False
-        self.attachments.supports_filtering = False
-        self.attachments.supports_sorting = False
-
     def create_attachment(self, attachment_type, attachment_value):
         """ Adds an AssetAttachment to a DataRow.
             Labelers can view these attachments while labeling.
@@ -108,21 +128,3 @@ def create_attachment(self, attachment_type, attachment_value):
             })
         return Entity.AssetAttachment(self.client,
                                       res["createDataRowAttachment"])
-
-    def create_metadata(self, meta_type, meta_value):
-        """
-
-        This function is deprecated. Use create_attachment instead
-
-        Returns:
-            AssetMetadata
-        """
-        logger.warning(
-            "`create_metadata` is deprecated. Use `create_attachment` instead.")
-        attachment = self.create_attachment(meta_type, meta_value)
-        return Entity.AssetMetadata(
-            self.client, {
-                'id': attachment.uid,
-                'metaType': attachment.attachment_type,
-                'metaValue': attachment.attachment_value
-            })