Skip to content

Commit d2c4baa

Browse files
serhiy-storchakaserhiy-storchaka
authored
gh-97928: Partially restore the behavior of tkinter.Text.count() by default (GH-115031)
By default, it preserves an inconsistent behavior of older Python versions: packs the count into a 1-tuple if only one or none options are specified (including 'update'), returns None instead of 0. Except that setting wantobjects to 0 no longer affects the result. Add a new parameter return_ints: specifying return_ints=True makes Text.count() always returning the single count as an integer instead of a 1-tuple or None.
1 parent 5d2794a commit d2c4baa

File tree

5 files changed

+59
-28
lines changed

5 files changed

+59
-28
lines changed

‎Doc/whatsnew/3.13.rst

+6-7
Original file line numberDiff line numberDiff line change
@@ -469,6 +469,12 @@ tkinter
469469
a dict instead of a tuple.
470470
(Contributed by Serhiy Storchaka in :gh:`43457`.)
471471

472+
* Add new optional keyword-only parameter *return_ints* in
473+
the :meth:`!Text.count` method.
474+
Passing ``return_ints=True`` makes it always returning the single count
475+
as an integer instead of a 1-tuple or ``None``.
476+
(Contributed by Serhiy Storchaka in :gh:`97928`.)
477+
472478
* Add support of the "vsapi" element type in
473479
the :meth:`~tkinter.ttk.Style.element_create` method of
474480
:class:`tkinter.ttk.Style`.
@@ -1286,13 +1292,6 @@ that may require changes to your code.
12861292
Changes in the Python API
12871293
-------------------------
12881294

1289-
* :meth:`!tkinter.Text.count` now always returns an integer if one or less
1290-
counting options are specified.
1291-
Previously it could return a single count as a 1-tuple, an integer (only if
1292-
option ``"update"`` was specified) or ``None`` if no items found.
1293-
The result is now the same if ``wantobjects`` is set to ``0``.
1294-
(Contributed by Serhiy Storchaka in :gh:`97928`.)
1295-
12961295
* Functions :c:func:`PyDict_GetItem`, :c:func:`PyDict_GetItemString`,
12971296
:c:func:`PyMapping_HasKey`, :c:func:`PyMapping_HasKeyString`,
12981297
:c:func:`PyObject_HasAttr`, :c:func:`PyObject_HasAttrString`, and

‎Lib/idlelib/sidebar.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def get_displaylines(text, index):
2727
"""Display height, in lines, of a logical line in a Tk text widget."""
2828
return text.count(f"{index} linestart",
2929
f"{index} lineend",
30-
"displaylines")
30+
"displaylines", return_ints=True)
3131

3232
def get_widget_padding(widget):
3333
"""Get the total padding of a Tk widget, including its border."""

‎Lib/test/test_tkinter/test_text.py

+32-12
Original file line numberDiff line numberDiff line change
@@ -52,27 +52,47 @@ def test_count(self):
5252
options = ('chars', 'indices', 'lines',
5353
'displaychars', 'displayindices', 'displaylines',
5454
'xpixels', 'ypixels')
55+
self.assertEqual(len(text.count('1.0', 'end', *options, return_ints=True)), 8)
5556
self.assertEqual(len(text.count('1.0', 'end', *options)), 8)
56-
self.assertEqual(text.count('1.0', 'end', 'chars', 'lines'), (124, 4))
57+
self.assertEqual(text.count('1.0', 'end', 'chars', 'lines', return_ints=True),
58+
(124, 4))
5759
self.assertEqual(text.count('1.3', '4.5', 'chars', 'lines'), (92, 3))
60+
self.assertEqual(text.count('4.5', '1.3', 'chars', 'lines', return_ints=True),
61+
(-92, -3))
5862
self.assertEqual(text.count('4.5', '1.3', 'chars', 'lines'), (-92, -3))
63+
self.assertEqual(text.count('1.3', '1.3', 'chars', 'lines', return_ints=True),
64+
(0, 0))
5965
self.assertEqual(text.count('1.3', '1.3', 'chars', 'lines'), (0, 0))
60-
self.assertEqual(text.count('1.0', 'end', 'lines'), 4)
61-
self.assertEqual(text.count('end', '1.0', 'lines'), -4)
62-
self.assertEqual(text.count('1.3', '1.5', 'lines'), 0)
63-
self.assertEqual(text.count('1.3', '1.3', 'lines'), 0)
64-
self.assertEqual(text.count('1.0', 'end'), 124) # 'indices' by default
65-
self.assertEqual(text.count('1.0', 'end', 'indices'), 124)
66+
self.assertEqual(text.count('1.0', 'end', 'lines', return_ints=True), 4)
67+
self.assertEqual(text.count('1.0', 'end', 'lines'), (4,))
68+
self.assertEqual(text.count('end', '1.0', 'lines', return_ints=True), -4)
69+
self.assertEqual(text.count('end', '1.0', 'lines'), (-4,))
70+
self.assertEqual(text.count('1.3', '1.5', 'lines', return_ints=True), 0)
71+
self.assertEqual(text.count('1.3', '1.5', 'lines'), None)
72+
self.assertEqual(text.count('1.3', '1.3', 'lines', return_ints=True), 0)
73+
self.assertEqual(text.count('1.3', '1.3', 'lines'), None)
74+
# Count 'indices' by default.
75+
self.assertEqual(text.count('1.0', 'end', return_ints=True), 124)
76+
self.assertEqual(text.count('1.0', 'end'), (124,))
77+
self.assertEqual(text.count('1.0', 'end', 'indices', return_ints=True), 124)
78+
self.assertEqual(text.count('1.0', 'end', 'indices'), (124,))
6679
self.assertRaises(tkinter.TclError, text.count, '1.0', 'end', 'spam')
6780
self.assertRaises(tkinter.TclError, text.count, '1.0', 'end', '-lines')
6881

