The Wayback Machine - https://web.archive.org/web/20220214221224/https://github.com/python/cpython/pull/28950
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 34 commits into from Feb 13, 2022
Merged

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

merged 34 commits into from Feb 13, 2022

Conversation

@AlexWaygood
Copy link
Member

@AlexWaygood AlexWaygood commented Oct 14, 2021 •
edited by bedevere-bot

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.

https://bugs.python.org/issue45447
@AlexWaygood
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 AlexWaygood requested a review from terryjreedy as a code owner Oct 14, 2021
E-Paine
E-Paine reviewed Oct 15, 2021
View changes
Lib/idlelib/browser.py Outdated Show resolved Hide resolved
Lib/idlelib/util.py Outdated Show resolved Hide resolved
Lib/idlelib/idle_test/test_util.py Outdated Show resolved Hide resolved
Misc/NEWS.d/next/IDLE/2021-10-14-16-55-03.bpo-45447.FhiH5P.rst Outdated Show resolved Hide resolved
Lib/idlelib/util.py Outdated Show resolved Hide resolved
@AlexWaygood
Copy link
Member Author

@AlexWaygood AlexWaygood commented Dec 6, 2021 •
edited

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

terryjreedy
terryjreedy requested changes Jan 16, 2022
View changes
Copy link
Member

@terryjreedy terryjreedy left a comment

Besides inline comments, add file requested on issue.

Lib/idlelib/util.py Outdated Show resolved Hide resolved
Lib/idlelib/idle_test/test_browser.py Outdated Show resolved Hide resolved
Lib/idlelib/idle_test/test_util.py Outdated
from idlelib import util


class ExtensionTest(unittest.TestCase):
Copy link
Member

@terryjreedy terryjreedy Jan 16, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will condense the extension tests.

Lib/idlelib/browser.py Outdated Show resolved Hide resolved
Lib/idlelib/browser.py Outdated Show resolved Hide resolved
@bedevere-bot
Copy link

@bedevere-bot bedevere-bot commented Jan 16, 2022

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.

@AlexWaygood AlexWaygood reopened this Jan 18, 2022
@terryjreedy
Copy link
Member

@terryjreedy terryjreedy commented Jan 24, 2022

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

@terryjreedy
Copy link
Member

@terryjreedy terryjreedy commented Feb 11, 2022

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.

@AlexWaygood AlexWaygood reopened this Feb 11, 2022
@AlexWaygood
Copy link
Member Author

@AlexWaygood AlexWaygood commented Feb 11, 2022

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
Copy link
Member

@terryjreedy terryjreedy commented Feb 11, 2022

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

@terryjreedy terryjreedy merged commit 50cf499 into python:main Feb 13, 2022
12 checks passed
@miss-islington
Copy link
Contributor

@miss-islington miss-islington commented Feb 13, 2022

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
Copy link
Contributor

@miss-islington miss-islington commented Feb 13, 2022

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
Copy link
Contributor

@miss-islington miss-islington commented Feb 13, 2022

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

@AlexWaygood AlexWaygood deleted the idle-pyi-syntax-highlighting branch Feb 13, 2022
terryjreedy added a commit to terryjreedy/cpython that referenced this issue Feb 13, 2022
@terryjreedy
bpo-45447: Add syntax highlighting for .pyi files in IDLE (pythonGH…
87339c0 
…-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 <[email protected]>
Co-authored-by: Terry Jan Reedy <[email protected]>
(cherry picked from commit 50cf499)
@bedevere-bot
Copy link

@bedevere-bot bedevere-bot commented Feb 13, 2022

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

terryjreedy added a commit that referenced this issue Feb 13, 2022
@terryjreedy
bpo-45447: Add syntax highlighting for .pyi files in IDLE (GH-28950)
9fabcfb 
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 <[email protected]>
Co-authored-by: Terry Jan Reedy <[email protected]>
(cherry picked from commit 50cf499)

Co-authored-by: Alex Waygood <[email protected]>
miss-islington added a commit to miss-islington/cpython that referenced this issue Feb 13, 2022
@terryjreedy @miss-islington
bpo-45447: Add syntax highlighting for .pyi files in IDLE (pythonGH…
1968d37 
…-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 <[email protected]>
Co-authored-by: Terry Jan Reedy <[email protected]>
(cherry picked from commit 50cf499)

Co-authored-by: Alex Waygood <[email protected]>
(cherry picked from commit 9fabcfb)

Co-authored-by: Terry Jan Reedy <[email protected]>
@bedevere-bot
Copy link

@bedevere-bot bedevere-bot commented Feb 13, 2022

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

miss-islington added a commit that referenced this issue Feb 13, 2022
@terryjreedy @miss-islington
bpo-45447: Add syntax highlighting for .pyi files in IDLE (GH-28950)
1d4d44c 
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 <[email protected]>
Co-authored-by: Terry Jan Reedy <[email protected]>
(cherry picked from commit 50cf499)

Co-authored-by: Alex Waygood <[email protected]>
(cherry picked from commit 9fabcfb)

Co-authored-by: Terry Jan Reedy <[email protected]>
@AlexWaygood
Copy link
Member Author

@AlexWaygood AlexWaygood commented Feb 13, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@E-Paine E-Paine

@terryjreedy terryjreedy

Assignees

@terryjreedy terryjreedy

Labels
CLA signed type-enhancement
Projects
None yet
Milestone
No milestone
6 participants
@AlexWaygood @bedevere-bot @terryjreedy @miss-islington @E-Paine @the-knights-who-say-ni