Suggestion for a better python support #274

incoggnito · 2020-04-12T20:05:07Z

I've tried to optimize the python support depending on this issues:
#273
#270
Related:
#74, #89, #114, #233, #234

Branch demo:

I've added:

python virtual environment
clear the screen after REPL init --> TODO: hide till cleared
interpreter run script (without pasting) --> TODO: add to other languages
cell-mode behavior --> TODO: not tested except python
paste magic for ipython

My settings:

let g:neoterm_default_mod = 'vertical'

# start python within a virtual environment like conda
let g:neoterm_repl_python_venv = 'conda activate py3conda'

# set the repl
let g:neoterm_repl_python = 'ipython'

# clear any startup screen like neofetch
let g:neoterm_clean_startup = 1

# use paste magic instead of the exec command
let g:neoterm_repl_ipython_magic = 1

# define a cell marker
let g:neoterm_repl_cellmarker = '^# %%'

README.md

CHANGELOG.md

README.md

autoload/neoterm/repl.vim

kassio

Thanks for the proposal.
I would like to avoid creating more ways to send text to REPL instances, also, the goal o the PR is to fix the python REPL integration, so new ways of sending text to the REPL should be in another proposal. I would also rather to have as little options as possible, so let's try to fix that without adding more options to the code.

I did a few suggestions there, let me know what you think.

incoggnito · 2020-04-13T10:26:33Z

Thanks for the proposal.
I would like to avoid creating more ways to send text to REPL instances, also, the goal o the PR is to fix the python REPL integration, so new ways of sending text to the REPL should be in another proposal. I would also rather to have as little options as possible, so let's try to fix that without adding more options to the code.

I did a few suggestions there, let me know what you think.

Thank's for your explanation. I already suspected that it was a bit too much for a single pull request. Can absolutely understand your point of view regarding maintainability. In some places it may make more sense to simply expand the documentation instead of new functions. I like the idea with filetype specific script. I could also imagine to write and maintain a python-plugin based on neoterm myself. Would have some more ideas such as interactive debugging.

kassio · 2020-04-13T16:00:01Z

I could also imagine to write and maintain a python-plugin based on neoterm myself.

That's an option, but I think with the filetype-specific REPL code most of the default behavior could be easily done. I'm looking forward to see this PR updated. 😄

incoggnito · 2020-04-15T10:50:10Z

Everything works for python and ipython like in my first screen video. In addition, I have embedded the function of jkroes @ d6c5098. A python specific file was added.
That's my current settings:

let g:neoterm_default_mod = 'vertical'
let g:neoterm_repl_python = 'conda activate py3conda, clear, ipython'
let g:neoterm_repl_ipy_magic = 0
let g:neoterm_repl_python_cellmarker = '# %%'

I will continue to test this on occasion, but so far it seems to be working quite well.

autoload/neoterm/repl.vim

kassio · 2020-04-16T17:52:48Z

autoload/neoterm/repl/python.vim

@@ -0,0 +1,57 @@
+"init python specific settings
+if !exists('g:neoterm_repl_ipy_magic')


is it magic a term used in the python community? Is the name of this variable is meaningful to someone starting in the python community?

Yes it is. Read here. The currently used command use is the ipython-paste-magic. I should probably insert the full name.

Great! That's good to know, thanks for sharing the reference.
So, I think we should the full qualified name here, just to be more clear:

if !exists('g:neoterm_repl_enable_ipython_paste_magic')

It's better to be a long name that it's more clear than a short one.

ftdetect/set_repl_cmd.vim

incoggnito · 2020-04-17T06:32:46Z

I've been thinking for a while how to cover cell mode with the existing commands such as the g-x movement. Generally it's possible to search for the marker /# %% and use wyn to select the area and then send it. But for that you would have to put a marker at the beginning and end of the file. This is not a nice solution. What do you think?

I have already considered using the sign column to set graphical markers instead of the text markers. I*ve currently read the docs to understand how sign_define () and sign_jump () works.
That's would be a nicer and more intuitive neovim solution.

kassio · 2020-04-17T10:13:45Z

autoload/neoterm/repl.vim

@@ -24,12 +24,11 @@ function! neoterm#repl#term(id)
  if has_key(g:neoterm.instances, a:id)
    let g:neoterm.repl.instance_id = a:id
    let g:neoterm.repl.loaded = 1
-


let's keep the diff with the minimum. Avoid unnecessary changes.

ftdetect/set_repl_cmd.vim

autoload/neoterm/repl/python.vim

