Revision 27 as of 2009-08-28 20:55:36

Clear message

Vi Improved

VI Improved (Vim) is an improved version of the editor "vi", one of the standard text editors on UNIX systems. It has all the features you'll ever need from an editor, and probably three times that many more that you'll never use ;-) The newer versions also include a 'vimdiff' mode that you can use to diff and merge file(s). Oh, I didn't mention it's also scriptable in Python, and there's a graphical version: GVIM. Get it from

Vim is also available in your favourite OS. Since version 6.0 it has folding. Folding makes your life easy when you have some long files.

You can download many scripts from and learn new tips from the site

Vim 7.0 (released mid-2006) includes the Intellisense-like omni-completion for several languages. Here is the latest version of pythoncomplete.

Configuring Vim

You can automatically enable syntax coloring and automatic indentation for Python code by adding the following lines to your ~/.vimrc file:

autocmd BufRead,BufNewFile *.py syntax on
autocmd BufRead,BufNewFile *.py set ai
autocmd BufRead *.py set smartindent cinwords=if,elif,else,for,while,with,try,except,finally,def,class

The following sections correspond to the guidelines from the HowToEditPythonCode page.


A useful addition to Python source files is this comment:

# vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4

This may need the modeline option enabled in your ~/.vimrc file:

set modeline

(In some versions of Ubuntu, for example, the modeline option has apparently been disabled for security reasons.)

The above # vim: ... text, when embedded in a source file, tells Vim that when the file is loaded, tabs are always expanded to spaces and that the width of each tab is four characters. Type the following in command mode to achieve the same effect:

:set tabstop=4 expandtab shiftwidth=4 softtabstop=4


:set ts=4 et sw=4 sts=4

Syntax Highlighting

You may be lucky enough to have syntax highlighting already switched on in your version of Vim. If not, edit a vimrc file (either /etc/vimrc or .vimrc in your home directory) and add the following:

syntax on

If you use a dark background, this command may help adjust the colours:

set background=dark


Some find that the methods described above does not work. An alternative method is adding...

set autoindent
set tabstop=4
set expandtab
set shiftwidth=4
filetype indent on your ~/.vimrc file. The first rule sets automatic tab indentation. The second rule sets tab stops to four characters wide. The third converts tabs to white space. set shiftwidth sets the width for autoindents. Finally, the last rule allows auto-indenting depending on file type. With this method, tab settings do not need to be set in your python file and the # vim: ... line in the template below is not needed.

A Simple Template

You could copy the following simple template and save it to a file somewhere. Then, when you need to make a new source file, just copy it to the intended location with a name of your choice.

   1 #!/usr/bin/env python
   3 """
   4 Python source code - replace this with a description of the code and write the code below this text.
   5 """
   7 # vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4

This contains useful UNIX-related information on the first line, and a docstring which can be used to describe what your program or module is about. As noted above, to work this requires modeline support to be enabled.

Scripting Vim with Python

There is a presentation given by Sean Reifschneider about scripting Vim with Python: Vim and Python: Two Great Tastes that Taste Great Together If you want to access the visual selection from Vim in Python read

Some more advice about configuring Vim can be found on this page: Notes on using Vim with Python

Python with a modular IDE (Vim), in this blog, can found information how to do that:

CategoryEditors CategoryEditors

Unable to edit the page? See the FrontPage for instructions.