Codon项目中实现Python扩展类RollingMedian的注意事项

概述

在使用Codon项目开发Python扩展时，开发者River-Shi尝试实现一个RollingMedian类时遇到了两个关键问题：类无法导入和deque类型不支持的问题。本文将详细分析这些问题产生的原因和解决方案。

问题分析

类无法导入问题

最初实现的RollingMedian类无法从编译后的Python扩展模块中导入，错误提示为"cannot import name 'RollingMedian' from 'vec'"。

根本原因：

• 在Codon中，默认情况下类不会自动暴露给Python接口
• 需要显式声明哪些类需要与Python交互

解决方案：

• 使用@dataclass(python=True)装饰器标记需要导出到Python的类
• 这个装饰器会生成必要的Python绑定代码

修正后的类定义应为：

@dataclass(python=True)
class RollingMedian:
    # 类实现...

deque类型不支持问题

添加装饰器后，又遇到了关于deque类型的问题，错误提示"'deque[float]' object has no attribute 'from_py'"。

根本原因：

• Codon的collections.deque类型目前尚未实现Python绑定
• Python和Codon之间的类型转换需要特定的接口方法

临时解决方案：

• 使用List类型替代deque
• List类型已经完整实现了Python绑定支持

未来改进：

• Codon团队已将此功能加入TODO列表
• 预计在后续版本中会添加对deque的完整支持

完整修正代码示例

import collections

@dataclass(python=True)
class RollingMedian:
    n: int 
    data: List[float]  # 使用List替代deque

    def __init__(self, n: int = 10):
        self.n = n
        self.data = []  # 初始化空列表

    def input(self, value: float) -> float:
        self.data.append(value)
        if len(self.data) > self.n:
            self.data.pop(0)  # 手动实现队列的FIFO行为
        return self.get_median()
        
    def get_median(self) -> float:
        sorted_data = sorted(self.data)
        mid = len(sorted_data) // 2

        if len(sorted_data) % 2 == 0:
            return (sorted_data[mid - 1] + sorted_data[mid]) / 2.0
        else:
            return sorted_data[mid]

开发建议

1. 类型选择：在Codon与Python交互的代码中，优先使用已支持绑定的基础类型
2. 装饰器使用：所有需要暴露给Python的类都必须添加@dataclass(python=True)
3. 功能验证：在实现复杂功能前，先用简单示例验证绑定是否正常工作
4. 版本关注：关注Codon的更新日志，了解新增的Python绑定支持

总结

通过本文的分析，我们了解到在Codon项目中开发Python扩展时需要注意类的导出声明和类型兼容性问题。虽然目前某些高级容器类型如deque的支持还不完善，但通过合理的变通方法仍然可以实现所需功能。随着Codon项目的持续发展，这些限制将会逐步解除，为开发者提供更完整的Python互操作体验。