tableauserverclient 0.33__py3-none-any.whl → 0.35__py3-none-any.whl

tableauserverclient/server/endpoint/resource_tagger.py

@@ -1,6 +1,7 @@
 import abc
 import copy
-from typing import Generic, Iterable, Optional, Protocol, Set, TypeVar, Union, TYPE_CHECKING, runtime_checkable
+from typing import Generic, Optional, Protocol, TypeVar, Union, TYPE_CHECKING, runtime_checkable
+from collections.abc import Iterable
 import urllib.parse
 
 from tableauserverclient.server.endpoint.endpoint import Endpoint, api
@@ -24,7 +25,7 @@ if TYPE_CHECKING:
 class _ResourceTagger(Endpoint):
     # Add new tags to resource
     def _add_tags(self, baseurl, resource_id, tag_set):
-        url = "{0}/{1}/tags".format(baseurl, resource_id)
+        url = f"{baseurl}/{resource_id}/tags"
         add_req = RequestFactory.Tag.add_req(tag_set)
 
         try:
@@ -39,7 +40,7 @@ class _ResourceTagger(Endpoint):
     # Delete a resource's tag by name
     def _delete_tag(self, baseurl, resource_id, tag_name):
         encoded_tag_name = urllib.parse.quote(tag_name)
-        url = "{0}/{1}/tags/{2}".format(baseurl, resource_id, encoded_tag_name)
+        url = f"{baseurl}/{resource_id}/tags/{encoded_tag_name}"
 
         try:
             self.delete_request(url)
@@ -59,7 +60,7 @@ class _ResourceTagger(Endpoint):
             if add_set:
                 resource_item.tags = self._add_tags(baseurl, resource_item.id, add_set)
             resource_item._initial_tags = copy.copy(resource_item.tags)
-        logger.info("Updated tags to {0}".format(resource_item.tags))
+        logger.info(f"Updated tags to {resource_item.tags}")
 
 
 class Response(Protocol):
@@ -68,8 +69,8 @@ class Response(Protocol):
 
 @runtime_checkable
 class Taggable(Protocol):
-    tags: Set[str]
-    _initial_tags: Set[str]
+    tags: set[str]
+    _initial_tags: set[str]
 
     @property
     def id(self) -> Optional[str]:
@@ -95,14 +96,14 @@ class TaggingMixin(abc.ABC, Generic[T]):
     def delete_request(self, url) -> None:
         pass
 
-    def add_tags(self, item: Union[T, str], tags: Union[Iterable[str], str]) -> Set[str]:
+    def add_tags(self, item: Union[T, str], tags: Union[Iterable[str], str]) -> set[str]:
         item_id = getattr(item, "id", item)
 
         if not isinstance(item_id, str):
             raise ValueError("ID not found.")
 
         if isinstance(tags, str):
-            tag_set = set([tags])
+            tag_set = {tags}
         else:
             tag_set = set(tags)
 
@@ -118,7 +119,7 @@ class TaggingMixin(abc.ABC, Generic[T]):
             raise ValueError("ID not found.")
 
         if isinstance(tags, str):
-            tag_set = set([tags])
+            tag_set = {tags}
         else:
             tag_set = set(tags)
 
@@ -158,9 +159,9 @@ class Tags(Endpoint):
         return f"{self.parent_srv.baseurl}/tags"
 
     @api(version="3.9")
-    def batch_add(self, tags: Union[Iterable[str], str], content: content) -> Set[str]:
+    def batch_add(self, tags: Union[Iterable[str], str], content: content) -> set[str]:
         if isinstance(tags, str):
-            tag_set = set([tags])
+            tag_set = {tags}
         else:
             tag_set = set(tags)
 
@@ -170,9 +171,9 @@ class Tags(Endpoint):
         return TagItem.from_response(server_response.content, self.parent_srv.namespace)
 
     @api(version="3.9")
-    def batch_delete(self, tags: Union[Iterable[str], str], content: content) -> Set[str]:
+    def batch_delete(self, tags: Union[Iterable[str], str], content: content) -> set[str]:
         if isinstance(tags, str):
-            tag_set = set([tags])
+            tag_set = {tags}
         else:
             tag_set = set(tags)
 

