" 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."
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'
def Black():
start = time.time()
fast = bool(int(vim.eval("g:black_fast")))
- line_length = int(vim.eval("g:black_linelength"))
- if bool(int(vim.eval("g:black_skip_string_normalization"))):
- mode = black.FileMode.AUTO_DETECT & black.FileMode.NO_STRING_NORMALIZATION
- buffer_str = '\n'.join(vim.current.buffer) + '\n'
+ 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'),
+ )
+ (cursor_line, cursor_column) = vim.current.window.cursor
+ cb = vim.current.buffer[:]
+ cb_bc = cb[0:cursor_line]
+ # Format all code before the cursor.
+ # Detect unclosed blocks, close them with pass.
+ last_line = cb_bc[-1]
+ if last_line.rstrip().endswith(":"):
+ cb_bc[-1] = last_line + " pass"
+ # Determine old:new cursor location mapping
+ buffer_str_before = '\n'.join(cb_bc)+'\n'
try:
- new_buffer_str = black.format_file_contents(buffer_str, line_length=line_length, fast=fast, mode=mode)
+ new_buffer_str_before = black.format_file_contents(buffer_str_before, fast=fast, mode=mode)
+ new_cb = new_buffer_str_before.split('\n')[:-1]
+ new_cursor_line = len(new_cb)
+ new_cursor = (new_cursor_line, cursor_column)
+ except black.NothingChanged:
+ new_cursor_line = cursor_line
+ new_cursor = (new_cursor_line, cursor_column)
+ except Exception as exc:
+ print(exc)
+ # Now we know where the cursor should be
+ # when we format the entire buffer. Do it:
+ buffer_str = '\n'.join(cb) + '\n'
+ try:
+ 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:
- vim.current.buffer[:] = new_buffer_str.split('\n')[:-1]
+ # Replace the buffer
+ new_cb = new_buffer_str.split('\n')[:-1]
+ vim.current.buffer[:] = new_cb
+ # Restore the cursor to its rightful place
+ try:
+ vim.current.window.cursor = new_cursor
+ except vim.error:
+ vim.current.window.cursor = (len(vim.current.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>