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

[sharktide]

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

Fixes #130693
Closes #130693

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:
[EDITED for change to new search_all method for -all and -overlap]

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 search_all
result = text.search_all('test', '1.0', 'end')
print('With search_all:', result)

# Test with -overlap
result = text.search_all('test', '1.0', 'end', overlap=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 search_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]

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.

[sharktide]

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

[sharktide]

@Wulian233 Please Review again

[sharktide]

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

[sharktide]

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]

Done!

[sharktide]

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

[ZeroIntensity]

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

[sharktide]

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: ***@***.***>

[sharktide]

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

[sharktide]

Gentle ping

[python-cla-bot]

All commit authors signed the Contributor License Agreement.

[sharktide]

@serhiy-storchaka Ready for review

[bedevere-app]

GH-141669 is a backport of this pull request to the 3.14 branch.

[serhiy-storchaka]

Thank you for your contribution, @sharktide. I rewrote the tests, so they clearly test the new options, and added many tests for already supported options. These tests will be backported.