[SYNPY-1634] Add walk method to containers (#1242)

* Add walk_async and walk methods to StorableContainer for entity traversal

Author: BryanFauble

docs/reference/experimental/async/folder.md

@@ -14,6 +14,7 @@ at your own risk.
         - store_async
         - delete_async
         - copy_async
+        - walk_async
         - sync_from_synapse_async
         - flatten_file_list
         - map_directory_to_all_contained_files

docs/reference/experimental/async/project.md

@@ -13,6 +13,7 @@ at your own risk.
         - get_async
         - store_async
         - delete_async
+        - walk_async
         - sync_from_synapse_async
         - flatten_file_list
         - map_directory_to_all_contained_files

docs/reference/experimental/sync/folder.md

@@ -25,6 +25,7 @@ at your own risk.
         - store
         - delete
         - copy
+        - walk
         - sync_from_synapse
         - flatten_file_list
         - map_directory_to_all_contained_files

docs/reference/experimental/sync/project.md

@@ -24,6 +24,7 @@ at your own risk.
         - get
         - store
         - delete
+        - walk
         - sync_from_synapse
         - flatten_file_list
         - map_directory_to_all_contained_files

synapseclient/core/async_utils.py

@@ -93,6 +93,68 @@ def wrap_async_to_sync(coroutine: Coroutine[Any, Any, Any], syn: "Synapse") -> A
         return asyncio.run(coroutine)
 
 
+def wrap_async_generator_to_sync_generator(async_gen_func: Callable, *args, **kwargs):
+    """
+    Wrap an async generator function to be called in a sync context, returning a sync generator.
+
+    This function takes an async generator function and its arguments, then yields items
+    synchronously by running the async generator in the appropriate event loop.
+
+    Arguments:
+        async_gen_func: The async generator function to wrap
+        *args: Positional arguments to pass to the async generator function
+        **kwargs: Keyword arguments to pass to the async generator function
+
+    Yields:
+        Items from the async generator, yielded synchronously
+    """
+    loop = None
+
+    try:
+        loop = asyncio.get_running_loop()
+    except RuntimeError:
+        pass
+
+    if loop:
+        nest_asyncio.apply(loop=loop)
+
+        # Create the async generator
+        async_gen = async_gen_func(*args, **kwargs)
+
+        # Yield items from the async generator synchronously
+        try:
+            while True:
+                try:
+                    item = loop.run_until_complete(async_gen.__anext__())
+                    yield item
+                except StopAsyncIteration:
+                    break
+        finally:
+            # Ensure the generator is properly closed
+            try:
+                loop.run_until_complete(async_gen.aclose())
+            except (RuntimeError, StopAsyncIteration):
+                pass
+    else:
+        # No running loop, create a new one
+        async def run_generator():
+            async_gen = async_gen_func(*args, **kwargs)
+            items = []
+            try:
+                async for item in async_gen:
+                    items.append(item)
+            finally:
+                try:
+                    await async_gen.aclose()
+                except (RuntimeError, StopAsyncIteration):
+                    pass
+            return items
+
+        items = asyncio.run(run_generator())
+        for item in items:
+            yield item
+
+
 # Adapted from
 # https://github.com/keflavich/astroquery/blob/30deafc3aa057916bcdca70733cba748f1b36b64/astroquery/utils/process_asyncs.py#L11
 def async_to_sync(cls):