|
| 1 | +from .project import DSSProject |
| 2 | + |
| 3 | +class DSSProjectFolder(object): |
| 4 | + """ |
| 5 | + A handle to interact with a project folder on the DSS instance. |
| 6 | +
|
| 7 | + Do not create this class directly, instead use :meth:`dataikuapi.DSSClient.get_project_folder` or :meth:`dataikuapi.DSSClient.get_root_project_folder` |
| 8 | + """ |
| 9 | + def __init__(self, client, project_folder_id): |
| 10 | + self.client = client |
| 11 | + self.project_folder_id = project_folder_id |
| 12 | + |
| 13 | + ######################################################## |
| 14 | + # Project folder basics |
| 15 | + ######################################################## |
| 16 | + def get_name(self): |
| 17 | + """ |
| 18 | + Get this project folder's name or None if it is the root project folder |
| 19 | +
|
| 20 | + :returns str: the name of this project folders or None for the root project folder |
| 21 | + """ |
| 22 | + return self.client._perform_json("GET", "/project-folders/%s" % self.project_folder_id).get("name", None) |
| 23 | + |
| 24 | + def get_path(self): |
| 25 | + """ |
| 26 | + Get this project fodler's path based on the root project folder |
| 27 | +
|
| 28 | + :returns str: the path of this project folder |
| 29 | + """ |
| 30 | + definition = self.client._perform_json("GET", "/project-folders/%s" % self.project_folder_id) |
| 31 | + parent_id = definition.get("parentId", None) |
| 32 | + if parent_id is not None: |
| 33 | + parent = DSSProjectFolder(self.client, parent_id) |
| 34 | + path = parent.get_path() |
| 35 | + return ("" if path == "/" else path) + "/" + definition.get("name", "") |
| 36 | + else: |
| 37 | + return "/" |
| 38 | + |
| 39 | + def get_parent(self): |
| 40 | + """ |
| 41 | + Get this project folder's parent or None if it is the root project folder |
| 42 | +
|
| 43 | + :returns: A :class:`dataikuapi.dss.projectfolders.DSSProjectFolder` to interact with its parent or None for the root project folder |
| 44 | + """ |
| 45 | + parent_id = self.client._perform_json("GET", "/project-folders/%s" % self.project_folder_id).get("parentId", None) |
| 46 | + if parent_id is None: |
| 47 | + return None |
| 48 | + else: |
| 49 | + return DSSProjectFolder(self.client, parent_id) |
| 50 | + |
| 51 | + def list_child_folders(self): |
| 52 | + """ |
| 53 | + List the child project folders inside this project folder |
| 54 | +
|
| 55 | + :returns list: A list of :class:`dataikuapi.dss.projectfolders.DSSProjectFolder` to interact with its sub-folders |
| 56 | + """ |
| 57 | + children = self.client._perform_json("GET", "/project-folders/%s" % self.project_folder_id).get("childrenIds", []) |
| 58 | + return [DSSProjectFolder(self.client, child) for child in children] |
| 59 | + |
| 60 | + def list_project_keys(self): |
| 61 | + """ |
| 62 | + List the project keys of the projects that are stored in this project folder |
| 63 | +
|
| 64 | + :returns list: A list of project keys |
| 65 | + """ |
| 66 | + return self.client._perform_json("GET", "/project-folders/%s" % self.project_folder_id).get("projectKeys", []) |
| 67 | + |
| 68 | + def list_projects(self): |
| 69 | + """ |
| 70 | + List the projects that are stored in this project folder |
| 71 | +
|
| 72 | + :returns list: A list of :class:`dataikuapi.dss.project.DSSProject` to interact with its projects |
| 73 | + """ |
| 74 | + project_keys = self.client._perform_json("GET", "/project-folders/%s" % self.project_folder_id).get("projectKeys", []) |
| 75 | + return [DSSProject(self.client, pkey) for pkey in project_keys] |
| 76 | + |
| 77 | + ######################################################## |
| 78 | + # Project folder deletion |
| 79 | + ######################################################## |
| 80 | + def delete(self): |
| 81 | + """ |
| 82 | + Delete the project folder |
| 83 | + Note: it must be empty (cannot contain any sub-project folders or projects), you must move or remove all its content before deleting it |
| 84 | +
|
| 85 | + This call requires an API key with admin rights |
| 86 | + """ |
| 87 | + return self.client._perform_empty( |
| 88 | + "DELETE", "/project-folders/%s" % self.project_folder_id) |
| 89 | + |
| 90 | + ######################################################## |
| 91 | + # Project folder settings |
| 92 | + ######################################################## |
| 93 | + def get_settings(self): |
| 94 | + """ |
| 95 | + :returns: A :class:`dataikuapi.dss.projectfolder.DSSProjectFolderSettings` to interact with this project folder settings |
| 96 | + """ |
| 97 | + settings = self.client._perform_json("GET", "/project-folders/%s/settings" % self.project_folder_id) |
| 98 | + return DSSProjectFolderSettings(self.client, self.project_folder_id, settings) |
| 99 | + |
| 100 | + ######################################################## |
| 101 | + # Project folder sub-folder creation |
| 102 | + ######################################################## |
| 103 | + def create_sub_folder(self, name): |
| 104 | + """ |
| 105 | + Create a sub-folder into the current project folder |
| 106 | +
|
| 107 | + :param str name: the name of the project folder to create |
| 108 | + :returns: A :class:`dataikuapi.dss.projectfolder.DSSProjectFolder` to interact with the newly created project folder |
| 109 | + """ |
| 110 | + params = { |
| 111 | + "name": name |
| 112 | + } |
| 113 | + pf = self.client._perform_json("POST", "/project-folders/%s/children" % self.project_folder_id, params=params) |
| 114 | + return DSSProjectFolder(self.client, pf["id"]) |
| 115 | + |
| 116 | + ######################################################## |
| 117 | + # Project creation |
| 118 | + ######################################################## |
| 119 | + def create_project(self, project_key, name, owner, description=None, settings=None): |
| 120 | + """ |
| 121 | + Creates a new project within this project folder, and return a project handle to interact with it. |
| 122 | +
|
| 123 | + Note: this call requires an API key with admin rights or the rights to create a project |
| 124 | +
|
| 125 | + :param str project_key: the identifier to use for the project. Must be globally unique |
| 126 | + :param str name: the display name for the project. |
| 127 | + :param str owner: the login of the owner of the project. |
| 128 | + :param str description: a description for the project. |
| 129 | + :param dict settings: Initial settings for the project (can be modified later). The exact possible settings are not documented. |
| 130 | + |
| 131 | + :returns: A class:`dataikuapi.dss.project.DSSProject` project handle to interact with this project |
| 132 | + """ |
| 133 | + return self.client.create_project(project_key, name, owner, description=description, settings=settings, project_folder_id=self.project_folder_id) |
| 134 | + |
| 135 | + ######################################################## |
| 136 | + # Project folder move |
| 137 | + ######################################################## |
| 138 | + def move_to(self, destination): |
| 139 | + """ |
| 140 | + Move this project folder into another project folder (aka. destination) |
| 141 | +
|
| 142 | + :param destination: the project folder to put this project folder into |
| 143 | + :type destination: A :class:`dataikuapi.dss.projectfolders.DSSProjectFolder` |
| 144 | + """ |
| 145 | + params = { |
| 146 | + "destination": destination.project_folder_id |
| 147 | + } |
| 148 | + self.client._perform_empty("POST", "/project-folders/%s/move" % self.project_folder_id, params=params) |
| 149 | + |
| 150 | + ######################################################## |
| 151 | + # Project move |
| 152 | + ######################################################## |
| 153 | + def move_project_to(self, project_key, destination): |
| 154 | + """ |
| 155 | + Move a project within this project folder into another project folder (aka. destination) |
| 156 | +
|
| 157 | + :param str project_key: the project key associated with the project to move |
| 158 | + :param destination: the project folder to put this project into |
| 159 | + :type destination: A :class:`dataikuapi.dss.projectfolders.DSSProjectFolder` |
| 160 | + """ |
| 161 | + params = { |
| 162 | + "destination": destination.project_folder_id |
| 163 | + } |
| 164 | + self.client._perform_empty("POST", "/project-folders/%s/projects/%s/move" % (self.project_folder_id, project_key), params=params) |
| 165 | + |
| 166 | +class DSSProjectFolderSettings(object): |
| 167 | + """ |
| 168 | + A handle to interact with project folder settings |
| 169 | +
|
| 170 | + Do not create this class directly, instead use :meth:`dataikuapi.dss.projectfolder.DSSProjectFolder.get_settings` |
| 171 | + """ |
| 172 | + def __init__(self, client, project_folder_id, settings): |
| 173 | + self.client = client |
| 174 | + self.project_folder_id = project_folder_id |
| 175 | + self.settings = settings |
| 176 | + |
| 177 | + def get_raw(self): |
| 178 | + """Gets all settings as a raw dictionary. This returns a reference to the raw retrieved settings, not a copy, |
| 179 | + so changes made to the returned object will be reflected when saving. |
| 180 | +
|
| 181 | + :rtype: dict |
| 182 | + """ |
| 183 | + return self.settings |
| 184 | + |
| 185 | + def get_name(self): |
| 186 | + """Get the name of the project folder |
| 187 | +
|
| 188 | + :returns str: the current name of the project folder |
| 189 | + """ |
| 190 | + return self.settings.get("name", None) |
| 191 | + |
| 192 | + def set_name(self, name): |
| 193 | + """Set the name of the project folder |
| 194 | +
|
| 195 | + :param str name: the new name of the project folder |
| 196 | + """ |
| 197 | + self.settings["name"] = name |
| 198 | + |
| 199 | + def get_owner(self): |
| 200 | + """Get the login of the owner of the project folder |
| 201 | +
|
| 202 | + :returns str: the current login owner of the project folder |
| 203 | + """ |
| 204 | + return self.settings.get("owner", None) |
| 205 | + |
| 206 | + def set_owner(self, owner): |
| 207 | + """Set the owner of the project folder |
| 208 | +
|
| 209 | + :param str owner: the new owner login of the project folder |
| 210 | + """ |
| 211 | + self.settings["owner"] = owner |
| 212 | + |
| 213 | + def get_permissions(self): |
| 214 | + """Get the permissions of the project folder. This returns a reference to the retrieved permissions, not a copy, |
| 215 | + so changes made to the returned list will be reflected when saving. |
| 216 | +
|
| 217 | + :return list: the current permissions of the project folder |
| 218 | + """ |
| 219 | + return self.settings["permissions"] |
| 220 | + |
| 221 | + def save(self): |
| 222 | + """Saves back the settings to the project folder""" |
| 223 | + self.client._perform_empty("PUT", "/project-folders/%s/settings" % (self.project_folder_id), body = self.settings) |
| 224 | + |
0 commit comments