| Brett Cannon | b12efd3 | 2004-11-06 19:56:45 +0000 | [diff] [blame] | 1 | " vimrc file for following the coding standards specified in PEP 7 & 8. | 
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 2 | " | 
 | 3 | " To use this file, source it in your own personal .vimrc file (``source | 
 | 4 | " <filename>``) or, if you don't have a .vimrc file, you can just symlink to it | 
| Brett Cannon | b12efd3 | 2004-11-06 19:56:45 +0000 | [diff] [blame] | 5 | " (``ln -s <this file> ~/.vimrc``).  All options are protected by autocmds | 
 | 6 | " (read below for an explanation of the command) so blind sourcing of this file | 
 | 7 | " is safe and will not affect your settings for non-Python or non-C files. | 
 | 8 | " | 
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 9 | " | 
 | 10 | " All setting are protected by 'au' ('autocmd') statements.  Only files ending | 
 | 11 | " in .py or .pyw will trigger the Python settings while files ending in *.c or | 
| Brett Cannon | 07eca3a | 2005-03-05 05:52:21 +0000 | [diff] [blame] | 12 | " *.h will trigger the C settings.  This makes the file "safe" in terms of only | 
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 13 | " adjusting settings for Python and C files. | 
 | 14 | " | 
 | 15 | " Only basic settings needed to enforce the style guidelines are set. | 
 | 16 | " Some suggested options are listed but commented out at the end of this file. | 
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 17 |  | 
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 18 | " Number of spaces that a pre-existing tab is equal to. | 
| Brett Cannon | b12efd3 | 2004-11-06 19:56:45 +0000 | [diff] [blame] | 19 | " For the amount of space used for a new tab use shiftwidth. | 
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 20 | au BufRead,BufNewFile *py,*pyw,*.c,*.h set tabstop=8 | 
 | 21 |  | 
| Brett Cannon | 92634d6 | 2009-11-08 21:41:27 +0000 | [diff] [blame] | 22 | " What to use for an indent. | 
 | 23 | " This will affect Ctrl-T and 'autoindent'. | 
 | 24 | " Python: 4 spaces | 
 | 25 | " C: tabs (pre-existing files) or 4 spaces (new files) | 
 | 26 | au BufRead,BufNewFile *.py,*pyw set shiftwidth=4 | 
 | 27 | au BufRead,BufNewFile *.py,*.pyw set expandtab | 
 | 28 | fu Select_c_style() | 
 | 29 |     if search('^\t', 'n', 150) | 
 | 30 |         set shiftwidth=8 | 
 | 31 |         set noexpandtab | 
 | 32 |     el  | 
 | 33 |         set shiftwidth=4 | 
 | 34 |         set expandtab | 
 | 35 |     en | 
 | 36 | endf | 
 | 37 | au BufRead,BufNewFile *.c,*.h call Select_c_style() | 
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 38 | au BufRead,BufNewFile Makefile* set noexpandtab | 
 | 39 |  | 
| Brett Cannon | 92634d6 | 2009-11-08 21:41:27 +0000 | [diff] [blame] | 40 | " Use the below highlight group when displaying bad whitespace is desired. | 
| Brett Cannon | 07eca3a | 2005-03-05 05:52:21 +0000 | [diff] [blame] | 41 | highlight BadWhitespace ctermbg=red guibg=red | 
 | 42 |  | 
| Christian Heimes | 9a37159 | 2007-12-28 14:08:13 +0000 | [diff] [blame] | 43 | " Display tabs at the beginning of a line in Python mode as bad. | 
| Brett Cannon | 07eca3a | 2005-03-05 05:52:21 +0000 | [diff] [blame] | 44 | au BufRead,BufNewFile *.py,*.pyw match BadWhitespace /^\t\+/ | 
| Christian Heimes | 9a37159 | 2007-12-28 14:08:13 +0000 | [diff] [blame] | 45 | " Make trailing whitespace be flagged as bad. | 
| Brett Cannon | 767a0f8 | 2010-07-03 21:50:52 +0000 | [diff] [blame] | 46 | au BufRead,BufNewFile *.py,*.pyw,*.c,*.h,*.rst match BadWhitespace /\s\+$/ | 
| Brett Cannon | 07eca3a | 2005-03-05 05:52:21 +0000 | [diff] [blame] | 47 |  | 
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 48 | " Wrap text after a certain number of characters | 
 | 49 | " Python: 79  | 
 | 50 | " C: 79 | 
 | 51 | au BufRead,BufNewFile *.py,*.pyw,*.c,*.h set textwidth=79 | 
 | 52 |  | 
 | 53 | " Turn off settings in 'formatoptions' relating to comment formatting. | 
 | 54 | " - c : do not automatically insert the comment leader when wrapping based on | 
 | 55 | "    'textwidth' | 
 | 56 | " - o : do not insert the comment leader when using 'o' or 'O' from command mode | 
 | 57 | " - r : do not insert the comment leader when hitting <Enter> in insert mode | 
 | 58 | " Python: not needed | 
 | 59 | " C: prevents insertion of '*' at the beginning of every line in a comment | 
 | 60 | au BufRead,BufNewFile *.c,*.h set formatoptions-=c formatoptions-=o formatoptions-=r | 
 | 61 |  | 
 | 62 | " Use UNIX (\n) line endings. | 
 | 63 | " Only used for new files so as to not force existing files to change their | 
 | 64 | " line endings. | 
 | 65 | " Python: yes | 
 | 66 | " C: yes | 
 | 67 | au BufNewFile *.py,*.pyw,*.c,*.h set fileformat=unix | 
 | 68 |  | 
 | 69 |  | 
| Brett Cannon | b12efd3 | 2004-11-06 19:56:45 +0000 | [diff] [blame] | 70 | " ---------------------------------------------------------------------------- | 
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 71 | " The following section contains suggested settings.  While in no way required | 
 | 72 | " to meet coding standards, they are helpful. | 
 | 73 |  | 
 | 74 | " Set the default file encoding to UTF-8: ``set encoding=utf-8`` | 
 | 75 |  | 
| Brett Cannon | 07eca3a | 2005-03-05 05:52:21 +0000 | [diff] [blame] | 76 | " Puts a marker at the beginning of the file to differentiate between UTF and | 
| Brett Cannon | b12efd3 | 2004-11-06 19:56:45 +0000 | [diff] [blame] | 77 | " UCS encoding (WARNING: can trick shells into thinking a text file is actually | 
 | 78 | " a binary file when executing the text file): ``set bomb`` | 
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 79 |  | 
 | 80 | " For full syntax highlighting: | 
 | 81 | "``let python_highlight_all=1`` | 
 | 82 | "``syntax on`` | 
 | 83 |  | 
| Brett Cannon | e6c430d | 2005-03-21 20:41:51 +0000 | [diff] [blame] | 84 | " Automatically indent based on file type: ``filetype indent on`` | 
 | 85 | " Keep indentation level from previous line: ``set autoindent`` | 
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 86 |  | 
| Brett Cannon | b12efd3 | 2004-11-06 19:56:45 +0000 | [diff] [blame] | 87 | " Folding based on indentation: ``set foldmethod=indent`` |