Para comprobar que efectivamente se encuentre habilitado el soporte para Python ejecutar Vim y en modo comando escribir:

Un 1 indica que Vim interpreta Python ;)

Es muy recomendable leer la ayuda en línea:

También se puede acceder vía web desde http://vimdoc.sourceforge.net/htmldoc/if_pyth.html

Ejecución de código Python

La ejecución de una línea de código Python se realiza según la sintaxis:

Ejemplo:

Aquí el prompt mostrará el mensaje “hello world”.

En cambio para escribir código en varias líneas hay que usar la siguiente forma:

Ejemplo:

De esta manera la función queda guardada en la memoria de la sesión actual. Luego su uso podría ser el siguiente:

Tambien es posible cargar y/o ejecutar código desde un archivo externo. La sintaxis es:

Ejemplo:

Simyscript.pynecesitara parámetros la forma de pasárselos es la siguiente:

El módulo vim

La comunicación entre Python y Vim se realiza a través del módulo vim, el cual hay que importar antes de usar:

Como indica la ayuda de Vim, el módulo implementa dos métodos (vim.command(str)yvim.eval(str)), tres constantes (vim.buffers,vim.windowsyvim.current) y un objeto error (vim.error). Las tres constantes mencionadas no son realmente constantes sino variables que pueden ser reasignadas pero, como dice también la ayuda, esto sería absurdo ya que se perdería acceso a los objetos de Vim que referencian. Por otra parte cabe recordar que no existen constantes en Python. Como cita el libro “Inmersión en Python“:

Todo puede cambiar si lo intenta con ahínco. Esto se ajusta a uno de los principios básicos de Python: los comportamientos inadecuados sólo deben desaconsejarse, no prohibirse.

A continuación transcribo un detalle de cada una de las constantes mencionadas:

vim.buffers

Objeto de tipo secuencia que provee acceso al listado de buffers actuales. El objeto soporta las siguiente operaciones:

:py b = vim.buffers[i]     # Indexación (Read-Only)
:py b in vim.buffers       # Prueba de existencia
:py n = len(vim.buffers)   # Número de elementos
:py for b in vim.buffers:  # Acceso secuencial

vim.windows

Objeto de tipo secuencia que provee acceso al listado de ventanas actuales. El objeto soporta las mismas operaciones que vim.buffers:

:py w = vim.windows[i]     # Indexación (RO)
:py w in vim.windows       # Prueba de existencia
:py n = len(vim.windows)   # Número de elementos
:py for w in vim.windows:  # Acceso secuencial

vim.current

Objeto que provee acceso (vía atributos específicos) a distintos objetos actuales:

vim.current.line    # (RW) String
vim.current.buffer  # (RO) Buffer
vim.current.window  # (RO) Window
vim.current.range   # (RO) Range

Ejemplos básicos de uso del módulo vim

Usandovim.current.line:

Usandovim.current.buffer:

Usandovim.current.window:

Script para subrayado de títulos

El siguiente script (heading.vim) lo escribí para no tener que, manualmente, subrayar títulos y delimitar bloques de texto. Especialmente quería que reconociera cuando se tratara de texto dentro de comentarios de código fuente y que respetara los caracteres especiales al comienzo (y final) de los mismos.

El script tiene una función que decora la línea actual colocando él o los caracteres decoradores tanto arriba como debajo de la misma (comportamiento por defecto). El largo (también por defecto) es el largo de la línea, pero se puede fijar un límite (ejemplo 80 columnas) y pedirle que ocupe todo el espacio disponible. Esta opción funciona bien sólamente cuando el indentado es con espacios. La opción uppercase funciona como se espera.

El código es el siguiente:

Para usarlo hay que colocar el archivo heading.vim en el directorio~/.vim/plugins.

Ejemplos de uso

1. Texto normal

Título

======
Título
======

2. Comentario en línea (Python, Bash, Perl, PHP, Ruby)

    # Comment

    # =======
    # Comment
    # =======

3. Comentario en bloque, estilo javadoc (C, C++, Java, Javascript, CSS, PHP, SQL)

    /**
     * Comment
     */

    /**
     * #######
     * COMMENT
     * #######
     */

4. Comentario en línea (C, C++, Java, Javascript, CSS, PHP, SQL)

/* Comment */

/* ~+~+~+~ */
/* Comment */
/* ~+~+~+~ */

5. Comentario en línea (C, Java, Javascript, PHP)

