Merge pull request #772 from simvue-io/feature/set-folder-details

Add `read_only` parameter to `Client.get_folder`

Author: kzscisoft

simvue/client.py

@@ -631,7 +631,9 @@ def get_artifacts_as_files(
     @prettify_pydantic
     @pydantic.validate_call
     def get_folder(
-        self, folder_path: typing.Annotated[str, pydantic.Field(pattern=FOLDER_REGEX)]
+        self,
+        folder_path: typing.Annotated[str, pydantic.Field(pattern=FOLDER_REGEX)],
+        read_only: bool = True,
     ) -> Folder | None:
         """Retrieve a folder by identifier
 
@@ -640,6 +642,10 @@ def get_folder(
         folder_path : str
             the path of the folder to retrieve on the server.
             Paths are prefixed with `/`
+        read_only : bool, optional
+            whether the returned object should be editable or not,
+            default is True, the object is a cached copy of data
+            from the server.
 
         Returns
         -------
@@ -657,6 +663,8 @@ def get_folder(
 
         try:
             _, _folder = next(_folders)
+            if not read_only:
+                _folder.read_only(read_only)
             return _folder
         except StopIteration:
             return None