Python 数值中的下划线是怎么回事？

花下猫语：Python 中下划线的用法令人叹为观止，相信你已在各种文章或教程中见识过了。在 2016 年的 3.6 版本之后，Python 还引入了一种新的语法，使得下划线也可以出现在数值中。这篇翻译的文档，将带你重温这个特性的引入过程。

PEP原文：https://www.python.org/dev/peps/pep-0515

PEP标题：PEP 515 -- Underscores in Numeric Literals

PEP作者：Guido van Rossum, Nick Coghlan

创建日期：Georg Brandl, Serhiy Storchaka

合入版本：3.6

译者：豌豆花下猫@Python猫

PEP翻译计划：https://github.com/chinesehuazhou/peps-cn

概要和原理

本 PEP 提议扩展 Python 的语法，使得在“字符串变成数”（number-from-string）构造器中，下划线可以作为视觉分隔符，对整数、浮点和复数字面量的数字进行分组。

（Python猫注：关于 Python 的数值类型，可以查看 PEP -314 1）

这是其它现代语言的一个常见特性，有助于理解长的或者值应该被直观地分成几部分的字面量，如十六进制表示法中的字节或单词。

例子：

# grouping decimal numbers by thousands

amount = 10_000_000.0

# grouping hexadecimal addresses by words

addr = 0xCAFE_F00D

# grouping bits into nibbles in a binary literal

flags = 0b_0011_1111_0100_1110

# same, for string conversions

flags = int('0b_1111_0000', 2)

规范

目前的提议是在数字之间和在数字字面量的基本标识符之后，允许有一个下划线。下划线没有语义上的意义，数字字面量会被解析得就像没有下划线一样。

字面量语法

因此，整型字面量的表示法看起来像这样：

integer: decinteger | bininteger | octinteger | hexinteger

decinteger: nonzerodigit (["_"] digit)* | "0" (["_"] "0")*

bininteger: "0" ("b" | "B") (["_"] bindigit)+

octinteger: "0" ("o" | "O") (["_"] octdigit)+

hexinteger: "0" ("x" | "X") (["_"] hexdigit)+

nonzerodigit: "1"..."9"

digit: "0"..."9"

bindigit: "0" | "1"

octdigit: "0"..."7"

hexdigit: digit | "a"..."f" | "A"..."F"

浮点数和复数的字面量：

floatnumber: pointfloat | exponentfloat

pointfloat: [digitpart] fraction | digitpart "."

exponentfloat: (digitpart | pointfloat) exponent

digitpart: digit (["_"] digit)*

fraction: "." digitpart

exponent: ("e" | "E") ["+" | "-"] digitpart

imagnumber: (floatnumber | digitpart) ("j" | "J")

构造函数

遵循相同的放置规则，下划线可以在以下构造函数中使用：

int()（任意进制）
float()
complex()
Decimal()

进一步的变更

新式的数字转字符串（number-to-string）格式化语法将被扩展，允许 _ 作为千位分隔符。这可以用更具可读性的字面量来轻松地生成代码。[11]

The syntax would be the same as for the comma, e.g. {:10_} for a width of 10 with _ separator.（这句没看懂...不译）

对于 b、x 和 o 格式符，_ 也将支持，并按 4 位数分组。

现有的技术

那些允许下划线分组的语言，实现了大量放置下划线的规则。在语言规范与实际行为相矛盾的情况下，以下会列出实际的行为。(“单个”或“多个”指的是允许多少连续的下划线。)

Ada：单个，仅在数字间 [8]
C# （7.0 版本的提案）：多个，仅在数字间 [6]
C++14：单个，在数字之间（选了其它分隔符） [1]
D：多个，任意位置，包括末尾 [2]
Java：多个，仅在数字间 [7]
Julia：单个，仅在数字间（但不含浮点指数部分） [9]
Perl 5：多个，基本是任意位置，尽管文档说数字间限制 1 个下划线 [3]
Ruby：单个，仅在数字间（尽管文档说“任意位置”）[10]
Rust：多个，任意位置，除了指数“e”与数字间 [4]
Swift：多个，数字之间和末尾（尽管文档说仅在“数字之间”） [5]

被否决的语法

（Python猫注：每个 PEP 在初提出阶段，都可能引起很多关于语法设计的讨论，在正式采纳的 PEP 中，一般会保留一些有代表性的被否决的方案，例如下面的两项）

1、下划线的放置规则

减少下划线的使用限制，而不是上面声明的相对严格的规则。在其它语言中，常见的规则包括：

只允许一个连续的下划线，并且只能在数字之间。
允许多个连续的下划线，但只能在数字之间。
允许多个连续的下划线，在大多数位置，除了字面量的开头，或特殊的位置（例如小数点后）。

本 PEP 中的语法最终被选中，因为它涵盖了常见的用例，并且不会出现被 Python 风格指南所不鼓励使用的语法。

一个不太常见的规则是只允许每 N 位数字有下划线（其中 N 可能是 3 个十进制字面量，或 4 个十六进制字面量）。这是不必要的限制，特别是考虑到这些分隔符位置在不同的文化中是不同的。（Python猫注：例如，我们国家习惯将 4 个数字分为一组，即 10000 是 1 万，而不是英语文化中的 10 thousand）

2、其它的分隔符

还有一种建议是使用空格进行分组。虽然字符串是一种结合相邻字面量的先例，但这种行为可能会导致意外的效果，而下划线则不会。而且，除了那些基本会忽略任何空格的语言外，没有其它语言使用此规则。

c++ 14 引入了单引号来进行分组（因为下划线会与用户定义的字面量产生歧义），由于单引号已经被 Python 的字符串字面量使用了，所以没有考虑它。［1］

实现

实现上述规范的初步补丁已经发布到问题跟踪器。[12]

参考内容

[1] (1, 2) http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2013/n3499.html

[2] https://dlang.org/spec/lex.html#integerliteral

[3] https://perldoc.perl.org/perldata#Scalar-value-constructors

[4] https://web.archive.org/web/20160304121349/http://doc.rust-lang.org/reference.html#integer-literals

[5] https://docs.swift.org/swift-book/ReferenceManual/LexicalStructure.html

[6] https://github.com/dotnet/roslyn/issues/216

[7] https://docs.oracle.com/javase/7/docs/technotes/guides/language/underscores-literals.html

[8] http://archive.adaic.com/standards/83lrm/html/lrm-02-04.html#2.4

[9] https://web.archive.org/web/20160223175334/http://docs.julialang.org/en/release-0.4/manual/integers-and-floating-point-numbers/

[10] https://ruby-doc.org/core-2.3.0/doc/syntax/literals_rdoc.html#label-Numbers

[11] https://mail.python.org/pipermail/python-dev/2016-February/143283.html

[12] http://bugs.python.org/issue26331

版权

该文档已放入公共领域。

源文件：https://github.com/python/peps/blob/master/pep-0515.txt