cn2an: Chinese Numerals To Arabic Numerals

📦 cn2an 是一个快速转化 中文数字 和 阿拉伯数字 的工具包！

🎈 v0.5.24 update: fix numeral parsing and transform edge cases

🎈 en2an: 「英文数字」和「阿拉伯数字」互转正在收集需求中！ 详情

🎈 Cn2An.jl: Julia 语言版本已经上线，正在丰富基础功能。详情

1 功能

1.1 中文数字 => 阿拉伯数字

• 支持 中文数字 => 阿拉伯数字；
• 支持 大写中文数字 => 阿拉伯数字；
• 支持 中文数字和阿拉伯数字 => 阿拉伯数字；
• 支持 中文数字 => 阿拉伯数字字符串 的原样直译；

1.2 阿拉伯数字 => 中文数字

• 支持 阿拉伯数字 => 中文数字；
• 支持 阿拉伯数字 => 大写中文数字；
• 支持 阿拉伯数字 => 大写人民币；
• 支持 阿拉伯数字字符串 => 中文数字 的原样直译；

1.3 句子转化

• 支持 中文数字 => 阿拉伯数字；

  • 支持 日期；
  • 支持 分数；
  • 支持 百分比；
  • 支持 摄氏度；

• 支持 阿拉伯数字 => 中文数字；

  • 支持 日期；
  • 支持 分数；
  • 支持 百分比；
  • 支持 摄氏度；

1.4 其他

• 支持 小数；
• 支持 负数；
• 支持 HTTP API。

2 安装

⚠️ 注意：

1. 本地安装仅支持 Python 的 3.7 以上版本；
2. 尽可能使用 cn2an 的最新版本。

2.1 使用 pip 安装

pip install cn2an -U

2.2 从代码库安装

git clone https://github.com/Ailln/cn2an.git
cd cn2an && python setup.py install

3 使用

# 在文件首部引入包
import cn2an

# 查看当前版本号
print(cn2an.__version__)
# 0.5.24

3.1 中文数字 => 阿拉伯数字

最大支持到 10**16，即 千万亿，最小支持到 10**-16。

import cn2an

# 在 strict 模式（默认）下，只有严格符合数字拼写的才可以进行转化
output = cn2an.cn2an("一百二十三")
# 或者
output = cn2an.cn2an("一百二十三", "strict")
# output:
# 123

# 在 normal 模式下，可以将 一二三 进行转化
output = cn2an.cn2an("一二三", "normal")
# output:
# 123

# 在 smart 模式下，可以将混合拼写的 1百23 进行转化
output = cn2an.cn2an("1百23", "smart")
# output:
# 123

# 以上三种模式均支持负数
output = cn2an.cn2an("负一百二十三", "strict")
# output:
# -123

# 以上三种模式均支持小数
output = cn2an.cn2an("一点二三", "strict")
# output:
# 1.23

# 在 direct 模式下，只做逐位原样转化，并返回字符串
output = cn2an.cn2an("零零三", "direct")
# output:
# 003

output = cn2an.cn2an("一二点三零", "direct")
# output:
# 12.30

3.2 阿拉伯数字 => 中文数字

最大支持到10**16，即千万亿，最小支持到 10**-16。

import cn2an

# 在 low 模式（默认）下，数字转化为小写的中文数字
output = cn2an.an2cn("123")
# 或者
output = cn2an.an2cn("123", "low")
# output:
# 一百二十三

# 在 up 模式下，数字转化为大写的中文数字
output = cn2an.an2cn("123", "up")
# output:
# 壹佰贰拾叁

# 在 rmb 模式下，数字转化为人民币专用的描述
output = cn2an.an2cn("123", "rmb")
# output:
# 壹佰贰拾叁元整

# 以上三种模式均支持负数
output = cn2an.an2cn("-123", "low")
# output:
# 负一百二十三

# 以上三种模式均支持小数
output = cn2an.an2cn("1.23", "low")
# output:
# 一点二三

# 在 direct 模式下，只做逐位原样转化
output = cn2an.an2cn("012", "direct")
# output:
# 零一二

output = cn2an.an2cn("12.30", "direct")
# output:
# 一二点三零

3.3 句子转化

