PR: Add option to use Jedi in the IPython console + warning on greedy completer #6832

hofingermarkus · 2018-03-24T13:25:00Z

This adds an option for Jedi Code completion in the ipython shell.

It also adds a warning text for the Greedy completer, to inform users, that the current version of the Greedy completer in ipython needs an extra space to split commands.
Related Spyder-ide issues: #6803 #6700

Related Ipython Console Issues:
https://github.com/ipython/ipython/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+greedy+completer

Also updated GUI text of Greedy completion to warn about greedy completion bug.

CAM-Gerlach

Thanks for your contribution! I found a number of elementary typos and errors in the text; please correct them. Also, overall, the total amount of text really needs to be cut down, and there's quite a bit of crazy and inconsistent formatting; I've provided a few suggestions to try to address both. Finally, can you add a simple test for this?

CAM-Gerlach · 2018-03-24T16:34:44Z

spyder/plugins/ipythonconsole.py

@@ -477,15 +477,42 @@ def setup_page(self):
        run_file_group.setLayout(run_file_layout)

        # ---- Advanced settings ----
+        # Enable Jedi completion in Ipyhton Console


"IPython" is the correct spelling and capitalization, though ipython also works.

CAM-Gerlach · 2018-03-24T16:36:54Z

spyder/plugins/ipythonconsole.py

@@ -477,15 +477,42 @@ def setup_page(self):
        run_file_group.setLayout(run_file_layout)

        # ---- Advanced settings ----
+        # Enable Jedi completion in Ipyhton Console
+        ipy_jedi_group = QGroupBox(_("Jedi completion in Ipython console"))


IPython Console, to follow the above convention. Also, needs the article "the" in front of it. So:

"Jedi Completion in the IPython Console"

However, as this is a section title, for consistancy with the general style and with the others on the page, it should be shortened to:

"Jedi Completion"

or something similar, and in Title Case.

CAM-Gerlach · 2018-03-24T16:37:14Z

spyder/plugins/ipythonconsole.py

@@ -477,15 +477,42 @@ def setup_page(self):
        run_file_group.setLayout(run_file_layout)

        # ---- Advanced settings ----
