blob: 56f19cb3238f11a60c8eb9fcf6e7d75ec4ab5811 [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001" Vim filetype plugin file
2" Language: python
Bram Moolenaar01164a62017-11-02 22:58:42 +01003" Maintainer: Tom Picton <tom@tompicton.co.uk>
4" Previous Maintainer: James Sully <sullyj3@gmail.com>
Bram Moolenaarc95a3022016-06-12 23:01:46 +02005" Previous Maintainer: Johannes Zellner <johannes@zellner.org>
Bram Moolenaar40962ec2018-01-28 22:47:25 +01006" Last Change: Wed, 20 December 2017
Bram Moolenaar01164a62017-11-02 22:58:42 +01007" https://github.com/tpict/vim-ftplugin-python
Bram Moolenaar071d4272004-06-13 20:20:40 +00008
9if exists("b:did_ftplugin") | finish | endif
10let b:did_ftplugin = 1
Bram Moolenaar9a7224b2012-04-30 15:56:52 +020011let s:keepcpo= &cpo
12set cpo&vim
Bram Moolenaar071d4272004-06-13 20:20:40 +000013
14setlocal cinkeys-=0#
15setlocal indentkeys-=0#
Bram Moolenaar92dff182014-02-11 19:15:50 +010016setlocal include=^\\s*\\(from\\\|import\\)
Bram Moolenaar071d4272004-06-13 20:20:40 +000017setlocal includeexpr=substitute(v:fname,'\\.','/','g')
18setlocal suffixesadd=.py
Bram Moolenaar36782082013-11-28 13:53:34 +010019setlocal comments=b:#,fb:-
20setlocal commentstring=#\ %s
Bram Moolenaar071d4272004-06-13 20:20:40 +000021
Bram Moolenaar18144c82006-04-12 21:52:12 +000022setlocal omnifunc=pythoncomplete#Complete
Bram Moolenaar40962ec2018-01-28 22:47:25 +010023if has('python3')
24 setlocal omnifunc=python3complete#Complete
25endif
Bram Moolenaara40ceaf2006-01-13 22:35:40 +000026
Bram Moolenaar071d4272004-06-13 20:20:40 +000027set wildignore+=*.pyc
28
Bram Moolenaardc083282016-10-11 08:57:33 +020029let b:next_toplevel='\v%$\|^(class\|def\|async def)>'
30let b:prev_toplevel='\v^(class\|def\|async def)>'
Bram Moolenaar01164a62017-11-02 22:58:42 +010031let b:next_endtoplevel='\v%$\|\S.*\n+(def\|class)'
32let b:prev_endtoplevel='\v\S.*\n+(def\|class)'
Bram Moolenaardc083282016-10-11 08:57:33 +020033let b:next='\v%$\|^\s*(class\|def\|async def)>'
34let b:prev='\v^\s*(class\|def\|async def)>'
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +010035let b:next_end='\v\S\n*(%$\|^(\s*\n*)*(class\|def\|async def)\|^\S)'
36let b:prev_end='\v\S\n*(^(\s*\n*)*(class\|def\|async def)\|^\S)'
Bram Moolenaare18dbe82016-07-02 21:42:23 +020037
Bram Moolenaarabd468e2016-09-08 22:22:43 +020038execute "nnoremap <silent> <buffer> ]] :call <SID>Python_jump('n', '". b:next_toplevel."', 'W')<cr>"
39execute "nnoremap <silent> <buffer> [[ :call <SID>Python_jump('n', '". b:prev_toplevel."', 'Wb')<cr>"
Bram Moolenaar01164a62017-11-02 22:58:42 +010040execute "nnoremap <silent> <buffer> ][ :call <SID>Python_jump('n', '". b:next_endtoplevel."', 'W', 0)<cr>"
41execute "nnoremap <silent> <buffer> [] :call <SID>Python_jump('n', '". b:prev_endtoplevel."', 'Wb', 0)<cr>"
Bram Moolenaarabd468e2016-09-08 22:22:43 +020042execute "nnoremap <silent> <buffer> ]m :call <SID>Python_jump('n', '". b:next."', 'W')<cr>"
43execute "nnoremap <silent> <buffer> [m :call <SID>Python_jump('n', '". b:prev."', 'Wb')<cr>"
Bram Moolenaar01164a62017-11-02 22:58:42 +010044execute "nnoremap <silent> <buffer> ]M :call <SID>Python_jump('n', '". b:next_end."', 'W', 0)<cr>"
45execute "nnoremap <silent> <buffer> [M :call <SID>Python_jump('n', '". b:prev_end."', 'Wb', 0)<cr>"
Bram Moolenaarabd468e2016-09-08 22:22:43 +020046
47execute "onoremap <silent> <buffer> ]] :call <SID>Python_jump('o', '". b:next_toplevel."', 'W')<cr>"
48execute "onoremap <silent> <buffer> [[ :call <SID>Python_jump('o', '". b:prev_toplevel."', 'Wb')<cr>"
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +010049execute "onoremap <silent> <buffer> ][ :call <SID>Python_jump('o', '". b:next_endtoplevel."', 'W', 0)<cr>"
50execute "onoremap <silent> <buffer> [] :call <SID>Python_jump('o', '". b:prev_endtoplevel."', 'Wb', 0)<cr>"
Bram Moolenaarabd468e2016-09-08 22:22:43 +020051execute "onoremap <silent> <buffer> ]m :call <SID>Python_jump('o', '". b:next."', 'W')<cr>"
52execute "onoremap <silent> <buffer> [m :call <SID>Python_jump('o', '". b:prev."', 'Wb')<cr>"
Bram Moolenaar01164a62017-11-02 22:58:42 +010053execute "onoremap <silent> <buffer> ]M :call <SID>Python_jump('o', '". b:next_end."', 'W', 0)<cr>"
54execute "onoremap <silent> <buffer> [M :call <SID>Python_jump('o', '". b:prev_end."', 'Wb', 0)<cr>"
Bram Moolenaarabd468e2016-09-08 22:22:43 +020055
56execute "xnoremap <silent> <buffer> ]] :call <SID>Python_jump('x', '". b:next_toplevel."', 'W')<cr>"
57execute "xnoremap <silent> <buffer> [[ :call <SID>Python_jump('x', '". b:prev_toplevel."', 'Wb')<cr>"
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +010058execute "xnoremap <silent> <buffer> ][ :call <SID>Python_jump('x', '". b:next_endtoplevel."', 'W', 0)<cr>"
59execute "xnoremap <silent> <buffer> [] :call <SID>Python_jump('x', '". b:prev_endtoplevel."', 'Wb', 0)<cr>"
Bram Moolenaarabd468e2016-09-08 22:22:43 +020060execute "xnoremap <silent> <buffer> ]m :call <SID>Python_jump('x', '". b:next."', 'W')<cr>"
61execute "xnoremap <silent> <buffer> [m :call <SID>Python_jump('x', '". b:prev."', 'Wb')<cr>"
Bram Moolenaar01164a62017-11-02 22:58:42 +010062execute "xnoremap <silent> <buffer> ]M :call <SID>Python_jump('x', '". b:next_end."', 'W', 0)<cr>"
63execute "xnoremap <silent> <buffer> [M :call <SID>Python_jump('x', '". b:prev_end."', 'Wb', 0)<cr>"
Bram Moolenaar071d4272004-06-13 20:20:40 +000064
Bram Moolenaar36782082013-11-28 13:53:34 +010065if !exists('*<SID>Python_jump')
Bram Moolenaar01164a62017-11-02 22:58:42 +010066 fun! <SID>Python_jump(mode, motion, flags, ...) range
67 let l:startofline = (a:0 >= 1) ? a:1 : 1
68
Bram Moolenaare18dbe82016-07-02 21:42:23 +020069 if a:mode == 'x'
70 normal! gv
71 endif
72
Bram Moolenaar01164a62017-11-02 22:58:42 +010073 if l:startofline == 1
74 normal! 0
75 endif
Bram Moolenaare18dbe82016-07-02 21:42:23 +020076
Bram Moolenaar36782082013-11-28 13:53:34 +010077 let cnt = v:count1
Bram Moolenaar36782082013-11-28 13:53:34 +010078 mark '
79 while cnt > 0
Bram Moolenaare18dbe82016-07-02 21:42:23 +020080 call search(a:motion, a:flags)
81 let cnt = cnt - 1
Bram Moolenaar36782082013-11-28 13:53:34 +010082 endwhile
Bram Moolenaare18dbe82016-07-02 21:42:23 +020083
Bram Moolenaar01164a62017-11-02 22:58:42 +010084 if l:startofline == 1
85 normal! ^
86 endif
Bram Moolenaar36782082013-11-28 13:53:34 +010087 endfun
88endif
Bram Moolenaar071d4272004-06-13 20:20:40 +000089
Bram Moolenaar36782082013-11-28 13:53:34 +010090if has("browsefilter") && !exists("b:browsefilter")
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 let b:browsefilter = "Python Files (*.py)\t*.py\n" .
Bram Moolenaare18dbe82016-07-02 21:42:23 +020092 \ "All Files (*.*)\t*.*\n"
Bram Moolenaar071d4272004-06-13 20:20:40 +000093endif
Bram Moolenaar9a7224b2012-04-30 15:56:52 +020094
Bram Moolenaarabd468e2016-09-08 22:22:43 +020095if !exists("g:python_recommended_style") || g:python_recommended_style != 0
96 " As suggested by PEP8.
97 setlocal expandtab shiftwidth=4 softtabstop=4 tabstop=8
98endif
Bram Moolenaarb1332082013-10-06 14:22:40 +020099
100" First time: try finding "pydoc".
101if !exists('g:pydoc_executable')
102 if executable('pydoc')
103 let g:pydoc_executable = 1
104 else
105 let g:pydoc_executable = 0
106 endif
107endif
108" If "pydoc" was found use it for keywordprg.
109if g:pydoc_executable
110 setlocal keywordprg=pydoc
111endif
112
Bram Moolenaar9a7224b2012-04-30 15:56:52 +0200113let &cpo = s:keepcpo
114unlet s:keepcpo