" Author: Łukasz Langa
" Created: Mon Mar 26 23:27:53 2018 -0700
" Requires: Vim Ver7.0+
-" Version: 1.0
+" Version: 1.1
"
" Documentation:
" This plugin formats Python files.
" History:
" 1.0:
" - initial version
+" 1.1:
+" - restore cursor/window position after formatting
if v:version < 700 || !has('python3')
echo "This script requires vim7.0+ with Python 3.6 support."
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
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
+endif
python3 << endpython3
+import os
import sys
import vim
def _get_python_binary(exec_prefix):
+ try:
+ default = vim.eval("g:pymode_python").strip()
+ except vim.error:
+ default = ""
+ if default and os.path.exists(default):
+ return default
if sys.platform[:3] == "win":
return exec_prefix / 'python.exe'
return exec_prefix / 'bin' / 'python3'
if upgrade:
print('Upgrading Black with pip...')
if first_install or upgrade:
- subprocess.run([str(_get_pip(virtualenv_path)), 'install', '-U', 'black'])
+ 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)
+ if virtualenv_site_packages not in sys.path:
+ sys.path.append(virtualenv_site_packages)
return True
if _initialize_black_env():
def Black():
start = time.time()
fast = bool(int(vim.eval("g:black_fast")))
- line_length = int(vim.eval("g:black_linelength"))
+ mode = black.FileMode(
+ line_length=int(vim.eval("g:black_linelength")),
+ string_normalization=not bool(int(vim.eval("g:black_skip_string_normalization"))),
+ is_pyi=vim.current.buffer.name.endswith('.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)
+ new_buffer_str = black.format_file_contents(buffer_str, 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:
+ current_buffer = vim.current.window.buffer
+ cursors = []
+ for i, tabpage in enumerate(vim.tabpages):
+ if tabpage.valid:
+ for j, window in enumerate(tabpage.windows):
+ if window.valid and window.buffer == current_buffer:
+ cursors.append((i, j, window.cursor))
vim.current.buffer[:] = new_buffer_str.split('\n')[:-1]
+ for i, j, cursor in cursors:
+ window = vim.tabpages[i].windows[j]
+ try:
+ window.cursor = cursor
+ except vim.error:
+ window.cursor = (len(window.buffer), 0)
print(f'Reformatted in {time.time() - start:.4f}s.')
def BlackUpgrade():
command! Black :py3 Black()
command! BlackUpgrade :py3 BlackUpgrade()
command! BlackVersion :py3 BlackVersion()
-
-nmap ,= :Black<CR>
-vmap ,= :Black<CR>