README.rst

   1 vim-python-pep8-indent
   2 ======================
   3
   4 .. image:: https://travis-ci.org/Vimjas/vim-python-pep8-indent.png?branch=master
   5    :target: https://travis-ci.org/Vimjas/vim-python-pep8-indent
   6
   7 This small script modifies Vim_’s indentation behavior to comply with PEP8_ and my aesthetic preferences.
   8 Most importantly::
   9
  10    foobar(foo,
  11           bar)
  12
  13 and::
  14
  15    foobar(
  16       foo,
  17       bar
  18    )
  19
  20
  21 Installation
  22 ------------
  23
  24 Install the plugin using your favorite plugin manager / method, a few examples
  25 follow:
  26
  27 Pathogen
  28 ^^^^^^^^
  29
  30 Follow the instructions on installing Pathogen_ and then:
  31
  32 .. code-block:: shell-session
  33
  34    $ cd ~/.vim/bundle
  35    $ git clone https://github.com/Vimjas/vim-python-pep8-indent.git
  36
  37
  38 Vundle
  39 ^^^^^^
  40
  41 Follow the instructions on installing Vundle_ and add the appropriate plugin line into your ``.vimrc``:
  42
  43 .. code-block:: vim
  44
  45    Plugin 'Vimjas/vim-python-pep8-indent'
  46
  47
  48 NeoBundle
  49 ^^^^^^^^^
  50
  51 Follow the instructions on installing NeoBundle_ and add the appropriate NeoBundle line into your ``.vimrc``:
  52
  53 .. code-block:: vim
  54
  55    NeoBundle 'Vimjas/vim-python-pep8-indent'
  56
  57
  58 Configuration
  59 -------------
  60
  61 g:python_pep8_indent_multiline_string
  62 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  63
  64 You can configure the initial indentation of multiline strings using ``g:python_pep8_indent_multiline_string`` (which can also be set per buffer).
  65 This defaults to ``0``, which means that multiline strings are not indented.
  66 ``-1`` and positive values will be used as-is, where ``-1`` is a special value for Vim's ``indentexpr``, and will keep the existing indent (using Vim's ``autoindent`` setting).
  67 ``-2`` is meant to be used for strings that are wrapped with ``textwrap.dedent`` etc.  It will add a level of indentation if the multiline string started in the previous line, without any content in it already::
  68
  69    testdir.makeconftest("""
  70        _
  71
  72 With content already, it will be aligned to the opening parenthesis::
  73
  74    testdir.makeconftest("""def pytest_addoption(parser):
  75                         _
  76
  77 Existing indentation (including ``0``) in multiline strings will be kept, so this setting only applies to the indentation of new/empty lines.
  78
  79 g:python_pep8_indent_hang_closing
  80 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  81
  82 Control closing bracket indentation with ``python_pep8_indent_hang_closing``, set globally or per buffer.
  83
  84 By default (set to ``0``), closing brackets line up with the opening line::
  85
  86    my_list = [
  87        1, 2, 3,
  88        4, 5, 6,
  89    ]
  90    result = some_function_that_takes_arguments(
  91        'a', 'b', 'c',
  92        'd', 'e', 'f',
  93    )
  94
  95 With ``python_pep8_indent_hang_closing = 1``, closing brackets line up with the items::
  96
  97    my_list = [
  98        1, 2, 3,
  99        4, 5, 6,
 100        ]
 101    result = some_function_that_takes_arguments(
 102        'a', 'b', 'c',
 103        'd', 'e', 'f',
 104        )
 105
 106
 107 Troubleshooting
 108 ---------------
 109
 110 In case it is not working, please make sure your Vim is configured to load
 111 indent files (``filetype indent on``).
 112 This is typically the case when using a plugin manager, but check its docs.
 113
 114 Check ``:verbose set indentexpr?`` in a Python file, which should show
 115 something like the following:
 116
 117   indentexpr=GetPythonPEPIndent(v:lnum)
 118         Last set from ~/…/plugged/vim-python-pep8-indent/indent/python.vim
 119
 120
 121 Notes
 122 -----
 123
 124 Please note that Kirill Klenov’s python-mode_ ships its own version of this bundle.
 125 Therefore, if you want to use this version specifically, you’ll have to disable python-mode’s using:
 126
 127 .. code-block:: vim
 128
 129    let g:pymode_indent = 0
 130
 131
 132 License and Authorship
 133 ----------------------
 134
 135 This script is based on one from Vim’s official `script repo`_  that was *not* originally written by me.
 136 Unfortunately the indentation was off by one character in one case and the script hasn’t been updated since 2005.
 137
 138 Even more unfortunately, I wasn’t able to reach any of the original authors/maintainers:
 139 **David Bustos** and **Eric Mc Sween**.
 140
 141 So I fixed the annoyance with the help of `Steve Losh`_ and am putting it out here so you don’t have to patch the original yourself.
 142 The original patch is still available here_.
 143
 144 Over the time a lot more improvements have been contributed_ by `generous people`_.
 145
 146 I’d like to thank the original authors here for their work and release it hereby to the *Public Domain* (using the CC0_ licence) since I hope that would be in their spirit.
 147 If anyone with a say in this objects, please let me_ know immediately.
 148 Also, if someone is in contact with one of them, I would appreciate being introduced.
 149
 150 While my Vimscript_ skills are still feeble, I intend to maintain it for now.
 151 This mainly means that I’ll triage through bugs and pull requests but won’t be fixing much myself.
 152
 153
 154 .. _Vim: http://www.vim.org/
 155 .. _PEP8: http://www.python.org/dev/peps/pep-0008/
 156 .. _`script repo`: http://www.vim.org/scripts/script.php?script_id=974
 157 .. _`Steve Losh`: http://stevelosh.com/
 158 .. _here: https://gist.github.com/2965846
 159 .. _Neobundle: https://github.com/Shougo/neobundle.vim
 160 .. _Pathogen: https://github.com/tpope/vim-pathogen
 161 .. _python-mode: https://github.com/klen/python-mode
 162 .. _`Vimscript`: http://learnvimscriptthehardway.stevelosh.com/
 163 .. _vundle: https://github.com/gmarik/Vundle.vim
 164 .. _me: https://hynek.me/
 165 .. _CC0: http://creativecommons.org/publicdomain/zero/1.0/
 166 .. _contributed: https://github.com/hynek/vim-python-pep8-indent/blob/master/CONTRIBUTING.rst
 167 .. _`generous people`: https://github.com/hynek/vim-python-pep8-indent/graphs/contributors