README: add g: prefix to config section

[etc/vim.git] / indent / python.vim

diff --git a/indent/python.vim b/indent/python.vim
index 6bf45a8bf20405e2d51b47c66464fb4817671ce5..19b649e4f7bbfb35fa09de2f92fb1418f0c5c538 100644 (file)
--- a/indent/python.vim
+++ b/indent/python.vim
@@ -1,6 +1,7 @@
 " PEP8 compatible Python indent file
 " Language:         Python
 " 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
 " 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>
 " 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
 "
 " 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,19 +20,15 @@
 " <http://creativecommons.org/publicdomain/zero/1.0/>.
 
 " Only load this indent file when no other was loaded.
 " <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
 
     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 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
 
 if !exists('g:python_pep8_indent_multiline_string')
     let g:python_pep8_indent_multiline_string = 0


@@ -46,7 +44,7 @@ let s:block_rules_multiple = {
             \ '^\s*else\>': ['if', 'elif', 'for', 'try', 'except'],
             \ }
 let s:paren_pairs = ['()', '{}', '[]']
             \ '^\s*else\>': ['if', 'elif', 'for', 'try', 'except'],
             \ }
 let s:paren_pairs = ['()', '{}', '[]']

-if &ft == 'pyrex' || &ft == 'cython'
+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)>'
     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 +82,7 @@ if exists('*shiftwidth')
     endfunction
 else
     function! s:sw()
     endfunction
 else
     function! s:sw()

-        return &sw
+        return &shiftwidth

     endfunction
 endif
 
     endfunction
 endif
 


@@ -129,7 +127,7 @@ endfunction
 function! s:find_start_of_multiline_statement(lnum)
     let lnum = a:lnum
     while lnum > 0
 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 lnum = prevnonblank(lnum - 1)
         else
             let [paren_lnum, _] = s:find_opening_paren(lnum)


@@ -145,20 +143,26 @@ endfunction
 " Find possible indent(s) of the block starter that matches the current line.
 function! s:find_start_of_block(lnum, types, multiple)
     let r = []
 " 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
     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

-            if getline(lnum) =~# re
-                if !a:multiple
-                    return [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
                 endif

-                if !len(r) || index(r, indent) == -1
-                    let r += [indent]
-                endif
-            endif
+            endfor

             let last_indent = indent(lnum)
         endif
         let lnum = prevnonblank(lnum - 1)
             let last_indent = indent(lnum)
         endif
         let lnum = prevnonblank(lnum - 1)


@@ -178,7 +182,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)
     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
             let r = 0
             break
         endif


@@ -198,7 +202,7 @@ 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 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*[])}]'

 
     if nothing_after_opening_paren
         if starts_with_closing_paren
 
     if nothing_after_opening_paren
         if starts_with_closing_paren


@@ -239,14 +243,15 @@ function! s:indent_like_block(lnum)
             if len(indents) == 1
                 return indents[0]
             endif
             if len(indents) == 1
                 return indents[0]
             endif

+

             " Multiple valid indents, e.g. for 'else' with both try and if.
             let indent = indent(a:lnum)
             " Multiple valid indents, e.g. for 'else' with both try and if.
             let indent = indent(a:lnum)

-            for possible_indent in indents
-                if indent == possible_indent
-                    return indent
-                endif
-            endfor
-            return -2
+            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
         endfor
     endfor
     return -2


@@ -271,18 +276,18 @@ function! s:indent_like_previous_line(lnum)
 
     " Search for final colon that is not inside something to be ignored.
     while 1
 
     " 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 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
             normal! h
             continue

-        elseif text[curpos-1] == ':'
+        elseif text[curpos-1] ==# ':'

             return base + s:sw()
         endif
         break
     endwhile
 
             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.
         " If this line is the continuation of a control statement
         " indent further to distinguish the continuation line
         " from the next logical line.


@@ -294,17 +299,19 @@ function! s:indent_like_previous_line(lnum)
         return base + s:sw()
     endif
 
         return base + s:sw()
     endif
 

+    let empty = getline(a:lnum) =~# '^\s*$'
+

     " 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 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
 
             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
 
         return -1
     endif
 


@@ -329,7 +336,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),
     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
         end
     endfor


@@ -342,12 +349,25 @@ function! GetPythonPEPIndent(lnum)
         return 0
     endif
 
         return 0
     endif
 

+    let line = getline(a:lnum)
+    let prevline = getline(a:lnum-1)
+

     " Multilinestrings: continous, docstring or starting.
     " 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, 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)
         endif
 
         if s:is_python_string(a:lnum-1)


@@ -355,21 +375,35 @@ function! GetPythonPEPIndent(lnum)
             return indent(a:lnum-1)
         endif
 
             return indent(a:lnum-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))
             " 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 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
 
         return s:indent_like_opening_paren(a:lnum)
     endif