Mercurial > hg
changeset 51723:9367571fea21
cext: correct the argument handling of `b85encode()`
The type stub indicated that this argument is `Optional`, which implies None is
allowed. I don't see in the documentation where that's the case for `i`[1], and
trying it in `hg debugshell` resulted in the method failing with a TypeError. I
guess it was typed as an `int` argument because the `p` format unit wasn't added
until Python 3.3[2].
In any event, 2 clients in core (`pvec` and `obsolete`) call this with no
argument supplied, and `mdiff` calls it with True. So I guess we've avoided the
None arg case, and when no arg is supplied, it defaults to the 0 initialization
of the `pad` variable in C. Since the `p` format unit accepts both `int` and
None, as well as `bool`, I'm not bothering to bump the module version- this code
is more permissive than it was, in addition to being more correct.
Interestingly, when I first imported the `cext` and `pure` methods in the same
manner as the previous commit, it dropped the `Optional` part of the argument
type when generating `util.pyi`. No idea why.
[1] https://docs.python.org/3/c-api/arg.html#numbers
[2] https://docs.python.org/3/c-api/arg.html#other-objects
author | Matt Harbison <matt_harbison@yahoo.com> |
---|---|
date | Sat, 20 Jul 2024 01:55:09 -0400 |
parents | 43adbe03079b |
children | a3dc962cac62 |
files | mercurial/cext/base85.c mercurial/cext/base85.pyi mercurial/pure/base85.py |
diffstat | 3 files changed, 4 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/mercurial/cext/base85.c Fri Jul 19 20:09:48 2024 -0400 +++ b/mercurial/cext/base85.c Sat Jul 20 01:55:09 2024 -0400 @@ -38,7 +38,7 @@ unsigned int acc, val, ch; int pad = 0; - if (!PyArg_ParseTuple(args, "y#|i", &text, &len, &pad)) { + if (!PyArg_ParseTuple(args, "y#|p", &text, &len, &pad)) { return NULL; }
--- a/mercurial/cext/base85.pyi Fri Jul 19 20:09:48 2024 -0400 +++ b/mercurial/cext/base85.pyi Sat Jul 20 01:55:09 2024 -0400 @@ -1,6 +1,4 @@ -from typing import Optional - version: int -def b85encode(text: bytes, pad: Optional[int]) -> bytes: ... +def b85encode(text: bytes, pad: bool = False) -> bytes: ... def b85decode(text: bytes) -> bytes: ...
--- a/mercurial/pure/base85.py Fri Jul 19 20:09:48 2024 -0400 +++ b/mercurial/pure/base85.py Sat Jul 20 01:55:09 2024 -0400 @@ -23,7 +23,7 @@ _b85dec[c] = i -def b85encode(text, pad=False): +def b85encode(text: bytes, pad: bool = False) -> bytes: """encode text in base85 format""" l = len(text) r = l % 4 @@ -50,7 +50,7 @@ return out[:olen] -def b85decode(text): +def b85decode(text: bytes) -> bytes: """decode base85-encoded text""" if not _b85dec: _mkb85dec()