decimal — 十进制定点和浮点算术

源代码: Lib/decimal.py


decimal 模块提供了对快速、正确舍入的十进制浮点算术的支持。它比 float 数据类型有几个优点

  • 十进制数“基于一个为人们设计的浮点模型,并且必然有一个最重要的指导原则——计算机必须提供一种与人们在学校学习的算术运算方式相同的方式。” – 摘自十进制算术规范。

  • 十进制数可以精确表示。相比之下,像 1.12.2 这样的数字在二进制浮点数中没有精确的表示。最终用户通常不会期望 1.1 + 2.2 像二进制浮点数那样显示为 3.3000000000000003

  • 这种精确性会延续到算术运算中。在十进制浮点数中,0.1 + 0.1 + 0.1 - 0.3 完全等于零。在二进制浮点数中,结果是 5.5511151231257827e-017。虽然接近于零,但差异会妨碍可靠的相等性测试,并且差异会累积。因此,在具有严格相等性不变式的会计应用程序中,首选十进制。

  • decimal 模块包含有效位数的概念,因此 1.30 + 1.202.50。保留尾随零以表示有效性。这是货币应用程序的习惯表示法。对于乘法,“教科书”方法使用乘数中的所有数字。例如,1.3 * 1.2 得到 1.56,而 1.30 * 1.20 得到 1.5600

  • 与基于硬件的二进制浮点数不同,decimal 模块具有用户可更改的精度(默认为 28 位),该精度可以根据给定问题所需的大小进行调整

    >>> from decimal import *
    >>> getcontext().prec = 6
    >>> Decimal(1) / Decimal(7)
    Decimal('0.142857')
    >>> getcontext().prec = 28
    >>> Decimal(1) / Decimal(7)
    Decimal('0.1428571428571428571428571429')
    
  • 二进制和十进制浮点数都是根据已发布的标准实现的。虽然内置的 float 类型仅公开了其部分功能,但 decimal 模块公开了标准的所有必需部分。在需要时,程序员可以完全控制舍入和信号处理。这包括通过使用异常来阻止任何不精确的操作来强制执行精确算术的选项。

  • decimal 模块旨在“无偏见地同时支持精确的未舍入十进制算术(有时称为定点算术)和舍入的浮点算术。” – 摘自十进制算术规范。

该模块的设计围绕三个概念:十进制数、算术上下文和信号。

十进制数是不可变的。它具有符号、系数数字和指数。为了保留有效性,系数数字不会截断尾随零。十进制数还包括特殊值,例如 Infinity-InfinityNaN。该标准还将 -0+0 区分开。

算术上下文是一个指定精度、舍入规则、指数限制、指示运算结果的标志和确定信号是否被视为异常的陷阱使能器的环境。舍入选项包括 ROUND_CEILINGROUND_DOWNROUND_FLOORROUND_HALF_DOWNROUND_HALF_EVENROUND_HALF_UPROUND_UPROUND_05UP

信号是计算过程中出现的一组异常情况。根据应用程序的需要,信号可以被忽略、被视为信息或被视为异常。decimal 模块中的信号为:ClampedInvalidOperationDivisionByZeroInexactRoundedSubnormalOverflowUnderflowFloatOperation

对于每个信号,都有一个标志和一个陷阱使能器。当遇到信号时,其标志设置为 1,然后,如果陷阱使能器设置为 1,则会引发异常。标志是粘性的,因此用户需要在监视计算之前重置它们。

参见

快速入门教程

使用十进制数的通常开始是导入模块,使用 getcontext() 查看当前上下文,并在必要时设置精度、舍入或启用的陷阱的新值

>>> from decimal import *
>>> getcontext()
Context(prec=28, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
        capitals=1, clamp=0, flags=[], traps=[Overflow, DivisionByZero,
        InvalidOperation])

>>> getcontext().prec = 7       # Set a new precision

Decimal 实例可以从整数、字符串、浮点数或元组构造。从整数或浮点数构造会执行该整数或浮点数值的精确转换。十进制数包括特殊值,例如代表“非数字”的 NaN、正负 Infinity-0

>>> getcontext().prec = 28
>>> Decimal(10)
Decimal('10')
>>> Decimal('3.14')
Decimal('3.14')
>>> Decimal(3.14)
Decimal('3.140000000000000124344978758017532527446746826171875')
>>> Decimal((0, (3, 1, 4), -2))
Decimal('3.14')
>>> Decimal(str(2.0 ** 0.5))
Decimal('1.4142135623730951')
>>> Decimal(2) ** Decimal('0.5')
Decimal('1.414213562373095048801688724')
>>> Decimal('NaN')
Decimal('NaN')
>>> Decimal('-Infinity')
Decimal('-Infinity')

如果 FloatOperation 信号被捕获,则在构造函数或排序比较中意外混合十进制数和浮点数会引发异常

>>> c = getcontext()
>>> c.traps[FloatOperation] = True
>>> Decimal(3.14)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
decimal.FloatOperation: [<class 'decimal.FloatOperation'>]
>>> Decimal('3.5') < 3.7
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
decimal.FloatOperation: [<class 'decimal.FloatOperation'>]
>>> Decimal('3.5') == 3.5
True

3.3 版本新增。

一个新的 Decimal 的有效位数仅由输入的数字位数决定。上下文精度和舍入仅在算术运算时起作用。

>>> getcontext().prec = 6
>>> Decimal('3.0')
Decimal('3.0')
>>> Decimal('3.1415926535')
Decimal('3.1415926535')
>>> Decimal('3.1415926535') + Decimal('2.7182818285')
Decimal('5.85987')
>>> getcontext().rounding = ROUND_UP
>>> Decimal('3.1415926535') + Decimal('2.7182818285')
Decimal('5.85988')

如果超出 C 版本的内部限制,构造一个 decimal 会引发 InvalidOperation 异常。

>>> Decimal("1e9999999999999999999")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
decimal.InvalidOperation: [<class 'decimal.InvalidOperation'>]

在 3.3 版本中更改。

Decimal 可以很好地与 Python 的其他部分交互。以下是一个关于 decimal 浮点数的简单演示:

>>> data = list(map(Decimal, '1.34 1.87 3.45 2.35 1.00 0.03 9.25'.split()))
>>> max(data)
Decimal('9.25')
>>> min(data)
Decimal('0.03')
>>> sorted(data)
[Decimal('0.03'), Decimal('1.00'), Decimal('1.34'), Decimal('1.87'),
 Decimal('2.35'), Decimal('3.45'), Decimal('9.25')]
>>> sum(data)
Decimal('19.29')
>>> a,b,c = data[:3]
>>> str(a)
'1.34'
>>> float(a)
1.34
>>> round(a, 1)
Decimal('1.3')
>>> int(a)
1
>>> a * 5
Decimal('6.70')
>>> a * b
Decimal('2.5058')
>>> c % a
Decimal('0.77')

一些数学函数也可用于 Decimal:

>>> getcontext().prec = 28
>>> Decimal(2).sqrt()
Decimal('1.414213562373095048801688724')
>>> Decimal(1).exp()
Decimal('2.718281828459045235360287471')
>>> Decimal('10').ln()
Decimal('2.302585092994045684017991455')
>>> Decimal('10').log10()
Decimal('1')

quantize() 方法将数字四舍五入到固定指数。此方法对于货币应用非常有用,货币应用通常将结果四舍五入到固定的小数位数。

>>> Decimal('7.325').quantize(Decimal('.01'), rounding=ROUND_DOWN)
Decimal('7.32')
>>> Decimal('7.325').quantize(Decimal('1.'), rounding=ROUND_UP)
Decimal('8')

如上所示,getcontext() 函数访问当前上下文,并允许更改设置。此方法满足大多数应用程序的需求。

对于更高级的工作,使用 Context() 构造函数创建备用上下文可能会很有用。要使备用上下文生效,请使用 setcontext() 函数。

根据标准,decimal 模块提供了两个可立即使用的标准上下文,BasicContextExtendedContext。前者对于调试特别有用,因为许多陷阱已启用。

