" PEP8 compatible Python indent file
" Language: Python
-" Maintainer: Hynek Schlawack <hs@ox.cx>
+" Maintainer: Daniel Hahler <https://daniel.hahler.de/>
+" Prev Maintainer: Hynek Schlawack <hs@ox.cx>
" Prev Maintainer: Eric Mc Sween <em@tomcom.de> (address invalid)
" Original Author: David Bustos <bustos@caltech.edu> (address invalid)
" License: CC0
" Written in 2004 by David Bustos <bustos@caltech.edu>
" Maintained from 2004-2005 by Eric Mc Sween <em@tomcom.de>
" Maintained from 2013 by Hynek Schlawack <hs@ox.cx>
+" Maintained from 2017 by Daniel Hahler <https://daniel.hahler.de/>
"
" To the extent possible under law, the author(s) have dedicated all copyright
" and related and neighboring rights to this software to the public domain
setlocal softtabstop=4
setlocal shiftwidth=4
+if !exists('g:python_pep8_indent_multiline_string')
+ let g:python_pep8_indent_multiline_string = 0
+endif
+
let s:maxoff = 50
let s:block_rules = {
\ '^\s*elif\>': ['if', 'elif'],
- \ '^\s*else\>': ['if', 'elif', 'for', 'try', 'except'],
\ '^\s*except\>': ['try', 'except'],
\ '^\s*finally\>': ['try', 'except', 'else']
\ }
+let s:block_rules_multiple = {
+ \ '^\s*else\>': ['if', 'elif', 'for', 'try', 'except'],
+ \ }
let s:paren_pairs = ['()', '{}', '[]']
-let s:control_statement = '^\s*\(class\|def\|if\|while\|with\|for\|except\)\>'
+if &ft == 'pyrex' || &ft == 'cython'
+ let b:control_statement = '\v^\s*(class|def|if|while|with|for|except|cdef|cpdef)>'
+else
+ let b:control_statement = '\v^\s*(class|def|if|while|with|for|except)>'
+endif
let s:stop_statement = '^\s*\(break\|continue\|raise\|return\|pass\)\>'
" Skip strings and comments. Return 1 for chars to skip.
endwhile
endfunction
-" Find the block starter that matches the current line
-function! s:find_start_of_block(lnum, types)
+" Find possible indent(s) of the block starter that matches the current line.
+function! s:find_start_of_block(lnum, types, multiple)
+ let r = []
+ let types = copy(a:types)
let re = '\V\^\s\*\('.join(a:types, '\|').'\)\>'
-
let lnum = a:lnum
let last_indent = indent(lnum) + 1
while lnum > 0 && last_indent > 0
- if indent(lnum) < last_indent
- if getline(lnum) =~# re
- return lnum
- endif
+ let indent = indent(lnum)
+ if indent < last_indent
+ for type in types
+ let re = '\v^\s*'.type.'>'
+ if getline(lnum) =~# re
+ if !a:multiple
+ return [indent]
+ endif
+ if index(r, indent) == -1
+ let r += [indent]
+ endif
+ " Remove any handled type, e.g. 'if'.
+ call remove(types, index(types, type))
+ endif
+ endfor
let last_indent = indent(lnum)
endif
let lnum = prevnonblank(lnum - 1)
endwhile
- return 0
+ return r
endfunction
" Is "expr" true for every position in "lnum", beginning at "start"?
" If this line is the continuation of a control statement
" indent further to distinguish the continuation line
" from the next logical line.
- if text =~# s:control_statement && res == base + s:sw()
+ if text =~# b:control_statement && res == base + s:sw()
return base + s:sw() * 2
else
return res
" Match indent of first block of this type.
function! s:indent_like_block(lnum)
let text = getline(a:lnum)
+ for [multiple, block_rules] in [
+ \ [0, s:block_rules],
+ \ [1, s:block_rules_multiple]]
+ for [line_re, blocks] in items(block_rules)
+ if text !~# line_re
+ continue
+ endif
- for [line_re, blocks] in items(s:block_rules)
- if text !~# line_re
- continue
- endif
+ let indents = s:find_start_of_block(a:lnum - 1, blocks, multiple)
+ if !len(indents)
+ return -1
+ endif
+ if len(indents) == 1
+ return indents[0]
+ endif
- let lnum = s:find_start_of_block(a:lnum - 1, blocks)
- if lnum > 0
- return indent(lnum)
- else
- return -1
- endif
+ " Multiple valid indents, e.g. for 'else' with both try and if.
+ let indent = indent(a:lnum)
+ if index(indents, indent) != -1
+ " The indent is valid, keep it.
+ return indent
+ endif
+ " Fallback to the first/nearest one.
+ return indents[0]
+ endfor
endfor
-
return -2
endfunction
" If this line is the continuation of a control statement
" indent further to distinguish the continuation line
" from the next logical line.
- if getline(start) =~# s:control_statement
+ if getline(start) =~# b:control_statement
return base + s:sw() * 2
endif
return -1
endif
- " If this line is dedented and the number of indent spaces is valid
- " (multiple of the indentation size), trust the user
- let dedent_size = current - base
- if dedent_size < 0 && current % s:sw() == 0
+ if s:is_dedented_already(current, base)
return -1
endif
return base
endfunction
+" If this line is dedented and the number of indent spaces is valid
+" (multiple of the indentation size), trust the user.
+function! s:is_dedented_already(current, base)
+ let dedent_size = a:current - a:base
+ return (dedent_size < 0 && a:current % s:sw() == 0) ? 1 : 0
+endfunction
+
" Is the syntax at lnum (and optionally cnum) a python string?
function! s:is_python_string(lnum, ...)
let line = getline(a:lnum)
endfunction
function! GetPythonPEPIndent(lnum)
-
" First line has indent 0
if a:lnum == 1
return 0
endif
+ let line = getline(a:lnum)
+ let prevline = getline(a:lnum-1)
+
" Multilinestrings: continous, docstring or starting.
- if s:is_python_string(a:lnum)
+ if s:is_python_string(a:lnum-1, len(prevline))
+ \ && (s:is_python_string(a:lnum, 1)
+ \ || match(line, '^\%("""\|''''''\)') != -1)
+
+ " Indent closing quotes as the line with the opening ones.
+ let match_quotes = match(line, '^\s*\zs\%("""\|''''''\)')
+ if match_quotes != -1
+ " closing multiline string
+ let quotes = line[match_quotes:match_quotes+2]
+ let pairpos = searchpairpos(quotes, '', quotes, 'b')
+ if pairpos[0] != 0
+ return indent(pairpos[0])
+ else
+ " TODO: test to cover this!
+ endif
+ endif
+
if s:is_python_string(a:lnum-1)
" Previous line is (completely) a string.
- return s:indent_like_previous_line(a:lnum)
+ return indent(a:lnum-1)
endif
- if match(getline(a:lnum-1), '^\s*\%("""\|''''''\)') != -1
+ if match(prevline, '^\s*\%("""\|''''''\)') != -1
" docstring.
- return s:indent_like_previous_line(a:lnum)
+ return indent(a:lnum-1)
endif
- if s:is_python_string(a:lnum-1, len(getline(a:lnum-1)))
- " String started in previous line.
- return 0
+ let indent_multi = get(b:, 'python_pep8_indent_multiline_string',
+ \ get(g:, 'python_pep8_indent_multiline_string', 0))
+ if match(prevline, '\v%("""|'''''')$') != -1
+ " Opening multiline string, started in previous line.
+ if (&autoindent && indent(a:lnum) == indent(a:lnum-1))
+ \ || match(line, '\v^\s+$') != -1
+ " <CR> with empty line or to split up 'foo("""bar' into
+ " 'foo("""' and 'bar'.
+ if indent_multi == -2
+ return indent(a:lnum-1) + s:sw()
+ endif
+ return indent_multi
+ endif
endif
+
+ " Keep existing indent.
+ if match(line, '\v^\s*\S') != -1
+ return -1
+ endif
+
+ if indent_multi != -2
+ return indent_multi
+ endif
+
+ return s:indent_like_opening_paren(a:lnum)
endif
" Parens: If we can find an open parenthesis/bracket/brace, line up with it.
projects / etc / vim.git / blobdiff