Python Mode in Vim: Plugin or Built-In?

Python mode in Vim is not a single official plugin, but a collection of community-built plugins and built-in features that together provide Python-specific editing, syntax checking, and code completion. The most popular of these plugins is python-mode (often called pymode), which bundles many Python tools into one Vim plugin. This article explains what Python mode means in Vim, how to get it, what it does, and how it compares to other options.

What Is Python Mode in Vim?

Vim is a highly customizable text editor, and “Python mode” usually refers to a set of enhancements that make editing Python code more productive. These enhancements can include:

Syntax highlighting – colorizing keywords, strings, comments, and built-in functions.
Indentation and folding – automatic indentation based on Python’s PEP 8 style and code folding by indentation level.
Code completion – suggesting variable names, function names, and module attributes.
Linting and static analysis – checking code for errors or style issues without running it.
Running code – executing the current file or selection from within Vim.
Documentation lookup – viewing docstrings for functions and classes.

These features can be provided by a single plugin like python-mode, or by a combination of smaller plugins and Vim’s built-in options.

Built-in Python Support in Vim

Modern Vim (8.0 and later) and Neovim include basic Python support out of the box. For example, Vim has a built-in syntax file for Python that provides highlighting, and it can auto-indent Python code if you set the filetype and indentexpr options. You can enable these with simple commands in your .vimrc:

filetype plugin indent on
syntax on
set autoindent
set expandtab
set tabstop=4
set shiftwidth=4

These settings give you proper indentation and basic highlighting, but they do not provide code completion, linting, or running code. For those features, you need a plugin or a plugin manager.

What Does the python-mode Plugin Do?

The python-mode plugin (available on GitHub and via most plugin managers) is a comprehensive plugin that aims to turn Vim into a full Python IDE. It includes:

Syntax checking using pyflakes, pylint, or pep8.
Code completion using jedi (a Python autocompletion library).
Go to definition and show documentation via jedi.
Run Python with :Python or :PyRun.
Rope-based refactoring (optional) for renaming, extracting methods, etc.
Virtualenv support – automatically detects the active virtual environment.

To install it with a plugin manager like vim-plug, you would add to your .vimrc:

Plug 'python-mode/python-mode', { 'for': 'python' }

Then run :PlugInstall. After installation, many features work immediately, but you may need to configure paths to your Python interpreter and linters.

How to Choose Between python-mode and Other Plugins

python-mode is a “batteries included” plugin, but it is not the only way to get Python support in Vim. Many users prefer to combine smaller plugins to have more control. Common alternatives include:

jedi-vim – provides completion, go-to-definition, and documentation using jedi.
ale (Asynchronous Lint Engine) – runs linters like flake8 or pylint asynchronously.
coc.nvim – a language server client that can use the Python language server (pyls) for completion, diagnostics, and more.
vim-python-pep8-indent – improves indentation specifically for Python.

If you want a single plugin that does everything, python-mode is convenient. If you prefer to build your own setup, you might choose jedi-vim for completion and ale for linting. The choice depends on whether you want an integrated experience or a modular one.

Common Problems and Solutions

Users often encounter a few recurring issues when using python-mode:

Linter not found – python-mode expects pyflakes, pylint, or pep8 to be installed. If you get “linter not found” errors, install them via pip: pip install pyflakes pylint pep8.
Completion not working – jedi needs to be installed and the g:python_mode_use_jedi option must be enabled (it is by default). Also make sure your Vim has Python support (:echo has('python3') should return 1).
Slow performance – running linting on every save can be slow. You can set g:pymode_lint_on_write = 1 to lint only when saving, or increase the interval.
Conflicts with other plugins – python-mode may override keybindings. You can disable specific features by setting g:pymode_<feature> = 0, for example g:pymode_rope = 0 to disable rope.

Python Mode in Neovim

Neovim, a fork of Vim, also supports Python plugins. In fact, many modern Python plugins are developed with Neovim in mind. Neovim has built-in LSP (Language Server Protocol) support, so you can use a Python language server like pylsp or pyright to get completion, diagnostics, and more. This is a different approach from python-mode, but it achieves similar results. You can still use python-mode in Neovim, but you may prefer the native LSP for performance and integration.

Frequently Asked Questions

Is python-mode still maintained?

As of 2024, the python-mode plugin has had limited recent activity, but it still works for many users. However, the Python ecosystem and Vim/Neovim have evolved, and some users report issues with newer Python versions. If you encounter problems, consider switching to a more actively maintained alternative like coc.nvim or jedi-vim.

Do I need to install Python to use python-mode?

Yes, you need a Python interpreter installed on your system. python-mode uses Python for linting, completion, and running code. Vim itself does not need to be compiled with Python support for python-mode to work, but many features require it. Check with :python3 --version inside Vim to see if Python3 is available.

Can I use python-mode with virtual environments?

Yes, python-mode automatically detects the active virtual environment if you activate it before starting Vim. It will use the virtual environment’s Python and installed packages for linting and completion. If you switch environments while Vim is running, you may need to restart Vim or use the :PyRestart command.

What is the difference between python-mode and using a language server?

python-mode uses libraries like jedi and rope directly, while a language server (like pylsp) communicates with Vim via the Language Server Protocol. Language servers are often more powerful and support multiple editors, but they require additional setup. python-mode is simpler to install and works out of the box, but may be less feature-rich than a full LSP setup.

Does python-mode work with Vim 9?

Vim 9 introduced significant changes, and some older plugins may not be fully compatible. python-mode has not been updated for Vim 9 specifically, but many users report it works fine. If you encounter issues, check the plugin’s issue tracker or consider using a more modern alternative.

Final Thoughts

Python mode in Vim is not a single official plugin but a concept that can be implemented in various ways. The python-mode plugin offers a convenient all-in-one solution, while other plugins and built-in features provide more modular approaches. Choose what fits your workflow, and don’t be afraid to mix and match. Vim’s flexibility means you can create a Python editing environment that suits you perfectly.

Method: the standard formula for this calculation, rounded as each result states. See how the calculators work or report an error.

More cards in this drawer

The whole Numbers and Powers drawer →