1" Vim indent file 2" Language: Python 3" Maintainer: Bram Moolenaar <[email protected]> 4" Original Author: David Bustos <[email protected]> 5" Last Change: 2019 Feb 21 6 7" Only load this indent file when no other was loaded. 8if exists("b:did_indent") 9 finish 10endif 11let b:did_indent = 1 12 13" Some preliminary settings 14setlocal nolisp " Make sure lisp indenting doesn't supersede us 15setlocal autoindent " indentexpr isn't much help otherwise 16 17setlocal indentexpr=GetPythonIndent(v:lnum) 18setlocal indentkeys+=<:>,=elif,=except 19 20" Only define the function once. 21if exists("*GetPythonIndent") 22 finish 23endif 24let s:keepcpo= &cpo 25set cpo&vim 26 27" Come here when loading the script the first time. 28 29let s:maxoff = 50 " maximum number of lines to look backwards for () 30 31" See if the specified line is already user-dedented from the expected value. 32function s:Dedented(lnum, expected) 33 return indent(a:lnum) <= a:expected - shiftwidth() 34endfunction 35 36function GetPythonIndent(lnum) 37 38 " If this line is explicitly joined: If the previous line was also joined, 39 " line it up with that one, otherwise add two 'shiftwidth' 40 if getline(a:lnum - 1) =~ '\\$' 41 if a:lnum > 1 && getline(a:lnum - 2) =~ '\\$' 42 return indent(a:lnum - 1) 43 endif 44 return indent(a:lnum - 1) + (exists("g:pyindent_continue") ? eval(g:pyindent_continue) : (shiftwidth() * 2)) 45 endif 46 47 " If the start of the line is in a string don't change the indent. 48 if has('syntax_items') 49 \ && synIDattr(synID(a:lnum, 1, 1), "name") =~ "String$" 50 return -1 51 endif 52 53 " Search backwards for the previous non-empty line. 54 let plnum = prevnonblank(v:lnum - 1) 55 56 if plnum == 0 57 " This is the first non-empty line, use zero indent. 58 return 0 59 endif 60 61 call cursor(plnum, 1) 62 63 " Identing inside parentheses can be very slow, regardless of the searchpair() 64 " timeout, so let the user disable this feature if he doesn't need it 65 let disable_parentheses_indenting = get(g:, "pyindent_disable_parentheses_indenting", 0) 66 67 if disable_parentheses_indenting == 1 68 let plindent = indent(plnum) 69 let plnumstart = plnum 70 else 71 " searchpair() can be slow sometimes, limit the time to 150 msec or what is 72 " put in g:pyindent_searchpair_timeout 73 let searchpair_stopline = 0 74 let searchpair_timeout = get(g:, 'pyindent_searchpair_timeout', 150) 75 76 " If the previous line is inside parenthesis, use the indent of the starting 77 " line. 78 " Trick: use the non-existing "dummy" variable to break out of the loop when 79 " going too far back. 80 let parlnum = searchpair('(\|{\|\[', '', ')\|}\|\]', 'nbW', 81 \ "line('.') < " . (plnum - s:maxoff) . " ? dummy :" 82 \ . " synIDattr(synID(line('.'), col('.'), 1), 'name')" 83 \ . " =~ '\\(Comment\\|Todo\\|String\\)$'", 84 \ searchpair_stopline, searchpair_timeout) 85 if parlnum > 0 86 let plindent = indent(parlnum) 87 let plnumstart = parlnum 88 else 89 let plindent = indent(plnum) 90 let plnumstart = plnum 91 endif 92 93 " When inside parenthesis: If at the first line below the parenthesis add 94 " two 'shiftwidth', otherwise same as previous line. 95 " i = (a 96 " + b 97 " + c) 98 call cursor(a:lnum, 1) 99 let p = searchpair('(\|{\|\[', '', ')\|}\|\]', 'bW', 100 \ "line('.') < " . (a:lnum - s:maxoff) . " ? dummy :" 101 \ . " synIDattr(synID(line('.'), col('.'), 1), 'name')" 102 \ . " =~ '\\(Comment\\|Todo\\|String\\)$'", 103 \ searchpair_stopline, searchpair_timeout) 104 if p > 0 105 if p == plnum 106 " When the start is inside parenthesis, only indent one 'shiftwidth'. 107 let pp = searchpair('(\|{\|\[', '', ')\|}\|\]', 'bW', 108 \ "line('.') < " . (a:lnum - s:maxoff) . " ? dummy :" 109 \ . " synIDattr(synID(line('.'), col('.'), 1), 'name')" 110 \ . " =~ '\\(Comment\\|Todo\\|String\\)$'", 111 \ searchpair_stopline, searchpair_timeout) 112 if pp > 0 113 return indent(plnum) + (exists("g:pyindent_nested_paren") ? eval(g:pyindent_nested_paren) : shiftwidth()) 114 endif 115 return indent(plnum) + (exists("g:pyindent_open_paren") ? eval(g:pyindent_open_paren) : (shiftwidth() * 2)) 116 endif 117 if plnumstart == p 118 return indent(plnum) 119 endif 120 return plindent 121 endif 122 123 endif 124 125 126 " Get the line and remove a trailing comment. 127 " Use syntax highlighting attributes when possible. 128 let pline = getline(plnum) 129 let pline_len = strlen(pline) 130 if has('syntax_items') 131 " If the last character in the line is a comment, do a binary search for 132 " the start of the comment. synID() is slow, a linear search would take 133 " too long on a long line. 134 if synIDattr(synID(plnum, pline_len, 1), "name") =~ "\\(Comment\\|Todo\\)$" 135 let min = 1 136 let max = pline_len 137 while min < max 138 let col = (min + max) / 2 139 if synIDattr(synID(plnum, col, 1), "name") =~ "\\(Comment\\|Todo\\)$" 140 let max = col 141 else 142 let min = col + 1 143 endif 144 endwhile 145 let pline = strpart(pline, 0, min - 1) 146 endif 147 else 148 let col = 0 149 while col < pline_len 150 if pline[col] == '#' 151 let pline = strpart(pline, 0, col) 152 break 153 endif 154 let col = col + 1 155 endwhile 156 endif 157 158 " If the previous line ended with a colon, indent this line 159 if pline =~ ':\s*$' 160 return plindent + shiftwidth() 161 endif 162 163 " If the previous line was a stop-execution statement... 164 if getline(plnum) =~ '^\s*\(break\|continue\|raise\|return\|pass\)\>' 165 " See if the user has already dedented 166 if s:Dedented(a:lnum, indent(plnum)) 167 " If so, trust the user 168 return -1 169 endif 170 " If not, recommend one dedent 171 return indent(plnum) - shiftwidth() 172 endif 173 174 " If the current line begins with a keyword that lines up with "try" 175 if getline(a:lnum) =~ '^\s*\(except\|finally\)\>' 176 let lnum = a:lnum - 1 177 while lnum >= 1 178 if getline(lnum) =~ '^\s*\(try\|except\)\>' 179 let ind = indent(lnum) 180 if ind >= indent(a:lnum) 181 return -1 " indent is already less than this 182 endif 183 return ind " line up with previous try or except 184 endif 185 let lnum = lnum - 1 186 endwhile 187 return -1 " no matching "try"! 188 endif 189 190 " If the current line begins with a header keyword, dedent 191 if getline(a:lnum) =~ '^\s*\(elif\|else\)\>' 192 193 " Unless the previous line was a one-liner 194 if getline(plnumstart) =~ '^\s*\(for\|if\|try\)\>' 195 return plindent 196 endif 197 198 " Or the user has already dedented 199 if s:Dedented(a:lnum, plindent) 200 return -1 201 endif 202 203 return plindent - shiftwidth() 204 endif 205 206 " When after a () construct we probably want to go back to the start line. 207 " a = (b 208 " + c) 209 " here 210 if parlnum > 0 211 " ...unless the user has already dedented 212 if s:Dedented(a:lnum, plindent) 213 return -1 214 else 215 return plindent 216 endif 217 endif 218 219 return -1 220 221endfunction 222 223let &cpo = s:keepcpo 224unlet s:keepcpo 225 226" vim:sw=2 227