X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/e66de53b9e4c58e6d950b8dce8a0c32703bedb81..60ba5e11a61618c0344e2db190210145083c91f8:/indent/python.vim diff --git a/indent/python.vim b/indent/python.vim index 4dd4c67..047ae3d 100644 --- a/indent/python.vim +++ b/indent/python.vim @@ -1,6 +1,7 @@ " PEP8 compatible Python indent file " Language: Python -" Maintainer: Hynek Schlawack +" Maintainer: Daniel Hahler +" Prev Maintainer: Hynek Schlawack " Prev Maintainer: Eric Mc Sween (address invalid) " Original Author: David Bustos (address invalid) " License: CC0 @@ -9,6 +10,7 @@ " Written in 2004 by David Bustos " Maintained from 2004-2005 by Eric Mc Sween " Maintained from 2013 by Hynek Schlawack +" Maintained from 2017 by Daniel Hahler " " 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 @@ -18,37 +20,82 @@ " . " 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 -let s:maxoff = 50 +if !exists('g:python_pep8_indent_multiline_string') + let g:python_pep8_indent_multiline_string = 0 +endif + +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*else\>': ['if', 'elif', 'for', 'try', 'except'], - \ '^\s*except\>': ['try', 'except'], - \ '^\s*finally\>': ['try', 'except', 'else'] - \ } -let s:paren_pairs = ['()', '{}', '[]'] -let s:control_statement = '^\s*\(if\|while\|with\|for\|except\)\>' + \ '^\s*elif\>': [['if', 'elif'], ['else']], + \ '^\s*except\>': [['try', 'except'], []], + \ '^\s*finally\>': [['try', 'except', 'else'], []] + \ } +let s:block_rules_multiple = { + \ '^\s*else\>': [['if', 'elif', 'for', 'try', 'except'], []] + \ } +" 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 -let s:skip_special_chars = 'synIDattr(synID(line("."), col("."), 0), "name") ' . - \ '=~? "string\\|comment"' +let s:skip_after_opening_paren = 'synIDattr(synID(line("."), col("."), 0), "name") ' . + \ '=~? "\\vcomment|jedi\\S"' + +let s:special_chars_syn_pattern = "\\vstring|comment|^pythonbytes%(contents)=$|pythonTodo|jedi\\S" -let s:skip_search = 'synIDattr(synID(line("."), col("."), 0), "name") ' . - \ '=~? "comment"' +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') + \ =~? s:special_chars_syn_pattern + 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 + + function! s:_skip_special_chars(line, col) + return synIDattr(synID(a:line, a:col, 0), 'name') + \ =~? s:special_chars_syn_pattern + \ || 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'). @@ -58,55 +105,41 @@ if exists('*shiftwidth') 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 +function! s:find_opening_paren(lnum, col) + " Return if cursor is in a comment. + if synIDattr(synID(a:lnum, a:col, 0), 'name') =~? 'comment' + return [0, 0] endif - let stopline = max([0, line('.') - s:maxoff]) - - " Return if cursor is in a comment or string - exe 'if' s:skip_search '| 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 @@ -116,41 +149,85 @@ function! s:find_start_of_multiline_statement(lnum) 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, skip, multiple) abort + let r = [] let re = '\V\^\s\*\('.join(a:types, '\|').'\)\>' - - let lnum = a:lnum - let last_indent = indent(lnum) + 1 + if !empty(a:skip) + let re_skip = '\V\^\s\*\('.join(a:skip, '\|').'\)\>' + else + let re_skip = '' + endif + let last_indent = indent(a:lnum) + 1 + let lnum = a:lnum - 1 while lnum > 0 && last_indent > 0 - if indent(lnum) < last_indent - if getline(lnum) =~# re - return lnum + let indent = indent(lnum) + if indent < last_indent + let line = getline(lnum) + if !empty(re_skip) && line =~# re_skip + let last_indent = indent + elseif line =~# re + if !a:multiple + return [indent] + endif + if index(r, indent) == -1 + let r += [indent] + endif + let last_indent = indent endif - 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"? +" (optionally up to a:1 / 4th argument) +function! s:match_expr_on_line(expr, lnum, start, ...) + let text = getline(a:lnum) + let end = a:0 ? a:1 : len(text) + if a:start > end + return 1 + endif + let save_pos = getpos('.') + let r = 1 + for i in range(a:start, end) + call cursor(a:lnum, i) + if !(eval(a:expr) || text[i-1] =~# '\s') + let r = 0 + break + endif + endfor + call setpos('.', save_pos) + return r endfunction " 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 text = getline(paren_lnum) let base = indent(paren_lnum) - let nothing_after_opening_paren = text =~ '\%'.(paren_col + 1).'c\s*$' - let starts_with_closing_paren = getline(a:lnum) =~ '^\s*[])}]' + 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 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() + + " Special case for parenthesis. + if text[paren_col-1] ==# '(' && getline(a:lnum) !~# '\v\)\s*:?\s*$' + return res + endif endif else " Indent to match position of opening paren. @@ -160,30 +237,47 @@ function! s:indent_like_opening_paren(lnum) " 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() - return base + s:sw() * 2 - else - return res + if text =~# b:control_statement && res == base + s:sw() + " 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. 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_ignore] 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 [blocks, skip] = blocks_ignore + let indents = s:find_start_of_block(a:lnum, blocks, skip, multiple) + if empty(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 @@ -200,24 +294,27 @@ function! s:indent_like_previous_line(lnum) 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 a string or comment. - while search(':\s*\%(#.*\)\?$', 'bcW', lnum) - if eval(s:skip_special_chars) - normal! h - else - return base + s:sw() - endif + " Search for final colon that is not inside something to be ignored. + while 1 + if col == 1 | break | endif + if text[col-1] =~# '\s' || s:_skip_special_chars(lnum, col) + let col = col - 1 + continue + 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. - if getline(start) =~# s:control_statement + if getline(start) =~# b:control_statement return base + s:sw() * 2 endif @@ -225,20 +322,26 @@ function! s:indent_like_previous_line(lnum) 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 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 (current || !empty) && s:is_dedented_already(current, base) return -1 endif @@ -246,13 +349,95 @@ function! s:indent_like_previous_line(lnum) return base endfunction -function! GetPythonPEPIndent(lnum) +" 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) + if a:0 + let cols = type(a:1) != type([]) ? [a:1] : a:1 + else + let cols = range(1, max([1, len(line)])) + endif + for cnum in cols + if match(map(synstack(a:lnum, cnum), + \ "synIDattr(v:val, 'name')"), 'python\S*String') == -1 + return 0 + end + endfor + return 1 +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-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: keep current indent. + return -1 + endif + + 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 + " 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. let indent = s:indent_like_opening_paren(a:lnum) if indent >= -1