Add `black-primer` docs (#1427)

[etc/vim.git] / plugin / black.vim

diff --git a/plugin/black.vim b/plugin/black.vim
index a4047d49d4b1b170e6bbeb9ca37090bdf055cd80..a0de953645f769a70d7e270ca14ad9cf77689576 100644 (file)
--- a/plugin/black.vim
+++ b/plugin/black.vim
@@ -14,7 +14,12 @@
 "    - restore cursor/window position after formatting
 
 if v:version < 700 || !has('python3')
 "    - restore cursor/window position after formatting
 
 if v:version < 700 || !has('python3')

-    echo "The black.vim plugin requires vim7.0+ with Python 3.6 support."
+    func! __BLACK_MISSING()
+        echo "The black.vim plugin requires vim7.0+ with Python 3.6 support."
+    endfunc
+    command! Black :call __BLACK_MISSING()
+    command! BlackUpgrade :call __BLACK_MISSING()
+    command! BlackVersion :call __BLACK_MISSING()

     finish
 endif
 
     finish
 endif
 


@@ -40,7 +45,7 @@ if !exists("g:black_skip_string_normalization")
   let g:black_skip_string_normalization = 0
 endif
 
   let g:black_skip_string_normalization = 0
 endif
 

-python3 << endpython3
+python3 << EndPython3

 import collections
 import os
 import sys
 import collections
 import os
 import sys


@@ -105,13 +110,23 @@ def _initialize_black_env(upgrade=False):
   if not virtualenv_path.is_dir():
     print('Please wait, one time setup for Black.')
     _executable = sys.executable
   if not virtualenv_path.is_dir():
     print('Please wait, one time setup for Black.')
     _executable = sys.executable

+    _base_executable = getattr(sys, "_base_executable", _executable)

     try:
     try:

-      sys.executable = str(_get_python_binary(Path(sys.exec_prefix)))
+      executable = str(_get_python_binary(Path(sys.exec_prefix)))
+      sys.executable = executable
+      sys._base_executable = executable

       print(f'Creating a virtualenv in {virtualenv_path}...')
       print('(this path can be customized in .vimrc by setting g:black_virtualenv)')
       venv.create(virtualenv_path, with_pip=True)
       print(f'Creating a virtualenv in {virtualenv_path}...')
       print('(this path can be customized in .vimrc by setting g:black_virtualenv)')
       venv.create(virtualenv_path, with_pip=True)

+    except Exception:
+      print('Encountered exception while creating virtualenv (see traceback below).')
+      print(f'Removing {virtualenv_path}...')
+      import shutil
+      shutil.rmtree(virtualenv_path)
+      raise

     finally:
       sys.executable = _executable
     finally:
       sys.executable = _executable

+      sys._base_executable = _base_executable

     first_install = True
   if first_install:
     print('Installing Black with pip...')
     first_install = True
   if first_install:
     print('Installing Black with pip...')


@@ -123,7 +138,7 @@ def _initialize_black_env(upgrade=False):
   if first_install:
     print('Pro-tip: to upgrade Black in the future, use the :BlackUpgrade command and restart Vim.\n')
   if virtualenv_site_packages not in sys.path:
   if first_install:
     print('Pro-tip: to upgrade Black in the future, use the :BlackUpgrade command and restart Vim.\n')
   if virtualenv_site_packages not in sys.path:

-    sys.path.append(virtualenv_site_packages)
+    sys.path.insert(0, virtualenv_site_packages)

   return True
 
 if _initialize_black_env():
   return True
 
 if _initialize_black_env():


@@ -186,7 +201,7 @@ def BlackUpgrade():
 def BlackVersion():
   print(f'Black, version {black.__version__} on Python {sys.version}.')
 
 def BlackVersion():
   print(f'Black, version {black.__version__} on Python {sys.version}.')
 

-endpython3
+EndPython3

 
 command! Black :py3 Black()
 command! BlackUpgrade :py3 BlackUpgrade()
 
 command! Black :py3 Black()
 command! BlackUpgrade :py3 BlackUpgrade()