gh-130693: Add options of the tkinter.Text.search method: -nolinestop -all -overlap -strictlimits #130848

sharktide · 2025-03-04T17:17:39Z

Add options -nolinestop, -all, -overlap, and -strictlimits to the search function of the text class of tkinter.

Tested against

.\PCbuild\amd64\python_d.exe -m test -ugui test_tkinter

And test passed. Result:

0:00:00 [1/1] test_tkinter
0:00:27 load avg: 3.93 [1/1] test_tkinter passed

== Tests result: SUCCESS ==

1 test OK.

Total duration: 27.6 sec
Total tests: run=787 skipped=11
Total test files: run=1/1
Result: SUCCESS

Also tested against a custom test file:

import tkinter as tk

root = tk.Tk()
text = tk.Text(root)
text.pack()

text.insert('1.0', 'This is a test. This is only a test.\nAnother line.\nYet another line.')

# Test without options
result = text.search('test', '1.0', 'end')
print('Without options:', result)

# Test with -nolinestop
result = text.search('line', '1.0', 'end', nolinestop=True, regexp=True)
print('With -nolinestop:', result)

# Test with -all
result = text.search('test', '1.0', 'end', all=True)
print('With -all:', result)

# Test with -overlap
result = text.search('test', '1.0', 'end', overlap=True, all=True)
print('With -overlap:', result)

# Test with -strictlimits
result = text.search('test', '1.0', 'end', strictlimits=True)
print('With -strictlimits:', result)

root.mainloop()

Which returns:

Without options: 1.10
With -nolinestop: 2.8
With -all: (<textindex object: '1.10'>, <textindex object: '1.31'>)
With -overlap: (<textindex object: '1.10'>, <textindex object: '1.31'>)
With -strictlimits: 1.10

Indicating that the new features are functioning correctly

Issue: tkinter missing -nolinestop on tk.Text #130693

bedevere-app · 2025-03-04T17:17:43Z

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

Misc/NEWS.d/next/Library/2025-03-04-17-19-26.gh-issue-130693.Kv01r8.rst

sharktide · 2025-05-05T13:04:34Z

@ZeroIntensity Could someone please review? I think the original reviewer forgot

Misc/NEWS.d/next/Library/2025-03-04-17-19-26.gh-issue-130693.Kv01r8.rst

sharktide · 2025-05-10T14:40:44Z

@Wulian233 Please Review again

sharktide · 2025-05-30T16:32:59Z

I am currently pinging this PR as I have not seen a review in nearly a month.
Could someone please review?

sharktide · 2025-05-30T20:04:48Z

On it

…

On Fri, May 30, 2025 at 13:22 Peter Bierma ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In Misc/NEWS.d/next/Library/2025-03-04-17-19-26.gh-issue-130693.Kv01r8.rst <#130848 (comment)>: > @@ -0,0 +1,6 @@ +================ +Type: Enhancement We don't need this metadata. — Reply to this email directly, view it on GitHub <#130848 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BNITW52CNI3C5F6RICJESQD3BCHTXAVCNFSM6AAAAABYKCKEFWVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDQOBRHE2TMNRRHE> . You are receiving this because you authored the thread.Message ID: ***@***.***>

sharktide · 2025-05-30T20:08:37Z

Done!

sharktide · 2025-06-17T13:15:52Z

It has been nearly a month. @ZeroIntensity Could you please review?

ZeroIntensity

All new features need tests. Please add one to test_tkinter.

Misc/NEWS.d/next/Library/2025-03-04-17-19-26.gh-issue-130693.Kv01r8.rst

Lib/tkinter/__init__.py

sharktide · 2025-06-17T13:38:26Z

Will do

…