incoggnito · 2020-04-17T13:24:18Z

autoload/neoterm/repl/python.vim

+      if a:value[i] =~ 'python'
+        let l:pyCmd = 1
+        if a:value[i] == 'ipython'
+          let g:neoterm_repl_python[i] = 'ipython --no-autoindent'
+        endif
+      endif
+      if executable(split(a:value[i])[0]) == 0
+        let l:invalid = 1
+      endif


In python i would create a function to handle the list item and the string. Do you know if it is possible here?

Sorry, I don't understand your intention. What do you mean?

Has already cleared up.

autoload/neoterm/repl/python.vim

kassio · 2020-04-17T15:14:01Z

autoload/neoterm/repl/python.vim

+  endif
+endfunction
+
+function! neoterm#repl#python#exec(command)


What do you think to make things a bit more explicit in here, as well, like:

function! neoterm#repl#python#exec(command) if g:neoterm_repl_ipy_magic == 1 && join(g:neoterm_repl_command) =~ "ipython" let l:cmd = s:ipython_magic_command_for(a:command) elseif join(g:neoterm_repl_command) !~ 'ipython' let l:cmd = s:ipython_command_for(a:command) else let l:cmd = s:python_command_for(a:command) end call g:neoterm.repl.instance().exec(add(l:cmd, g:neoterm_eof)) endfunction

This way we'd have one private function for each way neoterm can send python commands to the REPL, it'd be easier to debug and easier to maintain. 😄

Yeah, of course.
How do you debug vim scripts?

When needed, yes, but usually only with echo 🙈

kassio · 2020-04-18T21:33:22Z

doc/neoterm.txt

+Both a string and a list can be passed to. Defaults to an empty string,
+in which case NeoTerm will fall back to IPython followed by Python.


Suggested change

Both a string and a list can be passed to. Defaults to an empty string,

in which case NeoTerm will fall back to IPython followed by Python.

This option accepts either a String or a list of commands. Its default

value is an empty string, which will try to use `ipython` or `python`,

in this order, to execute the REPL.

kassio · 2020-04-18T21:35:08Z

doc/neoterm.txt

 Default value: (empty)

+Example for a valid command list:
+|g:neoterm_repl_python| = `['conda activate venv', 'clear', 'ipython']``


Let's write the example in a way that users can copy'n'paste:

Suggested change

|g:neoterm_repl_python| = `['conda activate venv', 'clear', 'ipython']``

`let g:neoterm_repl = ['conda activate venv', 'clear', 'ipython']`

kassio · 2020-04-18T21:35:36Z

autoload/neoterm/repl/python.vim

+  return get(l:, 'ipycommand', pycommand)
+


Suggested change

return get(l:, 'ipycommand', pycommand)

return get(l:, 'ipycommand', pycommand)

kassio · 2020-04-18T21:36:27Z

autoload/neoterm/repl/python.vim

+  end
+endfunction
+
+function! s:ipython_magic_command_for(command)


can you put the private functions after the public function that call them? In this case, after the neoterm#repl#python#exec

kassio

Can you add a changelog as well, please?

kassio · 2020-04-18T21:37:59Z

can you also remove that sample.gif file, please?

kassio

Thank you for the great contribution! ❤️💛💚💜💙🖤🧡

incoggnito · 2020-04-19T12:05:56Z

Thank you for your support.
A great way to find out more about vim and open source.

one-shot-monkey added 4 commits April 12, 2020 21:16

Added some new pythonic features

fc1dff6

Changed description

1635f7c

bugfix

736207c

bugfix

caaf9bf

kassio reviewed Apr 12, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

kassio reviewed Apr 12, 2020

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

kassio reviewed Apr 12, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

one-shot-monkey added 6 commits April 12, 2020 22:35

copy error

df95658

Merged changelog

a6a95d7

further merging

69c89c5

further merging

b49d3d2

further merging

e425b64

added gif again

6a848c3

incoggnito mentioned this pull request Apr 13, 2020

Python support #273

Closed

kassio reviewed Apr 13, 2020

View reviewed changes

kassio requested changes Apr 13, 2020

View reviewed changes

file-type-specific REPL code

180d19e

kassio reviewed Apr 16, 2020

View reviewed changes

autoload/neoterm/repl.vim Outdated Show resolved Hide resolved

kassio reviewed Apr 16, 2020

View reviewed changes

autoload/neoterm/repl.vim Outdated Show resolved Hide resolved

kassio reviewed Apr 16, 2020

View reviewed changes

