bpo-41773: Raise exception for non-finite weights in random.choices(). (GH-22441)

This commit is contained in:
Ram Rachum 2020-09-29 04:32:10 +03:00 committed by GitHub
parent e8acc355d4
commit b0dfc75816
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 23 additions and 3 deletions

View File

@ -180,8 +180,8 @@ Functions for sequences
The *weights* or *cum_weights* can use any numeric type that interoperates The *weights* or *cum_weights* can use any numeric type that interoperates
with the :class:`float` values returned by :func:`random` (that includes with the :class:`float` values returned by :func:`random` (that includes
integers, floats, and fractions but excludes decimals). Behavior is integers, floats, and fractions but excludes decimals). Weights are assumed
undefined if any weight is negative. A :exc:`ValueError` is raised if all to be non-negative and finite. A :exc:`ValueError` is raised if all
weights are zero. weights are zero.
For a given seed, the :func:`choices` function with equal weighting For a given seed, the :func:`choices` function with equal weighting

View File

@ -48,7 +48,7 @@ General notes on the underlying Mersenne Twister core generator:
from warnings import warn as _warn from warnings import warn as _warn
from math import log as _log, exp as _exp, pi as _pi, e as _e, ceil as _ceil from math import log as _log, exp as _exp, pi as _pi, e as _e, ceil as _ceil
from math import sqrt as _sqrt, acos as _acos, cos as _cos, sin as _sin from math import sqrt as _sqrt, acos as _acos, cos as _cos, sin as _sin
from math import tau as TWOPI, floor as _floor from math import tau as TWOPI, floor as _floor, isfinite as _isfinite
from os import urandom as _urandom from os import urandom as _urandom
from _collections_abc import Set as _Set, Sequence as _Sequence from _collections_abc import Set as _Set, Sequence as _Sequence
from itertools import accumulate as _accumulate, repeat as _repeat from itertools import accumulate as _accumulate, repeat as _repeat
@ -492,6 +492,8 @@ class Random(_random.Random):
total = cum_weights[-1] + 0.0 # convert to float total = cum_weights[-1] + 0.0 # convert to float
if total <= 0.0: if total <= 0.0:
raise ValueError('Total of weights must be greater than zero') raise ValueError('Total of weights must be greater than zero')
if not _isfinite(total):
raise ValueError('Total of weights must be finite')
bisect = _bisect bisect = _bisect
hi = n - 1 hi = n - 1
return [population[bisect(cum_weights, random() * total, 0, hi)] return [population[bisect(cum_weights, random() * total, 0, hi)]

View File

@ -324,6 +324,22 @@ class TestBasicOps:
with self.assertRaises(ValueError): with self.assertRaises(ValueError):
self.gen.choices('AB', [0.0, 0.0]) self.gen.choices('AB', [0.0, 0.0])
def test_choices_negative_total(self):
with self.assertRaises(ValueError):
self.gen.choices('ABC', [3, -5, 1])
def test_choices_infinite_total(self):
with self.assertRaises(ValueError):
self.gen.choices('A', [float('inf')])
with self.assertRaises(ValueError):
self.gen.choices('AB', [0.0, float('inf')])
with self.assertRaises(ValueError):
self.gen.choices('AB', [-float('inf'), 123])
with self.assertRaises(ValueError):
self.gen.choices('AB', [0.0, float('nan')])
with self.assertRaises(ValueError):
self.gen.choices('AB', [float('-inf'), float('inf')])
def test_gauss(self): def test_gauss(self):
# Ensure that the seed() method initializes all the hidden state. In # Ensure that the seed() method initializes all the hidden state. In
# particular, through 2.2.1 it failed to reset a piece of state used # particular, through 2.2.1 it failed to reset a piece of state used

View File

@ -0,0 +1,2 @@
Note in documentation that :func:`random.choices` doesn't support non-finite
weights, raise :exc:`ValueError` when given non-finite weights.