Add Project and Task Operations (#1294)

* wip add required routes for updates, deletions and creations.

* wip update api client.

* wip Fix typechecking issues.

* Add tests for project and update cassettes.

* wip TaskType operations.

* wip update tasktype class.

* Fix some tests.

* Update tests.

* Add tests and task_type operations.

* Changelog and task operations.

* Add tests for update and delete task.

* format and lint.k

* update command for task list.

* Update docstrings and parameters for settings.

* Add markdown extension for collapsed boxes.

---------

Co-authored-by: Tom Herold <[email protected]>

Author: markbader

docs/mkdocs.yml

@@ -109,6 +109,7 @@ markdown_extensions:
   - attr_list
   - md_in_html
   - footnotes
+  - pymdownx.details
   - pymdownx.highlight
   - pymdownx.inlinehilite
   - pymdownx.superfences

webknossos/Changelog.md

@@ -15,6 +15,22 @@ For upgrade instructions, please check the respective _Breaking Changes_ section
 ### Breaking Changes
 
 ### Added
+- Added operations for `Project`, `Task` and `TaskType` classes and objects: [#1294](https://github.com/scalableminds/webknossos-libs/pull/1294)
+  - Added operations for `Project` class:
+    - `Project.create()` for creating a new project.
+    - `my_project.delete()` to delete a project object
+  - Added `my_project.update()` to update `priority`, `expected_time` and `is_blacklisted_from_report` values of an existing project object.
+  - Added operations for `TaskType` class:
+    - `TaskType.get_list()` to get all `TaskType` objects.
+    - `TaskType.get_by_id()` to get a `TaskType` by id.
+    - `TaskType.get_by_name()` to get a `TaskType` by name.
+    - `TaskType.create()` to create a new `TaskType`.
+  - Added operations `my_task_type.delete()` method for `TaskType` objects.
+  - Added `Task.get_list()`to get all `Task` objects.
+  - Added operations for `Task` objects:
+    - `my_task.update()` to update a `Task` object.
+    - `my_task.delete()` to delete a `Task` object.
+- Added `TaskExperience` class to store domain and value pair.
 
 ### Changed
 
@@ -87,7 +103,6 @@ For upgrade instructions, please check the respective _Breaking Changes_ section
 - Fixed an issue that creates an Error when `add_mag()` was called just with a `chunk_shape`. [#1315](https://github.com/scalableminds/webknossos-libs/pull/1315)
 
 
-
 ## [2.3.8](https://github.com/scalableminds/webknossos-libs/releases/tag/v2.3.8) - 2025-05-28
 [Commits](https://github.com/scalableminds/webknossos-libs/compare/v2.3.7...v2.3.8)
 

webknossos/tests/administration/test_project.py

@@ -0,0 +1,131 @@
+import pytest
+
+import webknossos as wk
+
+pytestmark = [pytest.mark.use_proxay]
+
+
+def test_get_project() -> None:
+    teams = wk.Team.get_list()
+
+    project = wk.Project.create(
+        name="test_get_project",
+        priority=1,
+        paused=False,
+        expected_time=1234,
+        team=teams[0],
+        is_blacklisted_from_report=False,
+    )
+    project_by_name = wk.Project.get_by_name(project.name)
+    assert project_by_name == project
+    project_by_id = wk.Project.get_by_id(project.project_id)
+    assert project_by_id == project
+
+
+def test_project_create() -> None:
+    """Test creating a project."""
+
+    teams = wk.Team.get_list()
+
+    project = wk.Project.create(
+        name="test_create_project",
+        priority=1,
+        paused=False,
+        expected_time=1234,
+        team=teams[0],
+        is_blacklisted_from_report=False,
+    )
+    assert project.name == "test_create_project"
+    assert project.priority == 1
+    assert project.paused is False
+    assert project.expected_time == 1234
+    assert project.team_id == teams[0].id
+    assert project.is_blacklisted_from_report is False
+    assert project.owner_id == wk.User.get_current_user().user_id
+
+
+def test_project_update() -> None:
+    """Test updating a project."""
+    teams = wk.Team.get_list()
+
+    project = wk.Project.create(
+        name="test_update_project",
+        priority=1,
+        paused=False,
+        expected_time=1234,
+        team=teams[0],
+        is_blacklisted_from_report=False,
+    )
+    project = project.update(
+        priority=2,
+        expected_time=5678,
+        is_blacklisted_from_report=True,
+    )
+    assert project.priority == 2
+    assert project.expected_time == 5678
+    assert project.is_blacklisted_from_report is True
+
+
+def test_project_delete() -> None:
+    """Test deleting a project."""
+    teams = wk.Team.get_list()
+
+    project = wk.Project.create(
+        name="test_delete_project",
+        priority=1,
+        paused=False,
+        expected_time=1234,
+        team=teams[0],
+        is_blacklisted_from_report=False,
+    )
+    project.delete()
+    with pytest.raises(Exception):
+        wk.Project.get_by_name("test_delete_project")
+
+
+def test_project_get_owner() -> None:
+    """Test getting the owner of a project."""
+    teams = wk.Team.get_list()
+
+    project = wk.Project.create(
+        name="test_get_owner_project",
+        priority=1,
+        paused=False,
+        expected_time=1234,
+        team=teams[0],
+        is_blacklisted_from_report=False,
+    )
+    owner = project.get_owner()
+    assert owner.user_id == wk.User.get_current_user().user_id
+
+
+def test_project_get_tasks() -> None:
+    """Test getting the task of a project."""
+    teams = wk.Team.get_list()
+    ds_id = wk.Dataset.open_remote("l4_sample")._dataset_id
+
+    project = wk.Project.create(
+        name="test_get_task_project",
+        priority=1,
+        paused=False,
+        expected_time=1234,
+        team=teams[0].id,
+        is_blacklisted_from_report=False,
+    )
+    task_type = wk.TaskType.create(
+        name="test_task_type",
+        description="test_task_type_description",
+        team=teams[0].name,
+        tracing_type="volume",
+    )
+    for i in range(3):
+        wk.Task.create(
+            task_type_id=task_type.task_type_id,
+            project_name=project.name,
+            needed_experience_domain="test_domain",
+            needed_experience_value=3,
+            starting_position=wk.Vec3Int(0, 0, 0),
+            dataset_id=ds_id,
+        )
+
+    assert len(project.get_tasks()) == 3

webknossos/tests/administration/test_task.py

@@ -0,0 +1,114 @@
+from collections.abc import Iterator
+
+import pytest
+
+import webknossos as wk
+from webknossos.client.api_client.errors import UnexpectedStatusError
+
+pytestmark = [pytest.mark.use_proxay]
+
+TEST_PROJECT_NAME = "test_project"
+TEST_TASK_TYPE_NAME = "test_task_type"
+
+
+@pytest.fixture(autouse=True)
+def setup_task_type_and_project() -> Iterator[None]:
+    team = wk.Team.get_list()[0]
+    task_type = wk.TaskType.create(
+        name="test_task_type",
+        description="This is a test task type",
+        team=team,
+        tracing_type="volume",
+    )
+    project = wk.Project.create(
+        name=TEST_PROJECT_NAME,
+        priority=1,
+        paused=False,
+        expected_time=1234,
+        team=team,
+        is_blacklisted_from_report=False,
+    )
+    yield
+    task_type.delete()
+    project.delete()
+
+
+def test_get_task() -> None:
+    tasks = wk.Task.create(
+        task_type_id=wk.TaskType.get_by_name(TEST_TASK_TYPE_NAME).task_type_id,
+        project_name=TEST_PROJECT_NAME,
+        needed_experience_domain="testing",
+        needed_experience_value=0,
+        starting_position=wk.Vec3Int(0, 0, 0),
+        dataset_id=wk.Dataset.open_remote("l4_sample")._dataset_id,
+    )
+    task_by_id = wk.Task.get_by_id(tasks[0].task_id)
+    assert task_by_id == tasks[0]
+
+
+def test_task_get_project() -> None:
+    tasks = wk.Task.create(
+        task_type_id=wk.TaskType.get_by_name(TEST_TASK_TYPE_NAME).task_type_id,
+        project_name=TEST_PROJECT_NAME,
+        needed_experience_domain="testing",
+        needed_experience_value=0,
+        starting_position=wk.Vec3Int(0, 0, 0),
+        dataset_id=wk.Dataset.open_remote("l4_sample")._dataset_id,
+    )
+    project = tasks[0].get_project()
+    assert project.name == TEST_PROJECT_NAME
+
+
+def test_get_task_type() -> None:
+    task_type_by_name = wk.TaskType.get_by_name(TEST_TASK_TYPE_NAME)
+    assert task_type_by_name.name == TEST_TASK_TYPE_NAME
+
+    task_type_by_id = wk.TaskType.get_by_id(task_type_by_name.task_type_id)
+    assert task_type_by_id == task_type_by_name
+
+
+def test_update_task() -> None:
+    tasks = wk.Task.create(
+        task_type_id=wk.TaskType.get_by_name(TEST_TASK_TYPE_NAME).task_type_id,
+        project_name=TEST_PROJECT_NAME,
+        needed_experience_domain="testing",
+        needed_experience_value=0,
+        starting_position=wk.Vec3Int(0, 0, 0),
+        dataset_id=wk.Dataset.open_remote("l4_sample")._dataset_id,
+    )
+    task = tasks[0]
+    updated = task.update(
+        remaining_instances=4,
+    )
+    assert updated.status.pending_instance_count == 4
+
+
+def test_delete_task() -> None:
+    tasks = wk.Task.create(
+        task_type_id=wk.TaskType.get_by_name(TEST_TASK_TYPE_NAME).task_type_id,
+        project_name=TEST_PROJECT_NAME,
+        needed_experience_domain="testing",
+        needed_experience_value=0,
+        starting_position=wk.Vec3Int(0, 0, 0),
+        dataset_id=wk.Dataset.open_remote("l4_sample")._dataset_id,
+    )
+    task = tasks[0]
+    task.delete()
+    with pytest.raises(UnexpectedStatusError):
+        wk.Task.get_by_id(
+            task.task_id
+        )  # Should raise KeyError since the task is deleted
+
+
+def test_task_list() -> None:
+    tasks = wk.Task.create(
+        task_type_id=wk.TaskType.get_by_name(TEST_TASK_TYPE_NAME).task_type_id,
+        project_name=TEST_PROJECT_NAME,
+        needed_experience_domain="testing",
+        needed_experience_value=0,
+        starting_position=wk.Vec3Int(0, 0, 0),
+        dataset_id=wk.Dataset.open_remote("l4_sample")._dataset_id,
+    )
+    task_list = wk.Task.get_list()
+    assert len(task_list) > 0
+    assert tasks[0] in task_list