Skip to content

Commit

Permalink
lock and unlock_permissions() now return back an object - if no actio…
Browse files Browse the repository at this point in the history 
…n, the same object, but if there is an update you actually end up with a new object that should replace what you were using previously
  • Loading branch information
Bryant Howell committed Jan 6, 2020
1 parent 4f44efc commit d520289
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 20 deletions.
9 changes: 6 additions & 3 deletions tableau_rest_api/methods/project.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,9 @@ def update_project(self, name_or_luid: str, new_project_name: Optional[str] = No
url += '?publishSamples=true'

response = self.send_update_request(url, tsr)
proj_xml_obj = response.findall(".//t:project", TableauRestXml.ns_map)[0]
self.end_log_block()
return self.get_published_project_object(project_name_or_luid=project_luid, project_xml_obj=response)
return self.get_published_project_object(project_name_or_luid=project_luid, project_xml_obj=proj_xml_obj)

def delete_projects(self, project_name_or_luid_s: Union[List[str], str]):
self.start_log_block()
Expand Down Expand Up @@ -251,8 +252,9 @@ def update_project(self, name_or_luid: str, parent_project_name_or_luid: Optiona
url += '?publishSamples=true'

response = self.send_update_request(url, tsr)
proj_xml_obj = response.findall(".//t:project", TableauRestXml.ns_map)[0]
self.end_log_block()
return self.get_published_project_object(project_name_or_luid=project_luid, project_xml_obj=response)
return self.get_published_project_object(project_name_or_luid=project_luid, project_xml_obj=proj_xml_obj)

def query_project(self, project_name_or_luid: str) -> Project28:

Expand Down Expand Up @@ -378,8 +380,9 @@ def update_project(self, name_or_luid: str, parent_project_name_or_luid: Optiona
url += '?publishSamples=true'

response = self.send_update_request(url, tsr)
proj_xml_obj = response.findall(".//t:project", TableauRestXml.ns_map)[0]
self.end_log_block()
return self.get_published_project_object(project_name_or_luid=project_luid, project_xml_obj=response)
return self.get_published_project_object(project_name_or_luid=project_luid, project_xml_obj=proj_xml_obj)

class ProjectMethods34(ProjectMethods33):
def __init__(self, rest_api_base: TableauRestApiBase34):
Expand Down
100 changes: 83 additions & 17 deletions tableau_rest_api/published_content.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,11 @@ def __init__(self, luid: str, obj_type: str, tableau_rest_api_obj: Union['Tablea
self.current_perms_obj_list: Optional[List[Permissions]] = None
self.__permissionable_objects = self.permissionable_objects
self.get_permissions_from_server()
self.xml_obj = content_xml_obj
#self.log('Creating a Published Project Object from this XML:')
#self.log_xml_response(content_xml_obj)
self.api_version = tableau_rest_api_obj.api_version
self.permissions_object_class = ProjectPermissions # Override in any child class with specific

self.xml_obj = content_xml_obj
# If you want to know the name that matches to the group or user, need these
# But no need to request every single time
# self.groups_dict_cache = None
Expand Down Expand Up @@ -660,7 +661,7 @@ def convert_capabilities_xml_into_obj_list(xml_obj: ET.Element) -> List['Datasou

class Datasource28(Datasource):
def __init__(self, luid: str, tableau_rest_api_obj: Union['TableauRestApiConnection', 'TableauServerRest'],
default: bool = False, logger_obj: Optional[Logger] = None,
default: bool = False, logger_obj: Optional['Logger'] = None,
content_xml_obj: Optional[ET.Element] = None):
Datasource.__init__(self, luid=luid, tableau_rest_api_obj=tableau_rest_api_obj,
default=default, logger_obj=logger_obj, content_xml_obj=content_xml_obj)
Expand All @@ -674,7 +675,7 @@ def get_permissions_obj(self, group_name_or_luid: Optional[str] = None, username

class View(PublishedContent):
def __init__(self, luid: str, tableau_rest_api_obj: Union['TableauRestApiConnection', 'TableauServerRest'],
default: bool = False, logger_obj: Optional[Logger] = None,
default: bool = False, logger_obj: Optional['Logger'] = None,
content_xml_obj: Optional[ET.Element] = None):
PublishedContent.__init__(self, luid, "view", tableau_rest_api_obj,
default=default, logger_obj=logger_obj, content_xml_obj=content_xml_obj)
Expand Down Expand Up @@ -766,11 +767,13 @@ def get_permissions_obj(self, group_name_or_luid: Optional[str] = None, username

class Project(PublishedContent):
def __init__(self, luid: str, tableau_rest_api_obj: Union['TableauRestApiConnection', 'TableauServerRest'],
logger_obj: Optional[Logger] = None, content_xml_obj: Optional[ET.Element] = None):
logger_obj: Optional['Logger'] = None, content_xml_obj: Optional[ET.Element] = None):
PublishedContent.__init__(self, luid=luid, obj_type="project", tableau_rest_api_obj=tableau_rest_api_obj,
logger_obj=logger_obj, content_xml_obj=content_xml_obj)
self.log('Building Project object from this XML: ')
self.log_xml_response(content_xml_obj)
self.log('Project object has this XML: ')
self.log_xml_response(self.xml_obj)
# projects in 9.2 have child workbook and datasource permissions
self._workbook_defaults = Workbook(self.luid, self.t_rest_api,
default=True, logger_obj=logger_obj)
Expand Down Expand Up @@ -951,26 +954,33 @@ def are_permissions_locked(self) -> bool:
mapping = {'ManagedByOwner' : False, 'LockedToProject': True}
return mapping[locked_permissions]

def lock_permissions(self):
def lock_permissions(self) -> 'Project':
self.start_log_block()
if self.permissions_locked is False:
# This allows type checking without importing the class
if(type(self.t_rest_api).__name__.find('TableauRestApiConnection') != -1):
self.t_rest_api.update_project(self.luid, locked_permissions=True)
new_proj_obj = self.t_rest_api.update_project(self.luid, locked_permissions=True)
else:
self.t_rest_api.projects.update_project(self.luid, locked_permissions=True)
self.end_log_block()
new_proj_obj = self.t_rest_api.projects.update_project(self.luid, locked_permissions=True)
self.end_log_block()
return new_proj_obj
else:
self.end_log_block()
return self

def unlock_permissions(self):
def unlock_permissions(self) -> 'Project':
self.start_log_block()
if self.permissions_locked is True:
# This allows type checking without importing the class
if(type(self.t_rest_api).__name__.find('TableauRestApiConnection') != -1):
self.t_rest_api.update_project(self.luid, locked_permissions=False)
new_proj_obj = self.t_rest_api.update_project(self.luid, locked_permissions=False)
else:
self.t_rest_api.projects.update_project(self.luid, locked_permissions=False)

self.end_log_block()
new_proj_obj = self.t_rest_api.projects.update_project(self.luid, locked_permissions=False)
self.end_log_block()
return new_proj_obj
else:
self.end_log_block()
return self

# These are speciality methods just for exporting everything out for audit
def query_all_permissions(self) -> Dict:
Expand Down Expand Up @@ -1037,10 +1047,10 @@ def convert_all_permissions_to_list(self, all_permissions: Dict):

class Project28(Project):
def __init__(self, luid: str, tableau_rest_api_obj: Union['TableauRestApiConnection', 'TableauServerRest'],
logger_obj: Optional[Logger] = None,
logger_obj: Optional['Logger'] = None,
content_xml_obj: Optional[ET.Element] = None, parent_project_luid: Optional[str] = None):
Project.__init__(self, luid=luid, tableau_rest_api_obj=tableau_rest_api_obj, logger_obj=logger_obj,
content_xml_obj=content_xml_obj)
content_xml_obj=content_xml_obj)
self._parent_project_luid = parent_project_luid
self.permissions_object_class = ProjectPermissions28

Expand All @@ -1064,6 +1074,34 @@ def query_child_projects(self) -> ET.Element:
self.end_log_block()
return child_projects

def lock_permissions(self) -> 'Project28':
self.start_log_block()
if self.permissions_locked is False:
# This allows type checking without importing the class
if(type(self.t_rest_api).__name__.find('TableauRestApiConnection') != -1):
new_proj_obj = self.t_rest_api.update_project(self.luid, locked_permissions=True)
else:
new_proj_obj = self.t_rest_api.projects.update_project(self.luid, locked_permissions=True)
self.end_log_block()
return new_proj_obj
else:
self.end_log_block()
return self

def unlock_permissions(self) -> 'Project28':
self.start_log_block()
if self.permissions_locked is True:
# This allows type checking without importing the class
if(type(self.t_rest_api).__name__.find('TableauRestApiConnection') != -1):
new_proj_obj = self.t_rest_api.update_project(self.luid, locked_permissions=False)
else:
new_proj_obj = self.t_rest_api.projects.update_project(self.luid, locked_permissions=False)
self.end_log_block()
return new_proj_obj
else:
self.end_log_block()
return self

@staticmethod
def convert_capabilities_xml_into_obj_list(xml_obj: ET.Element) -> List['ProjectPermissions']:
# self.start_log_block()
Expand Down Expand Up @@ -1127,12 +1165,40 @@ def create_datasource_permissions_object_for_user(self, username_or_luid: str,

class Project33(Project28):
def __init__(self, luid: str, tableau_rest_api_obj: Union['TableauRestApiConnection', 'TableauServerRest'],
logger_obj: Optional[Logger] = None, content_xml_obj: Optional[ET.Element] = None,
logger_obj: Optional['Logger'] = None, content_xml_obj: Optional[ET.Element] = None,
parent_project_luid:str = None):
Project28.__init__(self, luid=luid, tableau_rest_api_obj=tableau_rest_api_obj, logger_obj=logger_obj,
content_xml_obj=content_xml_obj, parent_project_luid=parent_project_luid)
self.flow_defaults = Flow33(self.luid, self.t_rest_api, default=True, logger_obj=logger_obj)

def lock_permissions(self) -> 'Project33':
self.start_log_block()
if self.permissions_locked is False:
# This allows type checking without importing the class
if(type(self.t_rest_api).__name__.find('TableauRestApiConnection') != -1):
new_proj_obj = self.t_rest_api.update_project(self.luid, locked_permissions=True)
else:
new_proj_obj = self.t_rest_api.projects.update_project(self.luid, locked_permissions=True)
self.end_log_block()
return new_proj_obj
else:
self.end_log_block()
return self

def unlock_permissions(self) -> 'Project33':
self.start_log_block()
if self.permissions_locked is True:
# This allows type checking without importing the class
if(type(self.t_rest_api).__name__.find('TableauRestApiConnection') != -1):
new_proj_obj = self.t_rest_api.update_project(self.luid, locked_permissions=False)
else:
new_proj_obj = self.t_rest_api.projects.update_project(self.luid, locked_permissions=False)
self.end_log_block()
return new_proj_obj
else:
self.end_log_block()
return self

def get_permissions_obj(self, group_name_or_luid: Optional[str] = None, username_or_luid: Optional[str] = None,
role: Optional[str] = None) -> 'ProjectPermissions28':
return self._get_permissions_object(group_name_or_luid=group_name_or_luid, username_or_luid=username_or_luid,
Expand Down

0 comments on commit d520289

Please sign in to comment.