supervisely 6.73.227__py3-none-any.whl → 6.73.228__py3-none-any.whl

supervisely/__init__.py

@@ -309,4 +309,4 @@ except Exception as e:
 # If new changes in Supervisely Python SDK require upgrade of the Supervisely instance
 # set a new value for the environment variable MINIMUM_INSTANCE_VERSION_FOR_SDK, otherwise
 # users can face compatibility issues, if the instance version is lower than the SDK version.
-os.environ["MINIMUM_INSTANCE_VERSION_FOR_SDK"] = "6.11.16"
+os.environ["MINIMUM_INSTANCE_VERSION_FOR_SDK"] = "6.12.5"

supervisely/_utils.py

@@ -14,7 +14,7 @@ import urllib
 from datetime import datetime
 from functools import wraps
 from tempfile import gettempdir
-from typing import List, Literal, Optional
+from typing import Any, Dict, List, Literal, Optional, Tuple
 
 import numpy as np
 from requests.utils import DEFAULT_CA_BUNDLE_PATH
@@ -316,6 +316,15 @@ def get_readable_datetime(value: str) -> str:
     return dt.strftime("%Y-%m-%d %H:%M:%S")
 
 
+def get_unix_timestamp() -> int:
+    """Return the current Unix timestamp.
+
+    :return: Current Unix timestamp.
+    :rtype: int
+    """
+    return int(time.time())
+
+
 def get_certificates_list(path: str = DEFAULT_CA_BUNDLE_PATH) -> List[str]:
     with open(path, "r", encoding="ascii") as f:
         content = f.read().strip()
@@ -385,6 +394,51 @@ def add_callback(func, callback):
     return wrapper
 
 