>>> myothercontext = Context(prec=60, rounding=ROUND_HALF_DOWN)
>>> setcontext(myothercontext)
>>> Decimal(1) / Decimal(7)
Decimal('0.142857142857142857142857142857142857142857142857142857142857')

>>> ExtendedContext
Context(prec=9, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
        capitals=1, clamp=0, flags=[], traps=[])
>>> setcontext(ExtendedContext)
>>> Decimal(1) / Decimal(7)
Decimal('0.142857143')
>>> Decimal(42) / Decimal(0)
Decimal('Infinity')

>>> setcontext(BasicContext)
>>> Decimal(42) / Decimal(0)
Traceback (most recent call last):
  File "<pyshell#143>", line 1, in -toplevel-
    Decimal(42) / Decimal(0)
DivisionByZero: x / 0

上下文还具有信号标志,用于监视计算期间遇到的异常情况。这些标志会一直保持设置状态,直到被显式清除,因此最好在使用 clear_flags() 方法之前,在每次进行受监视的计算之前清除这些标志。

>>> setcontext(ExtendedContext)
>>> getcontext().clear_flags()
>>> Decimal(355) / Decimal(113)
Decimal('3.14159292')
>>> getcontext()
Context(prec=9, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
        capitals=1, clamp=0, flags=[Inexact, Rounded], traps=[])

flags 条目显示,pi 的有理数近似值被舍入(超出上下文精度的数字被丢弃),并且结果不精确(一些被丢弃的数字为非零)。

可以使用上下文的 traps 属性中的字典来设置各个陷阱。

>>> setcontext(ExtendedContext)
>>> Decimal(1) / Decimal(0)
Decimal('Infinity')
>>> getcontext().traps[DivisionByZero] = 1
>>> Decimal(1) / Decimal(0)
Traceback (most recent call last):
  File "<pyshell#112>", line 1, in -toplevel-
    Decimal(1) / Decimal(0)
DivisionByZero: x / 0

大多数程序仅在程序开始时调整当前上下文一次。并且在许多应用程序中,数据在循环内使用单个类型转换转换为 Decimal。设置好上下文并创建了 decimal 后,程序的大部分操作数据的方式与使用其他 Python 数字类型没有区别。

Decimal 对象

class decimal.Decimal(value='0', context=None)

基于 *value* 构造一个新的 Decimal 对象。

value 可以是整数、字符串、元组、float 或另一个 Decimal 对象。 如果没有给出 *value*,则返回 Decimal('0')。如果 *value* 是字符串,则在删除开头和结尾的空白字符以及所有下划线后,它应符合 decimal 数字字符串语法。

sign           ::=  '+' | '-'
digit          ::=  '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
indicator      ::=  'e' | 'E'
digits         ::=  digit [digit]...
decimal-part   ::=  digits '.' [digits] | ['.'] digits
exponent-part  ::=  indicator [sign] digits
infinity       ::=  'Infinity' | 'Inf'
nan            ::=  'NaN' [digits] | 'sNaN' [digits]
numeric-value  ::=  decimal-part [exponent-part] | infinity
numeric-string ::=  [sign] numeric-value | [sign] nan

在上面的 digit 出现的地方,也允许使用其他 Unicode 十进制数字。这些包括来自各种其他字母表(例如,阿拉伯-印度和提婆那伽梨数字)的十进制数字以及全角数字 '\uff10''\uff19'

如果 *value* 是一个 tuple,它应具有三个组成部分,一个符号(0 表示正数,或 1 表示负数),一个数字的 tuple 和一个整数指数。例如,Decimal((0, (1, 4, 1, 4), -3)) 返回 Decimal('1.414')

如果 *value* 是一个 float,则二进制浮点值将无损转换为其精确的十进制等效项。此转换通常可能需要 53 位或更多位的精度。例如,Decimal(float('1.1')) 转换为 Decimal('1.100000000000000088817841970012523233890533447265625')

context 精度不会影响存储的位数。它完全由 *value* 中的位数确定。例如,即使上下文精度只有三位,Decimal('3.00000') 也会记录所有五个零。

context 参数的目的是确定如果 *value* 是格式错误的字符串该怎么做。如果上下文捕获 InvalidOperation,则会引发异常;否则,构造函数将返回一个新的值为 NaN 的 Decimal。

构造完成后,Decimal 对象是不可变的。

在 3.2 版本中更改: 现在允许构造函数的参数是 float 实例。

在 3.3 版本中更改: 如果设置了 FloatOperation 陷阱,则 float 参数将引发异常。默认情况下,该陷阱处于关闭状态。

在 3.6 版本中更改: 允许使用下划线进行分组,就像代码中的整数和浮点文字一样。

Decimal 浮点数对象与诸如 floatint 之类的其他内置数字类型共享许多属性。所有常用的数学运算和特殊方法都适用。同样,decimal 对象可以被复制、pickle、打印、用作字典键、用作集合元素、比较、排序以及强制转换为另一种类型(例如 floatint)。

在 Decimal 对象上进行算术运算与在整数和浮点数上进行算术运算之间存在一些细微的差异。当余数运算符 % 应用于 Decimal 对象时,结果的符号是被除数的符号,而不是除数的符号。

>>> (-7) % 4
1
>>> Decimal(-7) % Decimal(4)
Decimal('-3')

整数除法运算符 // 的行为类似,返回真商的整数部分(向零截断)而不是其向下取整,以便保留通常的恒等式 x == (x // y) * y + x % y

>>> -7 // 4
-2
>>> Decimal(-7) // Decimal(4)
Decimal('-1')

%// 运算符分别实现规范中描述的 remainderdivide-integer 操作。

十进制对象通常不能与浮点数或 fractions.Fraction 的实例进行算术运算:例如,尝试将 Decimal 加到 float 将引发 TypeError。但是,可以使用 Python 的比较运算符将 Decimal 实例 x 与另一个数字 y 进行比较。这可以避免在比较不同类型的数字时产生混淆的结果。

在 3.2 版本中更改: 现在完全支持 Decimal 实例与其他数字类型之间的混合类型比较。

除了标准的数字属性外,十进制浮点数对象还具有许多专用方法。

adjusted()

返回调整后的指数,方法是移出系数的最右边的数字,直到只剩下前导数字: Decimal('321e+5').adjusted() 返回 7。用于确定相对于小数点的最高有效数字的位置。

as_integer_ratio()

返回一对整数 (n, d),它们将给定的 Decimal 实例表示为分数,该分数以最简形式且具有正分母。

>>> Decimal('-3.14').as_integer_ratio()
(-157, 50)

转换是精确的。对无穷大引发 OverflowError,对 NaN 引发 ValueError。

在 3.6 版本中添加。

as_tuple()

返回数字的 命名元组 表示形式:DecimalTuple(sign, digits, exponent)

canonical()

返回参数的规范编码。目前, Decimal 实例的编码始终是规范的,因此此操作返回其未更改的参数。

compare(other, context=None)

比较两个 Decimal 实例的值。 compare() 返回一个 Decimal 实例,如果其中一个操作数是 NaN,则结果是 NaN。

a or b is a NaN  ==> Decimal('NaN')
a < b            ==> Decimal('-1')
a == b           ==> Decimal('0')
a > b            ==> Decimal('1')
compare_signal(other, context=None)

此操作与 compare() 方法相同,只是所有 NaN 都会发出信号。也就是说,如果两个操作数都不是 signaling NaN,则任何 quiet NaN 操作数都会被视为 signaling NaN。

compare_total(other, context=None)

使用操作数的抽象表示而不是数值来比较两个操作数。与 compare() 方法类似,但是结果给出了 Decimal 实例的完全排序。在此排序中,具有相同数值但表示不同的两个 Decimal 实例会比较为不相等。

>>> Decimal('12.0').compare_total(Decimal('12'))
Decimal('-1')

quiet 和 signaling NaN 也包括在完全排序中。如果两个操作数具有相同的表示形式,则此函数的结果为 Decimal('0');如果第一个操作数在总顺序中低于第二个操作数,则结果为 Decimal('-1');如果第一个操作数在总顺序中高于第二个操作数,则结果为 Decimal('1')。有关总顺序的详细信息,请参阅规范。

