Merge pull request #1988 from mdtusz/pipenv-black

Add support for black usage with pipenv

autoload/ale/fixers/black.vim

@@ -4,22 +4,28 @@
 call ale#Set('python_black_executable', 'black')
 call ale#Set('python_black_use_global', get(g:, 'ale_use_global_executables', 0))
 call ale#Set('python_black_options', '')
+call ale#Set('python_black_auto_pipenv', 0)
+
+function! ale#fixers#black#GetExecutable(buffer) abort
+    if (ale#Var(a:buffer, 'python_auto_pipenv') || ale#Var(a:buffer, 'python_black_auto_pipenv'))
+    \ && ale#python#PipenvPresent(a:buffer)
+        return 'pipenv'
+    endif
+
+    return ale#python#FindExecutable(a:buffer, 'python_black', ['black'])
+endfunction
 
 function! ale#fixers#black#Fix(buffer) abort
-    let l:executable = ale#python#FindExecutable(
+    let l:executable = ale#fixers#black#GetExecutable(a:buffer)
-    \   a:buffer,
-    \   'python_black',
-    \   ['black'],
-    \)
 
-    if !executable(l:executable)
+    let l:exec_args = l:executable =~? 'pipenv$'
-        return 0
+    \   ? ' run black'
-    endif
+    \   : ''
 
     let l:options = ale#Var(a:buffer, 'python_black_options')
 
     return {
-    \   'command': ale#Escape(l:executable)
+    \   'command': ale#Escape(l:executable) . l:exec_args
     \       . (!empty(l:options) ? ' ' . l:options : '')
     \       . ' -',
     \}

doc/ale-python.txt

@@ -91,6 +91,14 @@ g:ale_python_black_use_global                   *g:ale_python_black_use_global*
 
   See |ale-integrations-local-executables|
 
+g:ale_python_black_auto_pipenv                  *g:ale_python_black_auto_pipenv*
+                                                *b:ale_python_black_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.
+
 
 ===============================================================================
 flake8                                                      *ale-python-flake8*

test/fixers/test_black_fixer_callback.vader

@@ -5,6 +5,7 @@ Before:
   " Use an invalid global executable, so we don't match it.
   let g:ale_python_black_executable = 'xxxinvalid'
   let g:ale_python_black_options = ''
+  let g:ale_python_black_auto_pipenv = 0
 
   call ale#test#SetDirectory('/testplugin/test/fixers')
   silent cd ..
@@ -21,10 +22,6 @@ After:
   call ale#test#RestoreDirectory()
 
 Execute(The black callback should return the correct default values):
-  AssertEqual
-  \ 0,
-  \ ale#fixers#black#Fix(bufnr(''))
-
   silent execute 'file ' . fnameescape(g:dir . '/python_paths/with_virtualenv/subdir/foo/bar.py')
   AssertEqual
   \ {'command': ale#Escape(ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/black')) . ' -'},
@@ -37,3 +34,11 @@ Execute(The black callback should include options):
   AssertEqual
   \ {'command': ale#Escape(ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/black')) . ' --some-option -' },
   \ ale#fixers#black#Fix(bufnr(''))
+
+Execute(Pipenv is detected when python_black_auto_pipenv is set):
+  let g:ale_python_black_auto_pipenv = 1
+  call ale#test#SetFilename('/testplugin/test/python_fixtures/pipenv/whatever.py')
+
+  AssertEqual 
+  \ {'command': ale#Escape('pipenv') . ' run black -'},
+  \ ale#fixers#black#Fix(bufnr(''))