Skip to content

webknossos.dataset

RemoteFolder

This class is used to access and edit metadata of a folder on the webknossos server.

allowed_teams property writable 

allowed_teams: tuple[Team, ...]

Teams that are allowed to access this folder. Controls which teams have read access to view and use this folder, as well as its datasets. Changes are immediately synchronized with WEBKNOSSOS.

Returns:

  • tuple[Team, ...] –

    tuple[Team, ...]: Teams currently having access

id instance-attribute 

id: str

metadata property writable 

metadata: FolderMetadata

name property writable 

name: str

The name for the folder in the WEBKNOSSOS interface. Changes are immediately synchronized with WEBKNOSSOS.

parent property writable 

parent: RemoteFolder | None

The parent folder of the folder in the WEBKNOSSOS interface.

add_subfolder 

add_subfolder(name: str) -> RemoteFolder

Adds a new folder with the specified name.

delete 

delete() -> None

Deletes the folder.

get_by_id classmethod 

get_by_id(folder_id: str) -> RemoteFolder

Returns the folder specified by the passed id.

get_by_path classmethod 

get_by_path(path: str) -> RemoteFolder

Returns the folder specified by the passed path. Separate multiple folder names with a slash.

get_datasets 

get_datasets() -> Mapping[str, RemoteDataset]

Returns all datasets in this folder.

get_root classmethod 

get_root() -> RemoteFolder

Returns the root folder of the current organization.

get_subfolders 

get_subfolders() -> tuple[RemoteFolder, ...]

Returns all subfolders in this folder.

move_to 

move_to(new_parent: RemoteFolder) -> RemoteFolder

Deprecated. Use RemoteFolder.parent instead. Move the folder to a new parent folder.

This method returns a new RemoteFolder instance representing the moved folder. The original RemoteFolder object is not modified, so you should use the returned value.

Parameters:

Returns:

  • RemoteFolder –

    A new RemoteFolder instance in the new location.