autoload/flake8.vim

   1 "
   2 " Python filetype plugin for running flake8
   3 " Language:     Python (ft=python)
   4 " Maintainer:   Vincent Driessen <vincent@3rdcloud.com>
   5 " Version:      Vim 7 (may work with lower Vim versions, but not tested)
   6 " URL:          http://github.com/nvie/vim-flake8
   7
   8 let s:save_cpo = &cpo
   9 set cpo&vim
  10
  11 "" ** external ** {{{
  12
  13 function! flake8#Flake8()
  14     call s:Flake8()
  15     call s:Warnings()
  16 endfunction
  17
  18 function! flake8#Flake8UnplaceMarkers()
  19     call s:UnplaceMarkers()
  20     call s:Warnings()
  21 endfunction
  22
  23 "" }}}
  24
  25 "" ** internal ** {{{
  26
  27 "" warnings
  28
  29 let s:displayed_warnings = 0
  30 function s:Warnings()
  31   if !s:displayed_warnings
  32     let l:show_website_url = 0
  33
  34     let l:msg = "has been deprecated in favour of flake8 config files"
  35     for setting_name in ['g:flake8_ignore', 'g:flake8_builtins', 'g:flake8_max_line_length', 'g:flake8_max_complexity']
  36       if exists(setting_name)
  37         echohl WarningMsg | echom setting_name l:msg | echohl None
  38         let l:show_website_url = 1
  39       endif
  40     endfor
  41
  42     if l:show_website_url
  43       let l:url = "http://flake8.readthedocs.org/en/latest/config.html"
  44       echohl WarningMsg | echom l:url | echohl None
  45     endif
  46     let s:displayed_warnings = 1
  47   endif
  48 endfunction
  49
  50 "" config
  51
  52 function! s:DeclareOption(name, globalPrefix, default)  " {{{
  53     if !exists('g:'.a:name)
  54         if a:default != ''
  55             execute 'let s:'.a:name.'='.a:default
  56         else
  57             execute 'let s:'.a:name.'=""'
  58         endif
  59     else
  60         execute 'let l:global="g:".a:name'
  61         if l:global != ''
  62             execute 'let s:'.a:name.'="'.a:globalPrefix.'".g:'.a:name
  63         else
  64             execute 'let s:'.a:name.'=""'
  65         endif
  66     endif
  67 endfunction  " }}}
  68
  69 function! s:Setup()  " {{{
  70     "" read options
  71
  72     " flake8 command
  73     call s:DeclareOption('flake8_cmd', '', '"flake8"')
  74     " quickfix
  75     call s:DeclareOption('flake8_quickfix_location', '', '"belowright"')
  76     call s:DeclareOption('flake8_quickfix_height', '', 5)
  77     call s:DeclareOption('flake8_show_quickfix', '', 1)
  78     " markers to show
  79     call s:DeclareOption('flake8_show_in_gutter', '',   0)
  80     call s:DeclareOption('flake8_show_in_file', '',   0)
  81     call s:DeclareOption('flake8_max_markers', '', 500)
  82     " marker signs
  83     call s:DeclareOption('flake8_error_marker', '', '"E>"')
  84     call s:DeclareOption('flake8_warning_marker', '', '"W>"')
  85     call s:DeclareOption('flake8_pyflake_marker', '', '"F>"')
  86     call s:DeclareOption('flake8_complexity_marker', '', '"C>"')
  87     call s:DeclareOption('flake8_naming_marker', '', '"N>"')
  88
  89     "" setup markerdata
  90
  91     if !exists('s:markerdata')
  92         let s:markerdata = {}
  93         let s:markerdata['E'] = {'name': 'Flake8_Error'}
  94         let s:markerdata['W'] = {'name': 'Flake8_Warning'}
  95         let s:markerdata['F'] = {'name': 'Flake8_PyFlake'}
  96         let s:markerdata['C'] = {'name': 'Flake8_Complexity'}
  97         let s:markerdata['N'] = {'name': 'Flake8_Nameing'}
  98     endif
  99     let s:markerdata['E'].marker = s:flake8_error_marker
 100     let s:markerdata['W'].marker = s:flake8_warning_marker
 101     let s:markerdata['F'].marker = s:flake8_pyflake_marker
 102     let s:markerdata['C'].marker = s:flake8_complexity_marker
 103     let s:markerdata['N'].marker = s:flake8_naming_marker
 104 endfunction  " }}}
 105
 106 "" do flake8
 107
 108 function! s:Flake8()  " {{{
 109     " read config
 110     call s:Setup()
 111
 112     let l:executable = split(s:flake8_cmd)[0]
 113
 114     if !executable(l:executable)
 115         echoerr "File " . l:executable . " not found. Please install it first."
 116         return
 117     endif
 118
 119     " clear old
 120     call s:UnplaceMarkers()
 121     let s:matchids = []
 122     let s:signids  = []
 123
 124     " store old grep settings (to restore later)
 125     let l:old_gfm=&grepformat
 126     let l:old_gp=&grepprg
 127     let l:old_shellpipe=&shellpipe
 128
 129     " write any changes before continuing
 130     if &readonly == 0
 131         update
 132     endif
 133
 134     set lazyredraw   " delay redrawing
 135
 136     " set shellpipe to > instead of tee (suppressing output)
 137     set shellpipe=>
 138
 139     " perform the grep itself
 140     let &grepformat="%f:%l:%c: %m\,%f:%l: %m"
 141     let &grepprg=s:flake8_cmd
 142     silent! grep! "%"
 143     " close any existing cwindows,
 144     " placed after 'grep' in case quickfix is open on autocmd QuickFixCmdPost
 145     cclose
 146
 147     " restore grep settings
 148     let &grepformat=l:old_gfm
 149     let &grepprg=l:old_gp
 150     let &shellpipe=l:old_shellpipe
 151
 152     " process results
 153     let l:results=getqflist()
 154     let l:has_results=results != []
 155     if l:has_results
 156         " markers
 157         if !s:flake8_show_in_gutter == 0 || !s:flake8_show_in_file == 0
 158             call s:PlaceMarkers(l:results)
 159         endif
 160         " quickfix
 161         if !s:flake8_show_quickfix == 0
 162             " open cwindow
 163             execute s:flake8_quickfix_location." copen".s:flake8_quickfix_height
 164             setlocal wrap
 165             nnoremap <buffer> <silent> c :cclose<CR>
 166             nnoremap <buffer> <silent> q :cclose<CR>
 167         endif
 168     endif
 169
 170     set nolazyredraw
 171     redraw!
 172
 173     " Show status
 174     if l:has_results == 0
 175         echon "Flake8 check OK"
 176     else
 177         echon "Flake8 found issues"
 178     endif
 179 endfunction  " }}}
 180
 181 "" markers
 182
 183 function! s:PlaceMarkers(results)  " {{{
 184     " in gutter?
 185     if !s:flake8_show_in_gutter == 0
 186         " define signs
 187         for val in values(s:markerdata)
 188             if val.marker != ''
 189                 execute "sign define ".val.name." text=".val.marker." texthl=".val.name
 190             endif
 191         endfor
 192     endif
 193
 194     " place
 195     let l:index0 = 100
 196     let l:index  = l:index0
 197     for result in a:results
 198         if l:index >= (s:flake8_max_markers+l:index0)
 199             break
 200         endif
 201         let l:type = strpart(result.text, 0, 1)
 202         if has_key(s:markerdata, l:type) && s:markerdata[l:type].marker != ''
 203             " file markers
 204             if !s:flake8_show_in_file == 0
 205                 if !has_key(s:markerdata[l:type], 'matchstr')
 206                     let s:markerdata[l:type].matchstr = '\%('
 207                 else
 208                     let s:markerdata[l:type].matchstr .= '\|'
 209                 endif
 210                 let s:markerdata[l:type].matchstr .= '\%'.result.lnum.'l\%'.result.col.'c'
 211             endif
 212             " gutter markers
 213             if !s:flake8_show_in_gutter == 0
 214                 execute ":sign place ".index." name=".s:markerdata[l:type].name
 215                             \ . " line=".result.lnum." file=".expand("%:p")
 216                 let s:signids += [l:index]
 217             endif
 218             let l:index += 1
 219         endif
 220     endfor
 221
 222     " in file?
 223     if !s:flake8_show_in_file == 0
 224         for l:val in values(s:markerdata)
 225             if l:val.marker != '' && has_key(l:val, 'matchstr')
 226                 let l:val.matchid = matchadd(l:val.name, l:val.matchstr.'\)')
 227             endif
 228         endfor
 229     endif
 230 endfunction  " }}}
 231
 232 function! s:UnplaceMarkers()  " {{{
 233     " gutter markers
 234     if exists('s:signids')
 235         for i in s:signids
 236             execute ":sign unplace ".i
 237         endfor
 238         unlet s:signids
 239     endif
 240     " file markers
 241     for l:val in values(s:markerdata)
 242         if has_key(l:val, 'matchid')
 243             call matchdelete(l:val.matchid)
 244             unlet l:val.matchid
 245             unlet l:val.matchstr
 246         endif
 247     endfor
 248 endfunction  " }}}
 249
 250 "" }}}
 251
 252 let &cpo = s:save_cpo
 253 unlet s:save_cpo
 254