此操作不受上下文影响,并且是安静的:不会更改任何标志,也不会执行任何舍入。作为例外,如果无法精确转换第二个操作数,则 C 版本可能会引发 InvalidOperation。

compare_total_mag(other, context=None)

使用操作数的抽象表示而不是其值来比较两个操作数,如 compare_total() 中所示,但忽略每个操作数的符号。x.compare_total_mag(y) 等效于 x.copy_abs().compare_total(y.copy_abs())

此操作不受上下文影响,并且是安静的:不会更改任何标志,也不会执行任何舍入。作为例外,如果无法精确转换第二个操作数,则 C 版本可能会引发 InvalidOperation。

conjugate()

只返回 self,此方法仅是为了符合十进制规范。

copy_abs()

返回参数的绝对值。此操作不受上下文影响,并且是安静的:不会更改任何标志,也不会执行任何舍入。

copy_negate()

返回参数的负值。此操作不受上下文影响,并且是安静的:不会更改任何标志,也不会执行任何舍入。

copy_sign(other, context=None)

返回第一个操作数的副本,其符号设置为与第二个操作数的符号相同。例如

>>> Decimal('2.3').copy_sign(Decimal('-1.5'))
Decimal('-2.3')

此操作不受上下文影响,并且是安静的:不会更改任何标志,也不会执行任何舍入。作为例外,如果无法精确转换第二个操作数,则 C 版本可能会引发 InvalidOperation。

exp(context=None)

返回给定数字的(自然)指数函数 e**x 的值。使用 ROUND_HALF_EVEN 舍入模式正确舍入结果。

>>> Decimal(1).exp()
Decimal('2.718281828459045235360287471')
>>> Decimal(321).exp()
Decimal('2.561702493119680037517373933E+139')
classmethod from_float(f)

仅接受 floatint 实例的替代构造函数。

请注意,Decimal.from_float(0.1)Decimal('0.1') 不同。由于 0.1 在二进制浮点数中不能精确表示,因此该值存储为最接近的可表示值,即 0x1.999999999999ap-4。十进制的等效值为 0.1000000000000000055511151231257827021181583404541015625

注意

从 Python 3.2 开始,Decimal 实例也可以直接从 float 构建。

>>> Decimal.from_float(0.1)
Decimal('0.1000000000000000055511151231257827021181583404541015625')
>>> Decimal.from_float(float('nan'))
Decimal('NaN')
>>> Decimal.from_float(float('inf'))
Decimal('Infinity')
>>> Decimal.from_float(float('-inf'))
Decimal('-Infinity')

3.1 版本新增。

fma(other, third, context=None)

融合乘加运算。返回 self*other+third,不进行中间乘积 self*other 的舍入。

>>> Decimal(2).fma(3, 5)
Decimal('11')
is_canonical()

如果参数是规范的,则返回 True,否则返回 False。目前,Decimal 实例始终是规范的,因此此操作始终返回 True

is_finite()

如果参数是有限数,则返回 True,如果参数是无穷大或 NaN,则返回 False

is_infinite()

如果参数是正无穷大或负无穷大,则返回 True,否则返回 False

is_nan()

如果参数是(静默或信令)NaN,则返回 True,否则返回 False

is_normal(context=None)

如果参数是正常的有限数,则返回 True。如果参数是零、次正规数、无穷大或 NaN,则返回 False

is_qnan()

如果参数是静默 NaN,则返回 True,否则返回 False

is_signed()

如果参数具有负号,则返回 True,否则返回 False。请注意,零和 NaN 都可以带有符号。

is_snan()

如果参数是信令 NaN,则返回 True,否则返回 False

is_subnormal(context=None)

如果参数是次正规数,则返回 True,否则返回 False

is_zero()

如果参数是(正或负)零,则返回 True,否则返回 False

ln(context=None)

返回操作数的自然对数(底数为 e)。结果使用 ROUND_HALF_EVEN 舍入模式进行正确舍入。

log10(context=None)

返回操作数的以 10 为底的对数。结果使用 ROUND_HALF_EVEN 舍入模式进行正确舍入。

logb(context=None)

对于非零数字,将其操作数的调整后的指数作为 Decimal 实例返回。如果操作数是零,则返回 Decimal('-Infinity') 并引发 DivisionByZero 标志。如果操作数是无穷大,则返回 Decimal('Infinity')

logical_and(other, context=None)

logical_and() 是一种逻辑运算,它接受两个逻辑操作数(参见 逻辑操作数)。结果是两个操作数的逐位 and

logical_invert(context=None)

logical_invert() 是一种逻辑运算。结果是操作数的逐位反转。

logical_or(other, context=None)

logical_or() 是一种逻辑运算,它接受两个逻辑操作数(参见 逻辑操作数)。结果是两个操作数的逐位 or

logical_xor(other, context=None)

logical_xor() 是一种逻辑运算,它接受两个逻辑操作数(参见 逻辑操作数)。结果是两个操作数的逐位异或。

max(other, context=None)

类似于 max(self, other),不同之处在于在返回之前应用上下文舍入规则,并且 NaN 值会被发出信号或忽略(取决于上下文以及它们是信令还是静默)。

max_mag(other, context=None)

max() 方法类似,但比较是使用操作数的绝对值进行的。

min(other, context=None)

类似于 min(self, other),不同之处在于,返回之前会应用上下文舍入规则,并且 NaN 值要么被发出信号,要么被忽略(取决于上下文以及它们是发出信号的 NaN 还是安静的 NaN)。

min_mag(other, context=None)

min() 方法类似,但比较是使用操作数的绝对值进行的。

next_minus(context=None)

返回给定上下文中(如果未给出上下文,则返回当前线程的上下文中)可表示的、小于给定操作数的最大数字。

next_plus(context=None)

返回给定上下文中(如果未给出上下文,则返回当前线程的上下文中)可表示的、大于给定操作数的最小数字。

next_toward(other, context=None)

如果两个操作数不相等,则返回最接近第一个操作数,并且方向指向第二个操作数的数字。 如果两个操作数在数值上相等,则返回第一个操作数的副本,并将符号设置为与第二个操作数的符号相同。

normalize(context=None)

用于在当前上下文或指定的上下文内生成等价类的规范值。

这与一元加运算具有相同的语义,但如果最终结果是有限的,则会将其简化为最简单的形式,删除所有尾随零并保留其符号。 也就是说,当系数非零且是 10 的倍数时,系数除以 10,并且指数增加 1。 否则(系数为零),指数设置为 0。在所有情况下,符号保持不变。

例如,Decimal('32.100')Decimal('0.321000e+2') 都被规范化为等效值 Decimal('32.1')

请注意,舍入是在简化为最简形式之前应用的。

在最新版本的规范中,此操作也称为 reduce

number_class(context=None)

返回一个描述操作数的字符串。 返回的值是以下十个字符串之一。

  • "-Infinity",表示操作数为负无穷大。

  • "-Normal",表示操作数为负正规数。

  • "-Subnormal",表示操作数为负次正规数。

  • "-Zero",表示操作数为负零。

  • "+Zero",表示操作数为正零。

  • "+Subnormal",表示操作数为正次正规数。

  • "+Normal",表示操作数为正正规数。

  • "+Infinity",表示操作数为正无穷大。

  • "NaN",表示操作数是安静的 NaN(非数字)。

  • "sNaN",表示操作数是发出信号的 NaN。

quantize(exp, rounding=None, context=None)

返回一个等于第一个操作数舍入后,并且具有第二个操作数的指数的值。

>>> Decimal('1.41421356').quantize(Decimal('1.000'))
Decimal('1.414')

与其他操作不同,如果量化操作后系数的长度大于精度,则会发出 InvalidOperation 信号。 这保证了,除非存在错误情况,否则量化的指数始终等于右手操作数的指数。

同样与其他操作不同,即使结果是次正规数且不精确,量化也永远不会发出下溢信号。

