gh-89610: Add syntax highlighting for `.pyi` files in IDLE #28950

AlexWaygood · 2021-10-14T16:10:48Z

This commit adds syntax highlighting for .pyi files in IDLE.
It also adds an option to open Python stub files in the "File-open" dialogue,
and an option to save a file as a .pyi file in the "File-save" dialogue.

Issue: Make IDLE recognize .pyi stub files as source for open, save, and edit #89610

This commit adds syntax highlighting for `.pyi` files in IDLE. It also adds an option to open Python stub files in the "File-open" dialogue, and an option to save a file as a `.pyi` file in the "File-save" dialogue.

Lib/idlelib/browser.py

Lib/idlelib/util.py

Lib/idlelib/idle_test/test_util.py

Misc/NEWS.d/next/IDLE/2021-10-14-16-55-03.bpo-45447.FhiH5P.rst

Lib/idlelib/util.py

Co-authored-by: E-Paine <63801254+E-Paine@users.noreply.github.com>

… docstrings to keep line length within 72 chars

AlexWaygood · 2021-12-06T18:51:15Z

@terryjreedy, would this be easier to review if I split it into several smaller PRs? 🙂 I'm happy to do so.

terryjreedy

Besides inline comments, add file requested on issue.

Lib/idlelib/util.py

Lib/idlelib/idle_test/test_browser.py

terryjreedy · 2022-01-16T03:43:10Z

Lib/idlelib/idle_test/test_util.py

+from idlelib import util
+
+
+class ExtensionTest(unittest.TestCase):


I will condense the extension tests.

Lib/idlelib/browser.py

bedevere-bot · 2022-01-16T04:00:24Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>

terryjreedy · 2022-01-24T05:53:58Z

Manual test: are you sure that stub users will prefer a separate entry to load stub files?
I should look at IDLE doc for possible revision.
Please update branch after updating main: 'git merge origin/main' or whatever. (Good to do this before every uploaded commit(s).
Change 'example.py' to 'example_stub.py' and add 'example_noext' (no extension) with #! line and 'normal' function.
For me, updated coverage module is not working with updated main. (Submitted report.) Leave alone for now.

…ighting

AlexWaygood · 2022-02-11T08:14:09Z

I think that this is now ready to merge. In manual testing all of py, .pyw, .pyi, and '' files can be opened and are syntax-highlighted.

Thanks for all your help, Terry. Let me know if there's anything else you'd like me to do!

terryjreedy · 2022-02-11T08:59:23Z

Reread the diff. Try the open on your system if different from Windows.

…xWaygood/cpython into pr_28950

miss-islington · 2022-02-13T00:04:51Z

Thanks @AlexWaygood for the PR, and @terryjreedy for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10.
🐍🍒⛏🤖

miss-islington · 2022-02-13T00:05:08Z

Sorry, @AlexWaygood and @terryjreedy, I could not cleanly backport this to 3.10 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 50cf4991c49e19f917305dd7b9c71085c11edddb 3.10

miss-islington · 2022-02-13T00:05:10Z

Sorry @AlexWaygood and @terryjreedy, I had trouble checking out the 3.9 backport branch.
Please backport using cherry_picker on command line.
cherry_picker 50cf4991c49e19f917305dd7b9c71085c11edddb 3.9

…-28950) Also add .pyi to the python extensions in the "File-open" and "File-save" dialogues. Add util.py to contain objects that are used in multiple idlelib modules and have no dependencies on any of them. Co-authored-by: E-Paine <63801254+E-Paine@users.noreply.github.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> (cherry picked from commit 50cf499)

bedevere-bot · 2022-02-13T00:25:12Z

GH-31303 is a backport of this pull request to the 3.10 branch.

Also add .pyi to the python extensions in the "File-open" and "File-save" dialogues. Add util.py to contain objects that are used in multiple idlelib modules and have no dependencies on any of them. Co-authored-by: E-Paine <63801254+E-Paine@users.noreply.github.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> (cherry picked from commit 50cf499) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

…-28950) Also add .pyi to the python extensions in the "File-open" and "File-save" dialogues. Add util.py to contain objects that are used in multiple idlelib modules and have no dependencies on any of them. Co-authored-by: E-Paine <63801254+E-Paine@users.noreply.github.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> (cherry picked from commit 50cf499) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> (cherry picked from commit 9fabcfb) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>

bedevere-bot · 2022-02-13T00:52:51Z

GH-31306 is a backport of this pull request to the 3.9 branch.

Also add .pyi to the python extensions in the "File-open" and "File-save" dialogues. Add util.py to contain objects that are used in multiple idlelib modules and have no dependencies on any of them. Co-authored-by: E-Paine <63801254+E-Paine@users.noreply.github.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> (cherry picked from commit 50cf499) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> (cherry picked from commit 9fabcfb) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>

AlexWaygood · 2022-02-13T15:18:08Z

Thanks for all the time you spent reviewing this, @terryjreedy! Hugely appreciate it.

…-28950) Also add .pyi to the python extensions in the "File-open" and "File-save" dialogues. Add util.py to contain objects that are used in multiple idlelib modules and have no dependencies on any of them. Co-authored-by: E-Paine <63801254+E-Paine@users.noreply.github.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> (cherry picked from commit 50cf499) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> (cherry picked from commit 9fabcfb) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>

bpo-45447: Add syntax highlighting for .pyi files in IDLE

bd2cdae

This commit adds syntax highlighting for `.pyi` files in IDLE. It also adds an option to open Python stub files in the "File-open" dialogue, and an option to save a file as a `.pyi` file in the "File-save" dialogue.

