首页
/ PyO3项目中的类型命名优化:从PyLong到PyInt的演进

PyO3项目中的类型命名优化:从PyLong到PyInt的演进

2025-05-17 23:10:59作者:钟日瑜

在Python与Rust的互操作库PyO3中,类型命名一直是一个值得关注的话题。最近,项目维护者们针对PyStringPyLong这两个核心类型的命名进行了深入讨论,最终决定对部分命名进行调整,使其更加符合现代Python的语义。

历史背景与命名现状

PyO3目前使用PyString来表示Python的str类型,而使用PyLong来表示Python的int类型。这种命名方式源于Python 2时代的历史遗留问题:

  • 在Python 2中,整数类型分为intlong两种
  • 字符串类型则分为str(字节串)和unicode(真正的字符串)
  • Python 3统一了这些类型,但C API中保留了PyLongObject等旧名称

PyO3目前还保留了PyInt作为pyo3::types::PyInt的类型别名,以及PyUnicode这样的历史遗留别名。

命名调整的讨论

项目维护者提出了两个主要调整建议:

  1. PyLong重命名为PyInt,保留PyLong作为已弃用的类型别名
  2. PyString重命名为PyStr,保留PyStringPyUnicode作为已弃用的类型别名

经过社区讨论,最终达成了以下共识:

保留PyString名称

尽管PyStr更简洁,但社区认为:

  • PyString能更明确地表示这是一个分配(allocated)的字符串类型
  • PyStr可能让人误以为与Rust的&str有特殊关联
  • 避免不必要的代码变动(churn)

将PyLong改为PyInt

这一变更获得了广泛支持,因为:

  • long在Rust和现代Python中都不是标准术语
  • PyInt能更清晰地表达其代表Python的int类型
  • 虽然底层使用PyLong_系列C API,但名称一致性不应成为障碍

技术实现与后续工作

这一变更已经由社区贡献者实现并合并。实现过程中:

  1. 创建了新的PyInt类型
  2. PyLong标记为#[deprecated]别名
  3. 确保向后兼容性,给予用户足够时间迁移

对于PyUnicode别名,社区也计划进行类似的弃用处理,使用#[deprecated]属性标记,并在未来版本中移除。

对开发者的影响

这一变更对PyO3用户的影响较小:

  • 新代码应使用PyInt而非PyLong
  • 现有代码中的PyLong仍能工作但会收到弃用警告
  • PyString保持不变,无需修改
  • PyUnicode别名将在未来弃用,建议迁移到PyString

这种命名优化使PyO3的类型系统更加直观,减少了历史包袱带来的认知负担,同时保持了良好的向后兼容性。对于Rust与Python互操作开发者来说,这代表着一小步但重要的API改进。

登录后查看全文
热门项目推荐
相关项目推荐