adds TaskType information to Tasks (#938)

* adds TaskType information to Tasks
* changelog
* merge
* revert .well-known
* Merge branch 'master' into administation-task-types
* less flaky test?
* Merge refs/heads/master into administation-task-types

Author: normanrz

webknossos/Changelog.md

@@ -15,6 +15,7 @@ For upgrade instructions, please check the respective _Breaking Changes_ section
 ### Breaking Changes
 
 ### Added
+- Added `task_type` property to `Task` class. [#938](https://github.com/scalableminds/webknossos-libs/pull/938)
 
 ### Changed
 

webknossos/__generate_client.py

@@ -320,6 +320,10 @@ def iterate_request_ids_with_responses() -> Iterable[Tuple[str, bytes]]:
     "pending",
     "active",
     "finished",
+    "type",
+    ##### TaskType ####
+    "summary",
+    "teamId",
     ##### Annotation #####
     # "owner", optional
     "description",

webknossos/tests/test_cli.py

@@ -78,6 +78,8 @@ def _tiff_cubing(out_path: Path, data_format: DataFormat) -> None:
     assert (out_path / "tiff" / "1").exists()
 
 
+@pytest.mark.block_network(allowed_hosts=[".*"])
+@pytest.mark.vcr(ignore_hosts=["webknossos.org", "data-humerus.webknossos.org"])
 def test_tiff_cubing_zarr_s3() -> None:
     """Tests zarr support when performing tiff cubing."""
 

webknossos/webknossos/administration/__init__.py

@@ -1,3 +1,3 @@
 from webknossos.administration.project import Project
-from webknossos.administration.task import Task
+from webknossos.administration.task import Task, TaskType
 from webknossos.administration.user import Team, User

webknossos/webknossos/administration/task.py

@@ -22,9 +22,15 @@
     from webknossos.client._generated.models.task_info_response_200 import (
         TaskInfoResponse200,
     )
+    from webknossos.client._generated.models.task_info_response_200_type import (
+        TaskInfoResponse200Type,
+    )
     from webknossos.client._generated.models.task_infos_by_project_id_response_200_item import (
         TaskInfosByProjectIdResponse200Item,
     )
+    from webknossos.client._generated.models.task_infos_by_project_id_response_200_item_type import (
+        TaskInfosByProjectIdResponse200ItemType,
+    )
 
 
 @attr.frozen
@@ -39,6 +45,30 @@ def open_instance_count(self) -> int:
         return self.pending_instance_count
 
 
+@attr.frozen
+class TaskType:
+    task_type_id: str
+    name: str
+    description: str
+    team_id: str
+    team_name: str
+
+    @classmethod
+    def _from_generated_response(
+        cls,
+        response: Union[
+            "TaskInfoResponse200Type", "TaskInfosByProjectIdResponse200ItemType"
+        ],
+    ) -> "TaskType":
+        return cls(
+            response.id,
+            response.summary,
+            response.description,
+            response.team_id,
+            response.team_name,
+        )
+
+
 @attr.frozen
 class Task:
     """Data class containing information about a WEBKNOSSOS task"""
@@ -47,6 +77,7 @@ class Task:
     project_id: str
     dataset_name: str
     status: TaskStatus
+    task_type: TaskType
 
     @classmethod
     def get_by_id(cls, task_id: str) -> "Task":
@@ -185,6 +216,7 @@ def _from_generated_response(
                 response.status.active,
                 response.status.finished,
             ),
+            TaskType._from_generated_response(response.type),
         )
 
     def get_annotation_infos(self) -> List[AnnotationInfo]:

webknossos/webknossos/client/_generated/models/annotation_info_response_200_task.py

@@ -26,13 +26,13 @@ class AnnotationInfoResponse200Task:
         id (str):
         project_id (str):
         team (str):
+        type (AnnotationInfoResponse200TaskType):
         data_set (str):
         created (int):
         status (AnnotationInfoResponse200TaskStatus):
         bounding_box (str):
         formatted_hash (Union[Unset, str]):
         project_name (Union[Unset, str]):
-        type (Union[Unset, AnnotationInfoResponse200TaskType]):
         needed_experience (Union[Unset, AnnotationInfoResponse200TaskNeededExperience]):
         script (Union[Unset, str]):
         tracing_time (Union[Unset, None, int]):
@@ -44,13 +44,13 @@ class AnnotationInfoResponse200Task:
     id: str
     project_id: str
     team: str
+    type: "AnnotationInfoResponse200TaskType"
     data_set: str
     created: int
     status: "AnnotationInfoResponse200TaskStatus"
     bounding_box: str
     formatted_hash: Union[Unset, str] = UNSET
     project_name: Union[Unset, str] = UNSET
-    type: Union[Unset, "AnnotationInfoResponse200TaskType"] = UNSET
     needed_experience: Union[
         Unset, "AnnotationInfoResponse200TaskNeededExperience"
     ] = UNSET
@@ -65,17 +65,15 @@ def to_dict(self) -> Dict[str, Any]:
         id = self.id
         project_id = self.project_id
         team = self.team
+        type = self.type.to_dict()
+
         data_set = self.data_set
         created = self.created
         status = self.status.to_dict()
 
         bounding_box = self.bounding_box
         formatted_hash = self.formatted_hash
         project_name = self.project_name
-        type: Union[Unset, Dict[str, Any]] = UNSET
-        if not isinstance(self.type, Unset):
-            type = self.type.to_dict()
-
         needed_experience: Union[Unset, Dict[str, Any]] = UNSET
         if not isinstance(self.needed_experience, Unset):
             needed_experience = self.needed_experience.to_dict()
@@ -98,6 +96,7 @@ def to_dict(self) -> Dict[str, Any]:
                 "id": id,
                 "projectId": project_id,
                 "team": team,
+                "type": type,
                 "dataSet": data_set,
                 "created": created,
                 "status": status,
@@ -108,8 +107,6 @@ def to_dict(self) -> Dict[str, Any]:
             field_dict["formattedHash"] = formatted_hash
         if project_name is not UNSET:
             field_dict["projectName"] = project_name
-        if type is not UNSET:
-            field_dict["type"] = type
         if needed_experience is not UNSET:
             field_dict["neededExperience"] = needed_experience
         if script is not UNSET:
@@ -144,6 +141,8 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
 
         team = d.pop("team")
 
+        type = AnnotationInfoResponse200TaskType.from_dict(d.pop("type"))
+
         data_set = d.pop("dataSet")
 
         created = d.pop("created")
@@ -156,13 +155,6 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
 
         project_name = d.pop("projectName", UNSET)
 
-        _type = d.pop("type", UNSET)
-        type: Union[Unset, AnnotationInfoResponse200TaskType]
-        if isinstance(_type, Unset):
-            type = UNSET
-        else:
-            type = AnnotationInfoResponse200TaskType.from_dict(_type)
-
         _needed_experience = d.pop("neededExperience", UNSET)
         needed_experience: Union[Unset, AnnotationInfoResponse200TaskNeededExperience]
         if isinstance(_needed_experience, Unset):
@@ -186,13 +178,13 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
             id=id,
             project_id=project_id,
             team=team,
+            type=type,
             data_set=data_set,
             created=created,
             status=status,
             bounding_box=bounding_box,
             formatted_hash=formatted_hash,
             project_name=project_name,
-            type=type,
             needed_experience=needed_experience,
             script=script,
             tracing_time=tracing_time,

webknossos/webknossos/client/_generated/models/annotation_info_response_200_task_type.py

@@ -18,31 +18,31 @@ class AnnotationInfoResponse200TaskType:
     """
     Attributes:
         id (str):
+        summary (str):
         description (str):
+        team_id (str):
         team_name (str):
-        summary (Union[Unset, str]):
-        team_id (Union[Unset, str]):
         settings (Union[Unset, AnnotationInfoResponse200TaskTypeSettings]):
         recommended_configuration (Union[Unset, str]):
         tracing_type (Union[Unset, str]):
     """
 
     id: str
+    summary: str
     description: str
+    team_id: str
     team_name: str
-    summary: Union[Unset, str] = UNSET
-    team_id: Union[Unset, str] = UNSET
     settings: Union[Unset, "AnnotationInfoResponse200TaskTypeSettings"] = UNSET
     recommended_configuration: Union[Unset, str] = UNSET
     tracing_type: Union[Unset, str] = UNSET
     additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
 
     def to_dict(self) -> Dict[str, Any]:
         id = self.id
-        description = self.description
-        team_name = self.team_name
         summary = self.summary
+        description = self.description
         team_id = self.team_id
+        team_name = self.team_name
         settings: Union[Unset, Dict[str, Any]] = UNSET
         if not isinstance(self.settings, Unset):
             settings = self.settings.to_dict()
@@ -55,14 +55,12 @@ def to_dict(self) -> Dict[str, Any]:
         field_dict.update(
             {
                 "id": id,
+                "summary": summary,
                 "description": description,
+                "teamId": team_id,
                 "teamName": team_name,
             }
         )
-        if summary is not UNSET:
-            field_dict["summary"] = summary
-        if team_id is not UNSET:
-            field_dict["teamId"] = team_id
         if settings is not UNSET:
             field_dict["settings"] = settings
         if recommended_configuration is not UNSET:
@@ -81,13 +79,13 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
         d = src_dict.copy()
         id = d.pop("id")
 
-        description = d.pop("description")
+        summary = d.pop("summary")
 
-        team_name = d.pop("teamName")
+        description = d.pop("description")
 
-        summary = d.pop("summary", UNSET)
+        team_id = d.pop("teamId")
 
-        team_id = d.pop("teamId", UNSET)
+        team_name = d.pop("teamName")
 
         _settings = d.pop("settings", UNSET)
         settings: Union[Unset, AnnotationInfoResponse200TaskTypeSettings]
@@ -102,10 +100,10 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
 
         annotation_info_response_200_task_type = cls(
             id=id,
-            description=description,
-            team_name=team_name,
             summary=summary,
+            description=description,
             team_id=team_id,
+            team_name=team_name,
             settings=settings,
             recommended_configuration=recommended_configuration,
             tracing_type=tracing_type,

webknossos/webknossos/client/_generated/models/annotation_infos_by_task_id_response_200_item_task.py

@@ -26,13 +26,13 @@ class AnnotationInfosByTaskIdResponse200ItemTask:
         id (str):
         project_id (str):
         team (str):
+        type (AnnotationInfosByTaskIdResponse200ItemTaskType):
         data_set (str):
         created (int):
         status (AnnotationInfosByTaskIdResponse200ItemTaskStatus):
         bounding_box (str):
         formatted_hash (Union[Unset, str]):
         project_name (Union[Unset, str]):
-        type (Union[Unset, AnnotationInfosByTaskIdResponse200ItemTaskType]):
         needed_experience (Union[Unset, AnnotationInfosByTaskIdResponse200ItemTaskNeededExperience]):
         script (Union[Unset, str]):
         tracing_time (Union[Unset, None, int]):
@@ -44,13 +44,13 @@ class AnnotationInfosByTaskIdResponse200ItemTask:
     id: str
     project_id: str
     team: str
+    type: "AnnotationInfosByTaskIdResponse200ItemTaskType"
     data_set: str
     created: int
     status: "AnnotationInfosByTaskIdResponse200ItemTaskStatus"
     bounding_box: str
     formatted_hash: Union[Unset, str] = UNSET
     project_name: Union[Unset, str] = UNSET
-    type: Union[Unset, "AnnotationInfosByTaskIdResponse200ItemTaskType"] = UNSET
     needed_experience: Union[
         Unset, "AnnotationInfosByTaskIdResponse200ItemTaskNeededExperience"
     ] = UNSET
@@ -65,17 +65,15 @@ def to_dict(self) -> Dict[str, Any]:
         id = self.id
         project_id = self.project_id
         team = self.team
+        type = self.type.to_dict()
+
         data_set = self.data_set
         created = self.created
         status = self.status.to_dict()
 
         bounding_box = self.bounding_box
         formatted_hash = self.formatted_hash
         project_name = self.project_name
-        type: Union[Unset, Dict[str, Any]] = UNSET
-        if not isinstance(self.type, Unset):
-            type = self.type.to_dict()
-
         needed_experience: Union[Unset, Dict[str, Any]] = UNSET
         if not isinstance(self.needed_experience, Unset):
             needed_experience = self.needed_experience.to_dict()
@@ -98,6 +96,7 @@ def to_dict(self) -> Dict[str, Any]:
                 "id": id,
                 "projectId": project_id,
                 "team": team,
+                "type": type,
                 "dataSet": data_set,
                 "created": created,
                 "status": status,
@@ -108,8 +107,6 @@ def to_dict(self) -> Dict[str, Any]:
             field_dict["formattedHash"] = formatted_hash
         if project_name is not UNSET:
             field_dict["projectName"] = project_name
-        if type is not UNSET:
-            field_dict["type"] = type
         if needed_experience is not UNSET:
             field_dict["neededExperience"] = needed_experience
         if script is not UNSET:
@@ -144,6 +141,8 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
 
         team = d.pop("team")
 
+        type = AnnotationInfosByTaskIdResponse200ItemTaskType.from_dict(d.pop("type"))
+
         data_set = d.pop("dataSet")
 
         created = d.pop("created")
@@ -158,13 +157,6 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
 
         project_name = d.pop("projectName", UNSET)
 
-        _type = d.pop("type", UNSET)
-        type: Union[Unset, AnnotationInfosByTaskIdResponse200ItemTaskType]
-        if isinstance(_type, Unset):
-            type = UNSET
-        else:
-            type = AnnotationInfosByTaskIdResponse200ItemTaskType.from_dict(_type)
-
         _needed_experience = d.pop("neededExperience", UNSET)
         needed_experience: Union[
             Unset, AnnotationInfosByTaskIdResponse200ItemTaskNeededExperience
@@ -192,13 +184,13 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
             id=id,
             project_id=project_id,
             team=team,
+            type=type,
             data_set=data_set,
             created=created,
             status=status,
             bounding_box=bounding_box,
             formatted_hash=formatted_hash,
             project_name=project_name,
-            type=type,
             needed_experience=needed_experience,
             script=script,
             tracing_time=tracing_time,