PR: Add Editor extensions #5002

rlaverde · 2017-08-18T15:11:27Z

Fixes: #877

See #4987 (comment)
I use #877 as example of an editor extension

They idea is to create an extension in spyder/widgets/sourcecode/extensions/ with a class that Inherits o EditorExtension (api.editor.extension), create custom methods and connect them in the on_uninstall method, and the add them to the Codeeditor.editor_extensions

class MultiCursorsEditorFeature(EditorFeature):
     def _on_key_pressed():
          ....
     def _on_mouse_released():

     def `on_uninstall():
           self._editor.key_pressed.connect(self._on_key_pressed)
           self._editor.sig_mouse_pressed.connect(self._on_mouse_pressed)

class CodeEditor():

    def __init__(self):
         editor_extensions = EditorExtensionsManager
         editor_extensions.register(MultiCursorEditorsFeature)

There is already some signals for key press, and paint event, ~~I also added a signal for mouse pressed.~~ Maybe there is missing a signal for timerEvent.

ping @jnsebgosselin

pep8speaks · 2017-08-18T15:11:33Z

Hello @rlaverde! Thanks for updating the PR.

Cheers ! There are no PEP8 issues in this Pull Request. 🍻

Comment last updated on August 23, 2017 at 16:01 Hours UTC

ccordoba12 · 2017-08-18T15:28:57Z

spyder/widgets/sourcecode/codeeditor.py

@@ -247,6 +249,8 @@ class CodeEditor(TextEditBaseWidget):
    #: Signal emitted when a key is pressed
    key_pressed = Signal(QKeyEvent)

+    sig_mouse_pressed = Signal(QMouseEvent)


This doesn't seem necessary as part of this PR, right?

ccordoba12 · 2017-08-18T15:31:49Z

I really like this, it's very neat! I just have one suggestion: could we add as part of this PR an EditorExtension that involves some kind of text manipulation in CodeEditor? It can be something very simple, nothing fancy.

That way it'd be easier to understand how to use extensions for the rest of us ;-)

…tor helper functions public.

rlaverde · 2017-08-22T22:30:53Z

@ccordoba12 This is ready, I moved close quote logic to an editor extension, and write some tests, although I didn't found any errors with that code.

Should I enable close quote by default?

ccordoba12 · 2017-08-22T23:03:04Z

spyder/widgets/sourcecode/editorextensions/closequotes.py

+        return ''
+
+
+class QuoteEditorExtension(EditorExtension):


Let's call this CloseQuoteExtension

Sorry, CloseQuotesExtension

ccordoba12 · 2017-08-22T23:07:44Z

although I didn't found any errors with that code.

I think issue #877 has several examples. Did you look at it?

Should I enable close quote by default?

If tests pass, why not? ;-)

goanpeca · 2017-08-23T14:41:28Z

spyder/widgets/sourcecode/editorextensions/manager.py


    def __init__(self, editor):
+        """Initialize and add a reference to the editor."""
        super(EditorExtensionsManager, self).__init__(editor)
        self._extensions = {}

    def append(self, extension):


Add/remove are the antonyms, not append/remove

I think append is more list-pythonic, should I change it for add?

Yes it is, but append even your docsting uses ADD and not APPEND, so you can see why append is not really a good choice, independent of the structure used to store extensions (dict, list, set or whatever). So either we append/prepend or add/remove, insert/pop, but not a mix of those. So yes, please change to add

@rlaverde ?

Sorry, I didn't see your response because It was collapsed, I'm going to change it for add

goanpeca · 2017-08-23T14:42:14Z

spyder/widgets/sourcecode/editorextensions/closequotes.py

-"""
-This module contains the close quotes editor extension
-"""
+"""This module contains the close quotes editor extension."""


We could just use extensions folder? like spyder/widgets/sourcecode/extensions/closequotes.py

ccordoba12 · 2017-08-23T14:49:34Z

I agree with @goanpeca to use only the sourcecode/extensions for this directory instead of sourcecode/editorextensions.

rlaverde · 2017-08-23T14:54:28Z

I agree with @goanpeca to use only the sourcecode/extensions for this directory instead of sourcecode/editorextensions.

Yes, me too (at first I thought that editorextensions was more specific, anyway they are into the sourcecode folder, or the plugins/editor, after split-plugins, so that long name is redundant)

rlaverde · 2017-08-23T15:06:08Z

I think issue #877 has several examples. Did you look at it?

I implement #877 (comment) although I change the behavior, It'll just keep the text selected allowing to add as many quotes as you like.

The parenthesis are managed by other logic, so integrate it with this extension could break some of their functionality

ccordoba12

Terrific job @rlaverde! I really like this!

ccordoba12 · 2017-08-23T15:52:42Z

I implement #877 (comment) although I change the behavior, It'll just keep the text selected allowing to add as many quotes as you like.

Ok, no problem. If more issues appear in the future, now we can fix and add tests for this quite easily.

rlaverde self-assigned this Aug 18, 2017

rlaverde requested review from ccordoba12 and goanpeca August 18, 2017 15:11

ccordoba12 reviewed Aug 18, 2017

View reviewed changes

rlaverde force-pushed the editor-extensions branch from 3bb3286 to da9e752 Compare August 22, 2017 22:12

rlaverde added 17 commits August 22, 2017 17:25

Add Editor Extensions manager.

74593d5

Move mode --> editorextension.

a25e49d

Rename Mode --> EditorExtension.

afd03cd

Add TODO to not working editor extension function.

6c65cee

Add editor extension to CodeEditor.

75dfd18

Add init to editorextensions module.

655f671

Remove comment, now editor extensions can be added to the editor.

b000e3e

Add QuoteEditorExtension.

600bc6b

Move autoinsert quotes logic to quote editor extension.

3ff6e17

Accept event in quote extension, to avoid it to call super class method.

a92f0c3

Move unmatched_quotes_in_line to quote extensions, and make other edi…

f17348b

…tor helper functions public.

Add some docstrings.

54ac85a

Make autoinsert quotes a private method.

7cb5cea

Add basic test for edit close quotes.

565cc3b

Test close quotes.

40ea3e3

Add test for close quotes selected text.

38041cf

Add test for activate/deactivate close quotes.

06a1e12

rlaverde force-pushed the editor-extensions branch from da9e752 to 06a1e12 Compare August 22, 2017 22:26

ccordoba12 reviewed Aug 22, 2017

View reviewed changes

ccordoba12 added this to the v4.0beta1 milestone Aug 22, 2017

Add multiquote insertion when selecting text.

a32db5e

rlaverde added 3 commits August 23, 2017 09:09

Add test for multiple lines quoting.

cd5f36c

Activate closing quotes by default.

7d43da0

Improve some docstrings.

a24144f

goanpeca reviewed Aug 23, 2017

View reviewed changes

Change name of CloseQuotesExtension.

c96352f

rlaverde force-pushed the editor-extensions branch from 7198526 to c96352f Compare August 23, 2017 14:43

Move sourcecode/editorextensions --> sourcecode/extensions

acc5895

ccordoba12 approved these changes Aug 23, 2017

View reviewed changes

Change EditorExtensionsManager method name: append-->add.

8c8a5c4

ccordoba12 changed the title ~~PR: Editor extensions~~ PR: Add Editor extensions Aug 28, 2017

ccordoba12 merged commit 70a874f into spyder-ide:master Aug 28, 2017

rlaverde deleted the editor-extensions branch August 29, 2017 00:03

rlaverde mentioned this pull request Sep 5, 2017

PR: Fix error Editor loosing focus #5139

Merged

bcolsen mentioned this pull request Jul 30, 2018

Add encapsulate with parentheses (quotes, brackets, braces) function #3414

Closed

jnsebgosselin mentioned this pull request Aug 21, 2018

[WIP] PR: Add multiline editing capability in the Editor #4987

Closed

23 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PR: Add Editor extensions #5002

PR: Add Editor extensions #5002

rlaverde commented Aug 18, 2017 •

edited

Loading

pep8speaks commented Aug 18, 2017 •

edited

Loading

ccordoba12 Aug 18, 2017

ccordoba12 commented Aug 18, 2017

rlaverde commented Aug 22, 2017

ccordoba12 Aug 22, 2017

ccordoba12 Aug 22, 2017

ccordoba12 commented Aug 22, 2017

goanpeca Aug 23, 2017

rlaverde Aug 23, 2017

goanpeca Aug 23, 2017

goanpeca Aug 23, 2017

rlaverde Aug 23, 2017 •

edited

Loading

goanpeca Aug 23, 2017

ccordoba12 commented Aug 23, 2017

rlaverde commented Aug 23, 2017 •

edited by ccordoba12

Loading

rlaverde commented Aug 23, 2017

ccordoba12 left a comment

ccordoba12 commented Aug 23, 2017

PR: Add Editor extensions #5002

PR: Add Editor extensions #5002

Conversation

rlaverde commented Aug 18, 2017 • edited Loading

pep8speaks commented Aug 18, 2017 • edited Loading

Comment last updated on August 23, 2017 at 16:01 Hours UTC

Choose a reason for hiding this comment

ccordoba12 commented Aug 18, 2017

rlaverde commented Aug 22, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ccordoba12 commented Aug 22, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rlaverde Aug 23, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ccordoba12 commented Aug 23, 2017

rlaverde commented Aug 23, 2017 • edited by ccordoba12 Loading

rlaverde commented Aug 23, 2017

ccordoba12 left a comment

Choose a reason for hiding this comment

ccordoba12 commented Aug 23, 2017

rlaverde commented Aug 18, 2017 •

edited

Loading

pep8speaks commented Aug 18, 2017 •

edited

Loading

rlaverde Aug 23, 2017 •

edited

Loading

rlaverde commented Aug 23, 2017 •

edited by ccordoba12

Loading