69-
self.assertIsInstance(text.count('1.3', '1.5', 'ypixels'), int)
82+
self.assertIsInstance(text.count('1.3', '1.5', 'ypixels', return_ints=True), int)
83+
self.assertIsInstance(text.count('1.3', '1.5', 'ypixels'), tuple)
84+
self.assertIsInstance(text.count('1.3', '1.5', 'update', 'ypixels', return_ints=True), int)
7085
self.assertIsInstance(text.count('1.3', '1.5', 'update', 'ypixels'), int)
71-
self.assertEqual(text.count('1.3', '1.3', 'update', 'ypixels'), 0)
86+
self.assertEqual(text.count('1.3', '1.3', 'update', 'ypixels', return_ints=True), 0)
87+
self.assertEqual(text.count('1.3', '1.3', 'update', 'ypixels'), None)
88+
self.assertEqual(text.count('1.3', '1.5', 'update', 'indices', return_ints=True), 2)
7289
self.assertEqual(text.count('1.3', '1.5', 'update', 'indices'), 2)
73-
self.assertEqual(text.count('1.3', '1.3', 'update', 'indices'), 0)
74-
self.assertEqual(text.count('1.3', '1.5', 'update'), 2)
75-
self.assertEqual(text.count('1.3', '1.3', 'update'), 0)
90+
self.assertEqual(text.count('1.3', '1.3', 'update', 'indices', return_ints=True), 0)
91+
self.assertEqual(text.count('1.3', '1.3', 'update', 'indices'), None)
92+
self.assertEqual(text.count('1.3', '1.5', 'update', return_ints=True), 2)
93+
self.assertEqual(text.count('1.3', '1.5', 'update'), (2,))
94+
self.assertEqual(text.count('1.3', '1.3', 'update', return_ints=True), 0)
95+
self.assertEqual(text.count('1.3', '1.3', 'update'), None)
7696

7797

7898
if __name__ == "__main__":

‎Lib/tkinter/__init__.py

+15-8
Original file line numberDiff line numberDiff line change
@@ -3745,27 +3745,34 @@ def compare(self, index1, op, index2):
37453745
return self.tk.getboolean(self.tk.call(
37463746
self._w, 'compare', index1, op, index2))
37473747

3748-
def count(self, index1, index2, *options): # new in Tk 8.5
3748+
def count(self, index1, index2, *options, return_ints=False): # new in Tk 8.5
37493749
"""Counts the number of relevant things between the two indices.
37503750
37513751
If INDEX1 is after INDEX2, the result will be a negative number
37523752
(and this holds for each of the possible options).
37533753
37543754
The actual items which are counted depends on the options given.
37553755
The result is a tuple of integers, one for the result of each
3756-
counting option given, if more than one option is specified,
3757-
otherwise it is an integer. Valid counting options are "chars",
3758-
"displaychars", "displayindices", "displaylines", "indices",
3759-
"lines", "xpixels" and "ypixels". The default value, if no
3760-
option is specified, is "indices". There is an additional possible
3761-
option "update", which if given then all subsequent options ensure
3762-
that any possible out of date information is recalculated."""
3756+
counting option given, if more than one option is specified or
3757+
return_ints is false (default), otherwise it is an integer.
3758+
Valid counting options are "chars", "displaychars",
3759+
"displayindices", "displaylines", "indices", "lines", "xpixels"
3760+
and "ypixels". The default value, if no option is specified, is
3761+
"indices". There is an additional possible option "update",
3762+
which if given then all subsequent options ensure that any
3763+
possible out of date information is recalculated.
3764+
"""
37633765
options = ['-%s' % arg for arg in options]
37643766
res = self.tk.call(self._w, 'count', *options, index1, index2)
37653767
if not isinstance(res, int):
37663768
res = self._getints(res)
37673769
if len(res) == 1:
37683770
res, = res
3771+
if not return_ints:
3772+
if not res:
3773+
res = None
3774+
elif len(options) <= 1:
3775+
res = (res,)
37693776
return res
37703777

37713778
def debug(self, boolean=None):

‎Misc/NEWS.d/next/Library/2024-02-05-16-48-06.gh-issue-97928.JZCies.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Partially revert the behavior of :meth:`tkinter.Text.count`. By default it
2+
preserves the behavior of older Python versions, except that setting
3+
``wantobjects`` to 0 no longer has effect. Add a new parameter *return_ints*:
4+
specifying ``return_ints=True`` makes ``Text.count()`` always returning the
5+
single count as an integer instead of a 1-tuple or ``None``.

0 commit comments

Comments
 (0)