On Tue, Jun 17, 2025 at 19:07 Peter Bierma ***@***.***> wrote: ***@***.**** commented on this pull request. All new features need tests. Please add one to test_tkinter. ------------------------------ In Misc/NEWS.d/next/Library/2025-03-04-17-19-26.gh-issue-130693.Kv01r8.rst <#130848 (comment)>: > @@ -0,0 +1,2 @@ +Add support for ``-nolinestop``, ``-all``, ``-overlap``, and ``-strictlimits`` options to ``tkinter.Text.search`` ⬇️ Suggested change -Add support for ``-nolinestop``, ``-all``, ``-overlap``, and ``-strictlimits`` options to ``tkinter.Text.search`` +Add support for ``-nolinestop``, ``-all``, ``-overlap``, and ``-strictlimits`` options to :meth:`tkinter.Text.search` ------------------------------ In Lib/tkinter/__init__.py <#130848 (comment)>: > @@ -4038,9 +4038,7 @@ def scan_dragto(self, x, y): scan_mark.""" self.tk.call(self._w, 'scan', 'dragto', x, y) - def search(self, pattern, index, stopindex=None, - forwards=None, backwards=None, exact=None, - regexp=None, nocase=None, count=None, elide=None): + def search(self, pattern, index, stopindex=None, forwards=None, backwards=None, exact=None, regexp=None, nocase=None, count=None, elide=None, nolinestop=None, all=None, overlap=None, strictlimits=None): Please change it back to the old formatting. ------------------------------ In Lib/tkinter/__init__.py <#130848 (comment)>: > + + Stray newline changes: ⬇️ Suggested change - - — Reply to this email directly, view it on GitHub <#130848 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BNITW5Z32DYZL5OQEMOCKLL3EAK2TAVCNFSM6AAAAABYKCKEFWVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDSMZVG4YTGOBSG4> . You are receiving this because you authored the thread.Message ID: ***@***.***>

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>

sharktide · 2025-06-17T13:48:16Z

I updated the branch as it has been a while since this PR has been opened

sharktide · 2025-08-10T21:44:11Z

Added implementation. Docs, whatsnew, and news updates next

serhiy-storchaka

Thank you for your update.

Doc/whatsnew/3.15.rst

Lib/tkinter/__init__.py

Lib/test/test_tkinter/test_text.py

Doc/whatsnew/3.15.rst

Lib/test/test_tkinter/test_text.py

serhiy-storchaka · 2025-08-11T15:08:34Z

Doc/whatsnew/3.15.rst

+tkinter
+-------
+
+* The ``tkinter.Text.search`` method now supports two additional


Suggested change

* The ``tkinter.Text.search`` method now supports two additional

* The :meth:`!tkinter.Text.search` method now supports two additional

So it will be formatted with the same font and color as other methods, just without a link.

Doc/whatsnew/3.15.rst

Lib/test/test_tkinter/test_text.py

Lib/tkinter/__init__.py

Misc/NEWS.d/next/Library/2025-03-04-17-19-26.gh-issue-130693.Kv01r8.rst

Update __init__.py

8b27bcb

bedevere-app bot added the awaiting review label Mar 4, 2025

bedevere-app bot mentioned this pull request Mar 4, 2025

tkinter missing -nolinestop on tk.Text #130693

Open

blurb-it bot and others added 2 commits March 4, 2025 17:19

📜🤖 Added by blurb_it.

18d5005

Update 2025-03-04-17-19-26.gh-issue-130693.Kv01r8.rst

e2a76c2

Wulian233 reviewed Mar 5, 2025

View reviewed changes

Misc/NEWS.d/next/Library/2025-03-04-17-19-26.gh-issue-130693.Kv01r8.rst Outdated Show resolved Hide resolved

Update 2025-03-04-17-19-26.gh-issue-130693.Kv01r8.rst

753da3a

sharktide requested a review from Wulian233 March 5, 2025 15:20

Update 2025-03-04-17-19-26.gh-issue-130693.Kv01r8.rst

1ca30c6

Wulian233 reviewed May 5, 2025

View reviewed changes

Misc/NEWS.d/next/Library/2025-03-04-17-19-26.gh-issue-130693.Kv01r8.rst Outdated Show resolved Hide resolved

sharktide added 2 commits May 5, 2025 11:46

Merge branch 'python:main' into patch-130693

548e36a

pythongh-130693 Remove wordiness; only title left

6ce83e3

sharktide requested a review from Wulian233 May 5, 2025 15:49

Update 2025-03-04-17-19-26.gh-issue-130693.Kv01r8.rst

39f5875

sharktide requested a review from ZeroIntensity May 30, 2025 20:09

