ez-a-sync 0.32.21__cp313-cp313-musllinux_1_2_x86_64.whl → 0.32.22__cp313-cp313-musllinux_1_2_x86_64.whl

a_sync/a_sync/decorator.py

@@ -1,5 +1,6 @@
 # mypy: disable-error-code=valid-type
 # mypy: disable-error-code=misc
+from concurrent.futures import Executor
 from a_sync._typing import *
 from a_sync.a_sync import config
 from a_sync.a_sync.function import (
@@ -24,6 +25,36 @@ from a_sync.a_sync.function import (
 #     pass
 
 
+@overload
+def a_sync(
+    default: Literal["async"],
+    executor: Executor,
+    **modifiers: Unpack[ModifierKwargs],
+) -> ASyncDecoratorAsyncDefault:
+    """
+    Creates an asynchronous default decorator to run a sync function in an executor.
+
+    Args:
+        default: Specifies the default execution mode as 'async'.
+        executor: The executor that will be used to call the sync function.
+        **modifiers: Additional keyword arguments to modify the behavior of the decorated function.
+
+    Examples:
+        Basic usage with an asynchronous default:
+
+        >>> @a_sync(default='async', executor=ThreadPoolExecutor(4))
+        ... def my_function():
+        ...     return True
+        >>> await my_function()
+        True
+        >>> my_function(sync=True)
+        True
+
+    See Also:
+        :class:`ASyncDecoratorAsyncDefault`
+    """
+
+
 @overload
 def a_sync(
     default: Literal["async"],
@@ -52,6 +83,36 @@ def a_sync(
     """
 
 
+@overload
+def a_sync(
+    default: Literal["sync"],
+    executor: Executor,
+    **modifiers: Unpack[ModifierKwargs],
+) -> ASyncDecoratorSyncDefault:
+    """
+    Creates a synchronous default decorator to run a sync function in an executor when called asynchronously.
+
+    Args:
+        default: Specifies the default execution mode as 'sync'.
+        executor: The executor that will be used to call the sync function.
+        **modifiers: Additional keyword arguments to modify the behavior of the decorated function.
+
+    Examples:
+        Usage with an executor without specifying a default mode:
+
+        >>> @a_sync(default="sync", executor=ThreadPoolExecutor(4))
+        ... def my_function():
+        ...     return True
+        >>> my_function()
+        True
+        >>> await my_function(sync=False)
+        True
+
+    See Also:
+        :class:`ASyncDecoratorSyncDefault`
+    """
+
+
 @overload
 def a_sync(
     default: Literal["sync"],
@@ -80,6 +141,34 @@ def a_sync(
     """
 
 
+@overload
+def a_sync(
+    executor: Executor,
+    **modifiers: Unpack[ModifierKwargs],
+) -> ASyncDecoratorSyncDefault:
+    """
+    Creates a synchronous default decorator to run a sync function in an executor when called asynchronously.
+
+    Args:
+        executor: The executor that will be used to call the sync function.
+        **modifiers: Additional keyword arguments to modify the behavior of the decorated function.
+
+    Examples:
+        Usage with an executor without specifying a default mode:
+
+        >>> @a_sync(executor=ThreadPoolExecutor(4))
+        ... def my_function():
+        ...     return True
+        >>> my_function()
+        True
+        >>> await my_function(sync=False)
+        True
+
+    See Also:
+        :class:`ASyncDecoratorSyncDefault`
+    """
+
+
 @overload
 def a_sync(
     **modifiers: Unpack[ModifierKwargs],

{ez_a_sync-0.32.21.dist-info → ez_a_sync-0.32.22.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ez_a_sync
-Version: 0.32.21
+Version: 0.32.22
 Summary: A library that makes it easy to define objects that can be used for both sync and async use cases.
 Home-page: https://github.com/BobTheBuidler/a-sync
 Author: BobTheBuidler

{ez_a_sync-0.32.21.dist-info → ez_a_sync-0.32.22.dist-info}/RECORD

@@ -58,7 +58,7 @@ a_sync/a_sync/base.cpython-313-x86_64-linux-musl.so,sha256=8M2pisO2z-71yjndafFB1
 a_sync/a_sync/base.pyi,sha256=t7AsaZzf74djHjkAA7Dnzf12sG1ppoxpwm0Iyn1GM3w,2326
 a_sync/a_sync/base.pyx,sha256=73vU-pr2XClsKLcGlQbhAhjLFHMoBQrb6UH-YuCBhxU,10603
 a_sync/a_sync/config.py,sha256=siXP4CFLQ_vswuG5K-G6cOSjQ6xKc1gN7-XNHFN2tFU,6221
-a_sync/a_sync/decorator.py,sha256=CdZuy_ql4oxzg4qbxCHTtHrGnMkxJKs1LwzlmLdX3Uc,17188
+a_sync/a_sync/decorator.py,sha256=mCSp2KxOsPObANAwR6VK4UzhuelxAOwPDGQ8-jxe8dk,19750
 a_sync/a_sync/flags.c,sha256=pnoCgI2Cochd4fMayKEKI82lw8f83fwhhUkNajLvxJk,175737
 a_sync/a_sync/flags.cpython-313-x86_64-linux-musl.so,sha256=FcPM8dKEPf40NdXKr2u4SupX4fRAN6NEwBwl6aIyMLs,68840
 a_sync/a_sync/flags.pxd,sha256=Jxe9hvWn-mPfGXHXLEvRPM2i44c4y2D4iq4ZqZZst80,2238
@@ -170,8 +170,8 @@ a_sync/utils/repr.c,sha256=4HDcDzNN4_R5Z_QrhMy9kxWXK7iALDKpa--_D0k6_-Y,571751
 a_sync/utils/repr.cpython-313-x86_64-linux-musl.so,sha256=8rGXE4HiblBAb_83Z7DJZPJO29jmXQz2DC6OUdblEuM,660856
 a_sync/utils/repr.pyi,sha256=PWdsa6sF9_3nBqEgLaxtaHty7o7gwL--jPqvcelHY10,131
 a_sync/utils/repr.pyx,sha256=xdsVdK75Zi5pAoh-8qRG0q7F0ySAq1zDkksZw37FoL4,2632
-ez_a_sync-0.32.21.dist-info/METADATA,sha256=lo0ppv5dvFgHlmVRYiPXVPgMdSC6MXS68CePUKbTh_8,13197
-ez_a_sync-0.32.21.dist-info/WHEEL,sha256=4VbEOkf4fdBUBHdV24POjoH-zuik_eIDLSImZZCAQpQ,112
-ez_a_sync-0.32.21.dist-info/top_level.txt,sha256=ew2xVyFeZE_a5XMEL64h7-vJIbaBQieaFcvBAWUpU_s,7
-ez_a_sync-0.32.21.dist-info/RECORD,,
-ez_a_sync-0.32.21.dist-info/licenses/LICENSE.txt,sha256=1on6-17OUMlja6vSPTcmlmeT_DwujCZJijYxaplBvZk,1075
+ez_a_sync-0.32.22.dist-info/METADATA,sha256=-ufQh9qrGBFLw3S-PW0gyYp2eLLtZSx1lgnwJEjxOQM,13197
+ez_a_sync-0.32.22.dist-info/WHEEL,sha256=4VbEOkf4fdBUBHdV24POjoH-zuik_eIDLSImZZCAQpQ,112
+ez_a_sync-0.32.22.dist-info/top_level.txt,sha256=ew2xVyFeZE_a5XMEL64h7-vJIbaBQieaFcvBAWUpU_s,7
+ez_a_sync-0.32.22.dist-info/RECORD,,
+ez_a_sync-0.32.22.dist-info/licenses/LICENSE.txt,sha256=1on6-17OUMlja6vSPTcmlmeT_DwujCZJijYxaplBvZk,1075