ez-a-sync 0.22.14__py3-none-any.whl → 0.22.16__py3-none-any.whl

tests/test_task.py

@@ -3,43 +3,101 @@ import pytest
 
 from a_sync import TaskMapping, create_task, exceptions
 
+
 @pytest.mark.asyncio_cooperative
 async def test_create_task():
-    await create_task(coro=asyncio.sleep(0), name='test')
+    """Test the creation of an asynchronous task.
+
+    Verifies that a task can be created using the `create_task`
+    function with a coroutine and a specified name.
+
+    See Also:
+        - :func:`a_sync.create_task`
+    """
+    t = create_task(coro=asyncio.sleep(0), name="test")
+    assert t.get_name() == "test", t
+    await t
+
 
 @pytest.mark.asyncio_cooperative
-async def test_persistent_task():
+async def test_persistent_task():  # sourcery skip: simplify-boolean-comparison
+    """Test the persistence of a task without a local reference.
+
+    Checks if a task created without a local reference
+    completes successfully by setting a nonlocal variable.
+    The test ensures that the task completes by verifying
+    the change in the nonlocal variable.
+
+    See Also:
+        - :func:`a_sync.create_task`
+    """
     check = False
+
     async def task():
         await asyncio.sleep(1)
         nonlocal check
         check = True
+
     create_task(coro=task(), skip_gc_until_done=True)
-    # there is no local reference to the newly created task. does it still complete? 
+    # there is no local reference to the newly created task. does it still complete?
     await asyncio.sleep(2)
     assert check is True
 
+
 @pytest.mark.asyncio_cooperative
 async def test_pruning():
+    """Test task creation and handling without errors.
+
+    Ensures that tasks can be created without causing errors.
+    This test does not explicitly check for task pruning, despite
+    its name, but rather focuses on task creation stability.
+
+    See Also:
+        - :func:`a_sync.create_task`
+    """
+
     async def task():
         return
+
     create_task(coro=task(), skip_gc_until_done=True)
     await asyncio.sleep(0)
     # previously, it failed here
     create_task(coro=task(), skip_gc_until_done=True)
 
+
 @pytest.mark.asyncio_cooperative
 async def test_task_mapping_init():
+    """Test initialization of TaskMapping.
+
+    Verifies that the :class:`TaskMapping` class initializes correctly
+    with the provided coroutine function and arguments. Checks
+    the handling of function arguments and the task name.
+
+    See Also:
+        - :class:`a_sync.TaskMapping`
+    """
     tasks = TaskMapping(_coro_fn)
-    assert tasks._wrapped_func is _coro_fn, f"{tasks._wrapped_func} , {_coro_fn}, {tasks._wrapped_func == _coro_fn}"
+    assert (
+        tasks._wrapped_func is _coro_fn
+    ), f"{tasks._wrapped_func} , {_coro_fn}, {tasks._wrapped_func == _coro_fn}"
     assert tasks._wrapped_func_kwargs == {}
     assert tasks._name is None
-    tasks = TaskMapping(_coro_fn, name='test', kwarg0=1, kwarg1=None)
-    assert tasks._wrapped_func_kwargs == {'kwarg0': 1, 'kwarg1': None}
+    tasks = TaskMapping(_coro_fn, name="test", kwarg0=1, kwarg1=None)
+    assert tasks._wrapped_func_kwargs == {"kwarg0": 1, "kwarg1": None}
     assert tasks._name == "test"
 
+
 @pytest.mark.asyncio_cooperative
 async def test_task_mapping():
+    """Test the functionality of TaskMapping.
+
+    Checks the behavior of :class:`TaskMapping`, including task
+    creation, retrieval, and execution. Verifies the ability
+    to await the mapping and checks the return values of tasks.
+
+    See Also:
+        - :class:`a_sync.TaskMapping`
+    """
     tasks = TaskMapping(_coro_fn)
     # does it return the correct type
     assert isinstance(tasks[0], asyncio.Task)