tableauserverclient/server/endpoint/schedules_endpoint.py

@@ -2,7 +2,7 @@ import copy
 import logging
 import warnings
 from collections import namedtuple
-from typing import TYPE_CHECKING, Callable, List, Optional, Tuple, Union
+from typing import TYPE_CHECKING, Callable, Optional, Union
 
 from .endpoint import Endpoint, api, parameter_added_in
 from .exceptions import MissingRequiredFieldError
@@ -22,14 +22,14 @@ if TYPE_CHECKING:
 class Schedules(Endpoint):
     @property
     def baseurl(self) -> str:
-        return "{0}/schedules".format(self.parent_srv.baseurl)
+        return f"{self.parent_srv.baseurl}/schedules"
 
     @property
     def siteurl(self) -> str:
-        return "{0}/sites/{1}/schedules".format(self.parent_srv.baseurl, self.parent_srv.site_id)
+        return f"{self.parent_srv.baseurl}/sites/{self.parent_srv.site_id}/schedules"
 
     @api(version="2.3")
-    def get(self, req_options: Optional["RequestOptions"] = None) -> Tuple[List[ScheduleItem], PaginationItem]:
+    def get(self, req_options: Optional["RequestOptions"] = None) -> tuple[list[ScheduleItem], PaginationItem]:
         logger.info("Querying all schedules")
         url = self.baseurl
         server_response = self.get_request(url, req_options)
@@ -42,8 +42,8 @@ class Schedules(Endpoint):
         if not schedule_id:
             error = "No Schedule ID provided"
             raise ValueError(error)
-        logger.info("Querying a single schedule by id ({})".format(schedule_id))
-        url = "{0}/{1}".format(self.baseurl, schedule_id)
+        logger.info(f"Querying a single schedule by id ({schedule_id})")
+        url = f"{self.baseurl}/{schedule_id}"
         server_response = self.get_request(url)
         return ScheduleItem.from_response(server_response.content, self.parent_srv.namespace)[0]
 
@@ -52,9 +52,9 @@ class Schedules(Endpoint):
         if not schedule_id:
             error = "Schedule ID undefined"
             raise ValueError(error)
-        url = "{0}/{1}".format(self.baseurl, schedule_id)
+        url = f"{self.baseurl}/{schedule_id}"
         self.delete_request(url)
-        logger.info("Deleted single schedule (ID: {0})".format(schedule_id))
+        logger.info(f"Deleted single schedule (ID: {schedule_id})")
 
     @api(version="2.3")
     def update(self, schedule_item: ScheduleItem) -> ScheduleItem:
@@ -62,10 +62,10 @@ class Schedules(Endpoint):
             error = "Schedule item missing ID."
             raise MissingRequiredFieldError(error)
 
-        url = "{0}/{1}".format(self.baseurl, schedule_item.id)
+        url = f"{self.baseurl}/{schedule_item.id}"
         update_req = RequestFactory.Schedule.update_req(schedule_item)
         server_response = self.put_request(url, update_req)
-        logger.info("Updated schedule item (ID: {})".format(schedule_item.id))
+        logger.info(f"Updated schedule item (ID: {schedule_item.id})")
         updated_schedule = copy.copy(schedule_item)
         return updated_schedule._parse_common_tags(server_response.content, self.parent_srv.namespace)
 
@@ -79,7 +79,7 @@ class Schedules(Endpoint):
         create_req = RequestFactory.Schedule.create_req(schedule_item)
         server_response = self.post_request(url, create_req)
         new_schedule = ScheduleItem.from_response(server_response.content, self.parent_srv.namespace)[0]
-        logger.info("Created new schedule (ID: {})".format(new_schedule.id))
+        logger.info(f"Created new schedule (ID: {new_schedule.id})")
         return new_schedule
 
     @api(version="2.8")
@@ -91,12 +91,12 @@ class Schedules(Endpoint):
         datasource: Optional["DatasourceItem"] = None,
         flow: Optional["FlowItem"] = None,
         task_type: Optional[str] = None,
-    ) -> List[AddResponse]:
+    ) -> list[AddResponse]:
         # There doesn't seem to be a good reason to allow one item of each type?
         if workbook and datasource:
             warnings.warn("Passing in multiple items for add_to_schedule will be deprecated", PendingDeprecationWarning)
