" 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
" <http://creativecommons.org/publicdomain/zero/1.0/>.
" Only load this indent file when no other was loaded.
-if exists("b:did_indent")
+if exists('b:did_indent')
finish
endif
let b:did_indent = 1
-setlocal expandtab
setlocal nolisp
setlocal autoindent
setlocal indentexpr=GetPythonPEPIndent(v:lnum)
setlocal indentkeys=!^F,o,O,<:>,0),0],0},=elif,=except
-setlocal tabstop=4
-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
+if !exists('g:python_pep8_indent_hang_closing')
+ let g:python_pep8_indent_hang_closing = 0
+endif
+
+" TODO: check required patch for timeout argument, likely lower than 7.3.429 though.
+if !exists('g:python_pep8_indent_searchpair_timeout')
+ if has('patch-8.0.1483')
+ let g:python_pep8_indent_searchpair_timeout = 150
+ else
+ let g:python_pep8_indent_searchpair_timeout = 0
+ endif
+endif
+
let s:block_rules = {
\ '^\s*elif\>': ['if', 'elif'],
\ '^\s*except\>': ['try', 'except'],
let s:block_rules_multiple = {
\ '^\s*else\>': ['if', 'elif', 'for', 'try', 'except'],
\ }
-let s:paren_pairs = ['()', '{}', '[]']
-if &ft == 'pyrex' || &ft == 'cython'
+" Pairs to look for when searching for opening parenthesis.
+" The value is the maximum offset in lines.
+let s:paren_pairs = {'()': 50, '[]': 100, '{}': 1000}
+
+if &filetype ==# 'pyrex' || &filetype ==# '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.
-" jedi* refers to syntax definitions from jedi-vim for call signatures, which
-" are inserted temporarily into the buffer.
-let s:skip_special_chars = 'synIDattr(synID(line("."), col("."), 0), "name") ' .
- \ '=~? "\\vstring|comment|jedi\\S"'
-
let s:skip_after_opening_paren = 'synIDattr(synID(line("."), col("."), 0), "name") ' .
\ '=~? "\\vcomment|jedi\\S"'
-" Also ignore anything concealed.
-" Wrapper around synconcealed for older Vim (7.3.429, used on Travis CI).
-function! s:is_concealed(line, col)
- let concealed = synconcealed(a:line, a:col)
- return len(concealed) && concealed[0]
-endfunction
-if has('conceal')
- let s:skip_special_chars .= '|| s:is_concealed(line("."), col("."))'
-endif
-
+if !get(g:, 'python_pep8_indent_skip_concealed', 0) || !has('conceal')
+ " Skip strings and comments. Return 1 for chars to skip.
+ " jedi* refers to syntax definitions from jedi-vim for call signatures, which
+ " are inserted temporarily into the buffer.
+ function! s:_skip_special_chars(line, col)
+ return synIDattr(synID(a:line, a:col, 0), 'name')
+ \ =~? "\\vstring|comment|^pythonbytes%(contents)=$|jedi\\S"
+ endfunction
+else
+ " Also ignore anything concealed.
+ " TODO: doc; likely only necessary with jedi-vim, where a better version is
+ " planned (https://github.com/Vimjas/vim-python-pep8-indent/pull/98).
+
+ " Wrapper around synconcealed for older Vim (7.3.429, used on Travis CI).
+ function! s:is_concealed(line, col)
+ let concealed = synconcealed(a:line, a:col)
+ return len(concealed) && concealed[0]
+ endfunction
-let s:skip_search = 'synIDattr(synID(line("."), col("."), 0), "name") ' .
- \ '=~? "comment"'
+ function! s:_skip_special_chars(line, col)
+ return synIDattr(synID(a:line, a:col, 0), 'name')
+ \ =~? "\\vstring|comment|^pythonbytes%(contents)=$|jedi\\S"
+ \ || s:is_concealed(a:line, a:col)
+ endfunction
+endif
" Use 'shiftwidth()' instead of '&sw'.
" (Since Vim patch 7.3.629, 'shiftwidth' can be set to 0 to follow 'tabstop').
endfunction
else
function! s:sw()
- return &sw
+ return &shiftwidth
endfunction
endif
-function! s:pair_sort(x, y)
- if a:x[0] == a:y[0]
- return a:x[1] == a:y[1] ? 0 : a:x[1] > a:y[1] ? 1 : -1
- else
- return a:x[0] > a:y[0] ? 1 : -1
- endif
-endfunction
-
" Find backwards the closest open parenthesis/bracket/brace.
-function! s:find_opening_paren(...)
- " optional arguments: line and column (defaults to 1) to search around
- if a:0 > 0
- let view = winsaveview()
- call cursor(a:1, a:0 > 1 ? a:2 : 1)
- let ret = s:find_opening_paren()
- call winrestview(view)
- return ret
- endif
-
- let stopline = max([0, line('.') - s:maxoff])
-
+function! s:find_opening_paren(lnum, col)
" Return if cursor is in a comment.
- exe 'if' s:skip_search '| return [0, 0] | endif'
+ if synIDattr(synID(a:lnum, a:col, 0), 'name') =~? 'comment'
+ return [0, 0]
+ endif
- let positions = []
- for p in s:paren_pairs
- call add(positions, searchpairpos(
- \ '\V'.p[0], '', '\V'.p[1], 'bnW', s:skip_special_chars, stopline))
+ call cursor(a:lnum, a:col)
+
+ let nearest = [0, 0]
+ let timeout = g:python_pep8_indent_searchpair_timeout
+ let skip_special_chars = 's:_skip_special_chars(line("."), col("."))'
+ for [p, maxoff] in items(s:paren_pairs)
+ let stopline = max([0, line('.') - maxoff, nearest[0]])
+ let next = searchpairpos(
+ \ '\V'.p[0], '', '\V'.p[1], 'bnW', skip_special_chars, stopline, timeout)
+ if next[0] && (next[0] > nearest[0] || (next[0] == nearest[0] && next[1] > nearest[1]))
+ let nearest = next
+ endif
endfor
-
- " Remove empty matches and return the type with the closest match
- call filter(positions, 'v:val[0]')
- call sort(positions, 's:pair_sort')
-
- return get(positions, -1, [0, 0])
+ return nearest
endfunction
" Find the start of a multi-line statement
function! s:find_start_of_multiline_statement(lnum)
let lnum = a:lnum
while lnum > 0
- if getline(lnum - 1) =~ '\\$'
+ if getline(lnum - 1) =~# '\\$'
let lnum = prevnonblank(lnum - 1)
else
- let [paren_lnum, _] = s:find_opening_paren(lnum)
+ let [paren_lnum, _] = s:find_opening_paren(lnum, 1)
if paren_lnum < 1
return lnum
else
" 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
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))
+ if getline(lnum) =~# re
+ if !a:multiple
+ return [indent]
+ endif
+ if index(r, indent) == -1
+ let r += [indent]
endif
- endfor
- let last_indent = indent(lnum)
+ let last_indent = indent
+ endif
endif
let lnum = prevnonblank(lnum - 1)
endwhile
let r = 1
for i in range(a:start, end)
call cursor(a:lnum, i)
- if !(eval(a:expr) || text[i-1] =~ '\s')
+ if !(eval(a:expr) || text[i-1] =~# '\s')
let r = 0
break
endif
" Line up with open parenthesis/bracket/brace.
function! s:indent_like_opening_paren(lnum)
- let [paren_lnum, paren_col] = s:find_opening_paren(a:lnum)
+ let [paren_lnum, paren_col] = s:find_opening_paren(a:lnum, 1)
if paren_lnum <= 0
return -2
endif
let nothing_after_opening_paren = s:match_expr_on_line(
\ s:skip_after_opening_paren, paren_lnum, paren_col+1)
- let starts_with_closing_paren = getline(a:lnum) =~ '^\s*[])}]'
+ let starts_with_closing_paren = getline(a:lnum) =~# '^\s*[])}]'
+
+ let hang_closing = get(b:, 'python_pep8_indent_hang_closing',
+ \ get(g:, 'python_pep8_indent_hang_closing', 0))
if nothing_after_opening_paren
- if starts_with_closing_paren
+ if starts_with_closing_paren && !hang_closing
let res = base
else
let res = base + s:sw()
" indent further to distinguish the continuation line
" from the next logical line.
if text =~# b:control_statement && res == base + s:sw()
- return base + s:sw() * 2
- else
- return res
+ " But only if not inside parens itself (Flake's E127).
+ let [paren_lnum, _] = s:find_opening_paren(paren_lnum, 1)
+ if paren_lnum <= 0
+ return res + s:sw()
+ endif
endif
+ return res
endfunction
" Match indent of first block of this type.
let base = indent(start)
let current = indent(a:lnum)
- " Jump to last character in previous line.
- call cursor(lnum, len(text))
- let ignore_last_char = eval(s:skip_special_chars)
+ " Ignore last character in previous line?
+ let lastcol = len(text)
+ let col = lastcol
" Search for final colon that is not inside something to be ignored.
while 1
- let curpos = getpos(".")[2]
- if curpos == 1 | break | endif
- if eval(s:skip_special_chars) || text[curpos-1] =~ '\s'
- normal! h
+ if col == 1 | break | endif
+ if text[col-1] =~# '\s' || s:_skip_special_chars(lnum, col)
+ let col = col - 1
continue
- elseif text[curpos-1] == ':'
+ elseif text[col-1] ==# ':'
return base + s:sw()
endif
break
endwhile
- if text =~ '\\$' && !ignore_last_char
+ if text =~# '\\$' && !s:_skip_special_chars(lnum, lastcol)
" If this line is the continuation of a control statement
" indent further to distinguish the continuation line
" from the next logical line.
return base + s:sw()
endif
+ let empty = getline(a:lnum) =~# '^\s*$'
+
+ " Current and prev line are empty, next is not -> indent like next.
+ if empty && a:lnum > 1 &&
+ \ (getline(a:lnum - 1) =~# '^\s*$') &&
+ \ !(getline(a:lnum + 1) =~# '^\s*$')
+ return indent(a:lnum + 1)
+ endif
+
" If the previous statement was a stop-execution statement or a pass
if getline(start) =~# s:stop_statement
" Remove one level of indentation if the user hasn't already dedented
- if indent(a:lnum) > base - s:sw()
+ if empty || current > base - s:sw()
return base - s:sw()
endif
" Otherwise, trust the user
return -1
endif
- if s:is_dedented_already(current, base)
+ if (current || !empty) && s:is_dedented_already(current, base)
return -1
endif
" Is the syntax at lnum (and optionally cnum) a python string?
function! s:is_python_string(lnum, ...)
let line = getline(a:lnum)
- let linelen = len(line)
- if linelen < 1
- let linelen = 1
+ if a:0
+ let cols = type(a:1) != type([]) ? [a:1] : a:1
+ else
+ let cols = range(1, max([1, len(line)]))
endif
- let cols = a:0 ? type(a:1) != type([]) ? [a:1] : a:1 : range(1, linelen)
for cnum in cols
if match(map(synstack(a:lnum, cnum),
- \ 'synIDattr(v:val,"name")'), 'python\S*String') == -1
+ \ "synIDattr(v:val, 'name')"), 'python\S*String') == -1
return 0
end
endfor
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, 1)
- \ && s:is_python_string(a:lnum-1, len(getline(a:lnum-1)))
- " Keep existing indent.
- if match(getline(a:lnum), '\v^\s*\S') != -1
- return -1
+ if s:is_python_string(a:lnum-1, max([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)]
+ call cursor(a:lnum, 1)
+ let pairpos = searchpairpos(quotes, '', quotes, 'bW', '', 0, g:python_pep8_indent_searchpair_timeout)
+ if pairpos[0] != 0
+ return indent(pairpos[0])
+ else
+ return -1
+ endif
endif
if s:is_python_string(a:lnum-1)
- " Previous line is (completely) a string.
- return indent(a:lnum-1)
+ " Previous line is (completely) a string: keep current indent.
+ return -1
endif
- if match(getline(a:lnum-1), '^\s*\%("""\|''''''\)') != -1
+ if match(prevline, '^\s*\%("""\|''''''\)') != -1
" docstring.
return indent(a:lnum-1)
endif
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
- if match(getline(a:lnum-1), '\v%("""|'''''')$') != -1
- " Opening multiline string, started in previous line.
- return indent(a:lnum-1) + s:sw()
- endif
return s:indent_like_opening_paren(a:lnum)
endif
projects / etc / vim.git / blobdiff