+def compare_dicts(
+    template: Dict[Any, Any], data: Dict[Any, Any], strict: bool = True
+) -> Tuple[List[str], List[str]]:
+    """Compare two dictionaries recursively (by keys only) and return lists of missing and extra fields.
+    If strict is True, the keys of the template and data dictionaries must match exactly.
+    Otherwise, the data dictionary may contain additional keys that are not in the template dictionary.
+
+    :param template: The template dictionary.
+    :type template: Dict[Any, Any]
+    :param data: The data dictionary.
+    :type data: Dict[Any, Any]
+    :param strict: If True, the keys of the template and data dictionaries must match exactly.
+    :type strict: bool, optional
+    :return: A tuple containing a list of missing fields and a list of extra fields.
+    :rtype: Tuple[List[str], List[str]]
+    """
+    missing_fields = []
+    extra_fields = []
+
+    if not isinstance(template, dict) or not isinstance(data, dict):
+        return missing_fields, extra_fields
+
+    if strict:
+        template_keys = set(template.keys())
+        data_keys = set(data.keys())
+
+        missing_fields = list(template_keys - data_keys)
+        extra_fields = list(data_keys - template_keys)
+
+        for key in template_keys & data_keys:
+            sub_missing, sub_extra = compare_dicts(template[key], data[key], strict)
+            missing_fields.extend([f"{key}.{m}" for m in sub_missing])
+            extra_fields.extend([f"{key}.{e}" for e in sub_extra])
+    else:
+        for key in template:
+            if key not in data:
+                missing_fields.append(key)
+            else:
+                sub_missing, sub_extra = compare_dicts(template[key], data[key], strict)
+                missing_fields.extend([f"{key}.{m}" for m in sub_missing])
+                extra_fields.extend([f"{key}.{e}" for e in sub_extra])
+
+    return missing_fields, extra_fields
+
+
 def get_or_create_event_loop() -> asyncio.AbstractEventLoop:
     """
     Get the current event loop or create a new one if it doesn't exist.

supervisely/api/dataset_api.py

@@ -4,7 +4,17 @@
 # docs
 from __future__ import annotations
 
-from typing import Dict, Generator, List, Literal, NamedTuple, Optional, Tuple, Union
+from typing import (
+    Any,
+    Dict,
+    Generator,
+    List,
+    Literal,
+    NamedTuple,
+    Optional,
+    Tuple,
+    Union,
+)
 
 from supervisely._utils import abs_url, compress_image_url, is_development
 from supervisely.api.module_api import (
@@ -61,6 +71,7 @@ class DatasetInfo(NamedTuple):
     team_id: int
     workspace_id: int
     parent_id: Union[int, None]
+    custom_data: dict
 
     @property
     def image_preview_url(self):
@@ -135,6 +146,7 @@ class DatasetApi(UpdateableModule, RemoveableModuleApi):
             ApiField.TEAM_ID,
             ApiField.WORKSPACE_ID,
             ApiField.PARENT_ID,
+            ApiField.CUSTOM_DATA,
         ]
 
     @staticmethod
@@ -362,6 +374,83 @@ class DatasetApi(UpdateableModule, RemoveableModuleApi):
             )
         return dataset_info
 
+    def update(
+        self,
+        id: int,
+        name: Optional[str] = None,
+        description: Optional[str] = None,
+        custom_data: Optional[Dict[Any, Any]] = None,
+    ) -> DatasetInfo:
+        """Update Dataset information by given ID.
+
+        :param id: Dataset ID in Supervisely.
+        :type id: int
+        :param name: New Dataset name.
+        :type name: str, optional
+        :param description: New Dataset description.
+        :type description: str, optional
+        :param custom_data: New custom data.
+        :type custom_data: Dict[Any, Any], optional
+        :return: Information about Dataset. See :class:`info_sequence<info_sequence>`
+        :rtype: :class:`DatasetInfo`
+
+        :Usage example:
+
+             .. code-block:: python
+
+                import supervisely as sly
+
+                dataset_id = 384126
+
+                os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
+                os.environ['API_TOKEN'] = 'Your Supervisely API Token'
+                api = sly.Api.from_env()
+
+                new_ds = api.dataset.update(dataset_id, name='new_ds', description='new description')
+        """
+        fields = [name, description, custom_data]  # Extend later if needed.
+        if all(f is None for f in fields):
+            raise ValueError(f"At least one of the fields must be specified: {fields}")
+
+        payload = {
+            ApiField.ID: id,
+            ApiField.NAME: name,
+            ApiField.DESCRIPTION: description,
+            ApiField.CUSTOM_DATA: custom_data,
+        }
+
+        payload = {k: v for k, v in payload.items() if v is not None}
+
+        response = self._api.post(self._get_update_method(), payload)
+        return self._convert_json_info(response.json())
+
+    def update_custom_data(self, id: int, custom_data: Dict[Any, Any]) -> DatasetInfo:
+        """Update custom data for Dataset by given ID.
+        Custom data is a dictionary that can store any additional information about the Dataset.
+
+        :param id: Dataset ID in Supervisely.
+        :type id: int
+        :param custom_data: New custom data.
+        :type custom_data: Dict[Any, Any]
+        :return: Information about Dataset. See :class:`info_sequence<info_sequence>`
+        :rtype: :class:`DatasetInfo`
+
+        :Usage example:
+
+         .. code-block:: python
+
+            import supervisely as sly
+
+            dataset_id = 384126
+
+            os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
+            os.environ['API_TOKEN'] = 'Your Supervisely API Token'
+            api = sly.Api.from_env()
+
+            new_ds = api.dataset.update_custom_data(dataset_id, custom_data={'key': 'value'})
+        """
+        return self.update(id, custom_data=custom_data)
+
     def _get_update_method(self):
         """ """
         return "datasets.editInfo"

supervisely/api/image_api.py

@@ -40,6 +40,7 @@ from tqdm import tqdm
 
 from supervisely._utils import (
     batched,
+    compare_dicts,
     generate_free_name,
     get_bytes_hash,
     resize_image_url,
@@ -1135,7 +1136,14 @@ class ImageApi(RemoveableBulkModuleApi):
         )
 
     def upload_path(
-        self, dataset_id: int, name: str, path: str, meta: Optional[Dict] = None
+        self,
+        dataset_id: int,
+        name: str,
+        path: str,
+        meta: Optional[Dict] = None,
+        validate_meta: Optional[bool] = False,
+        use_strict_validation: Optional[bool] = False,
+        use_caching_for_validation: Optional[bool] = False,
     ) -> ImageInfo:
         """
         Uploads Image with given name from given local path to Dataset.
@@ -1148,6 +1156,12 @@ class ImageApi(RemoveableBulkModuleApi):
         :type path: str
         :param meta: Image metadata.
         :type meta: dict, optional
+        :param validate_meta: If True, validates provided meta with saved JSON schema.
+        :type validate_meta: bool, optional
+        :param use_strict_validation: If True, uses strict validation.
+        :type use_strict_validation: bool, optional
+        :param use_caching_for_validation: If True, uses caching for validation.
+        :type use_caching_for_validation: bool, optional
         :return: Information about Image. See :class:`info_sequence<info_sequence>`
         :rtype: :class:`ImageInfo`
         :Usage example:
