Add option g:pymode_indent_hanging_width

wookayin · wookayin · commit 7487b7965b31 · 2021-08-12T04:32:31.000-04:00
This is an option for hanging indent size after an open parenthesis
in line continuations. It defaults to `&amp;shiftwidth` but can be assigned
a different value.

For example, hanging indent size can be set to 4 (even if the tabsize
or shiftwidth is not 4) as per Google Python Style Guide.
diff --git a/autoload/pymode/indent.vim b/autoload/pymode/indent.vim
@@ -24,7 +24,9 @@ function! pymode#indent#get_indent(lnum)
             if closing_paren
                 return indent(parlnum)
             else
-                return indent(parlnum) + &shiftwidth
+                let l:indent_width = (g:pymode_indent_hanging_width > 0 ?
+                            \ g:pymode_indent_hanging_width : &shiftwidth)
+                return indent(parlnum) + l:indent_width
             endif
         else
             return parcol
diff --git a/doc/pymode.txt b/doc/pymode.txt
@@ -170,6 +170,16 @@ Enable pymode indentation                                     *'g:pymode_indent'
 >
     let g:pymode_indent = 1
 
+
+Customization:
+
+Hanging indent size after an open parenthesis or bracket (but nothing after the
+parenthesis), when vertical alignment is not used. Defaults to `&shiftwidth`.
+                                                *'g:pymode_indent_hanging_width'*
+>
+    let g:pymode_indent_hanging_width = &shiftwidth
+    let g:pymode_indent_hanging_width = 4
+
 -------------------------------------------------------------------------------
 2.3 Python folding ~
                                                                  *pymode-folding*
diff --git a/plugin/pymode.vim b/plugin/pymode.vim
@@ -38,6 +38,9 @@ call pymode#default('g:pymode_doc_bind', 'K')
 " Enable/Disable pymode PEP8 indentation
 call pymode#default("g:pymode_indent", 1)
 
+" Customize hanging indent size different than &shiftwidth
+call pymode#default("g:pymode_indent_hanging_width", -1)
+
 " TODO: currently folding suffers from a bad performance and incorrect
 " implementation. This feature should be considered experimental.
 " Enable/disable pymode folding for pyfiles.
