skip to navigation
skip to content

vimpdb 0.4.0

Vim and Pdb integration

Latest Version: 0.4.5

Abstract

This package provides an integration of the Python debugger pdb into the VIM editor.

Requirements

vimpdb has been used successfully under Linux, Mac OSX and Windows.

It is compatible with Python 2.7, 2.6, 2.5 and 2.4. It is not compatible with Python 3.1 (it should be the same for 3.0).

vimpdb requires an installation of VIM that supports both python and clientserver options.

Find out if it is the case by issuing the following command at the VIM prompt:

:version

If the options are supported, you will see +clientserver and +python in the output. In the opposite case, you will see -clientserver or -python.

On Linux and Windows, the default VIM build should already be server-enabled.

On Windows, the python option compiled in VIM depends on a specific Python version. Find out if that specific version is installed and works in VIM by issuing the following command at the VIM prompt:

:python import sys; print sys.version

On Mac OSX, you’ll want to use MacVIM. MacVIM also has the python option compiled in by default.

Installation

Just install this package using easy_install or similar:

$ easy_install vimpdb

If you look inside the package, you will see a VIM script file: vimpdb.vim. Do not move it to VIM configuration directory (like ~/.vim/plugin). vimpdb knows how to make the script available to VIM.

Configuration

vimpdb is configured through its RC file : ~/.vimpdbrc. The options are found in the [vimpdb] section.

When vimpdb is started, it looks for that RC file. If it does not find it, vimpdb creates that file for you from default values.

If the default values do not work for you, you should modify the RC file. See below for details about the options.

You should not remove any of the options. If you do, vimpdb will break and complain accordingly.

VIM script

To communicate with the VIM instance where debugging happens, vimpdb needs to launch another VIM instance in client mode.

By default, vimpdb uses the vim script to start that VIM instance with clientserver support. If there exists such a vim script on your path, you are ok.

You can configure another script with the script option. It must hold the script that vimpdb should use to launch a VIM instance with clientserver support.

On Windows, it should hold the path to vim.exe, not to gvim.exe. Furthermore, do not include quotes in the enviromnent variable to take care of whitespace in the path.

Server Name

By default, vimpdb speaks to the server named VIMPDB. Note that the default servername used by VIM is VIM.

If you want vimpdb to use another server name, modify the server_name option. It should hold the name of the VIM server you will be using for debugging.

You may list the currently running VIM servers using:

$ vim --serverlist
VIM

Or, on a Mac:

$ /Applications/MacVim.app/Contents/MacOS/Vim --serverlist
VIM

When a VIM instance with clientserver support is running, you can find its name by issuing the following command at the VIM prompt:

:echo v:servername

Port

VIM communicates to vimpdb through a UDP socket. By default, the socket is opened on port 6666.

If that socket is not available in your system, you can specify an available port number in the port option.

Backward Compatibility

Before version 4.0, vimpdb was configured through environment variables. If you had a working configuration, you should have no problem. The values of VIMPDB_SERVERNAME and VIMPDB_VIMSCRIPT environment variables are setup in the RC file (~/.vimpdbrc). They are put respectively in server_name and script options.

Usage

Starting VIM

To start a VIM instance for debugging, issue the following command on the shell:

$ vim --servername VIMPDB

Or, on a Mac, if you installed the mvim script:

$ mvim --servername VIMPDB

Python code

Using vimpdb is easy – just insert a call to set_trace in your code almost as usual:

import vimpdb; vimpdb.set_trace()

Then start your python application/script.

When the python interpreter hits that line, VIM will get the focus and load the source file at the right line.

VIM commands

In VIM, you may now use the following commands:

<caption>VimPDB Commands</caption>
Key Command
n Next
s Step
a Args
u Up
d Down
r Return
c Continue
b Sets a breakpoint at the line on which the cursor is sitting.
w Displays the value of the word on which the cursor is sitting.
x Switch to debugging in shell with standard Pdb.
v Switch back to VimPdb from plain Pdb.

Standard Pdb hook

If you find it hard to change habits and keep on typing

import pdb; pdb.set_trace()

you can add the following line to the .pdbrc file sitting in your home folder:

import vimpdb; vimpdb.hookPdb()

This way, the command v(im) mentioned above is added to your standard Pdb and you can switch to vimpdb at any time.

Known issues

  • No convenient way to evaluate a Python expression.

CREDITS

Changelog

0.4.0 (2010-07-29)

  • tested with Python 2.7.
  • UDP port is now an option.
  • configuration through ~/.vimpdbrc instead of environment variables.

0.3.8 (2010-06-17)

0.3.7 (2010-05-20)

0.3.6 (2010-04-17)

0.3.5 (2010-03-22)

  • better documentation, especially for Windows
  • fix: capture of output was broken for Python 2.5 and 2.6
  • Windows compatibility (at least XP)

0.3.4 (2010-03-15)

  • close socket to allow debugging session to start again

0.3.3 (2010-03-04)

  • avoid leaving mappings in debugged buffers

0.3.2 (2010-03-03)

  • more documentation

0.3.1 (2010-03-02)

  • fix setup.py metadata so that it does not hold non ascii chars. This avoided actual release to PyPI

0.3 (2010-03-02)

  • fully rewritten

0.2.1 (2008-06-27)

  • added vimpdb script
  • added “exit” callback

0.2 (2008-06-17)

  • first release to PyPi

TODO

In priority order:

  • document the PDBxx commands in Ex mode
  • when switching from pdb to vimpdb, if the remote VIM is unavailable, log a message and keep pdb running.
  • when resetting, close vimpdb buffer and issue message
  • key bindings in vimpdb buffer
  • try to start Vim server if it is not started
  • try to guess Vim server name to avoid need of VIMPDB_SERVERNAME
  • check and complain if Vim does not support the right options

and much more…

 
File Type Py Version Uploaded on Size
vimpdb-0.4.0.tar.gz (md5) Source 2010-07-29 11KB