如果第二个操作数的指数大于第一个操作数的指数,则可能需要舍入。 在这种情况下,舍入模式由给定的 rounding 参数确定(如果给定),否则由给定的 context 参数确定; 如果两个参数均未给出,则使用当前线程上下文的舍入模式。

只要结果指数大于 Emax 或小于 Etiny(),就会返回错误。

radix()

返回 Decimal(10),即 Decimal 类执行所有算术的基数(底数)。 为了与规范兼容而包含。

remainder_near(other, context=None)

返回 self 除以 other 的余数。 这与 self % other 的不同之处在于,选择余数的符号是为了最小化其绝对值。 更准确地说,返回值是 self - n * other,其中 n 是最接近 self / other 精确值的整数,并且如果两个整数同样接近,则选择偶数。

如果结果为零,则其符号将为 self 的符号。

>>> Decimal(18).remainder_near(Decimal(10))
Decimal('-2')
>>> Decimal(25).remainder_near(Decimal(10))
Decimal('5')
>>> Decimal(35).remainder_near(Decimal(10))
Decimal('-5')
rotate(other, context=None)

返回将第一个操作数的数字旋转由第二个操作数指定的值的结果。 第二个操作数必须是 -precision 到 precision 范围内的整数。 第二个操作数的绝对值给出了旋转的位数。 如果第二个操作数为正,则向左旋转;否则,向右旋转。 如果需要,第一个操作数的系数在左侧用零填充至精度长度。 第一个操作数的符号和指数不变。

same_quantum(other, context=None)

测试 self 和 other 是否具有相同的指数,或者两者是否都是 NaN

此操作不受上下文影响,并且是安静的:不会更改任何标志,也不会执行任何舍入。作为例外,如果无法精确转换第二个操作数,则 C 版本可能会引发 InvalidOperation。

scaleb(other, context=None)

返回第一个操作数,其指数由第二个操作数调整。等效地,返回第一个操作数乘以 10**other。第二个操作数必须是整数。

shift(other, context=None)

返回将第一个操作数的数字移动由第二个操作数指定的量后的结果。第二个操作数必须是 -precision 到 precision 范围内的整数。第二个操作数的绝对值给出了移动的位数。如果第二个操作数为正数,则向左移动;否则向右移动。移入系数的数字为零。第一个操作数的符号和指数不变。

sqrt(context=None)

返回参数的平方根,精度为全精度。

to_eng_string(context=None)

转换为字符串,如果需要指数,则使用工程计数法。

工程计数法的指数是 3 的倍数。这可以在小数点左侧保留最多 3 位数字,并且可能需要添加一个或两个尾随零。

例如,这将 Decimal('123E+1') 转换为 Decimal('1.23E+3')

to_integral(rounding=None, context=None)

to_integral_value() 方法相同。to_integral 名称保留是为了与旧版本兼容。

to_integral_exact(rounding=None, context=None)

四舍五入到最接近的整数,如果发生舍入,则根据需要发出 InexactRounded 信号。舍入模式由给定的 rounding 参数确定(如果给定),否则由给定的 context 确定。如果未给出任何参数,则使用当前上下文的舍入模式。

to_integral_value(rounding=None, context=None)

四舍五入到最接近的整数,而不发出 InexactRounded 信号。如果给定,则应用*舍入*;否则,使用提供的*上下文*或当前上下文中的舍入方法。

可以使用 round() 函数对十进制数进行舍入

round(number)
round(number, ndigits)

如果未给出*ndigits* 或 None,则返回最接近*number*的 int,四舍五入到偶数,并忽略 Decimal 上下文的舍入模式。如果*number*是无穷大,则引发 OverflowError,如果它是(安静或发出信号的)NaN,则引发 ValueError

如果*ndigits* 是一个 int,则会遵守上下文的舍入模式,并返回一个表示*number* 四舍五入到 Decimal('1E-ndigits') 最接近倍数的 Decimal;在这种情况下,round(number, ndigits) 等效于 self.quantize(Decimal('1E-ndigits'))。如果*number*是安静的 NaN,则返回 Decimal('NaN')。如果*number*是无穷大、发出信号的 NaN,或者如果量化操作后系数的长度大于当前上下文的精度,则引发 InvalidOperation。换句话说,对于非极端情况

  • 如果*ndigits*为正,则返回*number*四舍五入到*ndigits*位小数;

  • 如果*ndigits*为零,则返回*number*四舍五入到最接近的整数;

  • 如果*ndigits*为负数,则返回*number*四舍五入到 10**abs(ndigits) 最接近的倍数。

例如

>>> from decimal import Decimal, getcontext, ROUND_DOWN
>>> getcontext().rounding = ROUND_DOWN
>>> round(Decimal('3.75'))     # context rounding ignored
4
>>> round(Decimal('3.5'))      # round-ties-to-even
4
>>> round(Decimal('3.75'), 0)  # uses the context rounding
Decimal('3')
>>> round(Decimal('3.75'), 1)
Decimal('3.7')
>>> round(Decimal('3.75'), -1)
Decimal('0E+1')

逻辑操作数

logical_and()logical_invert()logical_or()logical_xor() 方法期望它们的参数为*逻辑操作数*。*逻辑操作数*是一个 Decimal 实例,其指数和符号均为零,并且其数字全部为 01

上下文对象

上下文是算术运算的环境。它们控制精度,设置舍入规则,确定哪些信号被视为异常,并限制指数的范围。

每个线程都有自己的当前上下文,可以使用 getcontext()setcontext() 函数访问或更改。

decimal.getcontext()

返回活动线程的当前上下文。

decimal.setcontext(c)

将活动线程的当前上下文设置为*c*。

您还可以使用 with 语句和 localcontext() 函数来临时更改活动上下文。

decimal.localcontext(ctx=None, **kwargs)

返回一个上下文管理器,它将在进入 with 语句时将活动线程的当前上下文设置为*ctx*的副本,并在退出 with 语句时恢复之前的上下文。如果没有指定上下文,则使用当前上下文的副本。*kwargs* 参数用于设置新上下文的属性。

例如,以下代码将当前十进制精度设置为 42 位,执行计算,然后自动恢复之前的上下文

from decimal import localcontext

with localcontext() as ctx:
    ctx.prec = 42   # Perform a high precision calculation
    s = calculate_something()
s = +s  # Round the final result back to the default precision

使用关键字参数,代码将如下所示

from decimal import localcontext

with localcontext(prec=42) as ctx:
    s = calculate_something()
s = +s

如果 kwargs 提供的属性是 TypeError 不支持的,则会引发 TypeError 异常。如果 kwargs 为某个属性提供了无效值,则会引发 TypeErrorValueError 异常。

在 3.11 版本中更改: localcontext() 现在支持通过使用关键字参数来设置上下文属性。

也可以使用下面描述的 Context 构造函数创建新的上下文。此外,该模块还提供了三个预定义的上下文。

class decimal.BasicContext

这是由《通用十进制算术规范》定义的标准上下文。精度设置为 9。舍入设置为 ROUND_HALF_UP。所有标志都被清除。除了 Inexact, RoundedSubnormal 之外的所有陷阱都被启用(视为异常)。

由于启用了许多陷阱,此上下文对于调试非常有用。

class decimal.ExtendedContext

这是由《通用十进制算术规范》定义的标准上下文。精度设置为 9。舍入设置为 ROUND_HALF_EVEN。所有标志都被清除。不启用任何陷阱(因此在计算过程中不会引发异常)。

由于禁用了陷阱,因此此上下文适用于那些倾向于使用 NaNInfinity 作为结果值而不是引发异常的应用程序。这允许应用程序在存在可能导致程序停止的条件下完成运行。

class decimal.DefaultContext

此上下文被 Context 构造函数用作新上下文的原型。更改一个字段(如精度)会影响 Context 构造函数创建的新上下文的默认值。

此上下文在多线程环境中最为有用。在启动线程之前更改其中一个字段可以设置系统范围的默认值。不建议在线程启动后更改字段,因为它需要线程同步以防止竞争条件。

在单线程环境中,最好完全不使用此上下文。相反,只需如下所述显式创建上下文即可。

