Python异步函数命名规范及类中混合同异步函数最佳实践

1. Python中异步函数的命名规范 #

• 社区最通用的做法是给异步函数加_async后缀，比如fetch_data_async()，直观易懂，一眼就能和同步函数区分开。
• 少数场景会参考Python内置的异步协议命名风格，用a前缀，比如afetch_data()，但这种方式更多用在框架或底层库实现里，业务代码里不如后缀普及。
• 不管选哪种，项目内必须保持命名风格统一，别一会儿用前缀一会儿用后缀，容易搞混。

2. 类中同时用同步、异步函数的最佳实践 #

下面逐个分析三种方案的适用场景：

方案一：同一类里用_sync/_async后缀区分 #

class My_Class:
    def myfct_sync(...):
        pass
    async def myfct_async(...):
        pass

• 适合情况：同步和异步函数的逻辑高度相关，或者类本身需要同时提供两种调用方式（比如工具类，既支持阻塞调用也支持非阻塞调用）。
• 好处：类的职责集中，用户不用切换不同类就能用两种方式；命名清晰，不会搞混。
• 坏处：如果同步异步逻辑差异大，类会变得臃肿，职责不够单一。

方案二：同一类里用a前缀标记异步函数 #

class My_Class:
    def myfct(...):
        pass
    async def amyfct(...):
        pass

• 适合情况：模仿Python内置异步协议的命名风格，比如实现自定义异步迭代器、异步上下文管理器这类和内置功能对齐的场景。
• 好处：和Python原生命名习惯统一，符合框架开发者的使用习惯。
• 坏处：业务代码里可读性不如后缀，amyfct这类名字不够直观，新手容易懵。

方案三：拆成独立的同步类和异步类 #

class My_Class:
    def myfct(...):
        pass

class Async_My_Class:
    async def myfct(...):
        pass

• 适合情况：同步和异步逻辑独立、差异较大，或者需要严格分离同步/异步职责的场景（比如数据库客户端，同步和异步依赖不同底层驱动）。
• 好处：类的职责单一，代码结构清晰，方便分别维护两种逻辑；用户能按需选对应类，避免误用。
• 坏处：如果两种逻辑有大量重复代码，会增加冗余，需要额外抽离公共逻辑到基类或工具函数里。

总结建议 #

• 要是同步异步逻辑关联紧密、只是调用方式不同，优先选方案一。
• 要是做框架级的异步协议实现，可选方案二。
• 要是同步异步逻辑差异大、独立性强，优先选方案三。
• 最重要的是团队统一约定，项目内保持风格一致比选哪个方案更关键。

内容的提问来源于stack exchange，提问作者ninousf