synchronicity

Python 3对异步编程有一些惊人的支持，但可以说这使开发库变得更加困难。您是否厌倦了实施基本同样事情的同步和异步方法？这可能是您的简单解决方案。

安装

 pip install synchronicity

背景：为什么需要这样的东西

假设您具有异步功能

 async def f ( x ):
    await asyncio . sleep ( 1.0 )
    return x ** 2

假设（无论出于何种原因）您想向用户提供同步API。例如，也许您想使在基本脚本中运行代码变得容易，或者用户正在构建大多数是CPU的东西，因此他们不想打扰Asyncio。

创建同步等效的一种“简单”方法是实现一组同步函数，在这些函数中，他们所做的就是在异步函数上称为asyncio.run。但这不是更复杂的代码的绝佳解决方案：

• 必须为每种方法/功能做到这一点，这是一种乏味的咕unt工作
• asyncio.run与发电机不起作用
• 在许多情况下，您需要保留在呼叫之间运行的事件循环。

最后一个案例特别具有挑战性。例如，假设您正在将客户端实现到需要具有持久连接的数据库，并且您想在Asyncio：

 class DBConnection :
    def __init__ ( self , url ):
        self . _url = url

    async def connect ( self ):
        self . _connection = await connect_to_database ( self . _url )

    async def query ( self , q ):
        return await self . _connection . run_query ( q )

您如何将同步接口公开此代码？问题在于，在asyncio.lun中包装connect和query不起作用，因为您需要跨呼叫保留事件循环。很明显，我们需要一些更先进的东西。

如何使用此库

该库提供了一个简单的Synchronizer类，该类在单独的线程上创建事件循环，并包装功能/生成器/类，以便在该线程上进行同步执行。当您调用任何内容时，它将检测到您是在同步或异步上下文中运行的，并相应地行事。

• 在同步情况下，它将仅阻止直到结果可用（请注意，您也可以使其返回未来，请参见稍后）
• 在异步情况下，它的工作原理就像调用异步代码的通常业务

 from synchronicity import Synchronizer

synchronizer = Synchronizer ()

@ synchronizer . create_blocking
async def f ( x ):
    await asyncio . sleep ( 1.0 )
    return x ** 2


# Running f in a synchronous context blocks until the result is available
ret = f ( 42 )  # Blocks
print ( 'f(42) =' , ret )


async def g ():
    # Running f in an asynchronous context works the normal way
    ret = await f ( 42 )
    print ( 'f(42) =' , ret )

更高级的例子

发电机

装饰器还适用于发电机：

 @ synchronizer . create_blocking
async def f ( n ):
    for i in range ( n ):
        await asyncio . sleep ( 1.0 )
	yield i


# Note that the following runs in a synchronous context
# Each number will take 1s to print
for ret in f ( 10 ):
    print ( ret )

同步整个课程

它还通过包装课上的所有方法来在课程上运行：

 @ synchronizer . create_blocking
class DBConnection :
    def __init__ ( self , url ):
        self . _url = url

    async def connect ( self ):
        self . _connection = await connect_to_database ( self . _url )

    async def query ( self , q ):
        return await self . _connection . run_query ( q )


# Now we can call it synchronously, if we want to
db_conn = DBConnection ( 'tcp://localhost:1234' )
db_conn . connect ()
data = db_conn . query ( 'select * from foo' )

返回期货

您还可以通过在任何调用中添加_future=True来使函数返回Future对象。如果您想从阻塞上下文中派遣许多电话，这可能很有用，但是您想大致并行解决它们：

 from synchronicity import Synchronizer

synchronizer = Synchronizer ()

@ synchronizer . create_blocking
async def f ( x ):
    await asyncio . sleep ( 1.0 )
    return x ** 2

futures = [ f ( i , _future = True ) for i in range ( 10 )]  # This returns immediately
rets = [ fut . result () for fut in futures ]  # This should take ~1s to run, resolving all futures in parallel
print ( 'first ten squares:' , rets )

与其他异步代码一起使用

如果您有多个事件循环，或者如果您有一些CPU结合的部分，或者您想在单独的线程上以安全安全性运行，则该库也可以在纯粹的异步设置，如果您有多个事件循环或某些关键代码中很有用。所有对同步函数/发电机的调用都是设计螺纹安全的。这使其成为简单事物的loop.run_in_executor的有用替代方法。但是请注意，每个同步器仅运行一个线程。

上下文经理

您可以像其他任何类一样同步上下文管理器类，并且特殊方法将得到正确处理。

还有一个函数装饰@synchronizer.asynccontextmanager ，其行为就像https://docs.python.org/3/library/contextlib.html.html#contextlib.asyncconconconconconconconconconconcontextmanager，但在同步和异音方面都起作用。

陷入困境

• 它适用于上下文经理的课程，但不适合返回上下文管理器的功能
• 它在包装类时会创建一个新类（具有相同名称），如果您有任何同步的同步使用，这可能会导致键入问题
• 不知道这是如何与打字注释相互作用的
• 如果类“同步”，则它包含类上的所有方法，但这通常意味着您无法触及属性并在其上运行异步代码：您可能会遇到“附加到其他环路”之类的错误
• 请注意，所有同步代码都将在其他线程和其他事件循环上运行，因此调用代码可能会有一些较小的额外开销

戒酒

• 支持相反的情况，即您具有阻止函数/发电机/class/object，并且您想对其进行异步调用（使用loop.run_in_executor，对于普通函数来说，这相对简单，很高兴改变整个班级
• 更多文档
• 使方法可以选择性地注释方法以返回期货
• 也许使得可以即时同步对象，而不仅仅是类

这个库是肢体的边缘

这是我从个人项目中介绍的代码，但没有进行战斗测试。有一个小型测试套件，您可以使用Pytest运行。

发布过程

应该自动化这个...

• 从Main制作新的分支机构release-XYZ
• bump版本pyproject.toml to XYZ
• 提交改变并创建PR
• 合并PR曾经绿色
• 结帐主
• git tag -a vX.YZ -m "* release bullets"
• git推 - 标签
• TWINE_USERNAME=__token__ TWINE_PASSWORD="$PYPI_TOKEN_SYNCHRONICITY" make publish