forked from VimPlug/jedi-vim
moved jedi.vim
This commit is contained in:
David Halter
556
plugin/jedi.vim
Normal file
556
plugin/jedi.vim
Normal file
@@ -0,0 +1,556 @@
|
||||
"py_fuzzycomplete.vim - Omni Completion for python in vim
|
||||
" Maintainer: David Halter <davidhalter88@gmail.com>
|
||||
" Version: 0.1
|
||||
"
|
||||
" This part of the software is just the vim interface. The main source code
|
||||
" lies in the python files around it.
|
||||
|
||||
if !has('python')
|
||||
echomsg "Error: Required vim compiled with +python"
|
||||
finish
|
||||
endif
|
||||
|
||||
" load plugin only once
|
||||
if exists("g:loaded_jedi") || &cp
|
||||
finish
|
||||
endif
|
||||
let g:loaded_jedi = 1
|
||||
|
||||
|
||||
" ------------------------------------------------------------------------
|
||||
" defaults for jedi-vim
|
||||
" ------------------------------------------------------------------------
|
||||
if !exists("g:jedi#use_tabs_not_buffers ")
|
||||
let g:jedi#use_tabs_not_buffers = 1
|
||||
endif
|
||||
if !exists("g:jedi#auto_initialization")
|
||||
let g:jedi#auto_initialization = 1
|
||||
endif
|
||||
if !exists("g:jedi#goto_command")
|
||||
let g:jedi#goto_command = "<leader>g"
|
||||
endif
|
||||
if !exists("g:jedi#get_definition_command")
|
||||
let g:jedi#get_definition_command = "<leader>d"
|
||||
endif
|
||||
if !exists("g:jedi#related_names_command")
|
||||
let g:jedi#related_names_command = "<leader>n"
|
||||
endif
|
||||
if !exists("g:jedi#rename_command")
|
||||
let g:jedi#rename_command = "<leader>r"
|
||||
endif
|
||||
if !exists("g:jedi#popup_on_dot")
|
||||
let g:jedi#popup_on_dot = 1
|
||||
endif
|
||||
if !exists("g:jedi#pydoc")
|
||||
let g:jedi#pydoc = "K"
|
||||
endif
|
||||
if !exists("g:jedi#show_function_definition")
|
||||
let g:jedi#show_function_definition = 1
|
||||
endif
|
||||
if !exists("g:jedi#function_definition_escape")
|
||||
let g:jedi#function_definition_escape = '≡'
|
||||
endif
|
||||
if !exists("g:jedi#auto_close_doc")
|
||||
let g:jedi#auto_close_doc = 1
|
||||
endif
|
||||
|
||||
" ------------------------------------------------------------------------
|
||||
" completion
|
||||
" ------------------------------------------------------------------------
|
||||
function! jedi#complete(findstart, base)
|
||||
python << PYTHONEOF
|
||||
if 1:
|
||||
vim.eval('jedi#clear_func_def()')
|
||||
row, column = vim.current.window.cursor
|
||||
if vim.eval('a:findstart') == '1':
|
||||
count = 0
|
||||
for char in reversed(vim.current.line[:column]):
|
||||
if not re.match('[\w\d]', char):
|
||||
break
|
||||
count += 1
|
||||
vim.command('return %i' % (column - count))
|
||||
else:
|
||||
base = vim.eval('a:base')
|
||||
source = ''
|
||||
for i, line in enumerate(vim.current.buffer):
|
||||
# enter this path again, otherwise source would be incomplete
|
||||
if i == row - 1:
|
||||
source += line[:column] + base + line[column:]
|
||||
else:
|
||||
source += line
|
||||
source += '\n'
|
||||
# here again, the hacks, because jedi has a different interface than vim
|
||||
column += len(base)
|
||||
try:
|
||||
script = get_script(source=source, column=column)
|
||||
completions = script.complete()
|
||||
call_def = script.get_in_function_call()
|
||||
|
||||
out = []
|
||||
for c in completions:
|
||||
d = dict(word=c.word[:len(base)] + c.complete,
|
||||
abbr=c.word,
|
||||
# stuff directly behind the completion
|
||||
menu=PythonToVimStr(c.description),
|
||||
info=PythonToVimStr(c.doc), # docstr
|
||||
icase=1, # case insensitive
|
||||
dup=1 # allow duplicates (maybe later remove this)
|
||||
)
|
||||
out.append(d)
|
||||
|
||||
strout = str(out)
|
||||
except Exception:
|
||||
# print to stdout, will be in :messages
|
||||
print(traceback.format_exc())
|
||||
strout = ''
|
||||
completions = []
|
||||
call_def = None
|
||||
|
||||
#print 'end', strout
|
||||
show_func_def(call_def, len(completions))
|
||||
vim.command('return ' + strout)
|
||||
PYTHONEOF
|
||||
endfunction
|
||||
|
||||
|
||||
" ------------------------------------------------------------------------
|
||||
" func_def
|
||||
" ------------------------------------------------------------------------
|
||||
function jedi#show_func_def()
|
||||
python show_func_def(get_script().get_in_function_call())
|
||||
return ''
|
||||
endfunction
|
||||
|
||||
|
||||
function jedi#clear_func_def()
|
||||
python << PYTHONEOF
|
||||
if 1:
|
||||
cursor = vim.current.window.cursor
|
||||
e = vim.eval('g:jedi#function_definition_escape')
|
||||
regex = r'%sjedi=\([^%s]*\)%s.*%sjedi%s'.replace('%s', e)
|
||||
vim.command(r'try | %%s/%s/\1/g | catch | endtry' % regex)
|
||||
vim.current.window.cursor = cursor
|
||||
PYTHONEOF
|
||||
endfunction
|
||||
|
||||
|
||||
" ------------------------------------------------------------------------
|
||||
" goto
|
||||
" ------------------------------------------------------------------------
|
||||
function! jedi#goto()
|
||||
python _goto()
|
||||
endfunction
|
||||
|
||||
|
||||
" ------------------------------------------------------------------------
|
||||
" get_definition
|
||||
" ------------------------------------------------------------------------
|
||||
function! jedi#get_definition()
|
||||
python _goto(is_definition=True)
|
||||
endfunction
|
||||
|
||||
|
||||
" ------------------------------------------------------------------------
|
||||
" related_names
|
||||
" ------------------------------------------------------------------------
|
||||
function! jedi#related_names()
|
||||
python _goto(is_related_name=True)
|
||||
endfunction
|
||||
|
||||
|
||||
" ------------------------------------------------------------------------
|
||||
" rename
|
||||
" ------------------------------------------------------------------------
|
||||
function! jedi#rename(...)
|
||||
python << PYTHONEOF
|
||||
if 1:
|
||||
if not int(vim.eval('a:0')):
|
||||
temp_rename = _goto(is_related_name=True, no_output=True)
|
||||
_rename_cursor = vim.current.window.cursor
|
||||
|
||||
vim.command('normal A ') # otherwise startinsert doesn't work well
|
||||
vim.current.window.cursor = _rename_cursor
|
||||
|
||||
vim.command('augroup jedi_rename')
|
||||
vim.command('autocmd InsertLeave * call jedi#rename(1)')
|
||||
vim.command('augroup END')
|
||||
|
||||
vim.command('normal! diw')
|
||||
vim.command(':startinsert')
|
||||
else:
|
||||
# reset autocommand
|
||||
vim.command('autocmd! jedi_rename InsertLeave')
|
||||
|
||||
replace = vim.eval("expand('<cword>')")
|
||||
vim.command('normal! u') # undo new word
|
||||
vim.command('normal! u') # 2u didn't work...
|
||||
|
||||
if replace is None:
|
||||
echo_highlight('No rename possible, if no name is given.')
|
||||
else:
|
||||
for r in temp_rename:
|
||||
if r.in_builtin_module():
|
||||
continue
|
||||
start_pos = r.start_pos + (0, 1) # vim cursor starts with 1 indent
|
||||
if vim.current.buffer.name != r.module_path:
|
||||
vim.eval("jedi#new_buffer('%s')" % r.module_path)
|
||||
|
||||
vim.current.window.cursor = r.start_pos
|
||||
vim.command('normal! cw%s' % replace)
|
||||
|
||||
echo_highlight('Jedi did %s renames!' % len(temp_rename))
|
||||
# reset rename variables
|
||||
temp_rename = None
|
||||
PYTHONEOF
|
||||
endfunction
|
||||
|
||||
|
||||
" ------------------------------------------------------------------------
|
||||
" show_pydoc
|
||||
" ------------------------------------------------------------------------
|
||||
function! jedi#show_pydoc()
|
||||
python << PYTHONEOF
|
||||
if 1:
|
||||
script = get_script()
|
||||
try:
|
||||
definitions = script.get_definition()
|
||||
except jedi.NotFoundError:
|
||||
definitions = []
|
||||
except Exception:
|
||||
# print to stdout, will be in :messages
|
||||
definitions = []
|
||||
print("Exception, this shouldn't happen.")
|
||||
print(traceback.format_exc())
|
||||
|
||||
if not definitions:
|
||||
vim.command('return')
|
||||
else:
|
||||
docs = ['Docstring for %s\n%s\n%s' % (d.desc_with_module, '='*40, d.doc) if d.doc
|
||||
else '|No Docstring for %s|' % d for d in definitions]
|
||||
text = ('\n' + '-' * 79 + '\n').join(docs)
|
||||
vim.command('let l:doc = %s' % repr(PythonToVimStr(text)))
|
||||
vim.command('let l:doc_lines = %s' % len(text.split('\n')))
|
||||
PYTHONEOF
|
||||
if bufnr("__doc__") > 0
|
||||
" If the __doc__ buffer is open in the current window, jump to it
|
||||
silent execute "sbuffer ".bufnr("__doc__")
|
||||
else
|
||||
split '__doc__'
|
||||
endif
|
||||
|
||||
setlocal modifiable
|
||||
setlocal noswapfile
|
||||
setlocal buftype=nofile
|
||||
silent normal! ggdG
|
||||
silent $put=l:doc
|
||||
silent normal! 1Gdd
|
||||
setlocal nomodifiable
|
||||
setlocal nomodified
|
||||
setlocal filetype=rst
|
||||
|
||||
if l:doc_lines > 30 " max lines for plugin
|
||||
let l:doc_lines = 30
|
||||
endif
|
||||
execute "resize ".l:doc_lines
|
||||
|
||||
" quit comands
|
||||
nnoremap <buffer> q ZQ
|
||||
nnoremap <buffer> K ZQ
|
||||
|
||||
" highlight python code within rst
|
||||
unlet! b:current_syntax
|
||||
syn include @rstPythonScript syntax/python.vim
|
||||
" 4 spaces
|
||||
syn region rstPythonRegion start=/^\v {4}/ end=/\v^( {4}|\n)@!/ contains=@rstPythonScript
|
||||
" >>> python code -> (doctests)
|
||||
syn region rstPythonRegion matchgroup=pythonDoctest start=/^>>>\s*/ end=/\n/ contains=@rstPythonScript
|
||||
let b:current_syntax = "rst"
|
||||
endfunction
|
||||
|
||||
|
||||
" ------------------------------------------------------------------------
|
||||
" helper functions
|
||||
" ------------------------------------------------------------------------
|
||||
function! jedi#new_buffer(path)
|
||||
if g:jedi#use_tabs_not_buffers
|
||||
return jedi#tabnew(a:path)
|
||||
else
|
||||
if !&hidden && &modified
|
||||
w
|
||||
endif
|
||||
execute 'edit '.a:path
|
||||
endif
|
||||
endfunction
|
||||
|
||||
|
||||
function! jedi#tabnew(path)
|
||||
python << PYTHONEOF
|
||||
if 1:
|
||||
path = os.path.abspath(vim.eval('a:path'))
|
||||
for tab_nr in range(int(vim.eval("tabpagenr('$')"))):
|
||||
for buf_nr in vim.eval("tabpagebuflist(%i + 1)" % tab_nr):
|
||||
buf_nr = int(buf_nr) - 1
|
||||
try:
|
||||
buf_path = vim.buffers[buf_nr].name
|
||||
except IndexError:
|
||||
# just do good old asking for forgiveness. don't know why this happens :-)
|
||||
pass
|
||||
else:
|
||||
if buf_path == path:
|
||||
# tab exists, just switch to that tab
|
||||
vim.command('tabfirst | tabnext %i' % (tab_nr + 1))
|
||||
break
|
||||
else:
|
||||
continue
|
||||
break
|
||||
else:
|
||||
# tab doesn't exist, add a new one.
|
||||
vim.command('tabnew %s' % path)
|
||||
PYTHONEOF
|
||||
endfunction
|
||||
|
||||
|
||||
function! s:add_goto_window()
|
||||
set lazyredraw
|
||||
cclose
|
||||
execute 'belowright copen 3'
|
||||
set nolazyredraw
|
||||
if g:jedi#use_tabs_not_buffers == 1
|
||||
map <buffer> <CR> :call jedi#goto_window_on_enter()<CR>
|
||||
endif
|
||||
au WinLeave <buffer> q " automatically leave, if an option is chosen
|
||||
redraw!
|
||||
endfunction
|
||||
|
||||
|
||||
function! jedi#goto_window_on_enter()
|
||||
let l:list = getqflist()
|
||||
let l:data = l:list[line('.') - 1]
|
||||
if l:data.bufnr
|
||||
" close goto_window buffer
|
||||
normal ZQ
|
||||
call jedi#tabnew(bufname(l:data.bufnr))
|
||||
call cursor(l:data.lnum, l:data.col)
|
||||
else
|
||||
echohl WarningMsg | echo "Builtin module cannot be opened." | echohl None
|
||||
endif
|
||||
endfunction
|
||||
|
||||
|
||||
function! jedi#syn_stack()
|
||||
if !exists("*synstack")
|
||||
return []
|
||||
endif
|
||||
return map(synstack(line('.'), col('.') - 1), 'synIDattr(v:val, "name")')
|
||||
endfunc
|
||||
|
||||
|
||||
function! jedi#do_popup_on_dot()
|
||||
let highlight_groups = jedi#syn_stack()
|
||||
for a in highlight_groups
|
||||
if a == 'pythonDoctest'
|
||||
return 1
|
||||
endif
|
||||
endfor
|
||||
|
||||
for a in highlight_groups
|
||||
for b in ['pythonString', 'pythonComment']
|
||||
if a == b
|
||||
return 0
|
||||
endif
|
||||
endfor
|
||||
endfor
|
||||
return 1
|
||||
endfunc
|
||||
|
||||
" ------------------------------------------------------------------------
|
||||
" Initialization of jedi-vim
|
||||
" ------------------------------------------------------------------------
|
||||
|
||||
function! jedi#configure_function_definition()
|
||||
" conceal is normal for vim >= 7.3
|
||||
|
||||
let e = g:jedi#function_definition_escape
|
||||
let l1 = e.'jedi=[^'.e.']*'.e.'[^'.e.']*'.e.'jedi'.e
|
||||
let l2 = e.'jedi=\?[^'.e.']*'.e
|
||||
exe 'autocmd FileType python syn match jediIgnore "'.l2.'" contained conceal'
|
||||
autocmd FileType python setlocal conceallevel=2
|
||||
autocmd FileType python syn match jediFatSymbol "*" contained conceal
|
||||
autocmd FileType python syn match jediFat "\*[^*]\+\*" contained contains=jediFatSymbol
|
||||
autocmd FileType python syn match jediSpace "\v[ ]+( )@=" contained
|
||||
exe 'autocmd FileType python syn match jediFunction "'.l1.'" contains=jediIgnore,jediFat,jediSpace'
|
||||
|
||||
autocmd FileType python autocmd InsertLeave * call jedi#clear_func_def()
|
||||
|
||||
" , and () mappings
|
||||
autocmd FileType python inoremap <buffer> ( (<C-R>=jedi#show_func_def()<CR>
|
||||
autocmd FileType python inoremap <buffer> ) )<C-R>=jedi#show_func_def()<CR>
|
||||
autocmd FileType python inoremap <buffer> , ,<C-R>=jedi#show_func_def()<CR>
|
||||
autocmd FileType python inoremap <buffer> <BS> <BS><C-R>=jedi#show_func_def()<CR>
|
||||
|
||||
hi def link jediIgnore Ignore
|
||||
hi def link jediFatSymbol Ignore
|
||||
hi def link jediSpace Normal
|
||||
hi jediFat term=bold,underline cterm=bold,underline gui=bold,underline ctermbg=0 guibg=Grey
|
||||
hi jediFunction term=NONE cterm=NONE ctermfg=6 guifg=Cyan gui=NONE ctermbg=0 guibg=Grey
|
||||
endfunction
|
||||
|
||||
if g:jedi#auto_initialization
|
||||
autocmd FileType python setlocal omnifunc=jedi#complete
|
||||
" map ctrl+space for autocompletion
|
||||
autocmd FileType python inoremap <buffer> <Nul> <C-X><C-O>
|
||||
|
||||
" goto / get_definition / related_names
|
||||
autocmd FileType python execute "noremap <buffer>".g:jedi#goto_command." :call jedi#goto()<CR>"
|
||||
autocmd FileType python execute "noremap <buffer>".g:jedi#get_definition_command." :call jedi#get_definition()<CR>"
|
||||
autocmd FileType python execute "noremap <buffer>".g:jedi#related_names_command." :call jedi#related_names()<CR>"
|
||||
" rename
|
||||
autocmd FileType python execute "noremap <buffer>".g:jedi#rename_command." :call jedi#rename()<CR>"
|
||||
" pydoc
|
||||
autocmd FileType python execute "nnoremap <silent> <buffer>".g:jedi#pydoc." :call jedi#show_pydoc()<CR>"
|
||||
|
||||
if g:jedi#show_function_definition == 1 && has('conceal')
|
||||
call jedi#configure_function_definition()
|
||||
endif
|
||||
end
|
||||
|
||||
if g:jedi#popup_on_dot
|
||||
autocmd FileType python inoremap <buffer> . .<C-R>=jedi#do_popup_on_dot() ? "\<lt>C-X>\<lt>C-O>" : ""<CR>
|
||||
end
|
||||
|
||||
if g:jedi#auto_close_doc
|
||||
" close preview if its still open after insert
|
||||
autocmd InsertLeave * if pumvisible() == 0|pclose|endif
|
||||
end
|
||||
|
||||
set switchbuf=useopen " needed for pydoc
|
||||
let s:current_file=expand("<sfile>")
|
||||
|
||||
python << PYTHONEOF
|
||||
""" here we initialize the jedi stuff """
|
||||
import vim
|
||||
|
||||
# update the system path, to include the python scripts
|
||||
import sys
|
||||
import os
|
||||
from os.path import dirname, abspath
|
||||
sys.path.insert(0, dirname(dirname(abspath(vim.eval('s:current_file')))))
|
||||
|
||||
import traceback # for exception output
|
||||
import re
|
||||
|
||||
# normally you should import jedi. jedi-vim is an exception, because you can
|
||||
# copy that directly into the .vim directory.
|
||||
import jedi
|
||||
import jedi.keywords
|
||||
|
||||
temp_rename = None # used for jedi#rename
|
||||
|
||||
class PythonToVimStr(str):
|
||||
""" Vim has a different string implementation of single quotes """
|
||||
__slots__ = []
|
||||
def __repr__(self):
|
||||
return '"%s"' % self.replace('"', r'\"')
|
||||
|
||||
|
||||
def echo_highlight(msg):
|
||||
vim.command('echohl WarningMsg | echo "%s" | echohl None' % msg)
|
||||
|
||||
|
||||
def get_script(source=None, column=None):
|
||||
if source is None:
|
||||
source = '\n'.join(vim.current.buffer)
|
||||
row = vim.current.window.cursor[0]
|
||||
if column is None:
|
||||
column = vim.current.window.cursor[1]
|
||||
buf_path = vim.current.buffer.name
|
||||
return jedi.Script(source, row, column, buf_path)
|
||||
|
||||
|
||||
def _goto(is_definition=False, is_related_name=False, no_output=False):
|
||||
definitions = []
|
||||
script = get_script()
|
||||
try:
|
||||
if is_related_name:
|
||||
definitions = script.related_names()
|
||||
elif is_definition:
|
||||
definitions = script.get_definition()
|
||||
else:
|
||||
definitions = script.goto()
|
||||
except jedi.NotFoundError:
|
||||
echo_highlight("Cannot follow nothing. Put your cursor on a valid name.")
|
||||
except Exception:
|
||||
# print to stdout, will be in :messages
|
||||
echo_highlight("Some different eror, this shouldn't happen.")
|
||||
print(traceback.format_exc())
|
||||
else:
|
||||
if no_output:
|
||||
return definitions
|
||||
if not definitions:
|
||||
echo_highlight("Couldn't find any definitions for this.")
|
||||
elif len(definitions) == 1 and not is_related_name:
|
||||
# just add some mark to add the current position to the jumplist.
|
||||
# this is ugly, because it overrides the mark for '`', so if anyone
|
||||
# has a better idea, let me know.
|
||||
vim.command('normal! m`')
|
||||
|
||||
d = list(definitions)[0]
|
||||
if d.in_builtin_module():
|
||||
if isinstance(d.definition, jedi.keywords.Keyword):
|
||||
echo_highlight("Cannot get the definition of Python keywords.")
|
||||
else:
|
||||
echo_highlight("Builtin modules cannot be displayed.")
|
||||
else:
|
||||
if d.module_path != vim.current.buffer.name:
|
||||
if vim.eval('g:jedi#use_tabs_not_buffers') == '1':
|
||||
vim.command('call jedi#tabnew("%s")' % d.module_path)
|
||||
else:
|
||||
vim.command('edit ' + d.module_path)
|
||||
vim.current.window.cursor = d.line_nr, d.column
|
||||
vim.command('normal! zt') # cursor at top of screen
|
||||
else:
|
||||
# multiple solutions
|
||||
lst = []
|
||||
for d in definitions:
|
||||
if d.in_builtin_module():
|
||||
lst.append(dict(text='Builtin ' + d.description))
|
||||
else:
|
||||
lst.append(dict(filename=d.module_path, lnum=d.line_nr, col=d.column+1, text=d.description))
|
||||
vim.command('call setqflist(%s)' % str(lst))
|
||||
vim.command('call <sid>add_goto_window()')
|
||||
return definitions
|
||||
|
||||
|
||||
def show_func_def(call_def, completion_lines=0):
|
||||
vim.eval('jedi#clear_func_def()')
|
||||
|
||||
if call_def is None:
|
||||
return
|
||||
|
||||
row, column = call_def.bracket_start
|
||||
if column < 2 or row == 0:
|
||||
return # edge cases, just ignore
|
||||
|
||||
row_to_replace = row - 1 # TODO check if completion menu is above or below
|
||||
line = vim.eval("getline(%s)" % row_to_replace)
|
||||
|
||||
insert_column = column - 2 # because it has stuff at the beginning
|
||||
|
||||
params = [p.get_code().replace('\n', '') for p in call_def.params]
|
||||
try:
|
||||
params[call_def.index] = '*%s*' % params[call_def.index]
|
||||
except (IndexError, TypeError):
|
||||
pass
|
||||
|
||||
text = " (%s) " % ', '.join(params)
|
||||
text = ' ' * (insert_column - len(line)) + text
|
||||
end_column = insert_column + len(text) - 2 # -2 because of bold symbols
|
||||
# replace line before with cursor
|
||||
e = vim.eval('g:jedi#function_definition_escape')
|
||||
regex = "xjedi=%sx%sxjedix".replace('x', e)
|
||||
repl = ("%s" + regex + "%s") % (line[:insert_column],
|
||||
line[insert_column:end_column], text, line[end_column:])
|
||||
vim.eval('setline(%s, "%s")' % (row_to_replace, repl))
|
||||
PYTHONEOF
|
||||
|
||||
" vim: set et ts=4:
|
||||
Reference in New Issue
Block a user