@@ -1163,7 +1177,15 @@ class ImageApi(RemoveableBulkModuleApi):
             img_info = api.image.upload_path(dataset_id, name="7777.jpeg", path="/home/admin/Downloads/7777.jpeg")
         """
         metas = None if meta is None else [meta]
-        return self.upload_paths(dataset_id, [name], [path], metas=metas)[0]
+        return self.upload_paths(
+            dataset_id,
+            [name],
+            [path],
+            metas=metas,
+            validate_meta=validate_meta,
+            use_strict_validation=use_strict_validation,
+            use_caching_for_validation=use_caching_for_validation,
+        )[0]
 
     def upload_paths(
         self,
@@ -1173,6 +1195,9 @@ class ImageApi(RemoveableBulkModuleApi):
         progress_cb: Optional[Union[tqdm, Callable]] = None,
         metas: Optional[List[Dict]] = None,
         conflict_resolution: Optional[Literal["rename", "skip", "replace"]] = None,
+        validate_meta: Optional[bool] = False,
+        use_strict_validation: Optional[bool] = False,
+        use_caching_for_validation: Optional[bool] = False,
     ) -> List[ImageInfo]:
         """
         Uploads Images with given names from given local path to Dataset.
@@ -1189,6 +1214,12 @@ class ImageApi(RemoveableBulkModuleApi):
         :type metas: List[dict], optional
         :param conflict_resolution: The strategy to resolve upload conflicts. 'Replace' option will replace the existing images in the dataset with the new images. The images that are being deleted are logged. 'Skip' option will ignore the upload of new images that would result in a conflict. An original image's ImageInfo list will be returned instead. 'Rename' option will rename the new images to prevent any conflict.
         :type conflict_resolution: Optional[Literal["rename", "skip", "replace"]]
+        :param validate_meta: If True, validates provided meta with saved JSON schema.
+        :type validate_meta: bool, optional
+        :param use_strict_validation: If True, uses strict validation.
+        :type use_strict_validation: bool, optional
+        :param use_caching_for_validation: If True, uses caching for validation.
+        :type use_caching_for_validation: bool, optional
         :raises: :class:`ValueError` if len(names) != len(paths)
         :return: List with information about Images. See :class:`info_sequence<info_sequence>`
         :rtype: :class:`List[ImageInfo]`
