plugin/black.vim

   1 " black.vim
   2 " Author: Łukasz Langa
   3 " Created: Mon Mar 26 23:27:53 2018 -0700
   4 " Requires: Vim Ver7.0+
   5 " Version:  1.0
   6 "
   7 " Documentation:
   8 "   This plugin formats Python files.
   9 "
  10 " History:
  11 "  1.0:
  12 "    - initial version
  13
  14 if v:version < 700 || !has('python3')
  15     echo "This script requires vim7.0+ with Python 3.6 support."
  16     finish
  17 endif
  18
  19 if exists("g:load_black")
  20    finish
  21 endif
  22
  23 let g:load_black = "py1.0"
  24 if !exists("g:black_virtualenv")
  25   let g:black_virtualenv = "~/.vim/black"
  26 endif
  27 if !exists("g:black_fast")
  28   let g:black_fast = 0
  29 endif
  30 if !exists("g:black_linelength")
  31   let g:black_linelength = 88
  32 endif
  33
  34 python3 << endpython3
  35 import sys
  36 import vim
  37
  38 def _get_python_binary(exec_prefix):
  39   if sys.platform[:3] == "win":
  40     return exec_prefix / 'python.exe'
  41   return exec_prefix / 'bin' / 'python3'
  42
  43 def _get_pip(venv_path):
  44   if sys.platform[:3] == "win":
  45     return venv_path / 'Scripts' / 'pip.exe'
  46   return venv_path / 'bin' / 'pip'
  47
  48 def _get_virtualenv_site_packages(venv_path, pyver):
  49   if sys.platform[:3] == "win":
  50     return venv_path / 'Lib' / 'site-packages'
  51   return venv_path / 'lib' / f'python{pyver[0]}.{pyver[1]}' / 'site-packages'
  52
  53 def _initialize_black_env(upgrade=False):
  54   pyver = sys.version_info[:2]
  55   if pyver < (3, 6):
  56     print("Sorry, Black requires Python 3.6+ to run.")
  57     return False
  58
  59   from pathlib import Path
  60   import subprocess
  61   import venv
  62   virtualenv_path = Path(vim.eval("g:black_virtualenv")).expanduser()
  63   virtualenv_site_packages = str(_get_virtualenv_site_packages(virtualenv_path, pyver))
  64   first_install = False
  65   if not virtualenv_path.is_dir():
  66     print('Please wait, one time setup for Black.')
  67     _executable = sys.executable
  68     try:
  69       sys.executable = str(_get_python_binary(Path(sys.exec_prefix)))
  70       print(f'Creating a virtualenv in {virtualenv_path}...')
  71       print('(this path can be customized in .vimrc by setting g:black_virtualenv)')
  72       venv.create(virtualenv_path, with_pip=True)
  73     finally:
  74       sys.executable = _executable
  75     first_install = True
  76   if first_install:
  77     print('Installing Black with pip...')
  78   if upgrade:
  79     print('Upgrading Black with pip...')
  80   if first_install or upgrade:
  81     subprocess.run([str(_get_pip(virtualenv_path)), 'install', '-U', 'black'], stdout=subprocess.PIPE)
  82     print('DONE! You are all set, thanks for waiting ✨ 🍰 ✨')
  83   if first_install:
  84     print('Pro-tip: to upgrade Black in the future, use the :BlackUpgrade command and restart Vim.\n')
  85   if sys.path[0] != virtualenv_site_packages:
  86     sys.path.insert(0, virtualenv_site_packages)
  87   return True
  88
  89 if _initialize_black_env():
  90   import black
  91   import time
  92
  93 def Black():
  94   start = time.time()
  95   fast = bool(int(vim.eval("g:black_fast")))
  96   line_length = int(vim.eval("g:black_linelength"))
  97   buffer_str = '\n'.join(vim.current.buffer) + '\n'
  98   try:
  99     new_buffer_str = black.format_file_contents(buffer_str, line_length=line_length, fast=fast)
 100   except black.NothingChanged:
 101     print(f'Already well formatted, good job. (took {time.time() - start:.4f}s)')
 102   except Exception as exc:
 103     print(exc)
 104   else:
 105     vim.current.buffer[:] = new_buffer_str.split('\n')[:-1]
 106     print(f'Reformatted in {time.time() - start:.4f}s.')
 107
 108 def BlackUpgrade():
 109   _initialize_black_env(upgrade=True)
 110
 111 def BlackVersion():
 112   print(f'Black, version {black.__version__} on Python {sys.version}.')
 113
 114 endpython3
 115
 116 command! Black :py3 Black()
 117 command! BlackUpgrade :py3 BlackUpgrade()
 118 command! BlackVersion :py3 BlackVersion()
 119
 120 nmap ,= :Black<CR>
 121 vmap ,= :Black<CR>