|logo| Python-mode, Python in VIM
#################################
Python-mode is a vim plugin that allows you to use the pylint_, rope_, pydoc_, pyflakes_, pep8_, mccabe_ libraries in vim to provide
features like python code looking for bugs, refactoring and some other useful things.
This plugin allow you create python code in vim very easily.
There is no need to install the pylint_, rope_ or any used python library on your system.
- Python objects and motion (]], 3[[, ]]M, vaC, viM, daC, ciM, ...)
- Folding of python code
- Virtualenv support
- Highlight syntax errors
- Highlight and auto fix unused imports
- Many linters (pylint_, pyflakes_, ...) that can be run simultaneously
- Strong code completion
- Code refactoring
- Python documentation
- Run python code
- Go to definition
- Powerful customization
- And more, more ...
See (very old) screencast here: http://t.co/3b0bzeXA (sorry for quality, this is my first screencast)
Another old presentation here: http://www.youtube.com/watch?v=YhqsjUUHj6g
.. contents::
Requirements
============
- VIM >= 7.0 with python support
(also ``--with-features=big`` if you want use g:pymode_lint_signs)
How to install
==============
Using pathogen_ (recomended)
----------------------------
::
% cd ~/.vim
% mkdir -p bundle && cd bundle
% git clone git://github.com/klen/python-mode.git
- Enable pathogen_ in your ``~/.vimrc``: ::
" Pathogen load
filetype off
call pathogen#infect()
call pathogen#helptags()
filetype plugin indent on
syntax on
Manually
--------
::
% git clone git://github.com/klen/python-mode.git
% cd python-mode
% cp -R * ~/.vim
Then rebuild **helptags** in vim::
:helptags ~/.vim/doc/
.. note:: **filetype-plugin** (``:help filetype-plugin-on``) and **filetype-indent** (``:help filetype-indent-on``)
must be enabled for use python-mode.
Troubleshooting
===============
If your python-mode dont work, open any python file and type command: ::
:call pymode#troubleshooting#Test()
And fix warnings or copy output and send it to me (ex. with github issue).
Settings
========
.. note:: Also you can see vim help. ``:help PythonModeOptions``
To change this settings, edit your ``~/.vimrc``: ::
" Disable pylint checking every save
let g:pymode_lint_write = 0
" Set key 'R' for run python code
let g:pymode_run_key = 'R'
Loading the Plugin
------------------
Default values: ::
" Load the whole plugin
let g:pymode = 1
Python 3 support
----------------
.. note:: Requires vim to be compiled with ``python3`` support. You can verify it with
``:echo has('python3')``
Currently only rope_ is supported under python 3.
Default values: ::
" Enables python3 support
let g:pymode_py3k = 0
Show documentation
------------------
Default values: ::
" Load show documentation plugin
let g:pymode_doc = 1
" Key for show python documentation
let g:pymode_doc_key = 'K'
Run python code
---------------
Default values: ::
" Load run code plugin
let g:pymode_run = 1
" Key for run python code
let g:pymode_run_key = 'r'
Code checking
-------------
Default values: ::
" Load pylint code plugin
let g:pymode_lint = 1
" Switch pylint, pyflakes, pep8, mccabe code-checkers
" Can have multiply values "pep8,pyflakes,mcccabe"
" Choices are pyflakes, pep8, mccabe, pylint, pep257
let g:pymode_lint_checker = "pyflakes,pep8,mccabe"
" Skip errors and warnings
" E.g. "E501,W002", "E2,W" (Skip all Warnings and Errors startswith E2) and etc
let g:pymode_lint_ignore = "E501"
" Select errors and warnings
" E.g. "E4,W"
let g:pymode_lint_select = ""
" Run linter on the fly
let g:pymode_lint_onfly = 0
" Pylint configuration file
" If file not found use 'pylintrc' from python-mode plugin directory
let g:pymode_lint_config = "$HOME/.pylintrc"
" Check code every save
let g:pymode_lint_write = 1
" Auto open cwindow if errors be finded
let g:pymode_lint_cwindow = 1
" Show error message if cursor placed at the error line
let g:pymode_lint_message = 1
" Auto jump on first error
let g:pymode_lint_jump = 0
" Hold cursor in current window
" when quickfix is open
let g:pymode_lint_hold = 0
" Place error signs
let g:pymode_lint_signs = 1
" Maximum allowed mccabe complexity
let g:pymode_lint_mccabe_complexity = 8
" Minimal height of pylint error window
let g:pymode_lint_minheight = 3
" Maximal height of pylint error window
let g:pymode_lint_maxheight = 6
.. note::
Pylint options (ex. disable messages) may be defined in ``$HOME/pylint.rc``
See pylint documentation: http://pylint-messages.wikidot.com/all-codes
Rope refactoring library
------------------------
Default values: ::
" Load rope plugin
let g:pymode_rope = 1
" Map keys for autocompletion
let g:pymode_rope_autocomplete_map = ''
" Auto create and open ropeproject
let g:pymode_rope_auto_project = 1
" Enable autoimport
let g:pymode_rope_enable_autoimport = 1
" Auto generate global cache
let g:pymode_rope_autoimport_generate = 1
let g:pymode_rope_autoimport_underlineds = 0
let g:pymode_rope_codeassist_maxfixes = 10
let g:pymode_rope_sorted_completions = 1
let g:pymode_rope_extended_complete = 1
let g:pymode_rope_autoimport_modules = ["os","shutil","datetime"]
let g:pymode_rope_confirm_saving = 1
let g:pymode_rope_global_prefix = "p"
let g:pymode_rope_local_prefix = "r"
let g:pymode_rope_vim_completion = 1
let g:pymode_rope_guess_project = 1
let g:pymode_rope_goto_def_newwin = ""
let g:pymode_rope_always_show_complete_menu = 0
Automatically folding of python code
--------------------------------------
Default values: ::
" Enable python folding
let g:pymode_folding = 1
Vim python motions and operators
--------------------------------
Default values: ::
" Enable python objects and motion
let g:pymode_motion = 1
Virtualenv support
------------------
Default values: ::
" Auto fix vim python paths if virtualenv enabled
let g:pymode_virtualenv = 1
Other stuff
-----------
Default values: ::
" Additional python paths
let g:pymode_paths = []
" Load breakpoints plugin
let g:pymode_breakpoint = 1
" Key for set/unset breakpoint
let g:pymode_breakpoint_key = 'b'
" Autoremove unused whitespaces
let g:pymode_utils_whitespaces = 1
" Enable pymode indentation
let g:pymode_indent = 1
" Set default pymode python options
let g:pymode_options = 1
Syntax highlight
----------------
Default values: ::
" Enable pymode's custom syntax highlighting
let g:pymode_syntax = 1
" Enable all python highlightings
let g:pymode_syntax_all = 1
" Highlight "print" as function
let g:pymode_syntax_print_as_function = 0
" Highlight indentation errors
let g:pymode_syntax_indent_errors = g:pymode_syntax_all
" Highlight trailing spaces
let g:pymode_syntax_space_errors = g:pymode_syntax_all
" Highlight string formatting
let g:pymode_syntax_string_formatting = g:pymode_syntax_all
" Highlight str.format syntax
let g:pymode_syntax_string_format = g:pymode_syntax_all
" Highlight string.Template syntax
let g:pymode_syntax_string_templates = g:pymode_syntax_all
" Highlight doc-tests
let g:pymode_syntax_doctests = g:pymode_syntax_all
" Highlight builtin objects (__doc__, self, etc)
let g:pymode_syntax_builtin_objs = g:pymode_syntax_all
" Highlight builtin functions
let g:pymode_syntax_builtin_funcs = g:pymode_syntax_all
" Highlight exceptions
let g:pymode_syntax_highlight_exceptions = g:pymode_syntax_all
" Highlight equal operator
let g:pymode_syntax_highlight_equal_operator = g:pymode_syntax_all
" Highlight stars operator
let g:pymode_syntax_highlight_stars_operator = g:pymode_syntax_all
" Highlight `self`
let g:pymode_syntax_highlight_self = g:pymode_syntax_all
" For fast machines
let g:pymode_syntax_slow_sync = 0
Default keys
============
.. note:: Also you can see vim help ``:help PythonModeKeys``
============== =============
Keys Command
============== =============
**K** Show python docs (g:pymode_doc enabled)
-------------- -------------
**** Rope autocomplete (g:pymode_rope enabled)
-------------- -------------
**g** Rope goto definition (g:pymode_rope enabled)
-------------- -------------
**d** Rope show documentation (g:pymode_rope enabled)
-------------- -------------
**f** Rope find occurrences (g:pymode_rope enabled)
-------------- -------------
**r** Run python (g:pymode_run enabled)
-------------- -------------
**b** Set, unset breakpoint (g:pymode_breakpoint enabled)
-------------- -------------
[[ Jump on previous class or function (normal, visual, operator modes)
-------------- -------------
]] Jump on next class or function (normal, visual, operator modes)
-------------- -------------
[M Jump on previous class or method (normal, visual, operator modes)
-------------- -------------
]M Jump on next class or method (normal, visual, operator modes)
-------------- -------------
aC C Select a class. Ex: vaC, daC, dC, yaC, yC, caC, cC (normal, operator modes)
-------------- -------------
iC Select inner class. Ex: viC, diC, yiC, ciC (normal, operator modes)
-------------- -------------
aM M Select a function or method. Ex: vaM, daM, dM, yaM, yM, caM, cM (normal, operator modes)
-------------- -------------
iM Select inner function or method. Ex: viM, diM, yiM, ciM (normal, operator modes)
============== =============
.. note:: See also ``:help ropevim.txt``
Commands
========
.. note:: Also you can see vim help ``:help PythonModeCommands``
==================== =============
Command Description
==================== =============
:Pydoc Show python documentation
-------------------- -------------
PyLintToggle Enable, disable pylint
-------------------- -------------
PyLintCheckerToggle Toggle code checker (pylint, pyflakes)
-------------------- -------------
PyLint Check current buffer
-------------------- -------------
PyLintAuto Automatic fix PEP8 errors
-------------------- -------------
Pyrun Run current buffer in python
==================== =============
.. note:: See also ``:help ropevim.txt``
F.A.Q.
======
Rope completion is very slow
----------------------------
To work rope_ creates a service directory: ``.ropeproject``.
If ``g:pymode_rope_guess_project`` set (by default) and ``.ropeproject`` in current dir not found, rope scan ``.ropeproject`` on every dir in parent path.
If rope finded ``.ropeproject`` in parent dirs, rope set project for all child dir and scan may be slow for many dirs and files.
Solutions:
- Disable ``g:pymode_rope_guess_project`` to make rope always create ``.ropeproject`` in current dir.
- Delete ``.ropeproject`` from dip parent dir to make rope create ``.ropeproject`` in current dir.
- Press ``po`` or ``:RopeOpenProject`` to make force rope create ``.ropeproject`` in current dir.
Pylint check is very slow
-------------------------
In some projects pylint_ may check slowly, because it also scan imported modules if posible.
Try use pyflakes_, see ``:h 'pymode_lint_checker'``.
.. note:: You may ``set exrc`` and ``set secure`` in your ``vimrc`` for auto set custom settings from ``.vimrc`` from your projects directories.
Example: On Flask projects I automaticly set ``g:pymode_lint_checker = "pyflakes"``, on django ``g:pymode_lint_cheker = "pylint"``
OSX cannot import urandom
-------------------------
See: https://groups.google.com/forum/?fromgroups=#!topic/vim_dev/2NXKF6kDONo
The sequence of commands that fixed this: ::
brew unlink python
brew unlink macvim
brew remove macvim
brew install -v --force macvim
brew link macvim
brew link python
Bugtracker
===========
If you have any suggestions, bug reports or
annoyances please report them to the issue tracker
at https://github.com/klen/python-mode/issues
Contributing
============
See in the `AUTHORS` file.
Development of pylint-mode happens at github: https://github.com/klen/python-mode
Copyright
=========
Copyright © 2013 Kirill Klenov (klen_)
**Rope**
Copyright (C) 2006-2010 Ali Gholami Rudi
Copyright (C) 2009-2010 Anton Gritsay
**Pylint**
Copyright (C) 2003-2011 LOGILAB S.A. (Paris, FRANCE).
http://www.logilab.fr/
**Pyflakes**:
Copyright (c) 2005 Divmod, Inc.
http://www.divmod.com/
**PEP8**
Copyright (C) 2006 Johann C. Rocholl
http://github.com/jcrocholl/pep8
**autopep8**:
Copyright (c) 2012 hhatto
https://github.com/hhatto/autopep8
**Python syntax for vim**
Copyright (c) 2010 Dmitry Vasiliev
http://www.hlabs.spb.ru/vim/python.vim
**PEP8 VIM indentation**
Copyright (c) 2012 Hynek Schlawack
http://github.com/hynek/vim-python-pep8-indent
License
=======
Licensed under a `GNU lesser general public license`_.
If you like this plugin, you can send me postcard :)
My address is here: "Russia, 143401, Krasnogorsk, Shkolnaya 1-19" to "Kirill Klenov".
**Thanks for support!**
.. _GNU lesser general public license: http://www.gnu.org/copyleft/lesser.html
.. _klen: http://klen.github.com/
.. _pylint: http://www.logilab.org/857
.. _pyflakes: http://pypi.python.org/pypi/pyflakes
.. _rope: http://rope.sourceforge.net/
.. _pydoc: http://docs.python.org/library/pydoc.html
.. _pathogen: https://github.com/tpope/vim-pathogen
.. _pep8: http://pypi.python.org/pypi/pep8
.. _mccabe: http://en.wikipedia.org/wiki/Cyclomatic_complexity
.. |logo| image:: https://raw.github.com/klen/python-mode/develop/logo.png