+        # Enable Jedi completion in Ipyhton Console
+        ipy_jedi_group = QGroupBox(_("Jedi completion in Ipython console"))
+        ipy_jedi_label = QLabel(_("Enable Jedi based <tt>Tab</tt> completion in"


"Jedi-based", also needs a space at the end.

CAM-Gerlach · 2018-03-24T16:49:54Z

spyder/plugins/ipythonconsole.py

+        # Enable Jedi completion in Ipyhton Console
+        ipy_jedi_group = QGroupBox(_("Jedi completion in Ipython console"))
+        ipy_jedi_label = QLabel(_("Enable Jedi based <tt>Tab</tt> completion in"
+                                "the Ipython console. E.g. completion of"


"the IPython Console; works with e.g. nested lists, etc.

Alternately, you can cut everything after the semicolon and instead add "similar to the greedy completer, but without evaluating the code." A little longer and more visually awkward than cutting the second line, but cleaner flow on the textual side.

CAM-Gerlach · 2018-03-24T16:54:13Z

spyder/plugins/ipythonconsole.py

+        ipy_jedi_group = QGroupBox(_("Jedi completion in Ipython console"))
+        ipy_jedi_label = QLabel(_("Enable Jedi based <tt>Tab</tt> completion in"
+                                "the Ipython console. E.g. completion of"
+                                "nested lits etc. This is similar to the "


I'd lean toward cutting this sentence, as it saves a full line, and including it in the popup tip instead; better IMO to put that extra descriptive text in the popup tip as its designed for then clutter the UI with every last detail.

CAM-Gerlach · 2018-03-24T17:24:33Z

spyder/plugins/ipythonconsole.py

        # Greedy completer group
-        greedy_group = QGroupBox(_("Greedy completion"))
+        greedy_group = QGroupBox(_("Greedy completion in Ipython console"))
        greedy_label = QLabel(_("Enable <tt>Tab</tt> completion on elements "
                                "of lists, results of function calls, etc, "
                                "<i>without</i> assigning them to a "
                                "variable.<br>"
                                "For example, you can get completions on "


Since you're adding so much extra text, I'd recommend you simplify this to something like:

"Get completions on e.g. [...] and [...]"

CAM-Gerlach · 2018-03-24T17:25:41Z

spyder/plugins/ipythonconsole.py

@@ -575,7 +602,7 @@ def setup_page(self):
                                    _("Graphics"))
        tabs.addTab(self.create_tab(run_lines_group, run_file_group),
                                    _("Startup"))
-        tabs.addTab(self.create_tab(greedy_group, autocall_group, sympy_group,
+        tabs.addTab(self.create_tab(ipy_jedi_group, greedy_group , autocall_group, sympy_group,


Remove extra space added after greedy_group.

CAM-Gerlach · 2018-03-24T17:27:14Z

spyder/plugins/ipythonconsole.py

        greedy_label = QLabel(_("Enable <tt>Tab</tt> completion on elements "
                                "of lists, results of function calls, etc, "
                                "<i>without</i> assigning them to a "
                                "variable.<br>"
                                "For example, you can get completions on "
                                "things like <tt>li[0].&lt;Tab&gt;</tt> or "
-                                "<tt>ins.meth().&lt;Tab&gt;</tt>"))
+                                "<tt>ins.meth().&lt;Tab&gt;</tt> <br><br>"
+                                "<b>ATTENTION:<br> Ipython's Greedy completer has "


"IPython's greedy completer has "

Or better yet, rewrite the whole thing to read as follows:

"Due to a bug, IPython's greedy completer requires a leading space for some completions; e.g. np.sin(<Space>np.<Tab>) works, while np.sin(np.<Tab>) doesn't.

CAM-Gerlach · 2018-03-24T17:30:21Z

spyder/plugins/ipythonconsole.py

+                                "<b>ATTENTION:<br> Ipython's Greedy completer has "
+                                "a bug</b> that requires a leading "
+                                "<tt>&lt;Space&gt;</tt> "
+                                "for some completions to work. e.g. chane "


Typo; I presume you mean "change", and e.g. needs to be capitalized if starting a sentence, though I recommend rewriting it as above.

CAM-Gerlach · 2018-03-24T17:35:18Z

spyder/plugins/ipythonconsole.py

+                                "for some completions to work. e.g. chane "
+                                "<tt>np.sin(np.&lt;Tab&gt;</tt> "
+                                "to <tt>np.sin(&lt;Space&gt;np.&lt;Tab&gt;</tt> "
+                                ", and completion for string filenames has "


Everything after the comma on this line is redundant, you used the same phrase above and it is directly implied by what you've stated. I know it relates to your specific problem, but including every possible case (and this is one few if any others have complained about) is an issue for the documentation IMO, not the UI.

…ompletion in the iypthon console. Also updated GUI text of Greedy completion to warn about greedy completion bug.

pep8speaks · 2018-03-24T20:36:47Z

Hello @hofingermarkus! Thanks for updating the PR.

In the file spyder/plugins/ipythonconsole.py, following are the PEP8 issues :

Line 483:35: E127 continuation line over-indented for visual indent
Line 489:74: W291 trailing whitespace
Line 490:30: E127 continuation line over-indented for visual indent
Line 495:1: W293 blank line contains whitespace
Line 500:1: W293 blank line contains whitespace
Line 604:80: E501 line too long (90 > 79 characters)

Comment last updated on March 27, 2018 at 07:51 Hours UTC

…ompletion in the iypthon console. Also updated GUI text of Greedy completion to warn about greedy completion bug.

CAM-Gerlach

Looking good. Now just fix the last few PEP8 issues, update the screenshot, and add a test for enabling/disabling and basic functionality of jedi completion (spyder/plugins/tests/test_ipythonconsole.py should give you some good examples of what to do) and you should be good, pending further @ccordoba12 feedback. Thanks!

Changes executed as requested. Thanks!

ccordoba12 · 2018-03-26T19:20:40Z

spyder/config/main.py

@@ -158,6 +158,7 @@
              'startup/use_run_file': False,
              'startup/run_file': '',
              'greedy_completer': False,
+              'ipy_jedi_completer': False,


Please change this to jedi_completer. We already know that it's an IPython console option because it's in the right section.

ccordoba12 · 2018-03-26T19:21:03Z

spyder/plugins/ipythonconsole.py

+                                  "when working with large dataframes!"))
+        ipy_jedi_label.setWordWrap(True)
+        ipy_jedi_box = newcb(_("Use Jedi completion in the IPython console"), 
+                             "ipy_jedi_completer",


Change to jedi_completer

ccordoba12 · 2018-03-26T19:22:32Z

spyder/plugins/ipythonconsole.py

@@ -477,20 +477,46 @@ def setup_page(self):
        run_file_group.setLayout(run_file_layout)

        # ---- Advanced settings ----
+        # Enable Jedi completion in IPyhton Console
+        ipy_jedi_group = QGroupBox(_("Jedi completion"))


Remove the ipy_ prefix from all variables in this section. Again, these are IPython confg options, so there's no need for that prefix.

ccordoba12 · 2018-03-26T19:23:23Z

spyder/utils/ipython/kernelspec.py

@@ -124,6 +124,7 @@ def env(self):
            'SPY_RUN_FILE_O': CONF.get('ipython_console', 'startup/run_file'),
            'SPY_AUTOCALL_O': CONF.get('ipython_console', 'autocall'),
            'SPY_GREEDY_O': CONF.get('ipython_console', 'greedy_completer'),
+            'SPY_IPY_JEDI_O': CONF.get('ipython_console', 'ipy_jedi_completer'),


Again, remove IPY_ and ipy_ here.

ccordoba12 · 2018-03-26T19:23:51Z

spyder/utils/ipython/start_kernel.py

@@ -69,10 +69,12 @@ def kernel_config():
    # Until we implement Issue 1052
    spy_cfg.InteractiveShell.xmode = 'Plain'

+    # Jedi completer in IPpthon console
+    ipy_jedi_o = os.environ.get('SPY_IPY_JEDI_O') == 'True'


Remove ipy_ and IPY_ also here.

ccordoba12

This looks good, except for some minor formatting issues.

ccordoba12 · 2018-03-26T19:25:42Z

spyder/utils/ipython/start_kernel.py

@@ -69,10 +69,12 @@ def kernel_config():
    # Until we implement Issue 1052
    spy_cfg.InteractiveShell.xmode = 'Plain'

+    # Jedi completer in IPpthon console


Remove here in IPpthon console.

This is still missing. Please address it.

hofingermarkus · 2018-03-27T11:07:40Z

Updated according to change requests.
Added new updated Screenshot to PR

ccordoba12

Thanks @hofingermarkus! Great work here!

max added 2 commits March 24, 2018 14:10

Added GUI option to use Jedi code completion in the iypthon console.

5f59e4e

Also updated GUI text of Greedy completion to warn about greedy completion bug.

Added GUI option to use Jedi code completion in the iypthon console.

99e755d

Also updated GUI text of Greedy completion to warn about greedy completion bug.

ccordoba12 added this to the v3.2.9 milestone Mar 24, 2018

ccordoba12 changed the title ~~PR: Added GUI option to use Jedi code completion in the iypthon console + Warning on Greedy Completer Bug~~ PR: Added option to use Jedi the IPython console + warning on greedy completer Mar 24, 2018

CAM-Gerlach assigned hofingermarkus Mar 24, 2018

CAM-Gerlach added type:Bug component:Preferences User Interface (UI) status:Pending Changes/Test labels Mar 24, 2018

CAM-Gerlach changed the title ~~PR: Added option to use Jedi the IPython console + warning on greedy completer~~ PR: Add option to use Jedi the IPython console + warning on greedy completer Mar 24, 2018

CAM-Gerlach previously requested changes Mar 24, 2018

View reviewed changes

Rephrased text and fixed typos: - Added GUI option to use Jedi code c…

cdaa29c

…ompletion in the iypthon console. Also updated GUI text of Greedy completion to warn about greedy completion bug.

Rephrased text and fixed typos: - Added GUI option to use Jedi code c…

c07aee3

…ompletion in the iypthon console. Also updated GUI text of Greedy completion to warn about greedy completion bug.

CAM-Gerlach reviewed Mar 24, 2018

View reviewed changes

ccordoba12 reviewed Mar 26, 2018

View reviewed changes

ccordoba12 requested changes Mar 26, 2018

View reviewed changes

ccordoba12 reviewed Mar 26, 2018

View reviewed changes

max added 2 commits March 26, 2018 22:47

Final change of variable names to fit change request

6e8a465

Updated comments to fit existing namin conventions...

ff8731c

ccordoba12 approved these changes Mar 27, 2018

View reviewed changes

ccordoba12 changed the title ~~PR: Add option to use Jedi the IPython console + warning on greedy completer~~ PR: Add option to use Jedi in the IPython console + warning on greedy completer Mar 27, 2018

ccordoba12 merged commit 66c094e into spyder-ide:3.x Mar 27, 2018

ccordoba12 added a commit that referenced this pull request Mar 27, 2018

Merge from 3.x: PR #6832

ccdac16

ccordoba12 mentioned this pull request Jul 26, 2019

Strange autocomplete bugs on Ubuntu, depending on space before variable #6700

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PR: Add option to use Jedi in the IPython console + warning on greedy completer #6832

PR: Add option to use Jedi in the IPython console + warning on greedy completer #6832

hofingermarkus commented Mar 24, 2018 •

edited

CAM-Gerlach left a comment

CAM-Gerlach Mar 24, 2018

CAM-Gerlach Mar 24, 2018 •

edited

CAM-Gerlach Mar 24, 2018

CAM-Gerlach Mar 24, 2018

CAM-Gerlach Mar 24, 2018

CAM-Gerlach Mar 24, 2018

CAM-Gerlach Mar 24, 2018

CAM-Gerlach Mar 24, 2018

CAM-Gerlach Mar 24, 2018

CAM-Gerlach Mar 24, 2018

CAM-Gerlach Mar 24, 2018

pep8speaks commented Mar 24, 2018 •

edited

CAM-Gerlach left a comment

ccordoba12 Mar 26, 2018

ccordoba12 Mar 26, 2018

ccordoba12 Mar 26, 2018 •

edited

ccordoba12 Mar 26, 2018

ccordoba12 Mar 26, 2018

ccordoba12 left a comment

ccordoba12 Mar 26, 2018

ccordoba12 Mar 26, 2018

hofingermarkus Mar 27, 2018

hofingermarkus commented Mar 27, 2018

ccordoba12 left a comment

PR: Add option to use Jedi in the IPython console + warning on greedy completer #6832

PR: Add option to use Jedi in the IPython console + warning on greedy completer #6832

Conversation

hofingermarkus commented Mar 24, 2018 • edited

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CAM-Gerlach Mar 24, 2018 • edited

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pep8speaks commented Mar 24, 2018 • edited

Comment last updated on March 27, 2018 at 07:51 Hours UTC

CAM-Gerlach left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ccordoba12 Mar 26, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ccordoba12 left a comment

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

hofingermarkus commented Mar 27, 2018

ccordoba12 left a comment

Choose a reason for hiding this comment

hofingermarkus commented Mar 24, 2018 •

edited

CAM-Gerlach Mar 24, 2018 •

edited

pep8speaks commented Mar 24, 2018 •

edited

ccordoba12 Mar 26, 2018 •

edited