update function names

Author: danlu1

synapseclient/models/protocols/wikipage_protocol.py

@@ -1,9 +1,10 @@
 """Protocol for the specific methods of this class that have synchronous counterparts
 generated at runtime."""
 
-from typing import TYPE_CHECKING, List, Optional, Protocol
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Protocol, Union
 
 from synapseclient import Synapse
+from synapseclient.core.async_utils import async_to_sync
 
 if TYPE_CHECKING:
     from synapseclient.models import (
@@ -14,6 +15,7 @@
     )
 
 
+@async_to_sync
 class WikiOrderHintSynchronousProtocol(Protocol):
     """Protocol for the methods of the WikiOrderHint class that have synchronous counterparts
     generated at runtime."""
@@ -22,7 +24,7 @@ def get(
         self,
         *,
         synapse_client: Optional[Synapse] = None,
-    ) -> WikiOrderHint:
+    ) -> "WikiOrderHint":
         """
         Get the order hint of a wiki page tree.
         Arguments:
@@ -32,11 +34,11 @@ def get(
         """
         return self
 
-    def update(
+    def store(
         self,
         *,
         synapse_client: Optional["Synapse"] = None,
-    ) -> WikiOrderHint:
+    ) -> "WikiOrderHint":
         """
         Update the order hint of a wiki page tree.
         Arguments:
@@ -47,6 +49,7 @@ def update(
         return self
 
 
+@async_to_sync
 class WikiHistorySnapshotSynchronousProtocol(Protocol):
     """Protocol for the methods of the WikiHistorySnapshot class that have synchronous counterparts
     generated at runtime."""
@@ -60,7 +63,7 @@ def get(
         offset: int = 0,
         limit: int = 20,
         synapse_client: Optional["Synapse"] = None,
-    ) -> List[WikiHistorySnapshot]:
+    ) -> List["WikiHistorySnapshot"]:
         """
         Get the history of a wiki page as a list of WikiHistorySnapshot objects.
         Arguments:
@@ -75,6 +78,7 @@ def get(
         return list({})
 
 
+@async_to_sync
 class WikiHeaderSynchronousProtocol(Protocol):
     """Protocol for the methods of the WikiHeader class that have synchronous counterparts
     generated at runtime."""
@@ -87,7 +91,7 @@ def get(
         offset: int = 0,
         limit: int = 20,
         synapse_client: Optional["Synapse"] = None,
-    ) -> List[WikiHeader]:
+    ) -> List["WikiHeader"]:
         """
         Get the header tree (hierarchy) of wiki pages for an entity.
         Arguments:
@@ -101,43 +105,39 @@ def get(
         return list({})
 
 
+@async_to_sync
 class WikiPageSynchronousProtocol(Protocol):
     """Protocol for the methods of the WikiPage class that have synchronous counterparts
     generated at runtime."""
 
-    def create(
-        self, *, synapse_client: Optional["Synapse"] = None, force_version: bool = False
-    ) -> WikiPage:
+    def store(self, *, synapse_client: Optional["Synapse"] = None) -> "WikiPage":
         """
-        Create a new wiki page.
+        Store the wiki page. If there is no wiki page, a new wiki page will be created.
+        If the wiki page already exists, it will be updated.
         Arguments:
             synapse_client: Optionally provide a Synapse client.
-            force_version: If True, the wiki page will be created with a new version number.
         Returns:
             The created WikiPage object.
         """
         return self
 
-    def get(self, *, synapse_client: Optional["Synapse"] = None) -> WikiPage:
+    def restore(self, *, synapse_client: Optional["Synapse"] = None) -> "WikiPage":
         """
-        Get a wiki page from Synapse asynchronously.
+        Restore a specific version of the wiki page.
         Arguments:
             synapse_client: Optionally provide a Synapse client.
         Returns:
-            The WikiPage object.
+            The restored WikiPage object.
         """
         return self
 
-    def update(
-        self, *, force_version: bool = False, synapse_client: Optional["Synapse"] = None
-    ) -> WikiPage:
+    def get(self, *, synapse_client: Optional["Synapse"] = None) -> "WikiPage":
         """
-        Update a wiki page asynchronously. If force_version is True, restore a specific version of the content.
+        Get a wiki page from Synapse.
         Arguments:
-            force_version: If True, update a specific version of the wiki page (restore).
             synapse_client: Optionally provide a Synapse client.
         Returns:
-            The updated WikiPage object.
+            The WikiPage object.
         """
         return self
 
@@ -153,66 +153,70 @@ def delete(self, *, synapse_client: Optional["Synapse"] = None) -> None:
 
     def get_attachment_handles(
         self, *, synapse_client: Optional["Synapse"] = None
-    ) -> list:
+    ) -> List[Dict[str, Any]]:
         """
         Get the file handles of all attachments on this wiki page.
         Arguments:
             synapse_client: Optionally provide a Synapse client.
         Returns:
             The list of FileHandles for all file attachments of this WikiPage.
         """
-        return list([])
+        return list({})
 
-    def get_attachment_url(
+    def get_attachment(
         self,
         file_name: str,
         *,
+        download_file: bool = True,
+        download_location: Optional[str] = None,
         redirect: Optional[bool] = False,
         synapse_client: Optional["Synapse"] = None,
-    ) -> dict:
+    ) -> Union[str, None]:
         """
-        Get the URL of a wiki page attachment.
+        Download the wiki page attachment to a local file or return the URL.
         Arguments:
             file_name: The name of the file to get.
+            download_file: Whether to download the file. Default is True.
+            download_location: The location to download the file to. Required if download_file is True.
             redirect: When set to false, the URL will be returned as text/plain instead of redirecting. Default is False.
             synapse_client: Optionally provide a Synapse client.
         Returns:
-            The URL that can be used to download a file for a given WikiPage file attachment.
+            If download_file is True, the attachment file will be downloaded to the download_location. Otherwise, the URL will be returned.
         """
         return ""
 
-    def get_attachment_preview_url(
+    def get_attachment_preview(
         self,
         file_name: str,
         *,
         wiki_version: Optional[int] = None,
         redirect: Optional[bool] = False,
         synapse_client: Optional["Synapse"] = None,
-    ) -> dict:
+    ) -> Union[str, None]:
         """
-        Get the preview URL of a wiki page attachment asynchronously.
+        Download the wiki page attachment preview to a local file or return the URL.
         Arguments:
             file_name: The name of the file to get.
             wiki_version: Optional version of the wiki page. If not provided, uses self.wiki_version.
             redirect: When set to false, the URL will be returned as text/plain instead of redirecting. Default is False.
             synapse_client: Optionally provide a Synapse client.
         Returns:
-            The URL that can be used to download a preview file for a given WikiPage file attachment.
+            If download_file is True, the attachment preview file will be downloaded to the download_location. Otherwise, the URL will be returned.
         """
         return ""
 
-    def get_markdown_url_async(
+    def get_markdown(
         self,
         *,
         redirect: Optional[bool] = False,
         synapse_client: Optional["Synapse"] = None,
-    ) -> dict:
+    ) -> Union[str, None]:
         """
-        Get the markdown URL of this wiki page asynchronously.
+        Download the markdown file to a local file or return the URL.
         Arguments:
             redirect: When set to false, the URL will be returned as text/plain instead of redirecting. Default is False.
             synapse_client: Optionally provide a Synapse client.
         Returns:
-            The URL that can be used to download the markdown file for this WikiPage.
+            If download_file is True, the markdown file will be downloaded to the download_location. Otherwise, the URL will be returned.
         """
         return ""