ZeroIntensity reviewed Jun 17, 2025

View reviewed changes

Misc/NEWS.d/next/Library/2025-03-04-17-19-26.gh-issue-130693.Kv01r8.rst Outdated Show resolved Hide resolved

Lib/tkinter/__init__.py Outdated Show resolved Hide resolved

Lib/tkinter/__init__.py Outdated Show resolved Hide resolved

ZeroIntensity added the topic-tkinter label Jun 17, 2025

sharktide and others added 4 commits June 17, 2025 19:13

remove whitespace in Lib/tkinter/__init__.py

ba0c98a

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>

Revert formatting in Lib/tkinter/__init__.py

754a124

Update news entry to use :meth: tags

ffd95fa

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>

Merge branch 'main' into patch-130693

72e70fc

sharktide added 2 commits August 10, 2025 17:39

Explicitly return list and convert tcl objects into strings

d58a291

Modify test_search to also test search_all()

d3621e2

Add to whatsnew.rst

dfe46c0

sharktide requested a review from AA-Turner as a code owner August 10, 2025 21:54

sharktide added 6 commits August 10, 2025 17:57

Merge branch 'main' into patch-130693

efc1685

Fix text fauilures

a286199

Update news entry

9cf844a

Update whatsnew again

834d6d4

Fix fails, reword

e4c7bef

Fix lint fails, add heading in what’s new

7cb79b9

serhiy-storchaka reviewed Aug 11, 2025

View reviewed changes

sharktide added 2 commits August 11, 2025 09:11

Remove breaking changes

026ded8

Use self.tk._splitlist

430773c

serhiy-storchaka reviewed Aug 11, 2025

View reviewed changes

Lib/tkinter/__init__.py Outdated Show resolved Hide resolved

Use ASCII dashes and move to improved modules

2f5ad84

serhiy-storchaka reviewed Aug 11, 2025

View reviewed changes

Lib/test/test_tkinter/test_text.py Outdated Show resolved Hide resolved

serhiy-storchaka reviewed Aug 11, 2025

View reviewed changes

Doc/whatsnew/3.15.rst Outdated Show resolved Hide resolved

Revert docstring and make search_all keyword only

71d2a60

serhiy-storchaka reviewed Aug 11, 2025

View reviewed changes

Lib/test/test_tkinter/test_text.py Outdated Show resolved Hide resolved

sharktide added 3 commits August 11, 2025 10:04

Allow for other return types in list

77831d4

Value based assertions

1daff0f

Remove - where not necessary, add newlines

422aa6f

sharktide requested a review from serhiy-storchaka August 11, 2025 14:19

sharktide added 3 commits August 11, 2025 10:27

Fix test fails

1328308

Update type expectations from list to tuple

6e3d0c9

Update assertion values

6c6520b

serhiy-storchaka reviewed Aug 11, 2025

View reviewed changes

Use suggestions

2852ee2

sharktide requested a review from serhiy-storchaka August 11, 2025 20:17

	* The ``tkinter.Text.search`` method now supports two additional
	* The :meth:`!tkinter.Text.search` method now supports two additional

Uh oh!

gh-130693: Add options of the tkinter.Text.search method: -nolinestop -all -overlap -strictlimits #130848

Are you sure you want to change the base?

gh-130693: Add options of the tkinter.Text.search method: -nolinestop -all -overlap -strictlimits #130848

Conversation

sharktide commented Mar 4, 2025 • edited by bedevere-app bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bedevere-app bot commented Mar 4, 2025

Uh oh!

Uh oh!

sharktide commented May 5, 2025

Uh oh!

Uh oh!

sharktide commented May 10, 2025

Uh oh!

sharktide commented May 30, 2025

Uh oh!

sharktide commented May 30, 2025 via email

Uh oh!

sharktide commented May 30, 2025

Uh oh!

sharktide commented Jun 17, 2025

Uh oh!

ZeroIntensity left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sharktide commented Jun 17, 2025 via email

Uh oh!

sharktide commented Jun 17, 2025

Uh oh!

sharktide commented Aug 10, 2025

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

serhiy-storchaka Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sharktide commented Mar 4, 2025 •

edited by bedevere-app bot

Loading