// Comment

// =====================================
// Comment
// =====================================

6. Comentario en línea (Vim script)

" Comment

" Comment
" ======

7. Comentario en línea (Lua, SQL)

-- Comment

-- =======
-- Comment
-- =======

Atajos de teclado

El script también define algunos atajos en modo normal para Vim. Para los mismos se usa la tecla especial<Leader>que es definida por la variablemapleadery que generealmente es el caracter\.

Lectura adicional

• Extending Vim with Python
• Python and vim: Two great tastes that go great together

Por ejemplo, supongamos que estamos editando un programa en C y queremos agregar un ciclo for, simplemente escribimosfor<tab>y esto se expandirá en un típico bucle de C

Inmediatamente después el cursor quedará resaltando la palabra “count” para que podamos reemplazarla por nuestra condición de fin. Un par de tabs más nos llevarán al cuerpo del ciclo donde podremos seguir utlizando snippets comopr<tab>, lo que expandirá en la función printf

snipMate tiene una sintáxis muy sencilla (según dicen, muy similar a la usada por TextMate) lo que permite crear nuestros propios snippets, o mejorar los existentes. La versión actual (0.77) trae una colección de snippets para los siguientes lenguajes: C, Obj-C, C++, Sh, TeX, Java, Ruby, Perl, Python, PHP, JavaScript, y HTML.

El proyecto parace estar bastante activo y la última versión es del 30/03/2009.

Exuberant Ctag, escrito por Darren Hiebert, fue distribuído con Vim hasta la versión 6 de este último. Actualmente es un proyecto independiente. Soporta 34 lenguajes de programación y la posibilidad de utilizar expresiones regulares POSIX para afinar nuestra indexación.

Instalación

El nombre del programa difiere del nombre del paquete y se llamactags-exuberant. Aunque puede ser invocado mediante el link simbólicoctagscreado durante la instalación.

Creación del archivo tags

La forma más sencilla de crear un índice es movernos al directorio donde tenemos los archivos fuente y ejecutar

Esto creará el archivotagsconteniendo el índice de todo el código reconocido. La opción-Rindica que recorra recursivamente los subdirectorios bajo el actual. Podemos reemplazarla por*para evitar que explore subdirectorios.

Luego de generar el índice sólo nos resta indicarle a Vim el archivo de tags a usar. Esto podemos hacerlo desde el modo comando::set tags=~/my_project/tags; o bien definirlo en~/.vimrc. También funciona el ejecutar Vim desde el mismo directorio donde se encuentra el archivo de tags.

Uso desde Vim

• Ctrl-]sobre el nombre de clase o método nos lleva al archivo con su definición.
• Ctrl-Tnos regresa al archivo anterior.
• Ctrl-W ]sobre el nombre de clase o método abre el archivo con su definición en la mitad superior de la ventana.

• hizquierda
• jarriba
• kabajo
• lderecha

Atajos útiles para redimensionar ventanas horizontales (:split)

Atajos útiles para redimensionar ventanas verticales (:vsplit)

VIM en 1440×900 píxeles:

Al abrir archivos de otros SO podemos encontrarnos con^Mal final de cada línea:

Algunos programas no son consistentes en la manera de insertar saltos de línea, entonces te encontrarás con algunas líneas que tienen un salto de línea y un^My algunas que tengan un^My no un salto de línea… con Vim la limpieza se realiza en dos pasos:

1. reemplazar los ^M al final de cada línea:

Usar"C-v C-m"para escribir^M.

2. reemplazar todos los ^M’s que necesitan un salto de línea:

Voila! Archivo limpio.

Mas info en

Next occurrence of a word

If you hit*in command mode and your cursor resides on a word, you are taken to the next occurrence of the word. This is quite nice, if you like to know, where a function is called again.

Find matching brace

VIM 7.0 luckily highlights matching parenthesis, if your cursor resides on a brace, but sometimes you need to quickly jump to that matching brace. You can achieve this by hitting the%sign in command mode.

Repeat the last change

It often occurs, that you need to perform 1 change several times, but not often enough to write a short script or to address the changes with a complex regex. In those cases you can perform the change once, move the cursor to the next place and hit the.(dot) char, in command mode.

Enhanced functionality with external programs