@@ -52,11 +110,28 @@ async def test_task_mapping():
     # can we await the mapping?
     assert await tasks == {0: "1", 1: "22"}
     # can we await one from scratch?
-    assert await TaskMapping(_coro_fn, range(5)) == {0: "1", 1: "22", 2: "333", 3: "4444", 4: "55555"}
+    assert await TaskMapping(_coro_fn, range(5)) == {
+        0: "1",
+        1: "22",
+        2: "333",
+        3: "4444",
+        4: "55555",
+    }
     assert len(tasks) == 2
-    
+
+
 @pytest.mark.asyncio_cooperative
 async def test_task_mapping_map_with_sync_iter():
+    """Test TaskMapping with a synchronous iterator.
+
+    Verifies that :class:`TaskMapping` can map over a synchronous
+    iterator and correctly handle keys, values, and items.
+    Ensures that mapping in progress raises a :class:`RuntimeError`
+    when attempted concurrently.
+
+    See Also:
+        - :class:`a_sync.TaskMapping`
+    """
     tasks = TaskMapping(_coro_fn)
     i = 0
     async for k, v in tasks.map(range(5)):
@@ -69,9 +144,9 @@ async def test_task_mapping_map_with_sync_iter():
                     ...
         i += 1
     tasks = TaskMapping(_coro_fn)
-    async for k in tasks.map(range(5), pop=False, yields='keys'):
+    async for k in tasks.map(range(5), pop=False, yields="keys"):
         assert isinstance(k, int)
-    
+
     # test keys
     for k in tasks.keys():
         assert isinstance(k, int)
@@ -81,7 +156,7 @@ async def test_task_mapping_map_with_sync_iter():
         assert isinstance(k, int)
     async for k in tasks.keys():
         assert isinstance(k, int)
-    
+
     # test values
     for v in tasks.values():
         assert isinstance(v, asyncio.Future)
@@ -92,7 +167,7 @@ async def test_task_mapping_map_with_sync_iter():
         assert isinstance(v, str)
     async for v in tasks.values():
         assert isinstance(v, str)
-    
+
     # test items
     for k, v in tasks.items():
         assert isinstance(k, int)
@@ -106,12 +181,25 @@ async def test_task_mapping_map_with_sync_iter():
     async for k, v in tasks.items():
         assert isinstance(k, int)
         assert isinstance(v, str)
-    
+
+
 @pytest.mark.asyncio_cooperative
 async def test_task_mapping_map_with_async_iter():
+    """Test TaskMapping with an asynchronous iterator.
+
+    Verifies that :class:`TaskMapping` can map over an asynchronous
+    iterator and correctly handle keys, values, and items.
+    Ensures that mapping in progress raises a :class:`RuntimeError`
+    when attempted concurrently.
+
+    See Also:
+        - :class:`a_sync.TaskMapping`
+    """
+
     async def async_iter():
         for i in range(5):
             yield i
+
     tasks = TaskMapping(_coro_fn)
     i = 0
     async for k, v in tasks.map(async_iter()):
@@ -124,9 +212,9 @@ async def test_task_mapping_map_with_async_iter():
                     ...
         i += 1
     tasks = TaskMapping(_coro_fn)
-    async for k in tasks.map(async_iter(), pop=False, yields='keys'):
+    async for k in tasks.map(async_iter(), pop=False, yields="keys"):
         assert isinstance(k, int)
-    
+
     # test keys
     for k in tasks.keys():
         assert isinstance(k, int)
@@ -138,9 +226,13 @@ async def test_task_mapping_map_with_async_iter():
         assert isinstance(k, int)
     assert await tasks.keys().aiterbykeys() == list(range(5))
     assert await tasks.keys().aiterbyvalues() == list(range(5))
-    assert await tasks.keys().aiterbykeys(reverse=True) == sorted(range(5), reverse=True)
-    assert await tasks.keys().aiterbyvalues(reverse=True) == sorted(range(5), reverse=True)
-    
+    assert await tasks.keys().aiterbykeys(reverse=True) == sorted(
+        range(5), reverse=True
+    )
+    assert await tasks.keys().aiterbyvalues(reverse=True) == sorted(
+        range(5), reverse=True
+    )
+
     # test values
     for v in tasks.values():
         assert isinstance(v, asyncio.Future)
