remove unwanted changes

Author: danlu1

synapseclient/models/protocols/wikipage_protocol.py

@@ -112,11 +112,10 @@ class WikiHistorySnapshotSynchronousProtocol(Protocol):
     """Protocol for the methods of the WikiHistorySnapshot class that have synchronous counterparts
     generated at runtime."""
 
-    @classmethod
     def get(
         cls,
         owner_id: str,
-        wiki_id: str,
+        id: str,
         *,
         offset: int = 0,
         limit: int = 20,
@@ -140,9 +139,9 @@ def get(
             ```
         """
         return wrap_async_generator_to_sync_generator(
-            async_gen_func=WikiHistorySnapshot.get_async,
+            async_gen_func=cls().get_async,
             owner_id=owner_id,
-            id=wiki_id,
+            id=id,
             offset=offset,
             limit=limit,
             synapse_client=synapse_client,
@@ -153,7 +152,6 @@ class WikiHeaderSynchronousProtocol(Protocol):
     """Protocol for the methods of the WikiHeader class that have synchronous counterparts
     generated at runtime."""
 
-    @classmethod
     def get(
         cls,
         owner_id: str,
@@ -179,7 +177,7 @@ def get(
             ```
         """
         return wrap_async_generator_to_sync_generator(
-            async_gen_func=WikiHeader.get_async,
+            async_gen_func=cls().get_async,
             owner_id=owner_id,
             offset=offset,
             limit=limit,

synapseclient/models/wiki.py

@@ -5,7 +5,7 @@
 import os
 import pprint
 from dataclasses import dataclass, field
-from typing import Any, AsyncGenerator, Dict, List, Literal, Optional, Union
+from typing import Any, AsyncGenerator, Dict, Generator, List, Literal, Optional, Union
 
 from synapseclient import Synapse
 from synapseclient.api import (
@@ -23,7 +23,12 @@
     put_wiki_page,
     put_wiki_version,
 )
-from synapseclient.core.async_utils import async_to_sync, otel_trace_method
+from synapseclient.core.async_utils import (
+    async_to_sync,
+    otel_trace_method,
+    skip_async_to_sync,
+    wrap_async_generator_to_sync_generator,
+)
 from synapseclient.core.download import (
     PresignedUrlInfo,
     _pre_signed_url_expiration_time,
@@ -250,10 +255,8 @@ def fill_from_dict(
         self.modified_by = wiki_history.get("modifiedBy", None)
         return self
 
+    @skip_async_to_sync
     @classmethod
-    @otel_trace_method(
-        method_to_trace_name=lambda self, **kwargs: f"Get_Wiki_History for Owner ID {kwargs['owner_id']}, Wiki ID {kwargs['id']}"
-    )
     async def get_async(
         cls,
         owner_id: str = None,
@@ -297,6 +300,25 @@ async def main():
             item = cls().fill_from_dict(wiki_history=item)
             yield item
 
+    @classmethod
+    def get(
+        cls,
+        owner_id: str = None,
+        id: str = None,
+        *,
+        offset: int = 0,
+        limit: int = 20,
+        synapse_client: Optional["Synapse"] = None,
+    ) -> Generator["WikiHistorySnapshot", None, None]:
+        return wrap_async_generator_to_sync_generator(
+            async_gen_func=cls().get_async,
+            owner_id=owner_id,
+            id=id,
+            offset=offset,
+            limit=limit,
+            synapse_client=synapse_client,
+        )
+
 
 @dataclass
 @async_to_sync
@@ -337,10 +359,8 @@ def fill_from_dict(
         self.parent_id = wiki_header.get("parentId", None)
         return self
 
+    @skip_async_to_sync
     @classmethod
-    @otel_trace_method(
-        method_to_trace_name=lambda self, **kwargs: f"Get_Wiki_Header_Tree for Owner ID {kwargs['owner_id']}"
-    )
     async def get_async(
         cls,
         owner_id: str = None,
@@ -379,6 +399,39 @@ async def main():
             item = cls().fill_from_dict(wiki_header=item)
             yield item
 
+    @classmethod
+    def get(
+        cls,
+        owner_id: str,
+        *,
+        offset: int = 0,
+        limit: int = 20,
+        synapse_client: Optional["Synapse"] = None,
+    ) -> Generator["WikiHeader", None, None]:
+        """
+        Get the header tree (hierarchy) of wiki pages for an entity.
+        Arguments:
+            owner_id: The ID of the owner entity.
+            offset: The index of the pagination offset.
+            limit: Limits the size of the page returned.
+            synapse_client: Optionally provide a Synapse client.
+        Yields:
+            Individual WikiHeader objects for the entity.
+
+        Example: Get the header tree (hierarchy) of wiki pages for an entity
+            ```python
+            for header in WikiHeader.get(owner_id=project.id):
+                print(f"Header: {header}")
+            ```
+        """
+        return wrap_async_generator_to_sync_generator(
+            async_gen_func=cls().get_async,
+            owner_id=owner_id,
+            offset=offset,
+            limit=limit,
+            synapse_client=synapse_client,
+        )
+
 
 @dataclass
 @async_to_sync

tests/unit/synapseclient/models/async/unit_test_wiki_async.py

@@ -168,39 +168,35 @@ async def test_fill_from_dict(self) -> None:
         assert results == self.history_snapshot
 
     async def test_get_async_success(self) -> None:
-        # GIVEN mock responses
-        mock_responses = [
-            {
+        async def mock_responses() -> AsyncGenerator[Dict[str, Any], None]:
+            yield {
                 "version": 1,
                 "modifiedOn": "2023-01-01T00:00:00.000Z",
                 "modifiedBy": "12345",
-            },
-            {
+            }
+            yield {
                 "version": 2,
                 "modifiedOn": "2023-01-02T00:00:00.000Z",
                 "modifiedBy": "12345",
-            },
-            {
+            }
+            yield {
                 "version": 3,
                 "modifiedOn": "2023-01-03T00:00:00.000Z",
                 "modifiedBy": "12345",
-            },
-        ]
+            }
 
         # Create an async generator mock
-        async def mock_async_generator(
-            items: List[Dict[str, Any]]
-        ) -> AsyncGenerator[Dict[str, Any], None]:
-            for item in items:
+        async def mock_async_generator() -> AsyncGenerator[WikiHistorySnapshot, None]:
+            async for item in mock_responses():
                 yield item
 
         # WHEN I call `get_async`
         with patch(
             "synapseclient.models.wiki.get_wiki_history",
-            return_value=mock_async_generator(mock_responses),
+            return_value=mock_async_generator(),
         ) as mocked_get:
             results = []
-            async for item in WikiHistorySnapshot.get_async(
+            async for item in WikiHistorySnapshot().get_async(
                 owner_id="syn123",
                 id="wiki1",
                 offset=0,
@@ -298,30 +294,27 @@ async def test_fill_from_dict(self) -> None:
 
     async def test_get_async_success(self) -> None:
         # GIVEN mock responses
-        mock_responses = [
-            {
+        async def mock_responses() -> AsyncGenerator[Dict[str, Any], None]:
+            yield {
                 "id": "wiki1",
                 "title": "Test Wiki",
                 "parentId": "1234",
-            },
-            {
+            }
+            yield {
                 "id": "wiki2",
                 "title": "Test Wiki 2",
                 "parentId": "1234",
-            },
-        ]
+            }
 
         # Create an async generator mock
-        async def mock_async_generator(
-            values: List[Dict[str, Any]]
-        ) -> AsyncGenerator[Dict[str, Any], None]:
-            for item in values:
+        async def mock_async_generator() -> AsyncGenerator[WikiHeader, None]:
+            async for item in mock_responses():
                 yield item
 
         # WHEN I call `get_async`
         with patch(
             "synapseclient.models.wiki.get_wiki_header_tree",
-            return_value=mock_async_generator(mock_responses),
+            return_value=mock_async_generator(),
         ) as mocked_get:
             results = []
             async for item in WikiHeader.get_async(

tests/unit/synapseclient/models/synchronous/unit_test_wiki.py

@@ -167,43 +167,42 @@ def test_fill_from_dict(self) -> None:
 
     def test_get_success(self) -> None:
         # GIVEN mock responses
-        mock_responses = [
-            {
+        async def mock_responses() -> AsyncGenerator[Dict[str, Any], None]:
+            yield {
                 "version": 1,
                 "modifiedOn": "2023-01-01T00:00:00.000Z",
                 "modifiedBy": "12345",
-            },
-            {
+            }
+            yield {
                 "version": 2,
                 "modifiedOn": "2023-01-02T00:00:00.000Z",
                 "modifiedBy": "12345",
-            },
-            {
+            }
+            yield {
                 "version": 3,
                 "modifiedOn": "2023-01-03T00:00:00.000Z",
                 "modifiedBy": "12345",
-            },
-        ]
+            }
 
         # Create an async generator function
-        async def mock_async_generator(*args, **kwargs):
-            for item in mock_responses:
+        async def mock_async_generator():
+            async for item in mock_responses():
                 yield item
 
         # WHEN I call `get`
         with patch(
             "synapseclient.models.wiki.get_wiki_history",
-            side_effect=mock_async_generator,
+            return_value=mock_async_generator(),
         ) as mocked_get:
-            results = list(
-                WikiHistorySnapshot.get(
-                    owner_id="syn123",
-                    id="wiki1",
-                    offset=0,
-                    limit=20,
-                    synapse_client=self.syn,
-                )
-            )
+            results = []
+            for item in WikiHistorySnapshot().get(
+                owner_id="syn123",
+                id="wiki1",
+                offset=0,
+                limit=20,
+                synapse_client=self.syn,
+            ):
+                results.append(item)
             # THEN the API should be called with correct parameters
             mocked_get.assert_called_once_with(
                 owner_id="syn123",
@@ -318,7 +317,7 @@ async def mock_async_generator(*args, **kwargs):
 
         with patch(
             "synapseclient.models.wiki.get_wiki_header_tree",
-            side_effect=mock_async_generator,
+            return_value=mock_async_generator(),
         ) as mocked_get:
             results = list(
                 WikiHeader.get(