默认值为 Context.prec=28, Context.rounding=ROUND_HALF_EVEN, 并为 OverflowInvalidOperationDivisionByZero 启用陷阱。

除了提供的三个上下文之外,还可以使用 Context 构造函数创建新的上下文。

class decimal.Context(prec=None, rounding=None, Emin=None, Emax=None, capitals=None, clamp=None, flags=None, traps=None)

创建一个新的上下文。如果未指定字段或字段为 None,则默认值会从 DefaultContext 复制。如果未指定 *flags* 字段或字段为 None,则会清除所有标志。

prec 是一个介于 [1, MAX_PREC] 之间的整数,用于设置上下文中算术运算的精度。

rounding 选项是 舍入模式 部分中列出的常量之一。

trapsflags 字段列出要设置的任何信号。通常,新上下文应仅设置陷阱并保持标志清除状态。

EminEmax 字段是指定指数允许的外部限制的整数。Emin 必须在范围 [MIN_EMIN, 0] 中,Emax 必须在范围 [0, MAX_EMAX] 中。

capitals 字段是 01 (默认)。如果设置为 1,则指数会使用大写 E 打印;否则,会使用小写 eDecimal('6.02e+23')

clamp 字段是 0 (默认) 或 1。如果设置为 1,则在此上下文中可表示的 Decimal 实例的指数 e 严格限制在范围 Emin - prec + 1 <= e <= Emax - prec + 1 内。如果 clamp0,则成立的条件较弱:Decimal 实例的调整后的指数最多为 Emax。当 clamp1 时,一个大的正常数(如果可能)会将其指数减小,并在其系数中添加相应数量的零,以符合指数约束;这保留了数字的值,但会丢失有关重要尾随零的信息。例如

>>> Context(prec=6, Emax=999, clamp=1).create_decimal('1.23e999')
Decimal('1.23000E+999')

clamp 值为 1 允许与 IEEE 754 中指定的固定宽度十进制交换格式兼容。

Context 类定义了一些通用的方法,以及大量用于在给定上下文中直接进行算术运算的方法。此外,对于上面描述的每个 Decimal 方法(除了 adjusted()as_tuple() 方法),都有一个对应的 Context 方法。例如,对于一个 Context 实例 C 和一个 Decimal 实例 xC.exp(x) 等同于 x.exp(context=C)。每个 Context 方法都接受 Python 整数(int 的实例),如同接受 Decimal 实例一样。

clear_flags()

将所有标志重置为 0

clear_traps()

将所有陷阱重置为 0

3.3 版本新增。

copy()

返回上下文的副本。

copy_decimal(num)

返回 Decimal 实例 num 的副本。

create_decimal(num)

num 创建一个新的 Decimal 实例,但使用 self 作为上下文。与 Decimal 构造函数不同,上下文精度、舍入方法、标志和陷阱会应用于转换。

这很有用,因为常量通常以比应用程序需要的更高的精度给出。另一个好处是,舍入会立即消除超出当前精度的数字带来的意外影响。在以下示例中,使用未舍入的输入意味着将零添加到总和可以更改结果

>>> getcontext().prec = 3
>>> Decimal('3.4445') + Decimal('1.0023')
Decimal('4.45')
>>> Decimal('3.4445') + Decimal(0) + Decimal('1.0023')
Decimal('4.44')

此方法实现了 IBM 规范的 to-number 操作。如果参数是字符串,则不允许有前导或尾随的空格或下划线。

create_decimal_from_float(f)

从浮点数 f 创建一个新的 Decimal 实例,但使用 self 作为上下文进行舍入。与 Decimal.from_float() 类方法不同,上下文精度、舍入方法、标志和陷阱会应用于转换。

>>> context = Context(prec=5, rounding=ROUND_DOWN)
>>> context.create_decimal_from_float(math.pi)
Decimal('3.1415')
>>> context = Context(prec=5, traps=[Inexact])
>>> context.create_decimal_from_float(math.pi)
Traceback (most recent call last):
    ...
decimal.Inexact: None

3.1 版本新增。

Etiny()

返回一个等于 Emin - prec + 1 的值,这是次正规结果的最小指数值。当发生下溢时,指数将设置为 Etiny

Etop()

返回一个等于 Emax - prec + 1 的值。

处理小数的通常方法是创建 Decimal 实例,然后应用算术运算,这些运算在活动线程的当前上下文中进行。另一种方法是使用上下文方法在特定上下文中进行计算。这些方法与 Decimal 类的方法类似,这里只做简要介绍。

abs(x)

返回 x 的绝对值。

add(x, y)

返回 xy 的和。

canonical(x)

返回相同的 Decimal 对象 x

compare(x, y)

在数值上比较 xy

compare_signal(x, y)

在数值上比较两个操作数的值。

compare_total(x, y)

使用抽象表示形式比较两个操作数。

compare_total_mag(x, y)

使用抽象表示形式比较两个操作数,忽略符号。

copy_abs(x)

返回 x 的副本,并将符号设置为 0。

copy_negate(x)

返回 x 的副本,并将符号取反。

copy_sign(x, y)

y 的符号复制到 x

divide(x, y)

返回 x 除以 y 的结果。

divide_int(x, y)

返回 x 除以 y 的结果,截断为整数。

divmod(x, y)

将两个数字相除,并返回结果的整数部分。

exp(x)

返回 e ** x

fma(x, y, z)

返回 x 乘以 y,加上 z 的结果。

is_canonical(x)

如果 x 是规范的,则返回 True;否则返回 False

is_finite(x)

如果 x 是有限的,则返回 True;否则返回 False

is_infinite(x)

如果 x 是无限的,则返回 True;否则返回 False

is_nan(x)

如果 x 是 qNaN 或 sNaN,则返回 True;否则返回 False

is_normal(x)

如果 x 是一个正规数,则返回 True;否则返回 False

is_qnan(x)

如果 x 是一个安静的 NaN,则返回 True;否则返回 False

is_signed(x)

如果 x 是负数,则返回 True;否则返回 False

is_snan(x)

如果 x 是一个信号 NaN,则返回 True;否则返回 False

is_subnormal(x)

如果 x 是次正规数,则返回 True;否则返回 False

is_zero(x)

如果 x 是零,则返回 True;否则返回 False

ln(x)

返回 x 的自然对数(底为 e)。

log10(x)

返回 x 的以 10 为底的对数。

logb(x)

返回操作数 MSD 的大小的指数。

logical_and(x, y)

在每个操作数的数字之间应用逻辑运算

logical_invert(x)

反转 x 中的所有数字。

logical_or(x, y)

在每个操作数的数字之间应用逻辑运算

logical_xor(x, y)

在每个操作数的数字之间应用逻辑运算异或

max(x, y)

以数值方式比较两个值,并返回最大值。

max_mag(x, y)

以数值方式比较这些值,忽略它们的符号。

min(x, y)

以数值方式比较两个值,并返回最小值。

min_mag(x, y)

以数值方式比较这些值,忽略它们的符号。

minus(x)

Minus 对应于 Python 中的一元前缀减号运算符。

multiply(x, y)

返回 xy 的乘积。

next_minus(x)

返回小于 x 的最大可表示数字。

next_plus(x)

返回大于 x 的最小可表示数字。

next_toward(x, y)

返回最接近 x,并朝向 y 方向的数字。

normalize(x)

x 简化为其最简形式。

number_class(x)

返回 x 的类别的指示。

plus(x)

Plus 对应于 Python 中的一元前缀加号运算符。此操作应用上下文精度和舍入,因此它不是一个恒等运算。

power(x, y, modulo=None)

返回 xy 次幂,如果给定了 modulo,则对 modulo 取模。

使用两个参数,计算 x**y。如果 x 为负数,则 y 必须为整数。除非 y 为整数,并且结果为有限的并且可以用 ‘precision’ 位数精确表示,否则结果将不精确。使用上下文的舍入模式。Python 版本中的结果始终正确舍入。

Decimal(0) ** Decimal(0) 会导致 InvalidOperation,如果 InvalidOperation 没有被捕获,则会导致 Decimal('NaN')