-        items: List[
-            Tuple[str, Union[WorkbookItem, FlowItem, DatasourceItem], str, Callable[[Optional[str], str], bytes], str]
+        items: list[
+            tuple[str, Union[WorkbookItem, FlowItem, DatasourceItem], str, Callable[[Optional[str], str], bytes], str]
         ] = []
 
         if workbook is not None:
@@ -115,8 +115,7 @@ class Schedules(Endpoint):
             )  # type:ignore[arg-type]
 
         results = (self._add_to(*x) for x in items)
-        # list() is needed for python 3.x compatibility
-        return list(filter(lambda x: not x.result, results))  # type:ignore[arg-type]
+        return [x for x in results if not x.result]
 
     def _add_to(
         self,
@@ -133,13 +132,13 @@ class Schedules(Endpoint):
         item_task_type,
     ) -> AddResponse:
         id_ = resource.id
-        url = "{0}/{1}/{2}s".format(self.siteurl, schedule_id, type_)
+        url = f"{self.siteurl}/{schedule_id}/{type_}s"
         add_req = req_factory(id_, task_type=item_task_type)  # type: ignore[call-arg, arg-type]
         response = self.put_request(url, add_req)
 
         error, warnings, task_created = ScheduleItem.parse_add_to_schedule_response(response, self.parent_srv.namespace)
         if task_created:
