minor updates & read-only fixes (#866)

* update generated client

* bump recommended poetry version

* minor read-only changes

* add changelog entries

* minor fix to ensure correct usage of suffixes

Author: jstriebel

requirements.txt

@@ -1,2 +1,2 @@
 dunamai==1.6.0
-poetry==1.1.14
+poetry==1.3.2

webknossos/Changelog.md

@@ -15,12 +15,13 @@ For upgrade instructions, please check the respective *Breaking Changes* section
 ### Breaking Changes
 
 ### Added
+- Added `read_only` parameter for `annotation.temporary_volume_layer_copy`. [#866](https://github.com/scalableminds/webknossos-libs/pull/866)
 
 ### Changed
 
 ### Fixed
-
 - Fixed a bug where some czi, dm3, dm4 images could not be converted to wkw due to a too-strict check. [#865](https://github.com/scalableminds/webknossos-libs/pull/865)
+- Enforce `read_only` property of datasets also for down- and upsampling. [#866](https://github.com/scalableminds/webknossos-libs/pull/866)
 
 
 ## [0.12.0](https://github.com/scalableminds/webknossos-libs/releases/tag/v0.12.0) - 2023-02-10

webknossos/webknossos/annotation/annotation.py

@@ -784,6 +784,7 @@ def temporary_volume_layer_copy(
         self,
         volume_layer_name: Optional[str] = None,
         volume_layer_id: Optional[int] = None,
+        read_only: bool = True,
     ) -> Iterator[SegmentationLayer]:
 
         """
@@ -809,7 +810,7 @@ def temporary_volume_layer_copy(
                 volume_layer_id=volume_layer_id,
             )
 
-            input_annotation_dataset._read_only = True
+            input_annotation_dataset._read_only = read_only
 
             yield input_annotation_layer
 

webknossos/webknossos/client/_generated/__init__.py

@@ -1,2 +1,7 @@
 """ A client library for accessing webknossos """
 from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

webknossos/webknossos/client/_generated/api/datastore/dataset_cancel_upload.py

@@ -1,3 +1,4 @@
+from http import HTTPStatus
 from typing import Any, Dict, Union
 
 import httpx
@@ -15,17 +16,18 @@ def _get_kwargs(
 ) -> Dict[str, Any]:
     url = "{}/data/datasets/cancelUpload".format(client.base_url)
 
-    headers: Dict[str, Any] = client.get_headers()
+    headers: Dict[str, str] = client.get_headers()
     cookies: Dict[str, Any] = client.get_cookies()
 
-    params: Dict[str, Any] = {
-        "token": token,
-    }
+    params: Dict[str, Any] = {}
+    params["token"] = token
+
     params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
 
     json_json_body = json_body.to_dict()
 
     return {
+        "method": "post",
         "url": url,
         "headers": headers,
         "cookies": cookies,
@@ -37,7 +39,7 @@ def _get_kwargs(
 
 def _build_response(*, response: httpx.Response) -> Response[Any]:
     return Response(
-        status_code=response.status_code,
+        status_code=HTTPStatus(response.status_code),
         content=response.content,
         headers=response.headers,
         parsed=None,
@@ -50,13 +52,29 @@ def sync_detailed(
     json_body: DatasetCancelUploadJsonBody,
     token: Union[Unset, None, str] = UNSET,
 ) -> Response[Any]:
+    """Cancel a running dataset upload
+    Expects:
+     - As JSON object body with keys:
+      - uploadId (string): upload id that was also used in chunk upload (this time without file paths)
+     - As GET parameter:
+      - token (string): datastore token identifying the uploading user
+
+    Args:
+        token (Union[Unset, None, str]):
+        json_body (DatasetCancelUploadJsonBody):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         client=client,
         json_body=json_body,
         token=token,
     )
 
-    response = httpx.post(
+    response = httpx.request(
+        verify=client.verify_ssl,
         **kwargs,
     )
 
@@ -69,13 +87,28 @@ async def asyncio_detailed(
     json_body: DatasetCancelUploadJsonBody,
     token: Union[Unset, None, str] = UNSET,
 ) -> Response[Any]:
+    """Cancel a running dataset upload
+    Expects:
+     - As JSON object body with keys:
+      - uploadId (string): upload id that was also used in chunk upload (this time without file paths)
+     - As GET parameter:
+      - token (string): datastore token identifying the uploading user
+
+    Args:
+        token (Union[Unset, None, str]):
+        json_body (DatasetCancelUploadJsonBody):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         client=client,
         json_body=json_body,
         token=token,
     )
 
-    async with httpx.AsyncClient() as _client:
-        response = await _client.post(**kwargs)
+    async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
+        response = await _client.request(**kwargs)
 
     return _build_response(response=response)

webknossos/webknossos/client/_generated/api/datastore/dataset_download.py

@@ -1,3 +1,4 @@
+from http import HTTPStatus
 from typing import Any, Dict, Union
 
 import httpx
@@ -30,24 +31,34 @@ def _get_kwargs(
         dataLayerName=data_layer_name,
     )
 
-    headers: Dict[str, Any] = client.get_headers()
+    headers: Dict[str, str] = client.get_headers()
     cookies: Dict[str, Any] = client.get_cookies()
 
-    params: Dict[str, Any] = {
-        "token": token,
-        "x": x,
-        "y": y,
-        "z": z,
-        "width": width,
-        "height": height,
-        "depth": depth,
-        "mag": mag,
-        "halfByte": half_byte,
-        "mappingName": mapping_name,
-    }
+    params: Dict[str, Any] = {}
+    params["token"] = token
+
+    params["x"] = x
+
+    params["y"] = y
+
+    params["z"] = z
+
+    params["width"] = width
+
+    params["height"] = height
+
+    params["depth"] = depth
+
+    params["mag"] = mag
+
+    params["halfByte"] = half_byte
+
+    params["mappingName"] = mapping_name
+
     params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
 
     return {
+        "method": "get",
         "url": url,
         "headers": headers,
         "cookies": cookies,
@@ -58,7 +69,7 @@ def _get_kwargs(
 
 def _build_response(*, response: httpx.Response) -> Response[Any]:
     return Response(
-        status_code=response.status_code,
+        status_code=HTTPStatus(response.status_code),
         content=response.content,
         headers=response.headers,
         parsed=None,
@@ -82,6 +93,27 @@ def sync_detailed(
     half_byte: Union[Unset, None, bool] = False,
     mapping_name: Union[Unset, None, str] = UNSET,
 ) -> Response[Any]:
+    """Get raw binary data from a bounding box in a dataset layer
+
+    Args:
+        organization_name (str):
+        data_set_name (str):
+        data_layer_name (str):
+        token (Union[Unset, None, str]):
+        x (int):
+        y (int):
+        z (int):
+        width (int):
+        height (int):
+        depth (int):
+        mag (str):
+        half_byte (Union[Unset, None, bool]):
+        mapping_name (Union[Unset, None, str]):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         organization_name=organization_name,
         data_set_name=data_set_name,
@@ -99,7 +131,8 @@ def sync_detailed(
         mapping_name=mapping_name,
     )
 
-    response = httpx.get(
+    response = httpx.request(
+        verify=client.verify_ssl,
         **kwargs,
     )
 
@@ -123,6 +156,27 @@ async def asyncio_detailed(
     half_byte: Union[Unset, None, bool] = False,
     mapping_name: Union[Unset, None, str] = UNSET,
 ) -> Response[Any]:
+    """Get raw binary data from a bounding box in a dataset layer
+
+    Args:
+        organization_name (str):
+        data_set_name (str):
+        data_layer_name (str):
+        token (Union[Unset, None, str]):
+        x (int):
+        y (int):
+        z (int):
+        width (int):
+        height (int):
+        depth (int):
+        mag (str):
+        half_byte (Union[Unset, None, bool]):
+        mapping_name (Union[Unset, None, str]):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         organization_name=organization_name,
         data_set_name=data_set_name,
@@ -140,7 +194,7 @@ async def asyncio_detailed(
         mapping_name=mapping_name,
     )
 
-    async with httpx.AsyncClient() as _client:
-        response = await _client.get(**kwargs)
+    async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
+        response = await _client.request(**kwargs)
 
     return _build_response(response=response)

webknossos/webknossos/client/_generated/api/datastore/dataset_finish_upload.py

@@ -1,3 +1,4 @@
+from http import HTTPStatus
 from typing import Any, Dict, Union
 
 import httpx
@@ -15,17 +16,18 @@ def _get_kwargs(
 ) -> Dict[str, Any]:
     url = "{}/data/datasets/finishUpload".format(client.base_url)
 
-    headers: Dict[str, Any] = client.get_headers()
+    headers: Dict[str, str] = client.get_headers()
     cookies: Dict[str, Any] = client.get_cookies()
 
-    params: Dict[str, Any] = {
-        "token": token,
-    }
+    params: Dict[str, Any] = {}
+    params["token"] = token
+
     params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
 
     json_json_body = json_body.to_dict()
 
     return {
+        "method": "post",
         "url": url,
         "headers": headers,
         "cookies": cookies,
@@ -37,7 +39,7 @@ def _get_kwargs(
 
 def _build_response(*, response: httpx.Response) -> Response[Any]:
     return Response(
-        status_code=response.status_code,
+        status_code=HTTPStatus(response.status_code),
         content=response.content,
         headers=response.headers,
         parsed=None,
@@ -50,13 +52,33 @@ def sync_detailed(
     json_body: DatasetFinishUploadJsonBody,
     token: Union[Unset, None, str] = UNSET,
 ) -> Response[Any]:
+    """Finish dataset upload, call after all chunks have been uploaded via uploadChunk
+    Expects:
+     - As JSON object body with keys:
+      - uploadId (string): upload id that was also used in chunk upload (this time without file paths)
+      - organization (string): owning organization name
+      - name (string): dataset name
+      - needsConversion (boolean): mark as true for non-wkw datasets. They are stored differently and a
+    conversion job can later be run.
+     - As GET parameter:
+      - token (string): datastore token identifying the uploading user
+
+    Args:
+        token (Union[Unset, None, str]):
+        json_body (DatasetFinishUploadJsonBody):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         client=client,
         json_body=json_body,
         token=token,
     )
 
-    response = httpx.post(
+    response = httpx.request(
+        verify=client.verify_ssl,
         **kwargs,
     )
 
@@ -69,13 +91,32 @@ async def asyncio_detailed(
     json_body: DatasetFinishUploadJsonBody,
     token: Union[Unset, None, str] = UNSET,
 ) -> Response[Any]:
+    """Finish dataset upload, call after all chunks have been uploaded via uploadChunk
+    Expects:
+     - As JSON object body with keys:
+      - uploadId (string): upload id that was also used in chunk upload (this time without file paths)
+      - organization (string): owning organization name
+      - name (string): dataset name
+      - needsConversion (boolean): mark as true for non-wkw datasets. They are stored differently and a
+    conversion job can later be run.
+     - As GET parameter:
+      - token (string): datastore token identifying the uploading user
+
+    Args:
+        token (Union[Unset, None, str]):
+        json_body (DatasetFinishUploadJsonBody):
+
+    Returns:
+        Response[Any]
+    """
+
     kwargs = _get_kwargs(
         client=client,
         json_body=json_body,
         token=token,
     )
 
-    async with httpx.AsyncClient() as _client:
-        response = await _client.post(**kwargs)
+    async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
+        response = await _client.request(**kwargs)
 
     return _build_response(response=response)