在 3.3 版本中更改: C 模块根据正确舍入的 exp()ln() 函数计算 power()。结果是明确定义的,但仅“几乎总是正确舍入”。

使用三个参数,计算 (x**y) % modulo。对于三参数形式,以下参数限制适用

  • 所有三个参数必须为整数

  • y 必须为非负数

  • xy 中至少有一个必须为非零

  • modulo 必须为非零,并且最多具有 ‘precision’ 位数

Context.power(x, y, modulo) 产生的值等于通过计算具有无界精度的 (x**y) % modulo 获得的值,但是计算效率更高。结果的指数为零,而与 xymodulo 的指数无关。结果始终是精确的。

量化(x, y)

返回一个值,该值等于x(已舍入),且具有y的指数。

基数()

只返回 10,因为这是 Decimal,:)

余数(x, y)

返回整数除法的余数。

如果结果非零,则结果的符号与原始被除数的符号相同。

临近余数(x, y)

返回 x - y * n,其中 *n* 是最接近 x / y 精确值的整数(如果结果为 0,则其符号将与 *x* 的符号相同)。

循环(x, y)

返回 *x* 的循环副本,循环 *y* 次。

相同量子(x, y)

如果两个操作数具有相同的指数,则返回 True

scaleb(x, y)

返回第一个操作数,并在其 exp 中加上第二个值后。

移位(x, y)

返回 *x* 的移位副本,移位 *y* 次。

平方根(x)

在上下文精度范围内,一个非负数的平方根。

相减(x, y)

返回 *x* 和 *y* 之间的差值。

转为工程字符串(x)

转换为字符串,如果需要指数,则使用工程计数法。

工程计数法的指数是 3 的倍数。这可以在小数点左侧保留最多 3 位数字,并且可能需要添加一个或两个尾随零。

转为精确整数(x)

舍入为整数。

转为科学计数法字符串(x)

使用科学计数法将数字转换为字符串。

常量

本节中的常量仅与 C 模块相关。 为了兼容性,它们也包含在纯 Python 版本中。

32 位

64 位

decimal.MAX_PREC

425000000

999999999999999999

decimal.MAX_EMAX

425000000

999999999999999999

decimal.MIN_EMIN

-425000000

-999999999999999999

decimal.MIN_ETINY

-849999999

-1999999999999999997

decimal.HAVE_THREADS

该值为 True。 已弃用,因为 Python 现在始终具有线程。

自 3.9 版本起已弃用。

decimal.HAVE_CONTEXTVAR

默认值为 True。 如果 Python 使用 使用 --without-decimal-contextvar 选项配置,则 C 版本使用线程局部而非协程局部上下文,并且该值为 False。 在某些嵌套上下文场景中,这会稍微快一些。

在 3.8.3 版本中添加。

舍入模式

decimal.ROUND_CEILING

Infinity 舍入。

decimal.ROUND_DOWN

向零舍入。

decimal.ROUND_FLOOR

-Infinity 舍入。

decimal.ROUND_HALF_DOWN

舍入到最接近的数,其中关系走向零。

decimal.ROUND_HALF_EVEN

舍入到最接近的数,其中关系走向最接近的偶数整数。

decimal.ROUND_HALF_UP

舍入到最接近的数,其中关系远离零。

decimal.ROUND_UP

远离零舍入。

decimal.ROUND_05UP

如果向零舍入后的最后一位数字为 0 或 5,则远离零舍入; 否则向零舍入。

信号

信号表示计算过程中出现的条件。 每个信号对应一个上下文标志和一个上下文陷阱启用器。

每当遇到该条件时,都会设置上下文标志。 计算之后,可以检查标志以获取信息(例如,确定计算是否精确)。 检查完标志后,请务必在开始下一次计算之前清除所有标志。

如果为信号设置了上下文的陷阱启用器,则该条件会导致引发 Python 异常。 例如,如果设置了 DivisionByZero 陷阱,则在遇到该条件时会引发 DivisionByZero 异常。

class decimal.Clamped

更改了指数以适应表示约束。

通常,当指数超出上下文的 EminEmax 限制时,会发生钳位。 如果可能,通过在系数中添加零来减少指数以适应。

class decimal.DecimalException

其他信号的基类和 ArithmeticError 的子类。

class decimal.DivisionByZero

表示非无穷数除以零的信号。

可能发生在除法、模除法或将数字提高到负幂时。 如果未捕获此信号,则返回 Infinity-Infinity,其符号由计算的输入确定。

class decimal.Inexact

指示发生了舍入且结果不精确。

当在舍入期间丢弃非零数字时发出信号。 返回舍入后的结果。 信号标志或陷阱用于检测结果何时不精确。

class decimal.InvalidOperation

执行了无效操作。

指示请求的操作没有意义。 如果没有捕获,则返回 NaN。 可能的原因包括

Infinity - Infinity
0 * Infinity
Infinity / Infinity
x % 0
Infinity % x
sqrt(-x) and x > 0
0 ** 0
x ** (non-integer)
x ** Infinity
class decimal.Overflow

数值溢出。

表示在舍入发生后,指数大于 Context.Emax。如果未被捕获,则结果取决于舍入模式,要么向内拉到最大的可表示有限数,要么向外舍入到 Infinity。无论哪种情况,都会同时发出 InexactRounded 信号。

class decimal.Rounded

发生了舍入,尽管可能没有信息丢失。

每当舍入丢弃数字时发出信号;即使这些数字为零(例如将 5.00 舍入到 5.0)。如果未被捕获,则返回结果不变。此信号用于检测有效数字的丢失。

class decimal.Subnormal

舍入之前,指数低于 Emin

当操作结果为次正规数(指数太小)时发生。如果未被捕获,则返回结果不变。

class decimal.Underflow

数值下溢,结果舍入为零。

当次正规结果被舍入为零时发生。同时发出 InexactSubnormal 信号。

class decimal.FloatOperation

启用更严格的浮点数和 Decimal 混合语义。

如果信号未被捕获(默认),则允许在 Decimal 构造函数、 create_decimal() 和所有比较运算符中混合使用浮点数和 Decimal。转换和比较都是精确的。任何混合操作的发生都会通过在上下文标志中设置 FloatOperation 来静默记录。使用 from_float()create_decimal_from_float() 的显式转换不会设置该标志。

否则(信号被捕获),只有相等比较和显式转换是静默的。所有其他混合操作都会引发 FloatOperation

下表总结了信号的层次结构

exceptions.ArithmeticError(exceptions.Exception)
    DecimalException
        Clamped
        DivisionByZero(DecimalException, exceptions.ZeroDivisionError)
        Inexact
            Overflow(Inexact, Rounded)
            Underflow(Inexact, Rounded, Subnormal)
        InvalidOperation
        Rounded
        Subnormal
        FloatOperation(DecimalException, exceptions.TypeError)

浮点数说明

通过提高精度来减轻舍入误差

使用十进制浮点数消除了十进制表示误差(使得可以精确表示 0.1);但是,当非零数字超过固定精度时,某些操作仍然会产生舍入误差。

舍入误差的影响可以通过加法或减法几乎相互抵消的量来放大,从而导致有效数字的损失。Knuth 提供了两个具有指导意义的示例,其中精度不足的舍入浮点运算会导致加法的结合律和分配律失效

# Examples from Seminumerical Algorithms, Section 4.2.2.
>>> from decimal import Decimal, getcontext
>>> getcontext().prec = 8

>>> u, v, w = Decimal(11111113), Decimal(-11111111), Decimal('7.51111111')
>>> (u + v) + w
Decimal('9.5111111')
>>> u + (v + w)
Decimal('10')

>>> u, v, w = Decimal(20000), Decimal(-6), Decimal('6.0000003')
>>> (u*v) + (u*w)
Decimal('0.01')
>>> u * (v+w)
Decimal('0.0060000')

decimal 模块可以通过扩展精度以避免有效数字的损失来恢复这些恒等式