-            logger.info("Added {} to {} to schedule {}".format(type_, id_, schedule_id))
+            logger.info(f"Added {type_} to {id_} to schedule {schedule_id}")
 
         if error is not None or warnings is not None:
             return AddResponse(

tableauserverclient/server/endpoint/server_info_endpoint.py

@@ -1,4 +1,5 @@
 import logging
+from typing import Union
 
 from .endpoint import Endpoint, api
 from .exceptions import ServerResponseError
@@ -21,15 +22,49 @@ class ServerInfo(Endpoint):
         return self._info
 
     def __repr__(self):
-        return "<Endpoint {}>".format(self.serverInfo)
+        return f"<Endpoint {self.serverInfo}>"
 
     @property
-    def baseurl(self):
-        return "{0}/serverInfo".format(self.parent_srv.baseurl)
+    def baseurl(self) -> str:
+        return f"{self.parent_srv.baseurl}/serverInfo"
 
     @api(version="2.4")
-    def get(self):
-        """Retrieve the server info for the server.  This is an unauthenticated call"""
+    def get(self) -> Union[ServerInfoItem, None]:
+        """
+        Retrieve the build and version information for the server.
+
+        This method makes an unauthenticated call, so no sign in or
+        authentication token is required.
+
+        Returns
+        -------
+        :class:`~tableauserverclient.models.ServerInfoItem`
+
+        Raises
+        ------
+        :class:`~tableauserverclient.exceptions.ServerInfoEndpointNotFoundError`
+            Raised when the server info endpoint is not found.
+
+        :class:`~tableauserverclient.exceptions.EndpointUnavailableError`
+            Raised when the server info endpoint is not available.
+
+        Examples
+        --------
+        >>> import tableauserverclient as TSC
+
+        >>> # create a instance of server
+        >>> server = TSC.Server('https://MY-SERVER')
+
+        >>> # set the version number > 2.3
+        >>> # the server_info.get() method works in 2.4 and later
+        >>> server.version = '2.5'
+
+        >>> s_info = server.server_info.get()
+        >>> print("\nServer info:")
+        >>> print("\tProduct version: {0}".format(s_info.product_version))
+        >>> print("\tREST API version: {0}".format(s_info.rest_api_version))
+        >>> print("\tBuild number: {0}".format(s_info.build_number))
+        """
         try:
             server_response = self.get_unauthenticated_request(self.baseurl)
         except ServerResponseError as e:

tableauserverclient/server/endpoint/sites_endpoint.py

@@ -8,20 +8,49 @@ from tableauserverclient.models import SiteItem, PaginationItem
 
 from tableauserverclient.helpers.logging import logger
 
-from typing import TYPE_CHECKING, List, Optional, Tuple
+from typing import TYPE_CHECKING, Optional
 
 if TYPE_CHECKING:
     from ..request_options import RequestOptions
 
 
 class Sites(Endpoint):
+    """
+    Using the site methods of the Tableau Server REST API you can:
+
+    List sites on a server or get details of a specific site
+    Create, update, or delete a site
+    List views in a site
+    Encrypt, decrypt, or reencrypt extracts on a site
+
+    """
+
     @property
     def baseurl(self) -> str:
-        return "{0}/sites".format(self.parent_srv.baseurl)
+        return f"{self.parent_srv.baseurl}/sites"
 
     # Gets all sites
     @api(version="2.0")
-    def get(self, req_options: Optional["RequestOptions"] = None) -> Tuple[List[SiteItem], PaginationItem]:
+    def get(self, req_options: Optional["RequestOptions"] = None) -> tuple[list[SiteItem], PaginationItem]:
+        """
+        Query all sites on the server. This method requires server admin
+        permissions. This endpoint is paginated, meaning that the server will
+        only return a subset of the data at a time. The response will contain
+        information about the total number of sites and the number of sites
+        returned in the current response. Use the PaginationItem object to
+        request more data.
+
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_sites
+
+        Parameters
+        ----------
+        req_options : RequestOptions, optional
+            Filtering options for the request.
+
+        Returns
+        -------
+        tuple[list[SiteItem], PaginationItem]
+        """
         logger.info("Querying all sites on site")
         logger.info("Requires Server Admin permissions")
         url = self.baseurl
@@ -33,6 +62,33 @@ class Sites(Endpoint):
     # Gets 1 site by id
     @api(version="2.0")
     def get_by_id(self, site_id: str) -> SiteItem:
+        """
+        Query a single site on the server. You can only retrieve the site that
+        you are currently authenticated for.
+
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site
+
+        Parameters
+        ----------
+        site_id : str
+            The site ID.
+
+        Returns
+        -------
+        SiteItem
+
+        Raises
+        ------
+        ValueError
+            If the site ID is not defined.
+
+        ValueError
+            If the site ID does not match the site for which you are currently authenticated.
+
+        Examples
+        --------
+        >>> site = server.sites.get_by_id('1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p')
+        """
         if not site_id:
             error = "Site ID undefined."
             raise ValueError(error)
@@ -40,20 +96,45 @@ class Sites(Endpoint):
             error = "You can only retrieve the site for which you are currently authenticated."
             raise ValueError(error)
 
-        logger.info("Querying single site (ID: {0})".format(site_id))
-        url = "{0}/{1}".format(self.baseurl, site_id)
+        logger.info(f"Querying single site (ID: {site_id})")
+        url = f"{self.baseurl}/{site_id}"
         server_response = self.get_request(url)
         return SiteItem.from_response(server_response.content, self.parent_srv.namespace)[0]
 
     # Gets 1 site by name
     @api(version="2.0")
     def get_by_name(self, site_name: str) -> SiteItem:
+        """
+        Query a single site on the server. You can only retrieve the site that
+        you are currently authenticated for.
+
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site
+
+        Parameters
+        ----------
+        site_name : str
+            The site name.
+
+        Returns
+        -------
+        SiteItem
+
+        Raises
+        ------
+        ValueError
+            If the site name is not defined.
+
+        Examples
+        --------
+        >>> site = server.sites.get_by_name('Tableau')
+
+        """
         if not site_name:
             error = "Site Name undefined."
             raise ValueError(error)
         print("Note: You can only work with the site for which you are currently authenticated")
-        logger.info("Querying single site (Name: {0})".format(site_name))
-        url = "{0}/{1}?key=name".format(self.baseurl, site_name)
+        logger.info(f"Querying single site (Name: {site_name})")
+        url = f"{self.baseurl}/{site_name}?key=name"
         print(self.baseurl, url)
         server_response = self.get_request(url)
         return SiteItem.from_response(server_response.content, self.parent_srv.namespace)[0]
@@ -61,6 +142,31 @@ class Sites(Endpoint):
     # Gets 1 site by content url
     @api(version="2.0")
     def get_by_content_url(self, content_url: str) -> SiteItem:
+        """
+        Query a single site on the server. You can only retrieve the site that
+        you are currently authenticated for.
+
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#query_site
+
+        Parameters
+        ----------
+        content_url : str
+            The content URL.
+
+        Returns
+        -------
+        SiteItem
+
+        Raises
+        ------
+        ValueError
+            If the site name is not defined.
+
+        Examples
+        --------
+        >>> site = server.sites.get_by_name('Tableau')
+
+        """
         if content_url is None:
             error = "Content URL undefined."
             raise ValueError(error)
@@ -68,15 +174,51 @@ class Sites(Endpoint):
             error = "You can only work with the site you are currently authenticated for"
             raise ValueError(error)
 
-        logger.info("Querying single site (Content URL: {0})".format(content_url))
+        logger.info(f"Querying single site (Content URL: {content_url})")
         logger.debug("Querying other sites requires Server Admin permissions")
-        url = "{0}/{1}?key=contentUrl".format(self.baseurl, content_url)
+        url = f"{self.baseurl}/{content_url}?key=contentUrl"
         server_response = self.get_request(url)
         return SiteItem.from_response(server_response.content, self.parent_srv.namespace)[0]
 
     # Update site
     @api(version="2.0")
     def update(self, site_item: SiteItem) -> SiteItem:
+        """
+        Modifies the settings for site.
+
+        The site item object must include the site ID and overrides all other settings.
+
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#update_site
+
+        Parameters
+        ----------
+        site_item : SiteItem
+            The site item that you want to update. The settings specified in the
+            site item override the current site settings.
+
+        Returns
+        -------
+        SiteItem
+            The site item object that was updated.
+
+        Raises
+        ------
+        MissingRequiredFieldError
+            If the site item is missing an ID.
+
+        ValueError
+            If the site ID does not match the site for which you are currently authenticated.
+
+        ValueError
+            If the site admin mode is set to ContentOnly and a user quota is also set.
+
+        Examples
+        --------
+        >>> ...
+        >>> site_item.name = 'New Name'
+        >>> updated_site = server.sites.update(site_item)
+
+        """
         if not site_item.id:
             error = "Site item missing ID."
             raise MissingRequiredFieldError(error)
@@ -90,30 +232,94 @@ class Sites(Endpoint):
                 error = "You cannot set admin_mode to ContentOnly and also set a user quota"
                 raise ValueError(error)
 
-        url = "{0}/{1}".format(self.baseurl, site_item.id)
+        url = f"{self.baseurl}/{site_item.id}"
         update_req = RequestFactory.Site.update_req(site_item, self.parent_srv)
         server_response = self.put_request(url, update_req)
-        logger.info("Updated site item (ID: {0})".format(site_item.id))
+        logger.info(f"Updated site item (ID: {site_item.id})")
         update_site = copy.copy(site_item)
         return update_site._parse_common_tags(server_response.content, self.parent_srv.namespace)
 
     # Delete 1 site object
     @api(version="2.0")
     def delete(self, site_id: str) -> None:
+        """
+        Deletes the specified site from the server. You can only delete the site
+        if you are a Server Admin.
+
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#delete_site
+
+        Parameters
+        ----------
+        site_id : str
+            The site ID.
+
+        Raises
+        ------
+        ValueError
+            If the site ID is not defined.
+
+        ValueError
+            If the site ID does not match the site for which you are currently authenticated.
+
+        Examples
+        --------
+        >>> server.sites.delete('1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p')
+        """
         if not site_id:
             error = "Site ID undefined."
             raise ValueError(error)
-        url = "{0}/{1}".format(self.baseurl, site_id)
+        url = f"{self.baseurl}/{site_id}"
         if not site_id == self.parent_srv.site_id:
             error = "You can only delete the site you are currently authenticated for"
             raise ValueError(error)
         self.delete_request(url)
         self.parent_srv._clear_auth()
-        logger.info("Deleted single site (ID: {0}) and signed out".format(site_id))
+        logger.info(f"Deleted single site (ID: {site_id}) and signed out")
 
     # Create new site
     @api(version="2.0")
     def create(self, site_item: SiteItem) -> SiteItem:
+        """
+        Creates a new site on the server for the specified site item object.
+
+        Tableau Server only.
+
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#create_site
+
+        Parameters
+        ----------
+        site_item : SiteItem
+            The settings for the site that you want to create. You need to
+            create an instance of SiteItem and pass it to the create method.
+
+        Returns
+        -------
+        SiteItem
+            The site item object that was created.
+
+        Raises
+        ------
+        ValueError
+            If the site admin mode is set to ContentOnly and a user quota is also set.
+
+        Examples
+        --------
+        >>> import tableauserverclient as TSC
+
+        >>> # create an instance of server
+        >>> server = TSC.Server('https://MY-SERVER')
+
+        >>> # create shortcut for admin mode
+        >>> content_users=TSC.SiteItem.AdminMode.ContentAndUsers
+
+        >>> # create a new SiteItem
+        >>> new_site = TSC.SiteItem(name='Tableau', content_url='tableau', admin_mode=content_users, user_quota=15, storage_quota=1000, disable_subscriptions=True)
+
+        >>> # call the sites create method with the SiteItem
+        >>> new_site = server.sites.create(new_site)
+
+
+        """
         if site_item.admin_mode:
             if site_item.admin_mode == SiteItem.AdminMode.ContentOnly and site_item.user_quota:
                 error = "You cannot set admin_mode to ContentOnly and also set a user quota"
@@ -123,33 +329,92 @@ class Sites(Endpoint):
         create_req = RequestFactory.Site.create_req(site_item, self.parent_srv)
         server_response = self.post_request(url, create_req)
         new_site = SiteItem.from_response(server_response.content, self.parent_srv.namespace)[0]
-        logger.info("Created new site (ID: {0})".format(new_site.id))
+        logger.info(f"Created new site (ID: {new_site.id})")
         return new_site
 
     @api(version="3.5")
     def encrypt_extracts(self, site_id: str) -> None:
+        """
+        Encrypts all extracts on the site.
+
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_extract_and_encryption.htm#encrypt_extracts
+
+        Parameters
+        ----------
+        site_id : str
+            The site ID.
+
+        Raises
+        ------
+        ValueError
+            If the site ID is not defined.
+
+        Examples
+        --------
+        >>> server.sites.encrypt_extracts('1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p')
+        """
         if not site_id:
             error = "Site ID undefined."
             raise ValueError(error)
-        url = "{0}/{1}/encrypt-extracts".format(self.baseurl, site_id)
+        url = f"{self.baseurl}/{site_id}/encrypt-extracts"
         empty_req = RequestFactory.Empty.empty_req()
         self.post_request(url, empty_req)
 
     @api(version="3.5")
     def decrypt_extracts(self, site_id: str) -> None:
+        """
+        Decrypts all extracts on the site.
+
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_extract_and_encryption.htm#decrypt_extracts
+
+        Parameters
+        ----------
+        site_id : str
+            The site ID.
+
+        Raises
+        ------
+        ValueError
+            If the site ID is not defined.
+
+        Examples
+        --------
+        >>> server.sites.decrypt_extracts('1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p')
+        """
         if not site_id:
             error = "Site ID undefined."
             raise ValueError(error)
-        url = "{0}/{1}/decrypt-extracts".format(self.baseurl, site_id)
+        url = f"{self.baseurl}/{site_id}/decrypt-extracts"
         empty_req = RequestFactory.Empty.empty_req()
         self.post_request(url, empty_req)
 
     @api(version="3.5")
     def re_encrypt_extracts(self, site_id: str) -> None:
+        """
+        Reencrypt all extracts on a site with new encryption keys. If no site is
+        specified, extracts on the default site will be reencrypted.
+
+        REST API: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_extract_and_encryption.htm#reencrypt_extracts
+
+        Parameters
+        ----------
+        site_id : str
+            The site ID.
+
+        Raises
+        ------
+        ValueError
+            If the site ID is not defined.
+
+        Examples
+        --------
+        >>> server.sites.re_encrypt_extracts('1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p')
+
+        """
         if not site_id:
             error = "Site ID undefined."
             raise ValueError(error)
-        url = "{0}/{1}/reencrypt-extracts".format(self.baseurl, site_id)
+        url = f"{self.baseurl}/{site_id}/reencrypt-extracts"
 
         empty_req = RequestFactory.Empty.empty_req()
         self.post_request(url, empty_req)