2016-10-27 06:24:32 +00:00
|
|
|
" Author: keith <k@keith.so>
|
|
|
|
" Description: pylint for python files
|
|
|
|
|
2018-04-17 12:30:30 +00:00
|
|
|
call ale#Set('python_pylint_executable', 'pylint')
|
|
|
|
call ale#Set('python_pylint_options', '')
|
|
|
|
call ale#Set('python_pylint_use_global', get(g:, 'ale_use_global_executables', 0))
|
|
|
|
call ale#Set('python_pylint_change_directory', 1)
|
Add python_[linter]_auto_pipenv options for python linters (fixes #1656)
When set to true, and the buffer is currently inside a pipenv,
GetExecutable will return "pipenv", which will trigger the existing
functionality to append the correct pipenv arguments to run each linter.
Defaults to false.
I was going to implement ale#python#PipenvPresent by invoking
`pipenv --venv` or `pipenv --where`, but it seemed to be abominably
slow, even to the point where the test suite wasn't even finishing
("Tried to run tests 3 times"). The diff is:
diff --git a/autoload/ale/python.vim b/autoload/ale/python.vim
index 7baae079..8c100d41 100644
--- a/autoload/ale/python.vim
+++ b/autoload/ale/python.vim
@@ -106,5 +106,9 @@ endfunction
" Detects whether a pipenv environment is present.
function! ale#python#PipenvPresent(buffer) abort
- return findfile('Pipfile.lock', expand('#' . a:buffer . ':p:h') . ';') isnot# ''
+ let l:cd_string = ale#path#BufferCdString(a:buffer)
+ let l:output = systemlist(l:cd_string . 'pipenv --where')[0]
+ " `pipenv --where` returns the path to the dir containing the Pipfile
+ " if in a pipenv, or some error text otherwise.
+ return strpart(l:output, 0, 18) !=# "No Pipfile present"
endfunction
Using vim's `findfile` is much faster, behaves correctly in the majority
of situations, and also works reliably when the `pipenv` command doesn't
exist.
2018-07-12 03:02:23 +00:00
|
|
|
call ale#Set('python_pylint_auto_pipenv', 0)
|
2017-05-06 18:11:43 +00:00
|
|
|
|
2017-01-03 10:52:58 +00:00
|
|
|
function! ale_linters#python#pylint#GetExecutable(buffer) abort
|
2018-09-16 01:38:26 +00:00
|
|
|
if (ale#Var(a:buffer, 'python_auto_pipenv') || ale#Var(a:buffer, 'python_pylint_auto_pipenv'))
|
|
|
|
\ && ale#python#PipenvPresent(a:buffer)
|
Add python_[linter]_auto_pipenv options for python linters (fixes #1656)
When set to true, and the buffer is currently inside a pipenv,
GetExecutable will return "pipenv", which will trigger the existing
functionality to append the correct pipenv arguments to run each linter.
Defaults to false.
I was going to implement ale#python#PipenvPresent by invoking
`pipenv --venv` or `pipenv --where`, but it seemed to be abominably
slow, even to the point where the test suite wasn't even finishing
("Tried to run tests 3 times"). The diff is:
diff --git a/autoload/ale/python.vim b/autoload/ale/python.vim
index 7baae079..8c100d41 100644
--- a/autoload/ale/python.vim
+++ b/autoload/ale/python.vim
@@ -106,5 +106,9 @@ endfunction
" Detects whether a pipenv environment is present.
function! ale#python#PipenvPresent(buffer) abort
- return findfile('Pipfile.lock', expand('#' . a:buffer . ':p:h') . ';') isnot# ''
+ let l:cd_string = ale#path#BufferCdString(a:buffer)
+ let l:output = systemlist(l:cd_string . 'pipenv --where')[0]
+ " `pipenv --where` returns the path to the dir containing the Pipfile
+ " if in a pipenv, or some error text otherwise.
+ return strpart(l:output, 0, 18) !=# "No Pipfile present"
endfunction
Using vim's `findfile` is much faster, behaves correctly in the majority
of situations, and also works reliably when the `pipenv` command doesn't
exist.
2018-07-12 03:02:23 +00:00
|
|
|
return 'pipenv'
|
|
|
|
endif
|
|
|
|
|
2017-07-05 12:07:55 +00:00
|
|
|
return ale#python#FindExecutable(a:buffer, 'python_pylint', ['pylint'])
|
2017-01-03 10:52:58 +00:00
|
|
|
endfunction
|
|
|
|
|
|
|
|
function! ale_linters#python#pylint#GetCommand(buffer) abort
|
2018-04-17 12:30:30 +00:00
|
|
|
let l:cd_string = ale#Var(a:buffer, 'python_pylint_change_directory')
|
|
|
|
\ ? ale#path#BufferCdString(a:buffer)
|
|
|
|
\ : ''
|
|
|
|
|
2018-06-05 02:43:02 +00:00
|
|
|
let l:executable = ale_linters#python#pylint#GetExecutable(a:buffer)
|
|
|
|
|
|
|
|
let l:exec_args = l:executable =~? 'pipenv$'
|
|
|
|
\ ? ' run pylint'
|
|
|
|
\ : ''
|
|
|
|
|
2018-04-17 12:30:30 +00:00
|
|
|
return l:cd_string
|
2018-06-05 02:43:02 +00:00
|
|
|
\ . ale#Escape(l:executable) . l:exec_args
|
2017-04-16 00:24:08 +00:00
|
|
|
\ . ' ' . ale#Var(a:buffer, 'python_pylint_options')
|
2017-02-25 18:23:36 +00:00
|
|
|
\ . ' --output-format text --msg-template="{path}:{line}:{column}: {msg_id} ({symbol}) {msg}" --reports n'
|
2017-05-06 18:30:41 +00:00
|
|
|
\ . ' %s'
|
2017-01-03 10:52:58 +00:00
|
|
|
endfunction
|
|
|
|
|
2017-05-25 03:40:06 +00:00
|
|
|
function! ale_linters#python#pylint#Handle(buffer, lines) abort
|
|
|
|
" Matches patterns like the following:
|
|
|
|
"
|
|
|
|
" test.py:4:4: W0101 (unreachable) Unreachable code
|
2018-04-10 14:18:16 +00:00
|
|
|
let l:pattern = '\v^[a-zA-Z]?:?[^:]+:(\d+):(\d+): ([[:alnum:]]+) \(([^(]*)\) (.*)$'
|
2017-05-25 03:40:06 +00:00
|
|
|
let l:output = []
|
|
|
|
|
|
|
|
for l:match in ale#util#GetMatches(a:lines, l:pattern)
|
|
|
|
"let l:failed = append(0, l:match)
|
|
|
|
let l:code = l:match[3]
|
|
|
|
|
2017-08-08 07:39:13 +00:00
|
|
|
if (l:code is# 'C0303')
|
2017-05-25 03:40:06 +00:00
|
|
|
\ && !ale#Var(a:buffer, 'warn_about_trailing_whitespace')
|
|
|
|
" Skip warnings for trailing whitespace if the option is off.
|
|
|
|
continue
|
|
|
|
endif
|
|
|
|
|
2017-08-08 07:39:13 +00:00
|
|
|
if l:code is# 'I0011'
|
2017-05-25 03:40:06 +00:00
|
|
|
" Skip 'Locally disabling' message
|
|
|
|
continue
|
|
|
|
endif
|
|
|
|
|
|
|
|
call add(l:output, {
|
|
|
|
\ 'lnum': l:match[1] + 0,
|
|
|
|
\ 'col': l:match[2] + 1,
|
2017-11-15 17:35:34 +00:00
|
|
|
\ 'text': l:match[5],
|
|
|
|
\ 'code': l:match[4],
|
2017-08-08 07:39:13 +00:00
|
|
|
\ 'type': l:code[:0] is# 'E' ? 'E' : 'W',
|
2017-05-25 03:40:06 +00:00
|
|
|
\})
|
|
|
|
endfor
|
|
|
|
|
|
|
|
return l:output
|
|
|
|
endfunction
|
|
|
|
|
2016-10-27 06:24:32 +00:00
|
|
|
call ale#linter#Define('python', {
|
|
|
|
\ 'name': 'pylint',
|
2017-01-03 10:52:58 +00:00
|
|
|
\ 'executable_callback': 'ale_linters#python#pylint#GetExecutable',
|
|
|
|
\ 'command_callback': 'ale_linters#python#pylint#GetCommand',
|
2017-05-25 03:40:06 +00:00
|
|
|
\ 'callback': 'ale_linters#python#pylint#Handle',
|
2017-05-06 18:30:41 +00:00
|
|
|
\ 'lint_file': 1,
|
2016-10-27 06:24:32 +00:00
|
|
|
\})
|