This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: Idle: Auto insertion of the closing parens, brackets, and braces
Type: enhancement Stage: patch review
Components: IDLE Versions: Python 3.10
Status: open Resolution:
Dependencies: Superseder:
Assigned To: terry.reedy Nosy List: THRlWiTi, louielu, terry.reedy, wohlganger
Priority: normal Keywords: patch

Created on 2013-08-29 11:58 by THRlWiTi, last changed 2022-04-11 14:57 by admin.

File name Uploaded Description Edit wohlganger, 2017-07-17 20:39 Extension to close parens, brackets, braces, ticks, and quotes wohlganger, 2017-07-18 13:47 version 0.2, added docstring, pep8 fixes wohlganger, 2017-07-20 20:53 parenclose test wohlganger, 2017-07-20 20:59 version 0.4, made it easier to test, fixed problems found in testing wohlganger, 2017-07-21 15:15 parenclose test 0.2 - pep8-ified, fixed minor bug
Pull Requests
URL Status Linked Edit
PR 3520 open wohlganger, 2017-09-12 19:24
Messages (14)
msg196456 - (view) Author: Thrlwiti (THRlWiTi) * Date: 2013-08-29 11:58
Many other IDE's have this feature that allows automatic insertion of closing parentheses as user is typing something. I think it saves time and increases programming speed. Is it possible to have this on IDLE, too?
msg196593 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2013-08-30 22:30
I have thought about such a feature also. I would at least like to have patch to try it out. Possible? I suspect so.
msg220632 - (view) Author: Mark Lawrence (BreamoreBoy) * Date: 2014-06-15 13:18
I'd like to see this feature as I've been using IDLE quite a lot recently and I'm so used to seeing it in other IDEs.
msg220651 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2014-06-15 16:49
I have never actually used this feature, and I do not see it in Notepad++. I worry that some people, especially beginners with no experience of this 'feature' would hate this, so it would have to be optional.

Do you literally mean 'parentheses' or also square and curly brackets?  How about quotes? An autocloser here would be useful as Idle would not mishighlight the remainer of the text.

How does it increase speed? Hitting -> to skip over the closer is hardly faster that typing the closer. It might reduce errors though.

Tal, any opinion on this?
msg220653 - (view) Author: Tal Einat (taleinat) * (Python committer) Date: 2014-06-15 17:16
I like the idea, though it's really just nice to have. This is a very common in IDEs these days, and whoever finds it annoying will be able to disable it.

If we do this, we should go all the way and close square and curly brackets, parenthesis, and quotes (including triple quotes!).

Also, any implementation must allow typing the closing parenthesis to actually just move the cursor beyond the automatically generated closer. Getting this right is more difficult than it sounds! But certainly possible.

I actually seem to recall having seen this implemented for IDLE quite a few years ago. I might even have been the one to implement it... I can't see any mention in IDLE-Spoon, IdleX or VIDLE, though. I'll take a look through my old files when I get the chance back home.
msg220664 - (view) Author: Tal Einat (taleinat) * (Python committer) Date: 2014-06-15 18:55
Well, I was wrong. I can't find anything of the sort in my old IDLE files.
msg228254 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2014-10-02 20:15
This would have to be an extension, default off unless overridden, which is why I added config-extensions as dependency.
msg298554 - (view) Author: Charles Wohlganger (wohlganger) * Date: 2017-07-17 20:39
I've written an extension (see file) that does auto insertion of closing parens, brackets, braces, ticks, and quotes. It also (optionally) skips the closers when they are typed right next to the already exiting one. It also takes into account triple-ticks / triple-quotes.
msg298573 - (view) Author: Louie Lu (louielu) * Date: 2017-07-18 03:57
Charles, good to saw the patch, would you like to convert it into GitHub PR? also, it would have to adjust some coding style to satisfy PEP8. I can help you on GitHub to review this patch.
msg298586 - (view) Author: Charles Wohlganger (wohlganger) * Date: 2017-07-18 13:47
I (foolishly) was committing to master for a different IDLE enhancement. Until that one is pulled, I don't think I can make a new PR without it also having all the changes from my previous one. 

