Vim Tips Wiki
Register
No edit summary
 
(Change <tt> to <code>, perhaps also minor tweak.)
(17 intermediate revisions by 9 users not shown)
Line 1: Line 1:
  +
{{TipImported
{{review}}
 
{{Tip
 
 
|id=741
 
|id=741
  +
|previous=739
|title=Outline editing of Python programmes
 
  +
|next=742
|created=June 7, 2004 8:49
+
|created=2004
 
|complexity=intermediate
 
|complexity=intermediate
 
|author=Lee Chun Kin
 
|author=Lee Chun Kin
 
|version=6.0
 
|version=6.0
 
|rating=21/11
 
|rating=21/11
  +
|category1=Folding
|text=
 
  +
|category2=Python
With the folding function of Vim6 (+folding), we can edit the Python programmes similar to outline program editors such as SciTE.
 
 
}}
  +
The default files provided with Vim do not provide a way to fold Python programs, however entering the command <code>:setlocal foldmethod=indent</code> while editing a Python program enables [[folding]] based on the indent level, and that may be all that is needed. However, this tip provides the extra feature of folding <code>def</code> and <code>class</code> regions.
   
  +
==Modifying python.vim==
  +
Unfortunately, the Python syntax file provided with Vim does not contain folding information. You can however create a custom Python syntax script that folds <code>def</code> and <code>class</code> regions.
   
  +
To make this work, copy file <code>python.vim</code> provided with Vim, and modify the copy. In Vim, the file that needs to be copied is <code>$VIMRUNTIME/syntax/python.vim</code>, and the directory <code>$VIMRUNTIME</code> can be determined by entering the following command in Vim: <code>:echo $VIMRUNTIME</code>
   
  +
For example, on a Unix system the source file might be <code>/usr/share/vim/vim73/syntax/python.vim</code>, while on a Windows system it might be <code>C:\Program Files\Vim\Vim73\syntax\python.vim</code>.
Add follow lines to .vimrc:
 
   
  +
The <code>python.vim</code> file should be copied to the following directory (you need to create any directories that are not present on your system):
  +
*<code>~/.vim/after/syntax</code> on Unix-based systems; or
  +
*<code>$HOME/vimfiles/after/syntax</code> on Windows systems (use <code>:echo $HOME</code> to determine your <code>$HOME</code> directory)
   
  +
Open the copied file in Vim and change it like this:
   
  +
Find the line that looks like:
augroup python_prog
 
  +
<pre>
 
syn keyword pythonStatement nextgroup=pythonFunction skipwhite
  +
</pre>
  +
and delete it. And also find these lines:
  +
<pre>
  +
if version < 600
  +
syntax clear
  +
elseif exists("b:current_syntax")
  +
finish
  +
endif
  +
</pre>
  +
and change them to:
  +
<pre>
  +
syntax clear
  +
</pre>
   
  +
Additionally, you should create file <code>after/ftplugin/python.vim</code> which sets up folding for Python files. In that file, write:
au!
 
  +
<pre>
 
setlocal foldmethod=syntax
 
setlocal foldtext=substitute(getline(v:foldstart),'\\t','\ \ \ \ ','g')
  +
</pre>
   
  +
This will enable syntax folding for Python scripts. Additional settings for Python files can also be in <code>after/ftplugin/python.vim</code> (see [[indenting source code]] for an example).
fun! Python_fold()
 
   
  +
If the settings from this file do not work, you need to set up the <code>filetype</code> settings in your [[vimrc]] (see {{help|:filetype-plugin-on}}).
execute 'syntax clear pythonStatement'
 
   
  +
===Drawback===
execute 'syntax keyword pythonStatement break continue del'
 
  +
The changed syntax script removes the syntax highlighting for keywords <code>class</code> and <code>def</code>.
 
execute 'syntax keyword pythonStatement except exec finally'
 
 
execute 'syntax keyword pythonStatement pass print raise'
 
 
execute 'syntax keyword pythonStatement return try'
 
 
execute 'syntax keyword pythonStatement global assert'
 
 
execute 'syntax keyword pythonStatement lambda yield'
 
 
execute 'syntax match pythonStatement /\&lt;def\&gt;/ nextgroup=pythonFunction skipwhite'
 
 
execute 'syntax match pythonStatement /\&lt;class\&gt;/ nextgroup=pythonFunction skipwhite'
 
 
execute 'syntax region pythonFold start="^\z(\s*\)\%(class\|def\)" end="^\%(\n*\z1\s\)\@!" transparent fold'
 
 
execute 'syntax sync minlines=2000 maxlines=4000'
 
 
set autoindent
 
 
set foldmethod=syntax
 
 
" set foldopen=all foldclose=all
 
 
set foldtext=substitute(getline(v:foldstart),'\\t','\ \ \ \ ','g')
 
 
set fillchars=vert:\|,fold:\
 
 
set tabstop=4 shiftwidth=4 nowrap guioptions+=b
 
 
endfun
 
 
autocmd FileType python call Python_fold()
 
 
augroup END
 
 
 
 
You can use the folding functions (zm, zM, zr, zR, xa, zo, zc, zx...) in editing Python program.
 
 
 
}}
 
   
== Comments ==
+
==See also==
  +
