All patches and comments are welcome. Please squash your changes to logical
commits before using git-format-patch and git-send-email to
patches@git.madduck.net.
If you'd read over the Git project's submission guidelines and adhered to them,
I'd be especially grateful.
6 from distutils.util import strtobool
9 class Flag(collections.namedtuple("FlagBase", "name, cast")):
12 return self.name.replace("-", "_")
15 def vim_rc_name(self):
17 if name == "line_length":
18 name = name.replace("_", "")
19 return "g:black_" + name
23 Flag(name="line_length", cast=int),
24 Flag(name="fast", cast=strtobool),
25 Flag(name="skip_string_normalization", cast=strtobool),
26 Flag(name="quiet", cast=strtobool),
30 def _get_python_binary(exec_prefix):
32 default = vim.eval("g:pymode_python").strip()
35 if default and os.path.exists(default):
37 if sys.platform[:3] == "win":
38 return exec_prefix / 'python.exe'
39 return exec_prefix / 'bin' / 'python3'
41 def _get_pip(venv_path):
42 if sys.platform[:3] == "win":
43 return venv_path / 'Scripts' / 'pip.exe'
44 return venv_path / 'bin' / 'pip'
46 def _get_virtualenv_site_packages(venv_path, pyver):
47 if sys.platform[:3] == "win":
48 return venv_path / 'Lib' / 'site-packages'
49 return venv_path / 'lib' / f'python{pyver[0]}.{pyver[1]}' / 'site-packages'
51 def _initialize_black_env(upgrade=False):
52 pyver = sys.version_info[:3]
54 print("Sorry, Black requires Python 3.6.2+ to run.")
57 from pathlib import Path
60 virtualenv_path = Path(vim.eval("g:black_virtualenv")).expanduser()
61 virtualenv_site_packages = str(_get_virtualenv_site_packages(virtualenv_path, pyver))
63 if not virtualenv_path.is_dir():
64 print('Please wait, one time setup for Black.')
65 _executable = sys.executable
66 _base_executable = getattr(sys, "_base_executable", _executable)
68 executable = str(_get_python_binary(Path(sys.exec_prefix)))
69 sys.executable = executable
70 sys._base_executable = executable
71 print(f'Creating a virtualenv in {virtualenv_path}...')
72 print('(this path can be customized in .vimrc by setting g:black_virtualenv)')
73 venv.create(virtualenv_path, with_pip=True)
75 print('Encountered exception while creating virtualenv (see traceback below).')
76 print(f'Removing {virtualenv_path}...')
78 shutil.rmtree(virtualenv_path)
81 sys.executable = _executable
82 sys._base_executable = _base_executable
85 print('Installing Black with pip...')
87 print('Upgrading Black with pip...')
88 if first_install or upgrade:
89 subprocess.run([str(_get_pip(virtualenv_path)), 'install', '-U', 'black'], stdout=subprocess.PIPE)
90 print('DONE! You are all set, thanks for waiting ✨ 🍰 ✨')
92 print('Pro-tip: to upgrade Black in the future, use the :BlackUpgrade command and restart Vim.\n')
93 if virtualenv_site_packages not in sys.path:
94 sys.path.insert(0, virtualenv_site_packages)
97 if _initialize_black_env():
101 def get_target_version(tv):
102 if isinstance(tv, black.TargetVersion):
106 ret = black.TargetVersion[tv.upper()]
108 print(f"WARNING: Target version {tv!r} not recognized by Black, using default target")
113 kwargs allows you to override ``target_versions`` argument of
116 ``target_version`` needs to be cleaned because ``black.FileMode``
117 expects the ``target_versions`` argument to be a set of TargetVersion enums.
119 Allow kwargs["target_version"] to be a string to allow
120 to type it more quickly.
122 Using also target_version instead of target_versions to remain
123 consistent to Black's documentation of the structure of pyproject.toml.
126 configs = get_configs()
129 if "target_version" in kwargs:
130 target_version = kwargs["target_version"]
132 if not isinstance(target_version, (list, set)):
133 target_version = [target_version]
134 target_version = set(filter(lambda x: x, map(lambda tv: get_target_version(tv), target_version)))
135 black_kwargs["target_versions"] = target_version
137 mode = black.FileMode(
138 line_length=configs["line_length"],
139 string_normalization=not configs["skip_string_normalization"],
140 is_pyi=vim.current.buffer.name.endswith('.pyi'),
143 quiet = configs["quiet"]
145 buffer_str = '\n'.join(vim.current.buffer) + '\n'
147 new_buffer_str = black.format_file_contents(
149 fast=configs["fast"],
152 except black.NothingChanged:
154 print(f'Already well formatted, good job. (took {time.time() - start:.4f}s)')
155 except Exception as exc:
158 current_buffer = vim.current.window.buffer
160 for i, tabpage in enumerate(vim.tabpages):
162 for j, window in enumerate(tabpage.windows):
163 if window.valid and window.buffer == current_buffer:
164 cursors.append((i, j, window.cursor))
165 vim.current.buffer[:] = new_buffer_str.split('\n')[:-1]
166 for i, j, cursor in cursors:
167 window = vim.tabpages[i].windows[j]
169 window.cursor = cursor
171 window.cursor = (len(window.buffer), 0)
173 print(f'Reformatted in {time.time() - start:.4f}s.')
176 filename = vim.eval("@%")
177 path_pyproject_toml = black.find_pyproject_toml((filename,))
178 if path_pyproject_toml:
179 toml_config = black.parse_pyproject_toml(path_pyproject_toml)
184 flag.var_name: toml_config.get(flag.name, flag.cast(vim.eval(flag.vim_rc_name)))
190 _initialize_black_env(upgrade=True)
193 print(f'Black, version {black.__version__} on Python {sys.version}.')
197 function black#Black(...)
200 let arg_list = split(arg, '=')
201 let kwargs[arg_list[0]] = arg_list[1]
205 kwargs = vim.eval("kwargs")
210 function black#BlackUpgrade()
214 function black#BlackVersion()