organization_id to organization_name (#639)

* change all occurences to organization_id

* add changelog entry

* add change to webknossos context

* run generate_client

* changing test usage back'

Author: leowe

webknossos/Changelog.md

@@ -13,6 +13,7 @@ For upgrade instructions, please check the respective *Breaking Changes* section
 [Commits](https://github.com/scalableminds/webknossos-libs/compare/v0.9.12...HEAD)
 
 ### Breaking Changes
+- Consistently rename `organization_name` parameters to `organization_id` (except in deprecated `webknossos.client.download_dataset`). [#639](https://github.com/scalableminds/webknossos-libs/pull/639)
 
 ### Added
 

webknossos/__generate_client.py

@@ -85,7 +85,7 @@ def iterate_request_ids_with_responses() -> Iterable[Tuple[str, bytes]]:
     from webknossos.client.context import _get_generated_client
     from webknossos.utils import snake_to_camel_case
 
-    organization_name = "Organization_X"
+    organization_id = "Organization_X"
     dataset_name = "e2006_knossos"
     task_id = "581367a82faeb37a008a5352"
     user_id = "570b9f4d2a7c0e4d008da6ef"
@@ -99,12 +99,12 @@ def iterate_request_ids_with_responses() -> Iterable[Tuple[str, bytes]]:
         )
     )
     response = httpx.get(
-        url=f"{WK_URL}/api/datasets/{organization_name}/{dataset_name}",
+        url=f"{WK_URL}/api/datasets/{organization_id}/{dataset_name}",
         headers={"X-Auth-Token": f"{WK_TOKEN}"},
     )
     assert (
         response.status_code == 200 and response.json()["isActive"]
-    ), f"You need to copy or link any dataset to binaryData/{organization_name}/{dataset_name}."
+    ), f"You need to copy or link any dataset to binaryData/{organization_id}/{dataset_name}."
 
     d = datetime.utcnow()
     unixtime = calendar.timegm(d.utctimetuple())
@@ -126,7 +126,7 @@ def iterate_request_ids_with_responses() -> Iterable[Tuple[str, bytes]]:
         "datasetInfo",
         extract_200_response(
             dataset_info.sync_detailed(
-                organization_name=organization_name,
+                organization_name=organization_id,
                 data_set_name=dataset_name,
                 client=client,
             )

webknossos/examples/apply_merger_mode.py

@@ -93,7 +93,7 @@ def apply_mapping_for_chunk(args: Tuple[wk.View, wk.View, int]) -> None:
                 wk.LayerToLink(
                     dataset_name="l4_sample_dev",
                     layer_name="color",
-                    organization_name="scalable_minds",
+                    organization_id="scalable_minds",
                 )
             ],
         )

webknossos/examples/download_image_data.py

@@ -16,7 +16,7 @@ def main() -> None:
     # Download the datset
     ds = wk.Dataset.download(
         dataset_name=name,
-        organization_name=organization,
+        organization_id=organization,
         bbox=bbox,
         layers=layers,
         mags=mags,

webknossos/examples/learned_segmenter.py

@@ -24,7 +24,7 @@ def main() -> None:
     new_dataset_name = annotation.dataset_name + f"_segmented_{time_str}"
     dataset = wk.Dataset.download(
         annotation.dataset_name,
-        organization_name="scalable_minds",
+        organization_id="scalable_minds",
         path=new_dataset_name,
         webknossos_url="https://webknossos.org",
     )
@@ -77,7 +77,7 @@ def main() -> None:
     url = dataset.upload(
         layers_to_link=[
             wk.LayerToLink(
-                organization_name="scalable_minds",
+                organization_id="scalable_minds",
                 dataset_name=annotation.dataset_name,
                 layer_name="color",
             )

webknossos/tests/client/test_context.py

@@ -12,4 +12,4 @@ def env_context() -> _WebknossosContext:
 
 
 def test_user_organization(env_context: _WebknossosContext) -> None:
-    assert env_context.organization == "Organization_X"
+    assert env_context.organization_id == "Organization_X"

webknossos/webknossos/administration/user.py

@@ -30,7 +30,7 @@ class User:
 
     user_id: str
     email: str
-    organization: str
+    organization_id: str
     first_name: str
     last_name: str
     created: int
@@ -68,7 +68,7 @@ def _from_generated_response(
         return cls(
             user_id=response.id,
             email=response.email,
-            organization=response.organization,
+            organization_id=response.organization,
             first_name=response.first_name,
             last_name=response.last_name,
             created=response.created,

webknossos/webknossos/client/_download_dataset.py

@@ -23,7 +23,7 @@
 
 def download_dataset(
     dataset_name: str,
-    organization_name: Optional[str] = None,
+    organization_id: Optional[str] = None,
     bbox: Optional[BoundingBox] = None,
     layers: Optional[List[str]] = None,
     mags: Optional[List[Mag]] = None,
@@ -33,11 +33,11 @@ def download_dataset(
     client = _get_generated_client()
     context = _get_context()
 
-    if organization_name is None:
-        organization_name = context.organization
+    if organization_id is None:
+        organization_id = context.organization_id
 
     dataset_info_response = dataset_info.sync_detailed(
-        organization_name=organization_name,
+        organization_name=organization_id,
         data_set_name=dataset_name,
         client=client,
     )
@@ -108,7 +108,7 @@ def download_dataset(
             ):
                 chunk_in_mag = chunk.in_mag(mag)
                 response = dataset_download.sync_detailed(
-                    organization_name=organization_name,
+                    organization_name=organization_id,
                     data_set_name=dataset_name,
                     data_layer_name=layer_name,
                     resolution=mag.max_dim_log2,

webknossos/webknossos/client/_generated/models/__init__.py

@@ -119,9 +119,6 @@
 from .dataset_info_response_200_data_source_data_layers_item_bounding_box import (
     DatasetInfoResponse200DataSourceDataLayersItemBoundingBox,
 )
-from .dataset_info_response_200_data_source_data_layers_item_default_view_configuration import (
-    DatasetInfoResponse200DataSourceDataLayersItemDefaultViewConfiguration,
-)
 from .dataset_info_response_200_data_source_id import DatasetInfoResponse200DataSourceId
 from .dataset_info_response_200_data_store import DatasetInfoResponse200DataStore
 from .dataset_reserve_upload_json_body import DatasetReserveUploadJsonBody

webknossos/webknossos/client/_generated/models/dataset_info_response_200_data_source.py

@@ -18,7 +18,7 @@ class DatasetInfoResponse200DataSource:
 
     id: DatasetInfoResponse200DataSourceId
     data_layers: List[DatasetInfoResponse200DataSourceDataLayersItem]
-    scale: List[int]
+    scale: List[float]
     additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
 
     def to_dict(self) -> Dict[str, Any]:
@@ -58,7 +58,7 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
 
             data_layers.append(data_layers_item)
 
-        scale = cast(List[int], d.pop("scale"))
+        scale = cast(List[float], d.pop("scale"))
 
         dataset_info_response_200_data_source = cls(
             id=id,