Add flakehell python linter (#3295)

ale_linters/python/flakehell.vim

@@ -0,0 +1,175 @@
+" Author: w0rp <devw0rp@gmail.com>
+" Description: flakehell for python files
+
+call ale#Set('python_flakehell_executable', 'flakehell')
+call ale#Set('python_flakehell_options', '')
+call ale#Set('python_flakehell_use_global', get(g:, 'ale_use_global_executables', 0))
+call ale#Set('python_flakehell_change_directory', 'project')
+call ale#Set('python_flakehell_auto_pipenv', 0)
+call ale#Set('python_flakehell_auto_poetry', 0)
+
+function! s:UsingModule(buffer) abort
+    return ale#Var(a:buffer, 'python_flakehell_executable') is? 'python'
+endfunction
+
+function! ale_linters#python#flakehell#GetExecutable(buffer) abort
+    if (ale#Var(a:buffer, 'python_auto_pipenv') || ale#Var(a:buffer, 'python_flakehell_auto_pipenv'))
+    \ && ale#python#PipenvPresent(a:buffer)
+        return 'pipenv'
+    endif
+
+    if (ale#Var(a:buffer, 'python_auto_poetry') || ale#Var(a:buffer, 'python_flakehell_auto_poetry'))
+    \ && ale#python#PoetryPresent(a:buffer)
+        return 'poetry'
+    endif
+
+    if !s:UsingModule(a:buffer)
+        return ale#python#FindExecutable(a:buffer, 'python_flakehell', ['flakehell'])
+    endif
+
+    return ale#Var(a:buffer, 'python_flakehell_executable')
+endfunction
+
+function! ale_linters#python#flakehell#RunWithVersionCheck(buffer) abort
+    let l:executable = ale_linters#python#flakehell#GetExecutable(a:buffer)
+
+    let l:module_string = s:UsingModule(a:buffer) ? ' -m flakehell' : ''
+    let l:command = ale#Escape(l:executable) . l:module_string . ' --version'
+
+    return ale#semver#RunWithVersionCheck(
+    \   a:buffer,
+    \   l:executable,
+    \   l:command,
+    \   function('ale_linters#python#flakehell#GetCommand'),
+    \)
+endfunction
+
+function! ale_linters#python#flakehell#GetCwd(buffer) abort
+    let l:change_directory = ale#Var(a:buffer, 'python_flakehell_change_directory')
+    let l:cwd = ''
+
+    if l:change_directory is# 'project'
+        let l:project_root = ale#python#FindProjectRootIni(a:buffer)
+
+        if !empty(l:project_root)
+            let l:cwd = l:project_root
+        endif
+    endif
+
+    if (l:change_directory is# 'project' && empty(l:cwd))
+    \|| l:change_directory is# 1
+    \|| l:change_directory is# 'file'
+        let l:cwd = '%s:h'
+    endif
+
+    return l:cwd
+endfunction
+
+function! ale_linters#python#flakehell#GetCommand(buffer, version) abort
+    let l:executable = ale_linters#python#flakehell#GetExecutable(a:buffer)
+
+    if (l:executable =~? 'pipenv\|poetry$')
+        let l:exec_args = ' run flakehell'
+    elseif (l:executable is? 'python')
+        let l:exec_args = ' -m flakehell'
+    else
+        let l:exec_args = ''
+    endif
+
+    " Only include the --stdin-display-name argument if we can parse the
+    " flakehell version, and it is recent enough to support it.
+    let l:display_name_args = ale#semver#GTE(a:version, [0, 8, 0])
+    \   ? ' --stdin-display-name %s'
+    \   : ''
+
+    let l:options = ale#Var(a:buffer, 'python_flakehell_options')
+
+    return ale#Escape(l:executable)
+    \   . l:exec_args
+    \   . (!empty(l:options) ? ' lint ' . l:options : ' lint')
+    \   . ' --format=default'
+    \   . l:display_name_args . ' -'
+endfunction
+
+let s:end_col_pattern_map = {
+\   'F405': '\(.\+\) may be undefined',
+\   'F821': 'undefined name ''\([^'']\+\)''',
+\   'F999': '^''\([^'']\+\)''',
+\   'F841': 'local variable ''\([^'']\+\)''',
+\}
+
+function! ale_linters#python#flakehell#Handle(buffer, lines) abort
+    let l:output = ale#python#HandleTraceback(a:lines, 10)
+
+    if !empty(l:output)
+        return l:output
+    endif
+
+    " Matches patterns line the following:
+    "
+    " Matches patterns line the following:
+    "
+    " stdin:6:6: E111 indentation is not a multiple of four
+    let l:pattern = '\v^[a-zA-Z]?:?[^:]+:(\d+):?(\d+)?: ([[:alnum:]]+):? (.*)$'
+
+    for l:match in ale#util#GetMatches(a:lines, l:pattern)
+        let l:code = l:match[3]
+
+        if (l:code is# 'W291' || l:code is# 'W293')
+        \ && !ale#Var(a:buffer, 'warn_about_trailing_whitespace')
+            " Skip warnings for trailing whitespace if the option is off.
+            continue
+        endif
+
+        if l:code is# 'W391'
+        \&& !ale#Var(a:buffer, 'warn_about_trailing_blank_lines')
+            " Skip warnings for trailing blank lines if the option is off
+            continue
+        endif
+
+        let l:item = {
+        \   'lnum': l:match[1] + 0,
+        \   'col': l:match[2] + 0,
+        \   'vcol': 1,
+        \   'text': l:match[4],
+        \   'code': l:code,
+        \   'type': 'W',
+        \}
+
+        if l:code[:0] is# 'F'
+            if l:code isnot# 'F401'
+                let l:item.type = 'E'
+            endif
+        elseif l:code[:0] is# 'E'
+            let l:item.type = 'E'
+
+            if l:code isnot# 'E999' && l:code isnot# 'E112'
+                let l:item.sub_type = 'style'
+            endif
+        elseif l:code[:0] is# 'W'
+            let l:item.sub_type = 'style'
+        endif
+
+        let l:end_col_pattern = get(s:end_col_pattern_map, l:code, '')
+
+        if !empty(l:end_col_pattern)
+            let l:end_col_match = matchlist(l:match[4], l:end_col_pattern)
+
+            if !empty(l:end_col_match)
+                let l:item.end_col = l:item.col + len(l:end_col_match[1]) - 1
+            endif
+        endif
+
+        call add(l:output, l:item)
+    endfor
+
+    return l:output
+endfunction
+
+call ale#linter#Define('python', {
+\   'name': 'flakehell',
+\   'executable': function('ale_linters#python#flakehell#GetExecutable'),
+\   'cwd': function('ale_linters#python#flakehell#GetCwd'),
+\   'command': function('ale_linters#python#flakehell#RunWithVersionCheck'),
+\   'callback': 'ale_linters#python#flakehell#Handle',
+\})

doc/ale-python.txt

@@ -320,6 +320,69 @@ g:ale_python_flake8_auto_poetry               *g:ale_python_flake8_auto_poetry*
   Detect whether the file is inside a poetry, and set the executable to `poetry`
   if true. This is overridden by a manually-set executable.
 
+===============================================================================
+flakehell                                                *ale-python-flakehell*
+
+g:ale_python_flakehell_change_directory*g:ale_python_flakehell_change_directory*
+                                       *b:ale_python_flakehell_change_directory*
+  Type: |String|
+  Default: `project`
+
+  If set to `project`, ALE will switch to the project root before checking file.
+  If set to `file`, ALE will switch to directory the Python file being
+  checked with `flakehell` is in before checking it.
+  You can turn it off with `off` option if you want to control the directory
+  Python is executed from yourself.
+
+
+g:ale_python_flakehell_executable            *g:ale_python_flakehell_executable*
+                                             *b:ale_python_flakehell_executable*
+  Type: |String|
+  Default: `'flakehell'`
+
+  This variable can be changed to modify the executable used for flakehell. Set
+  this to `'pipenv'` to invoke `'pipenv` `run` `flakehell'`. Set this to
+  `'poetry'` to invoke `'poetry` `run` `flakehell'`. Set this to `'python'` to
+  invoke `'python` `-m` `flakehell'`.
+
+
+g:ale_python_flakehell_options                  *g:ale_python_flakehell_options*
+                                                *b:ale_python_flakehell_options*
+  Type: |String|
+  Default: `''`
+
+  This variable can be changed to add command-line arguments to the flakehell
+  lint invocation.
+
+
+g:ale_python_flakehell_use_global            *g:ale_python_flakehell_use_global*
+                                             *b:ale_python_flakehell_use_global*
+  Type: |Number|
+  Default: `get(g:, 'ale_use_global_executables', 0)`
+
+  This variable controls whether or not ALE will search for flakehell in a
+  virtualenv directory first. If this variable is set to `1`, then ALE will
+  always use |g:ale_python_flakehell_executable| for the executable path.
+
+  Both variables can be set with `b:` buffer variables instead.
+
+
+g:ale_python_flakehell_auto_pipenv          *g:ale_python_flakehell_auto_pipenv*
+                                            *b:ale_python_flakehell_auto_pipenv*
+  Type: |Number|
+  Default: `0`
+
+  Detect whether the file is inside a pipenv, and set the executable to `pipenv`
+  if true. This is overridden by a manually-set executable.
+
+
+g:ale_python_flakehell_auto_poetry         *g:ale_python_flakehell_auto_poetry*
+                                           *b:ale_python_flakehell_auto_poetry*
+  Type: |Number|
+  Default: `0`
+
+  Detect whether the file is inside a poetry, and set the executable to `poetry`
+  if true. This is overridden by a manually-set executable.
 
 ===============================================================================
 isort                                                        *ale-python-isort*

doc/ale-supported-languages-and-tools.txt

@@ -419,6 +419,7 @@ Notes:
   * `bandit`
   * `black`
   * `flake8`
+  * `flakehell`
   * `isort`
   * `mypy`
   * `prospector`!!

doc/ale.txt

@@ -2953,6 +2953,7 @@ documented in additional help files.
     bandit................................|ale-python-bandit|
     black.................................|ale-python-black|
     flake8................................|ale-python-flake8|
+    flakehell.............................|ale-python-flakehell|
     isort.................................|ale-python-isort|
     mypy..................................|ale-python-mypy|
     prospector............................|ale-python-prospector|

supported-tools.md

@@ -428,6 +428,7 @@ formatting.
   * [bandit](https://github.com/PyCQA/bandit) :warning:
   * [black](https://github.com/ambv/black)
   * [flake8](http://flake8.pycqa.org/en/latest/)
+  * [flakehell](https://github.com/flakehell/flakehell)
   * [isort](https://github.com/timothycrosley/isort)
   * [mypy](http://mypy-lang.org/)
   * [prospector](https://github.com/PyCQA/prospector) :warning: :floppy_disk: