Folder

synapseclient.entity.Folder

Bases: Entity

Represents a folder in Synapse.

Folders must have a name and a parent and can optionally have annotations.

ATTRIBUTE	DESCRIPTION
name	The name of the folder
parent	The parent project or folder
properties	A map of Synapse properties
annotations	A map of user defined annotations
local_state	Internal use only

Using this class

Creating an instance and storing the folder

folder = Folder(name='my data', parent=project)
folder = syn.store(folder)

Source code in synapseclient/entity.py

class Folder(Entity):
    """
    Represents a folder in Synapse.

    Folders must have a name and a parent and can optionally have annotations.

    Attributes:
        name: The name of the folder
        parent: The parent project or folder
        properties: A map of Synapse properties
        annotations: A map of user defined annotations
        local_state: Internal use only

    Example: Using this class
        Creating an instance and storing the folder

            folder = Folder(name='my data', parent=project)
            folder = syn.store(folder)
    """

    _synapse_entity_type = "org.sagebionetworks.repo.model.Folder"

    def __init__(
        self,
        name=None,
        parent=None,
        properties=None,
        annotations=None,
        local_state=None,
        **kwargs,
    ):
        if name:
            kwargs["name"] = name
        super(Folder, self).__init__(
            concreteType=Folder._synapse_entity_type,
            properties=properties,
            annotations=annotations,
            local_state=local_state,
            parent=parent,
            **kwargs,
        )