@@ -153,9 +245,13 @@ async def test_task_mapping_map_with_async_iter():
         assert isinstance(v, str)
     assert await tasks.values().aiterbykeys() == [str(i) * i for i in range(1, 6)]
     assert await tasks.values().aiterbyvalues() == [str(i) * i for i in range(1, 6)]
-    assert await tasks.values().aiterbykeys(reverse=True) == [str(i) * i for i in sorted(range(1, 6), reverse=True)]
-    assert await tasks.values().aiterbyvalues(reverse=True) == [str(i) * i for i in sorted(range(1, 6), reverse=True)]
-    
+    assert await tasks.values().aiterbykeys(reverse=True) == [
+        str(i) * i for i in sorted(range(1, 6), reverse=True)
+    ]
+    assert await tasks.values().aiterbyvalues(reverse=True) == [
+        str(i) * i for i in sorted(range(1, 6), reverse=True)
+    ]
+
     # test items
     for k, v in tasks.items():
         assert isinstance(k, int)
@@ -169,42 +265,72 @@ async def test_task_mapping_map_with_async_iter():
     async for k, v in tasks.items():
         assert isinstance(k, int)
         assert isinstance(v, str)
-    assert await tasks.items().aiterbykeys() == [(i, str(i+1) * (i+1)) for i in range(5)]
-    assert await tasks.items().aiterbyvalues() == [(i, str(i+1) * (i+1)) for i in range(5)]
-    assert await tasks.items().aiterbykeys(reverse=True) == [(i, str(i+1) * (i+1)) for i in sorted(range(5), reverse=True)]
-    assert await tasks.items(pop=True).aiterbyvalues(reverse=True) == [(i, str(i+1) * (i+1)) for i in sorted(range(5), reverse=True)]
+    assert await tasks.items().aiterbykeys() == [
+        (i, str(i + 1) * (i + 1)) for i in range(5)
+    ]
+    assert await tasks.items().aiterbyvalues() == [
+        (i, str(i + 1) * (i + 1)) for i in range(5)
+    ]
+    assert await tasks.items().aiterbykeys(reverse=True) == [
+        (i, str(i + 1) * (i + 1)) for i in sorted(range(5), reverse=True)
+    ]
+    assert await tasks.items(pop=True).aiterbyvalues(reverse=True) == [
+        (i, str(i + 1) * (i + 1)) for i in sorted(range(5), reverse=True)
+    ]
     assert not tasks  # did pop work?
 
+
 def test_taskmapping_views_sync():
+    """Test synchronous views of TaskMapping.
+
+    Checks the synchronous access to keys, values, and items
+    in :class:`TaskMapping`. Verifies the state of these views before
+    and after gathering tasks.
+
+    See Also:
+        - :class:`a_sync.TaskMapping`
+    """
     tasks = TaskMapping(_coro_fn, range(5))
-    
+
     # keys are currently empty until the loop has a chance to run
-    assert len(tasks.keys()) == 0
-    assert len(tasks.values()) == 0
-    assert len(tasks.items()) == 0
-    
+    _assert_len_dictviews(tasks, 0)
     tasks.gather()
 
-    assert len(tasks.keys()) == 5
-    assert len(tasks.values()) == 5
-    assert len(tasks.items()) == 5
-
+    _assert_len_dictviews(tasks, 5)
     for k in tasks.keys():
         assert isinstance(k, int)
 
     # test values
     for v in tasks.values():
         assert isinstance(v, asyncio.Future)
-    
+
     # test items
     for k, v in tasks.items():
         assert isinstance(k, int)
         assert isinstance(v, asyncio.Future)
-        
+
     assert len(tasks.keys()) == 5
     for k in tasks.keys():
         assert isinstance(k, int)
 