⚠️：试验性功能，可能会造成不符合期望的转化。

import cn2an

# 在 cn2an 方法（默认）下，可以将句子中的中文数字转成阿拉伯数字
output = cn2an.transform("小王捡了一百块钱")
# 或者
output = cn2an.transform("小王捡了一百块钱", "cn2an")
# output:
# 小王捡了100块钱

# 在 an2cn 方法下，可以将句子中的中文数字转成阿拉伯数字
output = cn2an.transform("小王捡了100块钱", "an2cn")
# output:
# 小王捡了一百块钱

# direct=True 时，句子中的数字只做逐位原样转化，不做日期、范围等额外处理
output = cn2an.transform("电话零零三，二〇〇二年", "cn2an", direct=True)
# output:
# 电话003，2002年

output = cn2an.transform("电话012，1-2个月", "an2cn", direct=True)
# output:
# 电话零一二，一-二个月


## 支持日期
output = cn2an.transform("小王的生日是二零零一年三月四日", "cn2an")
# output:
# 小王的生日是2001年3月4日

output = cn2an.transform("小王的生日是2001年3月4日", "an2cn")
# output:
# 小王的生日是二零零一年三月四日


## 支持分数
output = cn2an.transform("抛出去的硬币为正面的概率是二分之一", "cn2an")
# output:
# 抛出去的硬币为正面的概率是1/2

output = cn2an.transform("抛出去的硬币为正面的概率是1/2", "an2cn")
# output:
# 抛出去的硬币为正面的概率是二分之一

## 支持百分比
## 支持摄氏度

3.4 HTTP API

主要为其他语言（Java、Javascript、Go等）用户提供方便，当然 Python 用户也可以使用，点击查看详细用法。

4 版本支持

• 理论上支持 Windows、MacOS、Ubuntu 下的所有 Python 3.7+ 的版本。
• 实际上仅在 ubuntu-latest、windows-latest、macOS-latest 的 Python 3.7, 3.9, 3.11 上做过完整测试。
• 欢迎提交其他版本使用情况到 Issues 中，期待你的反馈。
• 如果你有 Python 2 的使用需求，可 Fork 代码自行修改。当然也欢迎提 PR，贡献自己代码给其他人。

5 问题反馈

1. 先搜索 Issues 中有没有人已经问过类似的问题；
2. 如果没有找到解答，请新开一个 issue：
   1. 首先，在「issue 标题」中填写你遇到的问题的简介；
   2. 然后，在「issue 详情」中填写你遇到的问题的详情；
   3. 最后，不要忘记注明你使用的操作系统（比如 Windows 10）和 Python 版本（比如 Python 3.7.9）。
3. 还可以参考 Issue Template 。

6 开发相关

6.1 开发进度

本项目是用看板管理开发进度，请点击 v0.5 查看开发进度和计划事项。

6.2 代码测试

本地测试使用 Anaconda 的虚拟环境，测试方法如下：

# 执行测试
bash scripts/local_test.sh

线上测试使用 GitHub Actions 。

6.3 性能测试

• 测试版本：v0.5.1

• 测试设备：2.3 GHz 双核Intel Core i5 MacBook Pro

• 测试代码：performance.py

• 测试方法：

  pip install -r requirements_test.txt
  
  python -m cn2an.performance
  

• 测试结果：

  序号	功能	执行次数	执行时间(万次平均)	性能(次/秒)
  1	an2cn	10000	0.15	67k
  2	cn2an	10000	0.35	29k

测试时，我使用的是最大长度的测试数据！因此，大多数情况下该库的性能会更好～

7 许可证

8 致谢

• Thunder Bouble: 提出很多有效的反馈，包括一些 bug 和新功能；
• Damon Yu: 增加对全角数字和全角符号的支持；
• Beants: 修复了口语格式的 bug；
• Ray: 提出修改输出 warn 的方法，以及其他一些建议。

9 参考

• 🎈 cn2an 核心代码解析
• 如何发布自己的包到 pypi
• Python 中的小陷阱
• 汉字数字转阿拉伯数字
• Chinese Text Normalization for Speech Processing
• The Best Tool of Chinese Number to Digits
• Microsoft Recognizers Text Overview
• process: 数据预处理管道
• wikipedia: 中文数字