supervisely 6.73.262__tar.gz → 6.73.263__tar.gz

{supervisely-6.73.262/supervisely.egg-info → supervisely-6.73.263}/PKG-INFO

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

{supervisely-6.73.262 → supervisely-6.73.263}/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.12.12"
+os.environ["MINIMUM_INSTANCE_VERSION_FOR_SDK"] = "6.12.17"

{supervisely-6.73.262 → supervisely-6.73.263}/supervisely/api/app_api.py

@@ -1212,17 +1212,80 @@ class AppApi(TaskApi):
 
     def get_list(
         self,
-        team_id,
-        filter=None,
-        context=None,
-        repository_key=None,
-        show_disabled=False,
-        integrated_into=None,
-        session_tags=None,
-        only_running=False,
-        with_shared=True,
+        team_id: int,
+        filter: Optional[List[dict]] = None,
+        context: Optional[List[str]] = None,
+        repository_key: Optional[str] = None,
+        show_disabled: bool = False,
+        integrated_into: Optional[List[str]] = None,
+        session_tags: Optional[List[str]] = None,
+        only_running: bool = False,
+        with_shared: bool = True,
+        force_all_sessions: bool = True,
     ) -> List[AppInfo]:
-        """get_list"""
+        """
+        Get list of applications for the specified team.
+
+        :param team_id: team id
+        :type team_id: int
+        :param filter: list of filters
+        :type filter: Optional[List[dict]]
+        :param context: list of application contexts
+        :type context: Optional[List[str]]
+        :param repository_key: repository key
+        :type repository_key: Optional[str]
+        :param show_disabled: show disabled applications
+        :type show_disabled: bool
+        :param integrated_into: destination of the application.
+                    Available values: "panel", "files", "standalone", "data_commander",
+                                    "image_annotation_tool", "video_annotation_tool",
+                                    "dicom_annotation_tool", "pointcloud_annotation_tool"
+        :type integrated_into: Optional[List[str]]
+        :param session_tags: list of session tags
+        :type session_tags: Optional[List[str]]
+        :param only_running: show only running applications (status is one of "queued"/"consumed"/"started"/"deployed")
+        :type only_running: bool
+        :param with_shared: include shared applications
+        :type with_shared: bool
+        :param force_all_sessions: force to get all sessions (tasks) for each application.
+                                Works only if only_running is False.
+                                Note that it can be a long operation.
+        :type force_all_sessions: bool
+
+        :return: list of applications
+        :rtype: List[AppInfo]
+
+
+        :Usage example:
+
+         .. code-block:: python
+
+            import supervisely as sly
+
+            os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
+            os.environ['API_TOKEN'] = 'Your Supervisely API Token'
+            api = sly.Api.from_env()
+
+            team_id = 447
+
+            # Get list of all applications (including all tasks in `tasks` field)
+            apps = api.app.get_list(team_id=team_id)
+
+            # Get list of all applications (only running tasks included in `tasks` field)
+            apps = api.app.get_list(team_id=team_id, force_all_sessions=False)
+
+            # Get list of only running applications
+            apps = api.app.get_list(team_id=team_id, only_running=True)
+
+            # Get list of applications with specific filters
+            filter = [{"field": "moduleId", "operator": "=", "value": 428}]
+            apps = api.app.get_list(team_id=team_id, filter=filter)
+        """
+
+        if only_running is True:
+            # no need to get all sessions if only running sessions are requested
+            # (`force_all_sessions` has higher priority than only_running)
+            force_all_sessions = False
 
         return self.get_list_all_pages(
             method="apps.list",
@@ -1240,6 +1303,7 @@ class AppApi(TaskApi):
                 "onlyRunning": only_running,
                 "showDisabled": show_disabled,
                 "withShared": with_shared,
+                "forceAllSessions": force_all_sessions,
             },
         )
 
@@ -1479,49 +1543,105 @@ class AppApi(TaskApi):
 
     def get_sessions(
         self,
-        team_id,
-        module_id,
-        # only_running=False,
-        show_disabled=False,
-        session_name=None,
-        statuses: List[TaskApi.Status] = None,
+        team_id: int,
+        module_id: int,
+        show_disabled: bool = False,
+        session_name: Optional[str] = None,
+        statuses: Optional[List[TaskApi.Status]] = None,
+        with_shared: bool = False,
     ) -> List[SessionInfo]:
