Differences between revisions 25 and 26
Revision 25 as of 2009-03-02 05:36:44
Size: 4254
Editor: 97-116-143-14
Comment:
Revision 26 as of 2009-03-02 21:20:12
Size: 4539
Editor: PaulBoddie
Comment: Added modeline notes and reformatted slightly. Fixed template formatting.
Deletions are marked like this. Additions are marked like this.
Line 32: Line 32:
This 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: 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:
Line 60: Line 68:
Some find that the methods described above does not work. An alternative method is adding: Some find that the methods described above does not work. An alternative method is adding...
Line 62: Line 71:
    set autoindent
    set tabstop=4
    set expandtab
    set shiftwidth=4
    filetype indent on
set autoindent
set tabstop=4
set expandtab
set shiftwidth=4
filetype indent on
Line 68: Line 77:
to 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: tabstop=4 expandtab shiftwidth=4 softtabstop=4}}} line in the template below is not needed.

...
to 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.
Line 75: Line 84:
{{{ {{{#!python
Line 85: Line 94:
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. 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.

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 http://www.vim.org/.

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 http://www.vim.org/ and learn new tips from the site http://vim.wikia.com/wiki/Main_Page

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,try,except,finally,def,class

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

Indentation

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

Or:

: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

Alternative

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 

...to 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
   2 
   3 """
   4 Python source code - replace this with a description of the code and write the code below this text.
   5 """
   6 
   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 http://www.tummy.com/journals/entries/jafo_20070301_035949

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: http://blog.sontek.net/2008/05/11/python-with-a-modular-ide-vim/


CategoryEditors

Vim (last edited 2013-06-18 05:14:05 by Apes)

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