New uploaded file has docstrings for the ParenClose class and I've run and fixed it against pep8 until it gave no errors. Namespaces should conform to PEP8, apart from the module name, which must match the class name due to how IDLE works with extensions.
msg298750 - (view) Author: Charles Wohlganger (wohlganger) * Date: 2017-07-20 20:59
I've uploaded a test file and updated ParenClose.
msg302620 - (view) Author: Charles Wohlganger (wohlganger) * Date: 2017-09-20 14:19
The PR contains all the requested features, as well as mutual deletion (requested on PR page), and I have separated out the options for mutual deletion triggered by delete or triggered by backspace. I've found in usage that it was irritating to have both, but nice to only have one. Let users pick one, both, or none.
msg315009 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2018-04-06 03:41
My question about the idea is whether beginners would use this, or if it is the sort of 'expert' feature that IDLE should avoid.  I may ask on python-list for more opinions. adds a vote in favor.  It also prompted me to review the patch.

Since I said, 4 years ago, that the feature should be an extension, we have converted extensions to features.  So the patch needs re-writing, as I outlined.

(Although there is now an extension configuration dialog, it is no longer a dependency of this issue.)

I am not convinced that we need 5 configuration options, especially since I do not understand 2 of them ;-).  Do symbol and quote fences need to be separately enabled?  Does anyone known what other IDEs do?
msg374049 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2020-07-21 02:59
I found this in Notepad++ under Settings -> Preferences -> Auto-completion -> Auto-insert with separate checkboxes for (, {, [, ', ", html/xml tags, and up to 3 custom pairs.  Way too elaborate for IDLE.  The only question to me is whether to have just one option for all 5 openers or separate option to complete ([{ versus quotes.

Concerns: a) matching triple quotes is a bit baroque, though possible the most useful part of the feature; b) except for completing tripple quotes, no keystrokes are saved, and then only if one used End to skip three chars at once.  On the other hand, at least some people who have use the feather elsewhere consider it a net win.

Implementation notes: 1. IDLE editors uses two mechanisms to respond to keystrokes.  The delegator mechanism checks all keystrokes and responds to some.  IDLE otherwise binds keystrokes to event-handlers or to pseudoevent bound to event-handlers.  Perhaps these could be unified and made more efficient.

2. In the meanwhile... Menu items are bound to pseudoevents, along with corresponding hot heys.  This issue will *not* add a menu entry "Add matching closer".  So the openers can be bound directly to event handlers that look at the opener.
Date User Action Args
2022-04-11 14:57:50adminsetgithub: 63075
2020-07-21 02:59:16terry.reedysetmessages: + msg374049
versions: + Python 3.10, - Python 3.6, Python 3.7, Python 3.8
2020-07-21 01:11:13terry.reedylinkissue41351 superseder
2018-04-06 03:41:01terry.reedysetdependencies: - IDLE - Add an extension configuration dialog
messages: + msg315009
versions: + Python 3.8
2017-09-28 06:58:19taleinatsetnosy: - taleinat
2017-09-20 14:19:39wohlgangersetmessages: + msg302620
2017-09-12 19:24:04wohlgangersetkeywords: + patch
stage: patch review
pull_requests: + pull_request3517
2017-07-21 15:15:55wohlgangersetfiles: +
2017-07-20 20:59:57wohlgangersetfiles: +

messages: + msg298750
2017-07-20 20:53:58wohlgangersetfiles: +
2017-07-18 13:47:11wohlgangersetfiles: +

messages: + msg298586
2017-07-18 03:57:42louielusetnosy: + louielu
messages: + msg298573
2017-07-17 20:39:57wohlgangersetfiles: +
nosy: + wohlganger
messages: + msg298554

2017-06-30 00:53:54terry.reedysetassignee: terry.reedy

nosy: - BreamoreBoy
versions: + Python 3.6, Python 3.7, - Python 2.7, Python 3.4, Python 3.5
2014-10-02 20:16:00terry.reedysettitle: Automatic insertion of the closing parentheses, brackets, and braces -> Idle: Auto insertion of the closing parens, brackets, and braces
dependencies: + IDLE - Add an extension configuration dialog
messages: + msg228254
versions: + Python 2.7, Python 3.4
2014-06-15 18:55:25taleinatsetmessages: + msg220664
2014-06-15 17:16:15taleinatsetmessages: + msg220653
2014-06-15 16:49:57terry.reedysetnosy: + taleinat
messages: + msg220651
2014-06-15 13:18:13BreamoreBoysetnosy: + BreamoreBoy

messages: + msg220632
versions: + Python 3.5, - Python 3.4
2013-08-30 22:30:07terry.reedysetnosy: + terry.reedy

messages: + msg196593
versions: + Python 3.4, - Python 2.7
2013-08-29 11:58:18THRlWiTicreate