This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: randrange() mishandles step when stop is None
Type: behavior Stage: resolved
Components: Library (Lib) Versions: Python 3.10, Python 3.9
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: rhettinger Nosy List: rhettinger, serhiy.storchaka, tim.peters
Priority: normal Keywords: patch

Created on 2020-12-28 19:23 by rhettinger, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 24018 merged rhettinger, 2020-12-31 01:19
Messages (8)
msg383919 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2020-12-28 19:23
When stop is None, the step argument is ignored:

>>> randrange(1000, None, 100)
651
>>> randrange(1000, step=100)
673
msg383922 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2020-12-28 19:57
One fix is to move up the code for converting step to istep and then modify the early out test to:  

        if stop is None and istep == 1:
            if istart > 0:
                return self._randbelow(istart)

That would have the downside of slowing down the common case.

Another possibility is changing the default step to a sentinel object and just testing for that:

        if stop is None and step is sentinel:
            if istart > 0:
                return self._randbelow(istart)

That would be user visible in the function signature but it would run fast.

We could bite the bullet and fully harmonize the randrange() signature with range().  That would entail switching to *args and no longer accepting keyword arguments:

     def randrange(self, /, *args):
         "Choose random item from range(stop) or range(start, stop[, step])."
         return self.choice(range(*args))

This would most closely match user expectations but is potentially a breaking change for existing code that uses keyword arguments.  Such code probably exists but is probably not common.

For speed, the actual implementation could still have fast paths for common cases.

For help() and tooltips, we could add a __text_signature__ to cover-up the *args.  However, signature objects currently aren't capable of describing range().  The best we could do is:

    randrange.__text_signature__ = '($self, start, stop, step, /)'

That would give help() that looks like this:

    >>> help(randrange)
    Help on method randrange in module Random:

    randrange(start, stop, step, /) method of __main__.R instance
        Choose random item from range(stop) or range(start, stop[, step]).
msg383928 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2020-12-28 20:33
Note, we can't actually use "self.choice(range(*args))" because the underlying len() call can Overflow.  If it does, the components need to be computed manually.
msg383930 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2020-12-28 21:06
Another solution is to use an identity test for the step argument

    _one = 1

    class Random:
        def randrange(start, stop=None, step=_one):
            ...
            if stop is None and step is _one:
                if istart > 0:
                    return self._randbelow(istart)

This has the advantage of keeping the API unchanged while still keeping the fast path fast.
msg383931 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2020-12-28 21:28
> Another solution is to use an identity test for the step argument

Should I restore that optimization in issue37319?
msg383938 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2020-12-28 23:51
> Should I restore that optimization in issue37319?

Yes, but to fix the bug it needs to occur earlier in the code (currently line 314):

    if stop is None and step is _ONE: <-- Line 314
                   ^^^^^^^^^^^^^^^^^  <-- Add this   

And again later:
         if istep == 1 and width > 0:   <-- Line 348
                     ^-- change to _ONE

As a standalone optimization, it wasn't worth it, but as a way to fix the bug without a regression, it is reasonable.
msg384097 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2020-12-31 01:28
Upon further reflection, I think these cases should raise a TypeError because the meaning is ambiguous:

    randrange(1000, step=10) # Could only mean start=0 stop=1000 step=10

but that conflicts with:

    randrange(1000, None, 100)  # Has no reasonable interpretation

For comparison, this currently raises a TypeError because None isn't a sensible argument for stop:

    range(1000, None, 100)
msg384235 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2021-01-02 18:24
New changeset 768fa145cfec2a0599802b74fc31d2bc2812ed96 by Raymond Hettinger in branch 'master':
bpo-42772: Step argument ignored when stop is None. (GH-24018)
https://github.com/python/cpython/commit/768fa145cfec2a0599802b74fc31d2bc2812ed96
History
Date User Action Args
2022-04-11 14:59:39adminsetgithub: 86938
2021-01-02 18:25:13rhettingersetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2021-01-02 18:24:58rhettingersetmessages: + msg384235
2020-12-31 01:28:45rhettingersetassignee: rhettinger
2020-12-31 01:28:29rhettingersetmessages: + msg384097
2020-12-31 01:19:12rhettingersetkeywords: + patch
stage: patch review
pull_requests: + pull_request22858
2020-12-28 23:51:39rhettingersetmessages: + msg383938
2020-12-28 21:28:33serhiy.storchakasetmessages: + msg383931
2020-12-28 21:06:51rhettingersetmessages: + msg383930
2020-12-28 20:33:13rhettingersetmessages: + msg383928
2020-12-28 19:57:33rhettingersetnosy: + tim.peters
2020-12-28 19:57:18rhettingersetmessages: + msg383922
2020-12-28 19:28:41rhettingersetassignee: rhettinger -> (no value)
versions: + Python 3.9
2020-12-28 19:23:54rhettingersetassignee: rhettinger
2020-12-28 19:23:37rhettingercreate