>>> getcontext().prec = 20
>>> u, v, w = Decimal(11111113), Decimal(-11111111), Decimal('7.51111111')
>>> (u + v) + w
Decimal('9.51111111')
>>> u + (v + w)
Decimal('9.51111111')
>>>
>>> u, v, w = Decimal(20000), Decimal(-6), Decimal('6.0000003')
>>> (u*v) + (u*w)
Decimal('0.0060000')
>>> u * (v+w)
Decimal('0.0060000')

特殊值

decimal 模块的数字系统提供特殊值,包括 NaNsNaN-InfinityInfinity 和两个零,+0-0

可以使用:Decimal('Infinity') 直接构造无穷大。此外,当 DivisionByZero 信号未被捕获时,它们也可能因除以零而产生。同样,当 Overflow 信号未被捕获时,无穷大可能因舍入超出最大可表示数的限制而产生。

无穷大是有符号的(仿射),并且可以在算术运算中使用,其中它们被视为非常大的、不确定的数字。例如,将一个常数加到无穷大上会得到另一个无限的结果。

一些运算是不确定的并返回 NaN,或者如果 InvalidOperation 信号被捕获,则引发异常。例如,0/0 返回 NaN,表示“不是数字”。这种 NaN 是静默的,一旦创建,它将在其他计算中流动,总是产生另一个 NaN。此行为对于偶尔缺少输入的一系列计算很有用 — 它允许计算继续进行,同时将特定结果标记为无效。

一个变体是 sNaN,它在每次操作后都会发出信号,而不是保持静默。当无效结果需要中断计算以进行特殊处理时,这是一个有用的返回值。

Python 的比较运算符的行为在涉及 NaN 时可能会有些令人惊讶。当其中一个操作数是安静或发出信号的 NaN 时,相等性测试总是返回 False(即使在执行 Decimal('NaN')==Decimal('NaN') 时),而不等性测试总是返回 True。如果任一操作数是 NaN,则尝试使用任何 <<=>>= 运算符比较两个 Decimal 将引发 InvalidOperation 信号,如果此信号未被捕获,则返回 False。请注意,通用十进制算术规范未指定直接比较的行为;这些涉及 NaN 的比较规则取自 IEEE 854 标准(参见 5.7 节中的表 3)。为了确保严格符合标准,请改用 compare()compare_signal() 方法。

带符号的零可能来自下溢的计算。它们保留如果计算以更高的精度执行本应产生的符号。由于它们的大小为零,因此正零和负零都被视为相等,并且它们的符号是信息性的。

除了两个带符号的零,它们是不同的但相等的之外,还有各种精度不同但值等效的零的表示形式。这需要一些时间来适应。对于习惯于规范化浮点数表示的人来说,以下计算返回的值等于零这一点并不明显

>>> 1 / Decimal('Infinity')
Decimal('0E-1000026')

使用线程

getcontext() 函数访问每个线程的不同 Context 对象。拥有单独的线程上下文意味着线程可以进行更改(例如 getcontext().prec=10),而不会干扰其他线程。

同样,setcontext() 函数会自动将其目标分配给当前线程。

如果在调用 setcontext() 之前没有调用过 getcontext(),则 getcontext() 将自动创建一个新的上下文,供当前线程使用。

新上下文是从名为 *DefaultContext* 的原型上下文复制的。 要控制默认值,以便每个线程在整个应用程序中使用相同的值,请直接修改 *DefaultContext* 对象。 这应该在任何线程启动 *之前* 完成,这样在线程调用 getcontext() 之间就不会出现竞争条件。 例如:

# Set applicationwide defaults for all threads about to be launched
DefaultContext.prec = 12
DefaultContext.rounding = ROUND_DOWN
DefaultContext.traps = ExtendedContext.traps.copy()
DefaultContext.traps[InvalidOperation] = 1
setcontext(DefaultContext)

# Afterwards, the threads can be started
t1.start()
t2.start()
t3.start()
 . . .

示例

这里有一些示例,它们充当实用函数,并演示了使用 Decimal 类的方法

def moneyfmt(value, places=2, curr='', sep=',', dp='.',
             pos='', neg='-', trailneg=''):
    """Convert Decimal to a money formatted string.

    places:  required number of places after the decimal point
    curr:    optional currency symbol before the sign (may be blank)
    sep:     optional grouping separator (comma, period, space, or blank)
    dp:      decimal point indicator (comma or period)
             only specify as blank when places is zero
    pos:     optional sign for positive numbers: '+', space or blank
    neg:     optional sign for negative numbers: '-', '(', space or blank
    trailneg:optional trailing minus indicator:  '-', ')', space or blank

    >>> d = Decimal('-1234567.8901')
    >>> moneyfmt(d, curr='$')
    '-$1,234,567.89'
    >>> moneyfmt(d, places=0, sep='.', dp='', neg='', trailneg='-')
    '1.234.568-'
    >>> moneyfmt(d, curr='$', neg='(', trailneg=')')
    '($1,234,567.89)'
    >>> moneyfmt(Decimal(123456789), sep=' ')
    '123 456 789.00'
    >>> moneyfmt(Decimal('-0.02'), neg='<', trailneg='>')
    '<0.02>'

    """
    q = Decimal(10) ** -places      # 2 places --> '0.01'
    sign, digits, exp = value.quantize(q).as_tuple()
    result = []
    digits = list(map(str, digits))
    build, next = result.append, digits.pop
    if sign:
        build(trailneg)
    for i in range(places):
        build(next() if digits else '0')
    if places:
        build(dp)
    if not digits:
        build('0')
    i = 0
    while digits:
        build(next())
        i += 1
        if i == 3 and digits:
            i = 0
            build(sep)
    build(curr)
    build(neg if sign else pos)
    return ''.join(reversed(result))

def pi():
    """Compute Pi to the current precision.

    >>> print(pi())
    3.141592653589793238462643383

    """
    getcontext().prec += 2  # extra digits for intermediate steps
    three = Decimal(3)      # substitute "three=3.0" for regular floats
    lasts, t, s, n, na, d, da = 0, three, 3, 1, 0, 0, 24
    while s != lasts:
        lasts = s
        n, na = n+na, na+8
        d, da = d+da, da+32
        t = (t * n) / d
        s += t
    getcontext().prec -= 2
    return +s               # unary plus applies the new precision

def exp(x):
    """Return e raised to the power of x.  Result type matches input type.

    >>> print(exp(Decimal(1)))
    2.718281828459045235360287471
    >>> print(exp(Decimal(2)))
    7.389056098930650227230427461
    >>> print(exp(2.0))
    7.38905609893
    >>> print(exp(2+0j))
    (7.38905609893+0j)

    """
    getcontext().prec += 2
    i, lasts, s, fact, num = 0, 0, 1, 1, 1
    while s != lasts:
        lasts = s
        i += 1
        fact *= i
        num *= x
        s += num / fact
    getcontext().prec -= 2
    return +s

def cos(x):
    """Return the cosine of x as measured in radians.

    The Taylor series approximation works best for a small value of x.
    For larger values, first compute x = x % (2 * pi).

    >>> print(cos(Decimal('0.5')))
    0.8775825618903727161162815826
    >>> print(cos(0.5))
    0.87758256189
    >>> print(cos(0.5+0j))
    (0.87758256189+0j)

    """
    getcontext().prec += 2
    i, lasts, s, fact, num, sign = 0, 0, 1, 1, 1, 1
    while s != lasts:
        lasts = s
        i += 2
        fact *= i * (i-1)
        num *= x * x
        sign *= -1
        s += num / fact * sign
    getcontext().prec -= 2
    return +s

def sin(x):
    """Return the sine of x as measured in radians.

    The Taylor series approximation works best for a small value of x.
    For larger values, first compute x = x % (2 * pi).

    >>> print(sin(Decimal('0.5')))
    0.4794255386042030002732879352
    >>> print(sin(0.5))
    0.479425538604
    >>> print(sin(0.5+0j))
    (0.479425538604+0j)

    """
    getcontext().prec += 2
    i, lasts, s, fact, num, sign = 1, 0, x, 1, x, 1
    while s != lasts:
        lasts = s
        i += 2
        fact *= i * (i-1)
        num *= x * x
        sign *= -1
        s += num / fact * sign
    getcontext().prec -= 2
    return +s