+
+def _assert_len_dictviews(tasks, i):
+    assert len(tasks.keys()) == i
+    assert len(tasks.values()) == i
+    assert len(tasks.items()) == i
+
+
 async def _coro_fn(i: int) -> str:
+    """Coroutine function for testing.
+
+    Args:
+        i: An integer input.
+
+    Returns:
+        A string representation of the incremented input.
+
+    See Also:
+        - :func:`a_sync.TaskMapping`
+    """
     i += 1
     return str(i) * i

ez_a_sync-0.22.14.dist-info/RECORD

@@ -1,74 +0,0 @@
-a_sync/ENVIRONMENT_VARIABLES.py,sha256=mbOTOeyDyc90OA0CcTNzaOHKm3YT3myanQvVcefdtBU,462
-a_sync/__init__.py,sha256=iPrNPP5i2H02HmX050hz-XqAYwAwrlyh3hkXRegdy7E,2204
-a_sync/_smart.py,sha256=mZ7zD8usbRG3dEjddwnz46gwFxcDjPri6na7vCPX9hw,6989
-a_sync/_typing.py,sha256=GTCqBBgeCGoB_wLb0WoizBrrYf2a-2GXgK82CZQKP2E,5368
-a_sync/aliases.py,sha256=kkv7JGdlJeyy2x8JauCy3D6spbYBCTMgNtC_QrT118s,213
-a_sync/exceptions.py,sha256=0VHUEBgTVmaF8LIuFINCv1YCuC_GfCJgmwnPP3I9HRI,6597
-a_sync/executor.py,sha256=ztaDCWQnQKoxrMHuEKPH1lm-gJWYinNjCeOTa3riBbk,13433
-a_sync/future.py,sha256=zQy3Gv1UvX399Yx5-W-ygxYZSS_C3aEhQlEz8gyoB90,26093
-a_sync/iter.py,sha256=riMXy2RSxmOtgv-L521YSWSTeZ8QXWhc8irU6mjEgkk,20804
-a_sync/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-a_sync/task.py,sha256=FEf788GSKzBCOqjtljlqKlisT5ZyK_kCa-d_-KTSuOc,28213
-a_sync/a_sync/__init__.py,sha256=V93WFLhKbDR9oSegknq6ub-M85HT983eIt_Tov0Reos,1092
-a_sync/a_sync/_descriptor.py,sha256=jhcPnzJ3PJ4o7l_wf5DbmH-sKQxS14Yd1uh_riYq_rU,7851
-a_sync/a_sync/_flags.py,sha256=2-97KHE-Hjb5RPnx4AU2h5TJ2nR7tBdnzqHWvkLgOs8,1669
-a_sync/a_sync/_helpers.py,sha256=z6TRvqlXUdLKRyw0ZCZyzY6FvkNyoGt8_XgEGjV-UaU,1837
-a_sync/a_sync/_kwargs.py,sha256=szblXLK1LF2S71LsLGQTCFM4v9E0xJP-rdkL6O2xKJo,1378
-a_sync/a_sync/_meta.py,sha256=0rNZ1jZMhsHlxXsKeU88B5xOW8PMcis2Y8vbK0ZzrrM,5973
-a_sync/a_sync/abstract.py,sha256=PzT_Uo7F4DR6cU1CGl8q_bFOiw95qbXnzCZXt_HfN0g,3261
-a_sync/a_sync/base.py,sha256=qE7p2nXmpwpMulCnZcBV1I5sXiWGtcmtAEZVrqAt0rc,7363
-a_sync/a_sync/config.py,sha256=b9YDs3cjoyxiwxIEld78dyVWsv1rGZMLutJVQauT29Y,2764
-a_sync/a_sync/decorator.py,sha256=s_KqDzIki3NvsXnjd9dlUnHgmOlM8HwcjOjl9rlzOK0,8424
-a_sync/a_sync/function.py,sha256=94qtv62rgJmIOwwYLdaTth53HJ3a_VSR4dDnwqpg-PU,28643
-a_sync/a_sync/method.py,sha256=Iq1FaklAzBavNHIR9FHwRVik1dAGlAPhOhsjMrWZtWU,23291
-a_sync/a_sync/property.py,sha256=--JEWuGLI47kV9-LL2psW5R6u1dlSgGISNgy-ZChCmA,18151
-a_sync/a_sync/singleton.py,sha256=dHFwuSkOYP58Dn_I6zciMpJmeG1ENMOjJ1j8lOFQrl0,1459
-a_sync/a_sync/modifiers/__init__.py,sha256=0kOpApvcDIBr37645vY50aG6lIdccNG_IupZZsAawBM,1052
-a_sync/a_sync/modifiers/limiter.py,sha256=WtMh-F_4O6kxAYGiCKTnTYu2RrPQNov3dDYB4OTigjk,1763
-a_sync/a_sync/modifiers/manager.py,sha256=Taknn8MjVbelzmRECd7mNvcSi-eX9_SZpW11bEWN8UQ,3637
-a_sync/a_sync/modifiers/semaphores.py,sha256=zgIzzJ_c1UuJRMb6wMQ3D5PlCK-FaYkC0jnQsd02n0M,2446
-a_sync/a_sync/modifiers/cache/__init__.py,sha256=cvjf_-M_UQFWXCs6NjEknlGT8Mq5tOuNDaU6zYw3kaQ,1838
-a_sync/a_sync/modifiers/cache/memory.py,sha256=jA_GxZWxLIUxcOA8ji0EBnhqfZYlmOh2TIXABa-Zzso,1648
-a_sync/asyncio/__init__.py,sha256=mgT590EGauaw_u-bknTKJUYX4-tvd7pHXH4hQr4GQcs,366
-a_sync/asyncio/as_completed.py,sha256=BYSmJXXtMP5bu1M95-PUQX4rGAO82eKdXh94NM8wKFQ,7761
-a_sync/asyncio/create_task.py,sha256=xhV_AlCldNffLQW1Ex_JmuxaFC2TNDT5WA8dVkXFacY,3591
-a_sync/asyncio/gather.py,sha256=EyrYLJ5gyY1WQdYvRw0shmS9HcsQqnYG3rrIkNpzjwM,5622
-a_sync/asyncio/utils.py,sha256=v4b3XtNyDEtW-wTRnM3snwx1A9vAzPcE17-KZon2L5U,389
-a_sync/primitives/__init__.py,sha256=X0Ijv35WmfNnjlIzqX8a-2RPUwV5dC5HXPumzAqCJT8,442
-a_sync/primitives/_debug.py,sha256=QOeb5Y2HQz_7eEpdKK2oGh6Q4fbYP2dNPFktfKfrN24,3121
-a_sync/primitives/_loggable.py,sha256=2ojtipyqwLSAwleipDyvUjl_an3Jhic4-RbO4x7uO_Q,1217
-a_sync/primitives/queue.py,sha256=wS1DekEG6Lj-3mS5YFOw5OJVM_dsEQA15pOPqLgjjjE,15907
-a_sync/primitives/locks/__init__.py,sha256=yKzj48RBl1einM4YIUGp5tRm3QgBpmKz2WAr601oLz4,267
-a_sync/primitives/locks/counter.py,sha256=J8kEv534IcRbL9r-CxU35ujQUwPkgnXHqNCD2otf0p8,5031
-a_sync/primitives/locks/event.py,sha256=fKXP5d89ux5B-JJEWje0UZpldLkNyGZJ4aqALDHWQss,2888
-a_sync/primitives/locks/prio_semaphore.py,sha256=IB850luLM-S8rFywh9Ed2_4z8d9Ux3qlsjDD4JcczR4,8238
-a_sync/primitives/locks/semaphore.py,sha256=oIFoIOj2KyBPWtWUJKcq0Las7nLpuu53BwoUy3Dd6sA,6382
-a_sync/sphinx/__init__.py,sha256=VcgVF_ea4HAVNxb8KXX-_fcLviBQGnN9OIRWaUjPhy4,50
-a_sync/sphinx/ext.py,sha256=UjPf7s57mAOpzOSWyxv58pel022XADxUrnL-tRjZIvw,6586
-a_sync/utils/__init__.py,sha256=MP2jX5G8-3WQSF3VxRNFQvbPFdlPPKBrd6rlcLqT9oM,3048
-a_sync/utils/iterators.py,sha256=5GGWSFrO_bAcCK3JHLOVlfMQCkWJpe_Qt01ru2olRm0,8769
-tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/conftest.py,sha256=Q7w6vrh3acUxttLU7Qx35KQS8jeV4ENQ7wzerK0OfLU,57
-tests/executor.py,sha256=quJtFDPFLkhPXrYVWYM1F4NJ1DCeG4XxMz9MLcyx5zg,239
-tests/fixtures.py,sha256=FcapEGhPmQFxcGm953AIdkBNWAXSq2T4m-QzEA20XWw,5532
-tests/test_abstract.py,sha256=OPkHLFw7jI2xVmSHtEZLbslrCadAdf--wxqMtljthpc,518
-tests/test_as_completed.py,sha256=t7_3n0XRe6Yeac4YXBF1pTX0kMhXANpPZVWWjZwsqYY,4328
-tests/test_base.py,sha256=RUnnMk-WttX4g4z7aVtag_ofa4_E_4JKnTkMqsn5MCQ,8702
-tests/test_cache.py,sha256=9GjBHBhPBAuabuzag2pVWSD468EMs3tGYd4ODIeo9-U,2489
-tests/test_decorator.py,sha256=T5ZwLGOwFOmVi9cO6KV1V6houI10ftdXaG1sOpl4jqs,3684
-tests/test_executor.py,sha256=LUa9tLtgG4SKBUQ9Llf2xIWFIIGrTcERlUzV3P_su8o,1164
-tests/test_future.py,sha256=-rxexe_KNtYvIKuTuyHp3bTa7shF18_CylhxHAhyZIs,3405
-tests/test_gather.py,sha256=W4V5NXwIkdDFJv-DVIP6D6bJ_2JboUfbU3xY7BL4CBQ,1376
-tests/test_helpers.py,sha256=kUGnPvq71DxBDbZfSO0czr6cjv_gsIOLki0G58caBz8,347
-tests/test_iter.py,sha256=OfB865Favt2bHsRgLOJfmMYS4joHfq4g7DF6umxpJAY,8908
-tests/test_limiter.py,sha256=l2L4EZtDntkrnbRpMLJ-a5J2rgvUVUO8ao5x_8eXFlA,835
-tests/test_meta.py,sha256=1EmUjgGlHfAwSZQfBZiBKyb_umeHvRrTPm1t4pFblPI,3569
-tests/test_modified.py,sha256=H_Z98JNvy1Ze2Qae6Jgyo1gPqOGycVkwmGutrSmnQmk,247
-tests/test_semaphore.py,sha256=pncCO3Y_xus9f85nCPY6Pr4WbUbHpNZNT5tBgwUAbZA,1628
-tests/test_singleton.py,sha256=KGLLWr4eM3PHh_MBDubseTxAaS0r7Bddal2wY-qY4oA,539
-tests/test_task.py,sha256=BpODWsy6I2LAZ4VZ4SGa4R6rly1U10gz0JjIPoW6GrI,7389
-ez_a_sync-0.22.14.dist-info/LICENSE.txt,sha256=1on6-17OUMlja6vSPTcmlmeT_DwujCZJijYxaplBvZk,1075
-ez_a_sync-0.22.14.dist-info/METADATA,sha256=T7dTZsYrPCtWhBGwFLBvXZwiYn8qdueqHxPkuc3HTpo,533
-ez_a_sync-0.22.14.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-ez_a_sync-0.22.14.dist-info/top_level.txt,sha256=GVK_7kp7dgBLeHp84iIQdsJmiXnrXd-5sIf2x0Q-VKc,13
-ez_a_sync-0.22.14.dist-info/RECORD,,