X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/a862795e1acf5010141939a11a33a694f6fe024e..59acf8af38a72e57b26d739adb5d5e7f350e8f2c:/plugin/black.vim?ds=inline diff --git a/plugin/black.vim b/plugin/black.vim index 34f30c5..3fc11fe 100644 --- a/plugin/black.vim +++ b/plugin/black.vim @@ -2,7 +2,7 @@ " Author: Łukasz Langa " Created: Mon Mar 26 23:27:53 2018 -0700 " Requires: Vim Ver7.0+ -" Version: 1.1 +" Version: 1.2 " " Documentation: " This plugin formats Python files. @@ -12,19 +12,30 @@ " - initial version " 1.1: " - restore cursor/window position after formatting +" 1.2: +" - use autoload script -if v:version < 700 || !has('python3') - echo "This script requires vim7.0+ with Python 3.6 support." - finish +if exists("g:load_black") + finish endif -if exists("g:load_black") - finish +if v:version < 700 || !has('python3') + 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 let g:load_black = "py1.0" if !exists("g:black_virtualenv") - let g:black_virtualenv = "~/.vim/black" + if has("nvim") + let g:black_virtualenv = "~/.local/share/nvim/black" + else + let g:black_virtualenv = "~/.vim/black" + endif endif if !exists("g:black_fast") let g:black_fast = 0 @@ -33,98 +44,37 @@ if !exists("g:black_linelength") let g:black_linelength = 88 endif if !exists("g:black_skip_string_normalization") - let g:black_skip_string_normalization = 0 + if exists("g:black_string_normalization") + let g:black_skip_string_normalization = !g:black_string_normalization + else + let g:black_skip_string_normalization = 0 + endif +endif +if !exists("g:black_skip_magic_trailing_comma") + if exists("g:black_magic_trailing_comma") + let g:black_skip_magic_trailing_comma = !g:black_magic_trailing_comma + else + let g:black_skip_magic_trailing_comma = 0 + endif +endif +if !exists("g:black_quiet") + let g:black_quiet = 0 +endif +if !exists("g:black_target_version") + let g:black_target_version = "" endif -python3 << endpython3 -import sys -import vim - -def _get_python_binary(exec_prefix): - if sys.platform[:3] == "win": - return exec_prefix / 'python.exe' - return exec_prefix / 'bin' / 'python3' - -def _get_pip(venv_path): - if sys.platform[:3] == "win": - return venv_path / 'Scripts' / 'pip.exe' - return venv_path / 'bin' / 'pip' - -def _get_virtualenv_site_packages(venv_path, pyver): - if sys.platform[:3] == "win": - return venv_path / 'Lib' / 'site-packages' - return venv_path / 'lib' / f'python{pyver[0]}.{pyver[1]}' / 'site-packages' - -def _initialize_black_env(upgrade=False): - pyver = sys.version_info[:2] - if pyver < (3, 6): - print("Sorry, Black requires Python 3.6+ to run.") - return False - - from pathlib import Path - import subprocess - import venv - virtualenv_path = Path(vim.eval("g:black_virtualenv")).expanduser() - virtualenv_site_packages = str(_get_virtualenv_site_packages(virtualenv_path, pyver)) - first_install = False - if not virtualenv_path.is_dir(): - print('Please wait, one time setup for Black.') - _executable = sys.executable - try: - sys.executable = str(_get_python_binary(Path(sys.exec_prefix))) - 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) - finally: - sys.executable = _executable - first_install = True - if first_install: - print('Installing Black with pip...') - if upgrade: - print('Upgrading Black with pip...') - if first_install or upgrade: - subprocess.run([str(_get_pip(virtualenv_path)), 'install', '-U', 'black'], stdout=subprocess.PIPE) - print('DONE! You are all set, thanks for waiting ✨ 🍰 ✨') - if first_install: - print('Pro-tip: to upgrade Black in the future, use the :BlackUpgrade command and restart Vim.\n') - if sys.path[0] != virtualenv_site_packages: - sys.path.insert(0, virtualenv_site_packages) - return True - -if _initialize_black_env(): - import black - import time - -def Black(): - start = time.time() - fast = bool(int(vim.eval("g:black_fast"))) - line_length = int(vim.eval("g:black_linelength")) - mode = black.FileMode.AUTO_DETECT - if bool(int(vim.eval("g:black_skip_string_normalization"))): - mode |= black.FileMode.NO_STRING_NORMALIZATION - if vim.current.buffer.name.endswith('.pyi'): - mode |= black.FileMode.PYI - buffer_str = '\n'.join(vim.current.buffer) + '\n' - try: - new_buffer_str = black.format_file_contents(buffer_str, line_length=line_length, fast=fast, mode=mode) - except black.NothingChanged: - print(f'Already well formatted, good job. (took {time.time() - start:.4f}s)') - except Exception as exc: - print(exc) - else: - cursor = vim.current.window.cursor - vim.current.buffer[:] = new_buffer_str.split('\n')[:-1] - vim.current.window.cursor = cursor - print(f'Reformatted in {time.time() - start:.4f}s.') - -def BlackUpgrade(): - _initialize_black_env(upgrade=True) - -def BlackVersion(): - print(f'Black, version {black.__version__} on Python {sys.version}.') - -endpython3 +function BlackComplete(ArgLead, CmdLine, CursorPos) + return [ +\ 'target_version=py27', +\ 'target_version=py36', +\ 'target_version=py37', +\ 'target_version=py38', +\ 'target_version=py39', +\ 'target_version=py310', +\ ] +endfunction -command! Black :py3 Black() -command! BlackUpgrade :py3 BlackUpgrade() -command! BlackVersion :py3 BlackVersion() +command! -nargs=* -complete=customlist,BlackComplete Black :call black#Black() +command! BlackUpgrade :call black#BlackUpgrade() +command! BlackVersion :call black#BlackVersion()