Decimal 常见问题

问:键入 decimal.Decimal('1234.5') 很麻烦。 在使用交互式解释器时,有没有办法减少键入次数?

答:一些用户将构造函数缩写为单个字母

>>> D = decimal.Decimal
>>> D('1.23') + D('3.45')
Decimal('4.68')

问:在具有两位小数的定点应用程序中,某些输入具有很多位,需要进行舍入。 其他输入不应有多余的数字,需要进行验证。 应该使用什么方法?

答:quantize() 方法会舍入到固定的小数位数。 如果设置了 Inexact 陷阱,它也很有用于验证

>>> TWOPLACES = Decimal(10) ** -2       # same as Decimal('0.01')
>>> # Round to two places
>>> Decimal('3.214').quantize(TWOPLACES)
Decimal('3.21')
>>> # Validate that a number does not exceed two places
>>> Decimal('3.21').quantize(TWOPLACES, context=Context(traps=[Inexact]))
Decimal('3.21')
>>> Decimal('3.214').quantize(TWOPLACES, context=Context(traps=[Inexact]))
Traceback (most recent call last):
   ...
Inexact: None

问:一旦我有了有效的两位小数输入,如何才能在整个应用程序中保持这种不变性?

答:某些操作(如加法、减法和整数乘法)会自动保留定点。 其他操作(如除法和非整数乘法)会更改小数位数,并且需要进行 quantize() 步骤来跟进

>>> a = Decimal('102.72')           # Initial fixed-point values
>>> b = Decimal('3.17')
>>> a + b                           # Addition preserves fixed-point
Decimal('105.89')
>>> a - b
Decimal('99.55')
>>> a * 42                          # So does integer multiplication
Decimal('4314.24')
>>> (a * b).quantize(TWOPLACES)     # Must quantize non-integer multiplication
Decimal('325.62')
>>> (b / a).quantize(TWOPLACES)     # And quantize division
Decimal('0.03')

在开发定点应用程序时,定义函数来处理 quantize() 步骤很方便

>>> def mul(x, y, fp=TWOPLACES):
...     return (x * y).quantize(fp)
...
>>> def div(x, y, fp=TWOPLACES):
...     return (x / y).quantize(fp)
>>> mul(a, b)                       # Automatically preserve fixed-point
Decimal('325.62')
>>> div(b, a)
Decimal('0.03')

问:有很多方法可以表示相同的值。 数字 200200.0002E2.02E+4 在不同的精度下都具有相同的值。 有没有办法将它们转换为单个可识别的规范值?

答:normalize() 方法将所有等效值映射到单个代表值

>>> values = map(Decimal, '200 200.000 2E2 .02E+4'.split())
>>> [v.normalize() for v in values]
[Decimal('2E+2'), Decimal('2E+2'), Decimal('2E+2'), Decimal('2E+2')]

问:计算中何时会发生舍入?

答:它发生在计算 *之后*。 decimal 规范的理念是,数字被认为是精确的,并且在创建时与当前上下文无关。 它们甚至可以具有比当前上下文更高的精度。 计算使用这些精确的输入进行处理,然后将舍入(或其他上下文操作)应用于计算的 *结果*

>>> getcontext().prec = 5
>>> pi = Decimal('3.1415926535')   # More than 5 digits
>>> pi                             # All digits are retained
Decimal('3.1415926535')
>>> pi + 0                         # Rounded after an addition
Decimal('3.1416')
>>> pi - Decimal('0.00005')        # Subtract unrounded numbers, then round
Decimal('3.1415')
>>> pi + 0 - Decimal('0.00005').   # Intermediate values are rounded
Decimal('3.1416')

问:某些十进制值始终以指数表示法打印。 有没有办法获得非指数表示?

答:对于某些值,指数表示法是表达系数中有效位数数量的唯一方法。 例如,将 5.0E+3 表示为 5000 可以保持值不变,但不能显示原始值的两位有效位。

如果应用程序不关心跟踪有效位数,则很容易删除指数和尾随零,从而失去有效位数,但保持值不变

>>> def remove_exponent(d):
...     return d.quantize(Decimal(1)) if d == d.to_integral() else d.normalize()
>>> remove_exponent(Decimal('5E+3'))
Decimal('5000')

问:有没有办法将常规浮点数转换为 Decimal

答:是的,任何二进制浮点数都可以精确地表示为 Decimal,尽管精确转换可能需要比直觉所建议的更高的精度

>>> Decimal(math.pi)
Decimal('3.141592653589793115997963468544185161590576171875')

问:在复杂的计算中,我如何确保我没有因为精度不足或舍入异常而得到虚假的结果?

答:decimal 模块可以轻松测试结果。 最佳实践是使用更高的精度和各种舍入模式重新运行计算。 差异很大的结果表示精度不足、舍入模式问题、输入条件不良或算法数值不稳定。

问:我注意到上下文精度应用于操作的结果,但不应用于输入。 混合使用不同精度的值时,有什么需要注意的吗?

答:是的。 原则是所有值都被认为是精确的,因此对这些值的算术运算也是精确的。 只有结果会被舍入。 输入的优点是“所见即所得”。 缺点是,如果您忘记输入没有被舍入,结果可能会看起来很奇怪

>>> getcontext().prec = 3
>>> Decimal('3.104') + Decimal('2.104')
Decimal('5.21')
>>> Decimal('3.104') + Decimal('0.000') + Decimal('2.104')
Decimal('5.20')

解决方案是提高精度或使用一元加号操作强制舍入输入

>>> getcontext().prec = 3
>>> +Decimal('1.23456789')      # unary plus triggers rounding
Decimal('1.23')

或者,可以使用 Context.create_decimal() 方法在创建时舍入输入

>>> Context(prec=5, rounding=ROUND_DOWN).create_decimal('1.2345678')
Decimal('1.2345')

问:CPython 实现对于大数是否快速?

答:是的。 在 CPython 和 PyPy3 实现中,decimal 模块的 C/CFFI 版本集成了高速 libmpdec 库,用于任意精度、正确舍入的十进制浮点算术[1]libmpdec 对于中等大小的数字使用 Karatsuba 乘法,对于非常大的数字使用 数论变换

必须调整上下文以进行精确的任意精度算术。 EminEmax 应始终设置为最大值,clamp 应始终为 0(默认值)。 设置 prec 需要小心。

尝试大数算术的最简单方法是将 prec 的最大值也用于 [2]

>>> setcontext(Context(prec=MAX_PREC, Emax=MAX_EMAX, Emin=MIN_EMIN))
>>> x = Decimal(2) ** 256
>>> x / 128
Decimal('904625697166532776746648320380374280103671755200316906558262375061821325312')

对于不精确的结果,MAX_PREC 在 64 位平台上过大,可用内存将不足

>>> Decimal(1) / 3
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
MemoryError

在具有过度分配的系统(例如 Linux)上,一种更复杂的方法是将 prec 调整为可用 RAM 的大小。 假设您有 8GB 的 RAM,并且期望 10 个同时运行的操作数,每个操作数最多使用 500MB

>>> import sys
>>>
>>> # Maximum number of digits for a single operand using 500MB in 8-byte words
>>> # with 19 digits per word (4-byte and 9 digits for the 32-bit build):
>>> maxdigits = 19 * ((500 * 1024**2) // 8)
>>>
>>> # Check that this works:
>>> c = Context(prec=maxdigits, Emax=MAX_EMAX, Emin=MIN_EMIN)
>>> c.traps[Inexact] = True
>>> setcontext(c)
>>>
>>> # Fill the available precision with nines:
>>> x = Decimal(0).logical_invert() * 9
>>> sys.getsizeof(x)
524288112
>>> x + 2
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  decimal.Inexact: [<class 'decimal.Inexact'>]

一般来说(尤其是在没有过度分配的系统上),建议估计更严格的范围,并且如果期望所有计算都精确,则设置 Inexact 陷阱。