-        infos_json = self.get_list_all_pages(
-            method="apps.list",
-            data={
-                "teamId": team_id,
-                "filter": [{"field": "moduleId", "operator": "=", "value": module_id}],
-                # "onlyRunning": only_running,
-                "showDisabled": show_disabled,
-            },
-            convert_json_info_cb=lambda x: x,
-            # validate_total=False,
+        """
+        Get list of sessions (tasks) for the specified team and module.
+
+        :param team_id: team id
+        :type team_id: int
+        :param module_id: application module id
+        :type module_id: int
+        :param show_disabled: show disabled applications
+        :type show_disabled: bool
+        :param session_name: session name to filter sessions
+        :type session_name: Optional[str]
+        :param statuses: list of statuses to filter sessions
+        :type statuses: Optional[List[TaskApi.Status]]
+        :param with_shared: include shared application sessions
+        :type with_shared: bool
+
+        :return: list of sessions
+        :rtype: List[SessionInfo]
+
+        :Usage example:
+
+         .. code-block:: python
+
+            import supervisely as sly
+
+            os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
+            os.environ['API_TOKEN'] = 'Your Supervisely API Token'
+            api = sly.Api.from_env()
+
+            team_id = 447
+            module_id = 428
+
+            # Get list of all sessions for the specified team and module ID
+            sessions = api.app.get_sessions(team_id, module_id)
+
+            # Get list of sessions with specific statuses
+            from supervisely.api.task_api import TaskApi
+
+            statuses = [TaskApi.Status.STARTED]
+            sessions = api.app.get_sessions(team_id, module_id, statuses=statuses)
+        """
+
+        infos_json = self.get_list(
+            team_id,
+            filter=[
+                {
+                    ApiField.FIELD: ApiField.MODULE_ID,
+                    ApiField.OPERATOR: "=",
+                    ApiField.VALUE: module_id,
+                }
+            ],
+            with_shared=with_shared,
+            only_running=False,
+            force_all_sessions=False,
         )
-        if len(infos_json) == 0:
-            # raise KeyError(f"App [module_id = {module_id}] not found in team {team_id}")
-            return []
-        if len(infos_json) > 1:
+        if len(infos_json) > 1 and with_shared is False:
             raise KeyError(
                 f"Apps list in team is broken: app [module_id = {module_id}] added to team {team_id} multiple times"
             )
-        dev_tasks = []
-        sessions = infos_json[0]["tasks"]
-
-        str_statuses = []
-        if statuses is not None:
-            for s in statuses:
-                str_statuses.append(str(s))
-
+        sessions = []
+        for app in infos_json:
+            data = {
+                ApiField.TEAM_ID: team_id,
+                ApiField.APP_ID: app.id,
+                # ApiField.ONLY_RUNNING: False,
+                ApiField.SHOW_DISABLED: show_disabled,
+                ApiField.WITH_SHARED: with_shared,
+                ApiField.SORT: ApiField.STARTED_AT,
+                ApiField.SORT_ORDER: "desc",
+            }
+            if statuses is not None:
+                data[ApiField.FILTER] = [
+                    {
+                        ApiField.FIELD: ApiField.STATUS,
+                        ApiField.OPERATOR: "in",
+                        ApiField.VALUE: [str(s) for s in statuses],
+                    }
+                ]
+            sessions.extend(
+                self.get_list_all_pages(
+                    method="apps.tasks.list",
+                    data=data,
+                    convert_json_info_cb=lambda x: x,
+                )
+            )
+        session_infos = []
         for session in sessions:
-            to_add = True
             if session_name is not None and session["meta"]["name"] != session_name:
-                to_add = False
-            if statuses is not None and session["status"] not in str_statuses:
-                to_add = False
-            if to_add is True:
-                session["moduleId"] = module_id
-                dev_tasks.append(SessionInfo.from_json(session))
-        return dev_tasks
+                continue
+            session["moduleId"] = module_id
+            session_infos.append(SessionInfo.from_json(session))
+        return session_infos
 
     def start(
         self,

{supervisely-6.73.262 → supervisely-6.73.263}/supervisely/api/module_api.py

@@ -596,6 +596,12 @@ class ApiField:
     """"""
     CLEAR_LOCAL_DATA_SOURCE = "clearLocalDataSource"
     """"""
+    ONLY_RUNNING = "onlyRunning"
+    """"""
+    SHOW_DISABLED = "showDisabled"
+    """"""
+    WITH_SHARED = "withShared"
+    """"""
 
 
 def _get_single_item(items):

{supervisely-6.73.262 → supervisely-6.73.263/supervisely.egg-info}/PKG-INFO

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