]> git.madduck.net Git - etc/vim.git/blobdiff - indent/python.vim

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Travis: do not pin rvm (#103)
[etc/vim.git] / indent / python.vim
index befc60a7d817f8ef01da2532ece825cd5e37d1d8..a095ca64ed2e905043a5bf4d777a31512bede49d 100644 (file)
@@ -1,6 +1,7 @@
 " 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
@@ -9,6 +10,7 @@
 " 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
+
 let s:block_rules = {
             \ '^\s*elif\>': ['if', 'elif'],
             \ '^\s*except\>': ['try', 'except'],
@@ -45,8 +46,11 @@ let s:block_rules = {
 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)>'
@@ -84,7 +88,7 @@ if exists('*shiftwidth')
     endfunction
 else
     function! s:sw()
-        return &sw
+        return &shiftwidth
     endfunction
 endif
 
@@ -107,29 +111,26 @@ function! s:find_opening_paren(...)
         return ret
     endif
 
-    let stopline = max([0, line('.') - s:maxoff])
-
     " Return if cursor is in a comment.
     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))
+    let nearest = [0, 0]
+    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', s:skip_special_chars, stopline)
+        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)
@@ -184,7 +185,7 @@ function! s:match_expr_on_line(expr, lnum, start, ...)
     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
@@ -204,10 +205,13 @@ function! s:indent_like_opening_paren(lnum)
 
     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()
@@ -278,18 +282,18 @@ function! s:indent_like_previous_line(lnum)
 
     " Search for final colon that is not inside something to be ignored.
     while 1
-        let curpos = getpos(".")[2]
+        let curpos = getpos('.')[2]
         if curpos == 1 | break | endif
-        if eval(s:skip_special_chars) || text[curpos-1] =~ '\s'
+        if eval(s:skip_special_chars) || text[curpos-1] =~# '\s'
             normal! h
             continue
-        elseif text[curpos-1] == ':'
+        elseif text[curpos-1] ==# ':'
             return base + s:sw()
         endif
         break
     endwhile
 
-    if text =~ '\\$' && !ignore_last_char
+    if text =~# '\\$' && !ignore_last_char
         " If this line is the continuation of a control statement
         " indent further to distinguish the continuation line
         " from the next logical line.
@@ -301,17 +305,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 s:is_dedented_already(current, base)
+    if !empty && s:is_dedented_already(current, base)
         return -1
     endif
 
@@ -336,7 +349,7 @@ function! s:is_python_string(lnum, ...)
     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
@@ -361,7 +374,7 @@ function! GetPythonPEPIndent(lnum)
         let match_quotes = match(line, '^\s*\zs\%("""\|''''''\)')
         if match_quotes != -1
             " closing multiline string
-            let quotes = line[match_quotes:match_quotes+2]
+            let quotes = line[match_quotes:(match_quotes+2)]
             let pairpos = searchpairpos(quotes, '', quotes, 'b')
             if pairpos[0] != 0
                 return indent(pairpos[0])