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:https://t.co/3b0bzeXA (sorry for quality, this is my first screencast) Another old presentation here: http:https://www.youtube.com/watch?v=YhqsjUUHj6g

• VIM >= 7.0 with python support (also --with-features=big if you want use g:pymode_lint_signs)

% cd ~/.vim
% mkdir -p bundle && cd bundle
% git clone git:https://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
  

% git clone git:https://github.com/klen/python-mode.git
% cd python-mode
% cp -R * ~/.vim

Then rebuild helptags in vim:

:helptags ~/.vim/doc/

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).

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'

Default values:

" Load the whole plugin
let g:pymode = 1

Default values:

" Load show documentation plugin
let g:pymode_doc = 1

" Key for show python documentation
let g:pymode_doc_key = 'K'

Default values:

" Load run code plugin
let g:pymode_run = 1

" Key for run python code
let g:pymode_run_key = '<leader>r'

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

Default values:

" Load rope plugin
let g:pymode_rope = 1

" Map keys for autocompletion
let g:pymode_rope_autocomplete_map = '<C-Space>'

" 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 = "<C-x>p"

let g:pymode_rope_local_prefix = "<C-c>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

Default values:

" Enable python folding
let g:pymode_folding = 1

Default values:

" Enable python objects and motion
let g:pymode_motion = 1

Default values:

" Auto fix vim python paths if virtualenv enabled
let g:pymode_virtualenv = 1

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 = '<leader>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

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

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 <C-x>po or :RopeOpenProject to make force rope create .ropeproject in current dir.

In some projects pylint may check slowly, because it also scan imported modules if posible. Try use pyflakes, see :h 'pymode_lint_checker'.

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

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/python-mode/issues

See in the AUTHORS file.

Development of pylint-mode happens at github: https://github.com/klen/python-mode

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:https://www.logilab.fr/

Pyflakes:

Copyright (c) 2005 Divmod, Inc. http:https://www.divmod.com/

PEP8

Copyright (C) 2006 Johann C. Rocholl <[email protected]> http:https://github.com/jcrocholl/pep8

autopep8:

Copyright (c) 2012 hhatto <[email protected]> https://github.com/hhatto/autopep8

Python syntax for vim

Copyright (c) 2010 Dmitry Vasiliev http:https://www.hlabs.spb.ru/vim/python.vim

PEP8 VIM indentation

Copyright (c) 2012 Hynek Schlawack <[email protected]> http:https://github.com/hynek/vim-python-pep8-indent

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!