autoload/neoterm/repl.vim Outdated Show resolved Hide resolved

kassio reviewed Apr 16, 2020

View reviewed changes

ftdetect/set_repl_cmd.vim Outdated Show resolved Hide resolved

remove some redundant code

690c74f

kassio reviewed Apr 17, 2020

View reviewed changes

ftdetect/set_repl_cmd.vim Outdated Show resolved Hide resolved

kassio reviewed Apr 17, 2020

View reviewed changes

autoload/neoterm/repl/python.vim Outdated Show resolved Hide resolved

Removed new featuers, added python command validation

12ddcd6

incoggnito commented Apr 17, 2020

View reviewed changes

kassio reviewed Apr 17, 2020

View reviewed changes

autoload/neoterm/repl/python.vim Show resolved Hide resolved

kassio reviewed Apr 17, 2020

View reviewed changes

maintaince improvements and documentation

f6c6ce0

kassio reviewed Apr 18, 2020

View reviewed changes

kassio requested changes Apr 18, 2020

View reviewed changes

one-shot-monkey and others added 2 commits April 19, 2020 10:34

improved docs and added changelog, some minor changes to python.vim

ef77bbe

Merge branch 'master' into master

d17b6a6

incoggnito requested a review from kassio April 19, 2020 08:41

kassio reviewed Apr 19, 2020

View reviewed changes

kassio merged commit 8a3a0fb into kassio:master Apr 19, 2020

This was referenced Apr 19, 2020

[help needed] send code block that contains blank lines to python/ipython. #270

Closed

Feature Request: Add haskell REPL support for GHCI #73

Closed

echasnovski mentioned this pull request Jul 26, 2020

Enable bracketed paste #295

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Suggestion for a better python support #274

Suggestion for a better python support #274

incoggnito commented Apr 12, 2020 •

edited

Loading

kassio left a comment

incoggnito commented Apr 13, 2020 •

edited

Loading

kassio commented Apr 13, 2020

incoggnito commented Apr 15, 2020

kassio Apr 16, 2020

incoggnito Apr 17, 2020 •

edited

Loading

kassio Apr 17, 2020

incoggnito commented Apr 17, 2020 •

edited

Loading

kassio Apr 17, 2020

incoggnito Apr 17, 2020

incoggnito Apr 17, 2020

kassio Apr 17, 2020

incoggnito Apr 18, 2020

kassio Apr 17, 2020

incoggnito Apr 17, 2020

kassio Apr 17, 2020

kassio Apr 18, 2020

kassio Apr 18, 2020

kassio Apr 18, 2020

kassio Apr 18, 2020

kassio left a comment

kassio commented Apr 18, 2020

kassio left a comment

incoggnito commented Apr 19, 2020 •

edited

Loading

		@@ -0,0 +1,57 @@
		"init python specific settings
		if !exists('g:neoterm_repl_ipy_magic')

		Both a string and a list can be passed to. Defaults to an empty string,
		in which case NeoTerm will fall back to IPython followed by Python.

-Both a string and a list can be passed to. Defaults to an empty string,
-in which case NeoTerm will fall back to IPython followed by Python.
+This option accepts either a String or a list of commands. Its default
+value is an empty string, which will try to use `ipython` or `python`,
+in this order, to execute the REPL.

	\|g:neoterm_repl_python\| = `['conda activate venv', 'clear', 'ipython']``
	`let g:neoterm_repl = ['conda activate venv', 'clear', 'ipython']`

	return get(l:, 'ipycommand', pycommand)

	return get(l:, 'ipycommand', pycommand)

Suggestion for a better python support #274

Suggestion for a better python support #274

Conversation

incoggnito commented Apr 12, 2020 • edited Loading

kassio left a comment

Choose a reason for hiding this comment

incoggnito commented Apr 13, 2020 • edited Loading

kassio commented Apr 13, 2020

incoggnito commented Apr 15, 2020

Choose a reason for hiding this comment

incoggnito Apr 17, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

incoggnito commented Apr 17, 2020 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kassio left a comment

Choose a reason for hiding this comment

kassio commented Apr 18, 2020

kassio left a comment

Choose a reason for hiding this comment

incoggnito commented Apr 19, 2020 • edited Loading

incoggnito commented Apr 12, 2020 •

edited

Loading

incoggnito commented Apr 13, 2020 •

edited

Loading

incoggnito Apr 17, 2020 •

edited

Loading

incoggnito commented Apr 17, 2020 •

edited

Loading

incoggnito commented Apr 19, 2020 •

edited

Loading