*[[Syntax folding of Vim scripts]] contains a complete but complex example on how to syntax fold Vim scripts
Or you could use the python_fold script ([/scripts/script.php?script_id=515 vimscript &#35;515])
 
  +
Folding Plugins for Python:
  +
*{{Script|id=2527|text=jpythonfold}}
  +
*{{Script|id=515|text=python_fold}}
   
  +
==Comments==
'''Anonymous'''
 
, June 10, 2004 3:47
 
----
 
<!-- parsed by vimtips.py in 0.470667 seconds-->
 

Revision as of 12:32, 15 July 2012

Tip 741 Printable Monobook Previous Next

created 2004 · complexity intermediate · author Lee Chun Kin · version 6.0


The default files provided with Vim do not provide a way to fold Python programs, however entering the command :setlocal foldmethod=indent while editing a Python program enables folding based on the indent level, and that may be all that is needed. However, this tip provides the extra feature of folding def and class regions.

Modifying python.vim

Unfortunately, the Python syntax file provided with Vim does not contain folding information. You can however create a custom Python syntax script that folds def and class regions.

To make this work, copy file python.vim provided with Vim, and modify the copy. In Vim, the file that needs to be copied is $VIMRUNTIME/syntax/python.vim, and the directory $VIMRUNTIME can be determined by entering the following command in Vim: :echo $VIMRUNTIME

For example, on a Unix system the source file might be /usr/share/vim/vim73/syntax/python.vim, while on a Windows system it might be C:\Program Files\Vim\Vim73\syntax\python.vim.

The python.vim file should be copied to the following directory (you need to create any directories that are not present on your system):

  • ~/.vim/after/syntax on Unix-based systems; or
  • $HOME/vimfiles/after/syntax on Windows systems (use :echo $HOME to determine your $HOME directory)

Open the copied file in Vim and change it like this:

Find the line that looks like:

syn keyword pythonStatement     nextgroup=pythonFunction skipwhite

and delete it. And also find these lines:

if version < 600
  syntax clear
elseif exists("b:current_syntax")
  finish
endif

and change them to:

syntax clear

Additionally, you should create file after/ftplugin/python.vim which sets up folding for Python files. In that file, write:

setlocal foldmethod=syntax
setlocal foldtext=substitute(getline(v:foldstart),'\\t','\ \ \ \ ','g')

This will enable syntax folding for Python scripts. Additional settings for Python files can also be in after/ftplugin/python.vim (see indenting source code for an example).

If the settings from this file do not work, you need to set up the filetype settings in your vimrc (see :help :filetype-plugin-on).

Drawback

The changed syntax script removes the syntax highlighting for keywords class and def.

See also

Folding Plugins for Python:

Comments