https://github.com/python/cpython/commit/62a6e898e017c9878490544f6a227b8a187a949c
commit: 62a6e898e017c9878490544f6a227b8a187a949c
branch: main
author: Stan Ulbrych <[email protected]>
committer: vstinner <[email protected]>
date: 2026-03-31T19:27:52+02:00
summary:
gh-147856: Allow the 'count' argument of `bytes.replace()` to be a keyword
(#147943)
files:
A
Misc/NEWS.d/next/Core_and_Builtins/2026-03-31-18-07-53.gh-issue-147856.62Dwee.rst
M Doc/library/stdtypes.rst
M Doc/whatsnew/3.15.rst
M Lib/test/test_bytes.py
M Objects/bytearrayobject.c
M Objects/bytesobject.c
M Objects/clinic/bytearrayobject.c.h
M Objects/clinic/bytesobject.c.h
M Objects/clinic/unicodeobject.c.h
M Objects/unicodeobject.c
diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
index 69152788616d11..2099ef56169ede 100644
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -3735,12 +3735,13 @@ arbitrary binary data.
The separator to search for may be any :term:`bytes-like object`.
-.. method:: bytes.replace(old, new, count=-1, /)
- bytearray.replace(old, new, count=-1, /)
+.. method:: bytes.replace(old, new, /, count=-1)
+ bytearray.replace(old, new, /, count=-1)
Return a copy of the sequence with all occurrences of subsequence *old*
- replaced by *new*. If the optional argument *count* is given, only the
- first *count* occurrences are replaced.
+ replaced by *new*. If *count* is given, only the first *count* occurrences
+ are replaced. If *count* is not specified or ``-1``, then all occurrences
+ are replaced.
The subsequence to search for and its replacement may be any
:term:`bytes-like object`.
@@ -3750,6 +3751,9 @@ arbitrary binary data.
The bytearray version of this method does *not* operate in place - it
always produces a new object, even if no changes were made.
+ .. versionchanged:: next
+ *count* is now supported as a keyword argument.
+
.. method:: bytes.rfind(sub[, start[, end]])
bytearray.rfind(sub[, start[, end]])
diff --git a/Doc/whatsnew/3.15.rst b/Doc/whatsnew/3.15.rst
index 97937892de3a6e..c8c283715874fa 100644
--- a/Doc/whatsnew/3.15.rst
+++ b/Doc/whatsnew/3.15.rst
@@ -605,6 +605,9 @@ Other language changes
respectively.
(Contributed by Sergey B Kirpichev in :gh:`146151`.)
+* Allow the *count* argument of :meth:`bytes.replace` to be a keyword.
+ (Contributed by Stan Ulbrych in :gh:`147856`.)
+
New modules
===========
diff --git a/Lib/test/test_bytes.py b/Lib/test/test_bytes.py
index df22d5cd96ee0c..120b611ba9cf4a 100644
--- a/Lib/test/test_bytes.py
+++ b/Lib/test/test_bytes.py
@@ -878,6 +878,13 @@ def test_replace(self):
self.assertEqual(b.replace(b'i', b'a'), b'massassappa')
self.assertEqual(b.replace(b'ss', b'x'), b'mixixippi')
+ def test_replace_count_keyword(self):
+ b = self.type2test(b'aa')
+ self.assertEqual(b.replace(b'a', b'b', count=0), b'aa')
+ self.assertEqual(b.replace(b'a', b'b', count=1), b'ba')
+ self.assertEqual(b.replace(b'a', b'b', count=2), b'bb')
+ self.assertEqual(b.replace(b'a', b'b', count=3), b'bb')
+
def test_replace_int_error(self):
self.assertRaises(TypeError, self.type2test(b'a b').replace, 32, b'')
diff --git
a/Misc/NEWS.d/next/Core_and_Builtins/2026-03-31-18-07-53.gh-issue-147856.62Dwee.rst
b/Misc/NEWS.d/next/Core_and_Builtins/2026-03-31-18-07-53.gh-issue-147856.62Dwee.rst
new file mode 100644
index 00000000000000..67ebd57b3a50f6
--- /dev/null
+++
b/Misc/NEWS.d/next/Core_and_Builtins/2026-03-31-18-07-53.gh-issue-147856.62Dwee.rst
@@ -0,0 +1 @@
+Allow the *count* argument of :meth:`bytes.replace` to be a keyword.
diff --git a/Objects/bytearrayobject.c b/Objects/bytearrayobject.c
index e2fea94e099626..552f7144c0d44b 100644
--- a/Objects/bytearrayobject.c
+++ b/Objects/bytearrayobject.c
@@ -1752,27 +1752,26 @@ bytearray_maketrans_impl(Py_buffer *frm, Py_buffer *to)
/*[clinic input]
-@permit_long_docstring_body
@critical_section
bytearray.replace
old: Py_buffer
new: Py_buffer
+ /
count: Py_ssize_t = -1
Maximum number of occurrences to replace.
-1 (the default value) means replace all occurrences.
- /
Return a copy with all occurrences of substring old replaced by new.
-If the optional argument count is given, only the first count occurrences are
-replaced.
+If count is given, only the first count occurrences are replaced.
+If count is not specified or -1, then all occurrences are replaced.
[clinic start generated code]*/
static PyObject *
bytearray_replace_impl(PyByteArrayObject *self, Py_buffer *old,
Py_buffer *new, Py_ssize_t count)
-/*[clinic end generated code: output=d39884c4dc59412a input=66afec32f4e095e0]*/
+/*[clinic end generated code: output=d39884c4dc59412a input=e2591806f954aec3]*/
{
return stringlib_replace((PyObject *)self,
(const char *)old->buf, old->len,
diff --git a/Objects/bytesobject.c b/Objects/bytesobject.c
index 00c1c63b8e01c6..b84ce2b53efdf6 100644
--- a/Objects/bytesobject.c
+++ b/Objects/bytesobject.c
@@ -2403,26 +2403,25 @@ bytes_maketrans_impl(Py_buffer *frm, Py_buffer *to)
/*[clinic input]
-@permit_long_docstring_body
bytes.replace
old: Py_buffer
new: Py_buffer
+ /
count: Py_ssize_t = -1
Maximum number of occurrences to replace.
-1 (the default value) means replace all occurrences.
- /
Return a copy with all occurrences of substring old replaced by new.
-If the optional argument count is given, only the first count occurrences are
-replaced.
+If count is given, only the first count occurrences are replaced.
+If count is not specified or -1, then all occurrences are replaced.
[clinic start generated code]*/
static PyObject *
bytes_replace_impl(PyBytesObject *self, Py_buffer *old, Py_buffer *new,
Py_ssize_t count)
-/*[clinic end generated code: output=994fa588b6b9c104 input=8b99a9ab32bc06a2]*/
+/*[clinic end generated code: output=994fa588b6b9c104 input=cdf3cf8639297745]*/
{
return stringlib_replace((PyObject *)self,
(const char *)old->buf, old->len,
diff --git a/Objects/clinic/bytearrayobject.c.h
b/Objects/clinic/bytearrayobject.c.h
index cf60d0ceadc7d1..d173f45d7beb1e 100644
--- a/Objects/clinic/bytearrayobject.c.h
+++ b/Objects/clinic/bytearrayobject.c.h
@@ -793,7 +793,7 @@ bytearray_maketrans(PyObject *null, PyObject *const *args,
Py_ssize_t nargs)
}
PyDoc_STRVAR(bytearray_replace__doc__,
-"replace($self, old, new, count=-1, /)\n"
+"replace($self, old, new, /, count=-1)\n"
"--\n"
"\n"
"Return a copy with all occurrences of substring old replaced by new.\n"
@@ -802,25 +802,56 @@ PyDoc_STRVAR(bytearray_replace__doc__,
" Maximum number of occurrences to replace.\n"
" -1 (the default value) means replace all occurrences.\n"
"\n"
-"If the optional argument count is given, only the first count occurrences
are\n"
-"replaced.");
+"If count is given, only the first count occurrences are replaced.\n"
+"If count is not specified or -1, then all occurrences are replaced.");
#define BYTEARRAY_REPLACE_METHODDEF \
- {"replace", _PyCFunction_CAST(bytearray_replace), METH_FASTCALL,
bytearray_replace__doc__},
+ {"replace", _PyCFunction_CAST(bytearray_replace),
METH_FASTCALL|METH_KEYWORDS, bytearray_replace__doc__},
static PyObject *
bytearray_replace_impl(PyByteArrayObject *self, Py_buffer *old,
Py_buffer *new, Py_ssize_t count);
static PyObject *
-bytearray_replace(PyObject *self, PyObject *const *args, Py_ssize_t nargs)
+bytearray_replace(PyObject *self, PyObject *const *args, Py_ssize_t nargs,
PyObject *kwnames)
{
PyObject *return_value = NULL;
+ #if defined(Py_BUILD_CORE) && !defined(Py_BUILD_CORE_MODULE)
+
+ #define NUM_KEYWORDS 1
+ static struct {
+ PyGC_Head _this_is_not_used;
+ PyObject_VAR_HEAD
+ Py_hash_t ob_hash;
+ PyObject *ob_item[NUM_KEYWORDS];
+ } _kwtuple = {
+ .ob_base = PyVarObject_HEAD_INIT(&PyTuple_Type, NUM_KEYWORDS)
+ .ob_hash = -1,
+ .ob_item = { &_Py_ID(count), },
+ };
+ #undef NUM_KEYWORDS
+ #define KWTUPLE (&_kwtuple.ob_base.ob_base)
+
+ #else // !Py_BUILD_CORE
+ # define KWTUPLE NULL
+ #endif // !Py_BUILD_CORE
+
+ static const char * const _keywords[] = {"", "", "count", NULL};
+ static _PyArg_Parser _parser = {
+ .keywords = _keywords,
+ .fname = "replace",
+ .kwtuple = KWTUPLE,
+ };
+ #undef KWTUPLE
+ PyObject *argsbuf[3];
+ Py_ssize_t noptargs = nargs + (kwnames ? PyTuple_GET_SIZE(kwnames) : 0) -
2;
Py_buffer old = {NULL, NULL};
Py_buffer new = {NULL, NULL};
Py_ssize_t count = -1;
- if (!_PyArg_CheckPositional("replace", nargs, 2, 3)) {
+ args = _PyArg_UnpackKeywords(args, nargs, NULL, kwnames, &_parser,
+ /*minpos*/ 2, /*maxpos*/ 3, /*minkw*/ 0, /*varpos*/ 0, argsbuf);
+ if (!args) {
goto exit;
}
if (PyObject_GetBuffer(args[0], &old, PyBUF_SIMPLE) != 0) {
@@ -829,8 +860,8 @@ bytearray_replace(PyObject *self, PyObject *const *args,
Py_ssize_t nargs)
if (PyObject_GetBuffer(args[1], &new, PyBUF_SIMPLE) != 0) {
goto exit;
}
- if (nargs < 3) {
- goto skip_optional;
+ if (!noptargs) {
+ goto skip_optional_pos;
}
{
Py_ssize_t ival = -1;
@@ -844,7 +875,7 @@ bytearray_replace(PyObject *self, PyObject *const *args,
Py_ssize_t nargs)
}
count = ival;
}
-skip_optional:
+skip_optional_pos:
Py_BEGIN_CRITICAL_SECTION(self);
return_value = bytearray_replace_impl((PyByteArrayObject *)self, &old,
&new, count);
Py_END_CRITICAL_SECTION();
@@ -1835,4 +1866,4 @@ bytearray_sizeof(PyObject *self, PyObject
*Py_UNUSED(ignored))
{
return bytearray_sizeof_impl((PyByteArrayObject *)self);
}
-/*[clinic end generated code: output=2d76ef023928424f input=a9049054013a1b77]*/
+/*[clinic end generated code: output=d4976faf6731b8da input=a9049054013a1b77]*/
diff --git a/Objects/clinic/bytesobject.c.h b/Objects/clinic/bytesobject.c.h
index 00cf13d422d900..99fcd48898c0bc 100644
--- a/Objects/clinic/bytesobject.c.h
+++ b/Objects/clinic/bytesobject.c.h
@@ -789,7 +789,7 @@ bytes_maketrans(PyObject *null, PyObject *const *args,
Py_ssize_t nargs)
}
PyDoc_STRVAR(bytes_replace__doc__,
-"replace($self, old, new, count=-1, /)\n"
+"replace($self, old, new, /, count=-1)\n"
"--\n"
"\n"
"Return a copy with all occurrences of substring old replaced by new.\n"
@@ -798,25 +798,56 @@ PyDoc_STRVAR(bytes_replace__doc__,
" Maximum number of occurrences to replace.\n"
" -1 (the default value) means replace all occurrences.\n"
"\n"
-"If the optional argument count is given, only the first count occurrences
are\n"
-"replaced.");
+"If count is given, only the first count occurrences are replaced.\n"
+"If count is not specified or -1, then all occurrences are replaced.");
#define BYTES_REPLACE_METHODDEF \
- {"replace", _PyCFunction_CAST(bytes_replace), METH_FASTCALL,
bytes_replace__doc__},
+ {"replace", _PyCFunction_CAST(bytes_replace), METH_FASTCALL|METH_KEYWORDS,
bytes_replace__doc__},
static PyObject *
bytes_replace_impl(PyBytesObject *self, Py_buffer *old, Py_buffer *new,
Py_ssize_t count);
static PyObject *
-bytes_replace(PyObject *self, PyObject *const *args, Py_ssize_t nargs)
+bytes_replace(PyObject *self, PyObject *const *args, Py_ssize_t nargs,
PyObject *kwnames)
{
PyObject *return_value = NULL;
+ #if defined(Py_BUILD_CORE) && !defined(Py_BUILD_CORE_MODULE)
+
+ #define NUM_KEYWORDS 1
+ static struct {
+ PyGC_Head _this_is_not_used;
+ PyObject_VAR_HEAD
+ Py_hash_t ob_hash;
+ PyObject *ob_item[NUM_KEYWORDS];
+ } _kwtuple = {
+ .ob_base = PyVarObject_HEAD_INIT(&PyTuple_Type, NUM_KEYWORDS)
+ .ob_hash = -1,
+ .ob_item = { &_Py_ID(count), },
+ };
+ #undef NUM_KEYWORDS
+ #define KWTUPLE (&_kwtuple.ob_base.ob_base)
+
+ #else // !Py_BUILD_CORE
+ # define KWTUPLE NULL
+ #endif // !Py_BUILD_CORE
+
+ static const char * const _keywords[] = {"", "", "count", NULL};
+ static _PyArg_Parser _parser = {
+ .keywords = _keywords,
+ .fname = "replace",
+ .kwtuple = KWTUPLE,
+ };
+ #undef KWTUPLE
+ PyObject *argsbuf[3];
+ Py_ssize_t noptargs = nargs + (kwnames ? PyTuple_GET_SIZE(kwnames) : 0) -
2;
Py_buffer old = {NULL, NULL};
Py_buffer new = {NULL, NULL};
Py_ssize_t count = -1;
- if (!_PyArg_CheckPositional("replace", nargs, 2, 3)) {
+ args = _PyArg_UnpackKeywords(args, nargs, NULL, kwnames, &_parser,
+ /*minpos*/ 2, /*maxpos*/ 3, /*minkw*/ 0, /*varpos*/ 0, argsbuf);
+ if (!args) {
goto exit;
}
if (PyObject_GetBuffer(args[0], &old, PyBUF_SIMPLE) != 0) {
@@ -825,8 +856,8 @@ bytes_replace(PyObject *self, PyObject *const *args,
Py_ssize_t nargs)
if (PyObject_GetBuffer(args[1], &new, PyBUF_SIMPLE) != 0) {
goto exit;
}
- if (nargs < 3) {
- goto skip_optional;
+ if (!noptargs) {
+ goto skip_optional_pos;
}
{
Py_ssize_t ival = -1;
@@ -840,7 +871,7 @@ bytes_replace(PyObject *self, PyObject *const *args,
Py_ssize_t nargs)
}
count = ival;
}
-skip_optional:
+skip_optional_pos:
return_value = bytes_replace_impl((PyBytesObject *)self, &old, &new,
count);
exit:
@@ -1411,4 +1442,4 @@ bytes_new(PyTypeObject *type, PyObject *args, PyObject
*kwargs)
exit:
return return_value;
}
-/*[clinic end generated code: output=08b9507244f73638 input=a9049054013a1b77]*/
+/*[clinic end generated code: output=5675f7008a84ce6d input=a9049054013a1b77]*/
diff --git a/Objects/clinic/unicodeobject.c.h b/Objects/clinic/unicodeobject.c.h
index 1819fbaea220a3..4b53e24fb7d649 100644
--- a/Objects/clinic/unicodeobject.c.h
+++ b/Objects/clinic/unicodeobject.c.h
@@ -918,8 +918,8 @@ PyDoc_STRVAR(unicode_replace__doc__,
" Maximum number of occurrences to replace.\n"
" -1 (the default value) means replace all occurrences.\n"
"\n"
-"If the optional argument count is given, only the first count occurrences
are\n"
-"replaced.");
+"If count is given, only the first count occurrences are replaced.\n"
+"If count is not specified or -1, then all occurrences are replaced.");
#define UNICODE_REPLACE_METHODDEF \
{"replace", _PyCFunction_CAST(unicode_replace),
METH_FASTCALL|METH_KEYWORDS, unicode_replace__doc__},
@@ -1908,4 +1908,4 @@ unicode_new(PyTypeObject *type, PyObject *args, PyObject
*kwargs)
exit:
return return_value;
}
-/*[clinic end generated code: output=238917fe66120bde input=a9049054013a1b77]*/
+/*[clinic end generated code: output=13eaf65699ea9fc9 input=a9049054013a1b77]*/
diff --git a/Objects/unicodeobject.c b/Objects/unicodeobject.c
index 35bd88d6254d9c..a0a26a75129929 100644
--- a/Objects/unicodeobject.c
+++ b/Objects/unicodeobject.c
@@ -12561,7 +12561,6 @@ PyUnicode_Replace(PyObject *str,
}
/*[clinic input]
-@permit_long_docstring_body
str.replace as unicode_replace
old: unicode
@@ -12573,14 +12572,14 @@ str.replace as unicode_replace
Return a copy with all occurrences of substring old replaced by new.
-If the optional argument count is given, only the first count occurrences are
-replaced.
+If count is given, only the first count occurrences are replaced.
+If count is not specified or -1, then all occurrences are replaced.
[clinic start generated code]*/
static PyObject *
unicode_replace_impl(PyObject *self, PyObject *old, PyObject *new,
Py_ssize_t count)
-/*[clinic end generated code: output=b63f1a8b5eebf448 input=f27ca92ac46b65a1]*/
+/*[clinic end generated code: output=b63f1a8b5eebf448 input=d15a6886b05e2edc]*/
{
return replace(self, old, new, count);
}
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