AlexWaygood requested a review from terryjreedy as a code owner October 14, 2021 16:10

bedevere-bot added the awaiting review label Oct 14, 2021

the-knights-who-say-ni added the CLA signed label Oct 14, 2021

E-Paine reviewed Oct 15, 2021

View reviewed changes

AlexWaygood and others added 9 commits October 15, 2021 11:36

Improve news entry.

b12399d

Co-authored-by: E-Paine <63801254+E-Paine@users.noreply.github.com>

Improve docstring at top of util.py

96d5a88

Co-authored-by: E-Paine <63801254+E-Paine@users.noreply.github.com>

Improve tests

eee661e

Use keyword arguments in test_util.py

b9ef62b

Correct alphabetical order in README.txt...

44fb0f1

Update coverage statistics in test files

2d8e0e8

Add __main__ block for util.py, tweak added test for iomenu.py, tweak…

4bba476

… docstrings to keep line length within 72 chars

Tweak test_util.py

be0043e

Merge branch 'python:main' into idle-pyi-syntax-highlighting

f8906a5

AlexWaygood added the type-feature A feature request or enhancement label Dec 6, 2021

terryjreedy requested changes Jan 16, 2022

View reviewed changes

bedevere-bot removed the awaiting review label Jan 16, 2022

bedevere-bot added the awaiting changes label Jan 16, 2022

AlexWaygood and others added 2 commits January 16, 2022 09:19

Update Lib/idlelib/util.py

5dc03fa

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>

Add example .pyi file

4b2c36c

AlexWaygood closed this Jan 18, 2022

AlexWaygood reopened this Jan 18, 2022

AlexWaygood added 5 commits January 24, 2022 18:32

Revert changes to coverage statistics

e9dfeb1

Rename example.pyi to example_stub.pyi

a197c93

Have stub files combined with other Python files in iomenu.py

eb754bd

Merge remote-tracking branch 'origin/main' into idle-pyi-syntax-highl…

e32bfca

…ighting

Fix broken test, improve other tests

c6bd524

terryjreedy approved these changes Feb 11, 2022

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting change review labels Feb 11, 2022

AlexWaygood closed this Feb 11, 2022

AlexWaygood reopened this Feb 11, 2022

AlexWaygood and others added 4 commits February 11, 2022 09:37

Remove commented-out line

e4b289a

Merge remote-tracking branch 'upstream/main' into pr_28950

91651a7

Final tweaks.

4931b3f

Merge branch 'idle-pyi-syntax-highlighting' of https://github.com/Ale…

38e5fc0

…xWaygood/cpython into pr_28950

terryjreedy merged commit 50cf499 into python:main Feb 13, 2022

bedevere-bot removed the awaiting merge label Feb 13, 2022

miss-islington assigned terryjreedy Feb 13, 2022

AlexWaygood deleted the idle-pyi-syntax-highlighting branch February 13, 2022 00:05

bedevere-bot removed the needs backport to 3.10 only security fixes label Feb 13, 2022

bedevere-bot removed the needs backport to 3.9 only security fixes label Feb 13, 2022

AlexWaygood mentioned this pull request Jul 27, 2022

Make IDLE recognize .pyi stub files as source for open, save, and edit #89610

Closed

terryjreedy changed the title ~~bpo-45447: Add syntax highlighting for .pyi files in IDLE~~ gh-89610: Add syntax highlighting for .pyi files in IDLE Aug 23, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-89610: Add syntax highlighting for `.pyi` files in IDLE #28950

gh-89610: Add syntax highlighting for `.pyi` files in IDLE #28950

AlexWaygood commented Oct 14, 2021 •

edited by terryjreedy

Loading

AlexWaygood commented Dec 6, 2021 •

edited

Loading

terryjreedy left a comment

terryjreedy Jan 16, 2022

bedevere-bot commented Jan 16, 2022

terryjreedy commented Jan 24, 2022

AlexWaygood commented Feb 11, 2022

terryjreedy commented Feb 11, 2022

miss-islington commented Feb 13, 2022

miss-islington commented Feb 13, 2022

miss-islington commented Feb 13, 2022

bedevere-bot commented Feb 13, 2022

bedevere-bot commented Feb 13, 2022

AlexWaygood commented Feb 13, 2022

		from idlelib import util


		class ExtensionTest(unittest.TestCase):

gh-89610: Add syntax highlighting for .pyi files in IDLE #28950

gh-89610: Add syntax highlighting for .pyi files in IDLE #28950

Conversation

AlexWaygood commented Oct 14, 2021 • edited by terryjreedy Loading

AlexWaygood commented Dec 6, 2021 • edited Loading

terryjreedy left a comment

Choose a reason for hiding this comment

terryjreedy Jan 16, 2022

Choose a reason for hiding this comment

bedevere-bot commented Jan 16, 2022

terryjreedy commented Jan 24, 2022

AlexWaygood commented Feb 11, 2022

terryjreedy commented Feb 11, 2022

miss-islington commented Feb 13, 2022

miss-islington commented Feb 13, 2022

miss-islington commented Feb 13, 2022

bedevere-bot commented Feb 13, 2022

bedevere-bot commented Feb 13, 2022

AlexWaygood commented Feb 13, 2022

gh-89610: Add syntax highlighting for `.pyi` files in IDLE #28950

gh-89610: Add syntax highlighting for `.pyi` files in IDLE #28950

AlexWaygood commented Oct 14, 2021 •

edited by terryjreedy

Loading

AlexWaygood commented Dec 6, 2021 •

edited

Loading