@@ -1214,7 +1245,14 @@ class ImageApi(RemoveableBulkModuleApi):
         self._upload_data_bulk(path_to_bytes_stream, zip(paths, hashes), progress_cb=progress_cb)
 
         return self.upload_hashes(
-            dataset_id, names, hashes, metas=metas, conflict_resolution=conflict_resolution
+            dataset_id,
+            names,
+            hashes,
+            metas=metas,
+            conflict_resolution=conflict_resolution,
+            validate_meta=validate_meta,
+            use_strict_validation=use_strict_validation,
+            use_caching_for_validation=use_caching_for_validation,
         )
 
     def upload_np(
@@ -1492,6 +1530,9 @@ class ImageApi(RemoveableBulkModuleApi):
         batch_size: Optional[int] = 50,
         skip_validation: Optional[bool] = False,
         conflict_resolution: Optional[Literal["rename", "skip", "replace"]] = None,
+        validate_meta: Optional[bool] = False,
+        use_strict_validation: Optional[bool] = False,
+        use_caching_for_validation: Optional[bool] = False,
     ) -> List[ImageInfo]:
         """
         Upload images from given hashes to Dataset.
@@ -1512,6 +1553,12 @@ class ImageApi(RemoveableBulkModuleApi):
         :type skip_validation: bool, optional
         :param conflict_resolution: The strategy to resolve upload conflicts. 'Replace' option will replace the existing images in the dataset with the new images. The images that are being deleted are logged. 'Skip' option will ignore the upload of new images that would result in a conflict. An original image's ImageInfo list will be returned instead. 'Rename' option will rename the new images to prevent any conflict.
         :type conflict_resolution: Optional[Literal["rename", "skip", "replace"]]
+        :param validate_meta: If True, validates provided meta with saved JSON schema.
+        :type validate_meta: bool, optional
+        :param use_strict_validation: If True, uses strict validation.
+        :type use_strict_validation: bool, optional
+        :param use_caching_for_validation: If True, uses caching for validation.
+        :type use_caching_for_validation: bool, optional
         :return: List with information about Images. See :class:`info_sequence<info_sequence>`
         :rtype: :class:`List[ImageInfo]`
         :Usage example:
@@ -1553,6 +1600,9 @@ class ImageApi(RemoveableBulkModuleApi):
             batch_size=batch_size,
             skip_validation=skip_validation,
             conflict_resolution=conflict_resolution,
+            validate_meta=validate_meta,
+            use_strict_validation=use_strict_validation,
+            use_caching_for_validation=use_caching_for_validation,
         )
 
     def upload_id(
@@ -1750,8 +1800,44 @@ class ImageApi(RemoveableBulkModuleApi):
         force_metadata_for_links=True,
         skip_validation=False,
         conflict_resolution: Optional[Literal["rename", "skip", "replace"]] = None,
+        validate_meta: Optional[bool] = False,
+        use_strict_validation: Optional[bool] = False,
+        use_caching_for_validation: Optional[bool] = False,
     ):
         """ """
+        if use_strict_validation and not validate_meta:
+            raise ValueError(
+                "use_strict_validation is set to True, while validate_meta is set to False. "
+                "Please set validate_meta to True to use strict validation "
+                "or disable strict validation by setting use_strict_validation to False."
+            )
+        if validate_meta:
+            dataset_info = self._api.dataset.get_info_by_id(dataset_id)
+
+            validation_schema = self._api.project.get_validation_schema(
+                dataset_info.project_id, use_caching=use_caching_for_validation
+            )
+
+            if validation_schema is None:
+                raise ValueError(
+                    "Validation schema is not set for the project, while "
+                    "validate_meta is set to True. Either disable the validation "
+                    "or set the validation schema for the project using the "
+                    "api.project.set_validation_schema method."
+                )
+
+            for idx, meta in enumerate(metas):
+                missing_fields, extra_fields = compare_dicts(
+                    validation_schema, meta, strict=use_strict_validation
+                )
+
+                if missing_fields or extra_fields:
+                    raise ValueError(
+                        f"Validation failed for the metadata of the image with index {idx} and name {names[idx]}. "
+                        "Please check the metadata and try again. "
+                        f"Missing fields: {missing_fields}, Extra fields: {extra_fields}"
+                    )
+
         if (
             conflict_resolution is not None
             and conflict_resolution not in SUPPORTED_CONFLICT_RESOLUTIONS

supervisely/api/project_api.py

@@ -4,7 +4,9 @@
 # docs
 from __future__ import annotations
 
+import os
 from collections import defaultdict
+from copy import deepcopy
 from typing import (
     TYPE_CHECKING,
     Any,
@@ -25,7 +27,13 @@ if TYPE_CHECKING:
 from datetime import datetime, timedelta
 
 from supervisely import logger
-from supervisely._utils import abs_url, compress_image_url, is_development
+from supervisely._utils import (
+    abs_url,
+    compare_dicts,
+    compress_image_url,
+    get_unix_timestamp,
+    is_development,
+)
 from supervisely.annotation.annotation import TagCollection
 from supervisely.annotation.obj_class import ObjClass
 from supervisely.annotation.obj_class_collection import ObjClassCollection
@@ -36,6 +44,7 @@ from supervisely.api.module_api import (
     RemoveableModuleApi,
     UpdateableModule,
 )
+from supervisely.io.json import dump_json_file, load_json_file
 from supervisely.project.project_meta import ProjectMeta
 from supervisely.project.project_meta import ProjectMetaJsonFields as MetaJsonF
 from supervisely.project.project_settings import (
@@ -43,6 +52,9 @@ from supervisely.project.project_settings import (
     ProjectSettingsJsonFields,
 )
 from supervisely.project.project_type import (
+    _METADATA_SYSTEM_KEY,
+    _METADATA_TIMESTAMP_KEY,
+    _METADATA_VALIDATION_SCHEMA_KEY,
     _MULTISPECTRAL_TAG_NAME,
     _MULTIVIEW_TAG_NAME,
     ProjectType,
@@ -969,6 +981,278 @@ class ProjectApi(CloneableModuleApi, UpdateableModule, RemoveableModuleApi):
         )
         return response.json()
 
+    def get_custom_data(self, id: int) -> Dict[Any, Any]:
+        """Returns custom data of the Project by ID.
+        Custom data is a dictionary that can be used to store any additional information.
+
+        :param id: Project ID in Supervisely.
+        :type id: int
+        :return: Custom data of the Project
+        :rtype: :class:`dict`
+
+        :Usage example:
+
+        .. code-block:: python
+
+            import supervisely as sly
+
+            api = sly.Api.from_env()
+
+            project_id = 123456
+
+            custom_data = api.project.get_custom_data(project_id)
+
+            print(custom_data) # Output: {'key': 'value'}
+        """
+        return self.get_info_by_id(id).custom_data
+
+    def _get_system_custom_data(self, id: int) -> Dict[Any, Any]:
+        """Returns system custom data of the Project by ID.
+        System custom data is just a part of custom data that is used to store system information
+        and obtained by the key `_METADATA_SYSTEM_KEY`.
+
+        :param id: Project ID in Supervisely.
+        :type id: int
+        :return: System custom data of the Project
+        :rtype: :class:`dict`
+
+        :Usage example:
+
+        .. code-block:: python
+
+            import supervisely as sly
+
+            api = sly.Api.from_env()
+
+            project_id = 123456
+
+            system_custom_data = api.project._get_system_custom_data(project_id)
+
+            print(system_custom_data)
+        """
+        return self.get_info_by_id(id).custom_data.get(_METADATA_SYSTEM_KEY, {})
+
+    def get_validation_schema(self, id: int, use_caching: bool = False) -> Optional[Dict[Any, Any]]:
+        """Returns validation schema of the Project by ID.
+        Validation schema is a dictionary that can be used to validate metadata of each entity in the project
+        if corresnpoding schema is provided.
+        If using caching, the schema will be loaded from the cache if available.
+        Use cached version only in scenarios when the schema is not expected to change,
+        otherwise it may lead to checks with outdated schema.
+
+        :param id: Project ID in Supervisely.
+        :type id: int
+        :param use_caching: If True, uses cached version of the schema if available.
+            NOTE: This may lead to checks with outdated schema. Use with caution.
+            And only in scenarios when the schema is not expected to change.
+        :return: Validation schema of the Project
+        :rtype: :class:`dict`
+
+        :Usage example:
+
+        .. code-block:: python
+
+            import supervisely as sly
+
+            api = sly.Api.from_env()
+
+            project_id = 123456
+
+            validation_schema = api.project.get_validation_schema(project_id)
+
+            print(validation_schema) # Output: {'key': 'Description of the field'}
+        """
+        SCHEMA_DIFF_THRESHOLD = 60 * 60  # 1 hour
+        json_cache_filename = os.path.join(os.getcwd(), f"{id}_validation_schema.json")
+
+        if use_caching:
+            if os.path.isfile(json_cache_filename):
+                try:
+                    schema = load_json_file(json_cache_filename)
+                    timestamp = schema.pop(_METADATA_TIMESTAMP_KEY, 0)
+
+                    if get_unix_timestamp() - timestamp < SCHEMA_DIFF_THRESHOLD:
+                        return schema
+                except RuntimeError:
+                    pass
+
+        schema = self._get_system_custom_data(id).get(_METADATA_VALIDATION_SCHEMA_KEY)
+        if schema and use_caching:
+            schema_with_timestamp = deepcopy(schema)
+            schema_with_timestamp[_METADATA_TIMESTAMP_KEY] = get_unix_timestamp()
+            dump_json_file(schema_with_timestamp, json_cache_filename)
+
+        return schema
+
+    def _edit_validation_schema(
+        self, id: int, schema: Optional[Dict[Any, Any]] = None
+    ) -> Dict[Any, Any]:
+        """Edits validation schema of the Project by ID.
+        Do not use this method directly, use `set_validation_schema` or `remove_validation_schema` instead.
+
+        :param id: Project ID in Supervisely.
+        :type id: int
+        :param schema: Validation schema to set. If None, removes validation schema.
+        :type schema: dict, optional
+        :return: Project information in dict format
+        :rtype: :class:`dict`
+
+        :Usage example:
+
+        .. code-block:: python
+
+            import supervisely as sly
+
+            api = sly.Api.from_env()
+
+            project_id = 123456
+
+            schema = {'key': 'Description of the field'}
+
+            api.project._edit_validation_schema(project_id, schema) #Set new validation schema.
+            api.project._edit_validation_schema(project_id) #Remove validation schema.
+        """
+        custom_data = self.get_custom_data(id)
+        system_data = custom_data.setdefault(_METADATA_SYSTEM_KEY, {})
+
+        if not schema:
+            system_data.pop(_METADATA_VALIDATION_SCHEMA_KEY, None)
+        else:
+            system_data[_METADATA_VALIDATION_SCHEMA_KEY] = schema
+        return self.update_custom_data(id, custom_data)
+
+    def set_validation_schema(self, id: int, schema: Dict[Any, Any]) -> Dict[Any, Any]:
+        """Sets validation schema of the Project by ID.
+        NOTE: This method will overwrite existing validation schema. To extend existing schema,
+        use `get_validation_schema` first to get current schema, then update it and use this method to set new schema.
+
+        :param id: Project ID in Supervisely.
+        :type id: int
+        :param schema: Validation schema to set.
+        :type schema: dict
+        :return: Project information in dict format
+        :rtype: :class:`dict`
+
+        :Usage example:
+
+        .. code-block:: python
+
+            import supervisely as sly
+
+            api = sly.Api.from_env()
+
+            project_id = 123456
+
+            schema = {'key': 'Description of the field'}
+
+            api.project.set_validation_schema(project_id, schema)
+        """
+        return self._edit_validation_schema(id, schema)
+
+    def remove_validation_schema(self, id: int) -> Dict[Any, Any]:
+        """Removes validation schema of the Project by ID.
+
+        :param id: Project ID in Supervisely.
+        :type id: int
+        :return: Project information in dict format
+        :rtype: :class:`dict`
+
+        :Usage example:
+
+        .. code-block:: python
+
+            import supervisely as sly
+
+            api = sly.Api.from_env()
+
+            project_id = 123456
+
+            api.project.remove_validation_schema(project_id)
+        """
+        return self._edit_validation_schema(id)
+
+    def validate_entities_schema(
+        self, id: int, strict: bool = False
+    ) -> List[Dict[str, Union[id, str, List[str], List[Any]]]]:
+        """Validates entities of the Project by ID using validation schema.
+        Returns list of entities that do not match the schema.
+
+        Example of the returned list:
+
+        [
+            {
+                "entity_id": 123456,
+                "entity_name": "image.jpg",
+                "missing_fields": ["location"],
+                "extra_fields": ["city.name"] <- Nested field (field "name" of the field "city")
+            }
+        ]
+
+        :param id: Project ID in Supervisely.
+        :type id: int
+        :param strict: If strict is disabled, only checks if the entity has all the fields from the schema.
+            Any extra fields in the entity will be ignored and will not be considered as an error.
+            If strict is enabled, checks that the entity custom data is an exact match to the schema.
+        :type strict: bool, optional
+        :return: List of dictionaries with information about entities that do not match the schema.
+        :rtype: :class:`List[Dict[str, Union[id, str, List[str], List[Any]]]`
+
+        :Usage example:
+
+        .. code-block:: python
+
+            import supervisely as sly
+
+            api = sly.Api.from_env()
+
+            project_id = 123456
+
+            incorrect_entities = api.project.validate_entities_schema(project_id)
+
+            for entity in incorrect_entities:
+                print(entity.id, entity.name) # Output: 123456, 'image.jpg'
+        """
+        validation_schema = self.get_validation_schema(id)
+        if not validation_schema:
+            raise ValueError("Validation schema is not set for this project.")
+
+        info = self.get_info_by_id(id)
+        listing_method = {
+            # Mapping of project type to listing method.
+            ProjectType.IMAGES.value: self._api.image.get_list,
+        }
+        custom_data_properties = {
+            # Mapping of project type to custom data property name.
+            # Can be different for different project types.
+            ProjectType.IMAGES.value: "meta"
+        }
+
+        listing_method = listing_method.get(info.type)
+        custom_data_property = custom_data_properties.get(info.type)
+
+        if not listing_method or not custom_data_property:
+            # TODO: Add support for other project types.
+            raise NotImplementedError("Validation schema is not supported for this project type.")
+
+        entities = listing_method(project_id=id)
+        incorrect_entities = []
+
+        for entity in entities:
+            custom_data = getattr(entity, custom_data_property)
+            missing_fields, extra_fields = compare_dicts(
+                validation_schema, custom_data, strict=strict
+            )
+            if missing_fields or extra_fields:
+                entry = {
+                    "entity_id": entity.id,
+                    "entity_name": entity.name,
+                    "missing_fields": missing_fields,
+                    "extra_fields": extra_fields,
+                }
+                incorrect_entities.append(entry)
+
+        return incorrect_entities
+
     def get_settings(self, id: int) -> Dict[str, str]:
         info = self._get_info_by_id(id, "projects.info")
         return info.settings

supervisely/project/project_type.py

@@ -11,7 +11,10 @@ class ProjectType(StrEnum):
     POINT_CLOUD_EPISODES = "point_cloud_episodes"
 
 
-
 # Constants for multispectral and multiview projects.
 _MULTISPECTRAL_TAG_NAME = "multispectral"
 _MULTIVIEW_TAG_NAME = "multiview"
+
+_METADATA_SYSTEM_KEY = "sly_system"
+_METADATA_VALIDATION_SCHEMA_KEY = "validation_schema"
+_METADATA_TIMESTAMP_KEY = "validation_schema_timestamp"

{supervisely-6.73.227.dist-info → supervisely-6.73.228.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: supervisely
-Version: 6.73.227
+Version: 6.73.228
 Summary: Supervisely Python SDK.
 Home-page: https://github.com/supervisely/supervisely
 Author: Supervisely

{supervisely-6.73.227.dist-info → supervisely-6.73.228.dist-info}/RECORD

@@ -1,6 +1,6 @@
 supervisely/README.md,sha256=XM-DiMC6To3I9RjQZ0c61905EFRR_jnCUx2q3uNR-X8,3331
-supervisely/__init__.py,sha256=mpj1kUpy8jURvMixE8b1QDccHDao-C-RSkYNM-2UL2k,10800
-supervisely/_utils.py,sha256=HV3PhGMbTIu5r95p8PqT7tzx84xEYb2uYI78OSy6xEA,12987
+supervisely/__init__.py,sha256=Ghm5UsSQGjTr7cWetpSxewX0Rys9yC3rb3PQJQJD0_E,10799
+supervisely/_utils.py,sha256=2l9e8L7-p9twlwsBTFKZPM71bCU0aeP3rvs31wy0P-A,15059
 supervisely/function_wrapper.py,sha256=R5YajTQ0GnRp2vtjwfC9hINkzQc0JiyGsu8TER373xY,1912
 supervisely/sly_logger.py,sha256=LG1wTyyctyEKuCuKM2IKf_SMPH7BzkTsFdO-0tnorzg,6225
 supervisely/tiny_timer.py,sha256=hkpe_7FE6bsKL79blSs7WBaktuPavEVu67IpEPrfmjE,183
@@ -24,11 +24,11 @@ supervisely/api/agent_api.py,sha256=ShWAIlXcWXcyI9fqVuP5GZVCigCMJmjnvdGUfLspD6Y,
 supervisely/api/annotation_api.py,sha256=kgbxlAmvwLX7nMFnQ23hZDZryD3tVSehfqRkLEGXQXA,58828
 supervisely/api/api.py,sha256=BdN99Znu_nLjnt--i6xoN9W4v0Am3kYlkqZZeIy4UuE,60633
 supervisely/api/app_api.py,sha256=hjoL24Nc1POlIqz5bkpMBij5D-cwCHvkznkaGpODyzA,67086
-supervisely/api/dataset_api.py,sha256=7iwAyz3pmzFG2i072gLdXjczfBGbyj-V_rRl7Tx-V30,37944
+supervisely/api/dataset_api.py,sha256=2-SQBlgEnIN-0uvDbtPlSXr6ztBeZ3WPryhkOtpBmk4,40786
 supervisely/api/file_api.py,sha256=RM3clcdcfj0MtSqGdu6afCqUieYj_2q5gcEch_36tCE,82421
 supervisely/api/github_api.py,sha256=NIexNjEer9H5rf5sw2LEZd7C1WR-tK4t6IZzsgeAAwQ,623
 supervisely/api/image_annotation_tool_api.py,sha256=YcUo78jRDBJYvIjrd-Y6FJAasLta54nnxhyaGyanovA,5237
-supervisely/api/image_api.py,sha256=N2JotH62h-3NRiCbgzPvXOjLavkygPYlEtqFw8rgvIg,158305
+supervisely/api/image_api.py,sha256=BMhlJZwfbxFx8eHBQaKNmGI9a7UbOpJrIEmC6Eci-Ck,162395
 supervisely/api/import_storage_api.py,sha256=BDCgmR0Hv6OoiRHLCVPKt3iDxSVlQp1WrnKhAK_Zl84,460
 supervisely/api/issues_api.py,sha256=BqDJXmNoTzwc3xe6_-mA7FDFC5QQ-ahGbXk_HmpkSeQ,17925
 supervisely/api/labeling_job_api.py,sha256=odnzZjp29yM16Gq-FYkv-OA4WFMNJCLFo4qSikW2A7c,56280
@@ -36,7 +36,7 @@ supervisely/api/module_api.py,sha256=nFMvROP7XB6_BVSsP9W_eEKiTlcGYxezyMCV4pdqk8k
 supervisely/api/neural_network_api.py,sha256=ktPVRO4Jeulougio8F0mioJJHwRJcX250Djp1wBoQ9c,7620
 supervisely/api/object_class_api.py,sha256=-rQcKwhBw3iL9KNH9c1ROgoimgWM1ls6Wi_tb1R-MzY,7683
 supervisely/api/plugin_api.py,sha256=TlfrosdRuYG4NUxk92QiQoVaOdztFspPpygyVa3M3zk,5283
-supervisely/api/project_api.py,sha256=CNB3kIh_RfW_yOEy58eNpQaE8u6NMOuBmk70QfVni4s,68654
+supervisely/api/project_api.py,sha256=3_4wP3RqLHhbdftwu2LF2iKUMmFxrhk3FryL-OpplZo,78633
 supervisely/api/project_class_api.py,sha256=5cyjdGPPb2tpttu5WmYoOxUNiDxqiojschkhZumF0KM,1426
 supervisely/api/remote_storage_api.py,sha256=xy9-j5hSftVcAILyqF_mQdQ1DUywt9msq2QYuSE-PVY,15032
 supervisely/api/report_api.py,sha256=Om7CGulUbQ4BuJ16eDtz7luLe0JQNqab-LoLpUXu7YE,7123
@@ -938,7 +938,7 @@ supervisely/project/pointcloud_project.py,sha256=Y8Xhi6Hg-KyztwFncezuDfKTt2FILss
 supervisely/project/project.py,sha256=8ghaq9OCFRdhTNuKo_morBgVxgFOS1KKpmU8Kyl1vdo,180328
 supervisely/project/project_meta.py,sha256=26s8IiHC5Pg8B1AQi6_CrsWteioJP2in00cRNe8QlW0,51423
 supervisely/project/project_settings.py,sha256=NLThzU_DCynOK6hkHhVdFyezwprn9UqlnrLDe_3qhkY,9347
-supervisely/project/project_type.py,sha256=XRcZG5zI4RR8-JSlG-n0VVjGA4gJSfLIU-hbqiaNOcc,384
+supervisely/project/project_type.py,sha256=_3RqW2CnDBKFOvSIrQT1RJQaiHirs34_jiQS8CkwCpo,530
 supervisely/project/readme_template.md,sha256=rGmSLRVUSGjvorjpzl0sZ7YA4sKfDexl95NFtMISj3I,9128
 supervisely/project/upload.py,sha256=AjgHYgVZwUE25ygC5pqvFjdAladbyB8T78mlet5Qpho,3750
 supervisely/project/video_project.py,sha256=AoZDIF3TAPke3WVZAOSWnuyIs12sFZsY5CxARSNQ5N8,63740
@@ -997,9 +997,9 @@ supervisely/worker_proto/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 supervisely/worker_proto/worker_api_pb2.py,sha256=VQfi5JRBHs2pFCK1snec3JECgGnua3Xjqw_-b3aFxuM,59142
 supervisely/worker_proto/worker_api_pb2_grpc.py,sha256=3BwQXOaP9qpdi0Dt9EKG--Lm8KGN0C5AgmUfRv77_Jk,28940
 supervisely_lib/__init__.py,sha256=7-3QnN8Zf0wj8NCr2oJmqoQWMKKPKTECvjH9pd2S5vY,159
-supervisely-6.73.227.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-supervisely-6.73.227.dist-info/METADATA,sha256=vUAUlDnXTIsqkAF3lL4hg0HMNuKe8CIa4xnEyNREKo0,33150
-supervisely-6.73.227.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-supervisely-6.73.227.dist-info/entry_points.txt,sha256=U96-5Hxrp2ApRjnCoUiUhWMqijqh8zLR03sEhWtAcms,102
-supervisely-6.73.227.dist-info/top_level.txt,sha256=kcFVwb7SXtfqZifrZaSE3owHExX4gcNYe7Q2uoby084,28
-supervisely-6.73.227.dist-info/RECORD,,
+supervisely-6.73.228.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+supervisely-6.73.228.dist-info/METADATA,sha256=gEzztrS-yBBzf4a8JM9h_HWYtonbH_CrRzFgNqGr1Fs,33150
+supervisely-6.73.228.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+supervisely-6.73.228.dist-info/entry_points.txt,sha256=U96-5Hxrp2ApRjnCoUiUhWMqijqh8zLR03sEhWtAcms,102
+supervisely-6.73.228.dist-info/top_level.txt,sha256=kcFVwb7SXtfqZifrZaSE3owHExX4gcNYe7Q2uoby084,28
+supervisely-6.73.228.dist-info/RECORD,,