This tip is quite commonly known, but I repeat it here, because it’s really helpful: Although VIM has a huge set of useful functions, it does not have everything. If you don’t find a utility in VIM, you can simply use extern shell tools to perform certain tasks, by using:!<command>in command or visual mode. For example sorting a range of lines can easily be achieved with the following 2 steps: 1. Select the lines to sort in visual mode. 2. Type:!sortand hit return.

Indenting and unindeting

Especially when editing code, it happens often, that you have to indent/unindent a code block. If you use VIM’s auto-indenting features (like used by my .vimrc), VIM can do that job for you, too. Simply select the lines to (un-)indent in visual mode and hit<to unindent 1 level or>to indent 1 more level. This also works (as usual in VIM) with quantifiers like 4> to indent 4 more levels.

Remote file editing

Often you have to quickly edit a file on a remote server. Usually you SSH to that server or mount a remote file system locally, edit the desired file and quit the session again. VIM allows you to do this in 1 step, using SCP. On your shell typevim scp://user@server//path/to/the/fileand VIM will edit the file directly through SCP.

Recover the last visual selection

It often happens, that you selected some text in visual mode, e.g. to perform a regex on it. Occasionally your regex is incorrect and you have to revert the changes or they don’t even happen. What you then need is to re-select the text portion again, which might take quite a long time, if you deal with large files. Hittinggvin command mode, takes that work from you and selects the last visual selection again.

Grep within VIM

Refactoring happens quite often in dynamic projects. “Real” IDE’s offer a lot of tools for this task. While VIM does not, you can enhance your refactoring process a lot with using regex and this tiny tip: To grep through a lot of files for certain strings and then perform changes on each occurrence, vim offers the:grep command.:grep <string> <files>and VIM will store the list of changes for you and :cn will take you to the next occurance of your string. The :grep command utilizes your systems instance of grep, or a custom command stored in the grepprg configuration variable. There is also an internal implementation of grep available in VIM, which you can use with:vimgrep /<regex>/<flags> <files>. The benefit of the external implementation is, that you can easily customize the command to use, e.g. if you need to ignore certain directories while grepping recursively (for instance .svn dirs). You can also get a list of all occurrences of your grep command, using :ll, which is actually a feature of VIMs quickfix tool. Simply select the next entry you want to jump to and hit return in the location list.

Placeholders in commands

Who doesn’t know the case, where you need to open a file in the same directory, the currently edited file resides in? Sure, you can simply use:split <file>, but if your current working directory is far away from the edited file, you possibly will have to type a long long path again. VIM offers you, to replace certain placeholders in commands automatically, most important:%is replaced with the actual file name (so,:split %will open a new window editing the current file – I know that just:splitdoes the same, but it’s a nice example to show what%does). So, how does this help in the described case? The replacement text can also be modified by certain modifiers, like:h, which removes the last portion of a file path (the file name). For instance if you currently edit/home/dotxp/dev/ez/ezc/trunk/ConsoleTools/src/table.phpand want to split to/home/dotxp/dev/ez/ezc/trunk/ConsoleTools/src/output.phpyou can do this easily using:split %:h/output.php. Another useful modifier is:s?<regex>?<replacement>?, which obviously uses a regex to modify the given path. Unlikely the usual replacement command:s, you need to specify the global modifiergbefore the regex instead of doing so after it. A short example::split %:gs?trunk?/releases/1.1/?will split to the file table.php of ConsoleTools release 1.1.

Emergency help

Appending an exclamation mark (!) to a command (:!) forces VIM to execute the command, even if it might be dangerous to do so. Quite useless, but still funny is:help!.

Rewrap my text

I reached a stage, where do not only edit my source code using VIM, but mainly every other kind of text data (like documentation, todo lists, etc.), because I’m simply so used to its features. When editing plain text, the automatic wrap features (e.g. textwidth) of VIM are quite useful. In some cases, you might edit text later and therefore destroy a nicely wrapped text block. VIM can easily re-perform the wrapping for you: Select the text block in visual mode (using <SHIFT>+<v>) and hit<g><q>.

Uppercase letters

There are a lot of helpful shortcuts on your keyboard, which you might not know about. Every VIM user should now, that<d>deletes something,<y>(yank) copies something and<c>changes something (delete and start inserting) in VIM (all in command mode). Furthermore, most people know that e.g.<d><w>deletes the next word, etc.. What I did not know for a long time was, that<D>, <Y&gt; and<C>are shortcuts to perform the desired operation until the end of the current line. For instance, simply type<C>to change the contents of the current line from your cursors position on.