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.
8 if text.lower() in ['y', 'yes', 't', 'true', 'on', '1']:
10 if text.lower() in ['n', 'no', 'f', 'false', 'off', '0']:
12 raise ValueError(f"{text} is not convertible to boolean")
14 class Flag(collections.namedtuple("FlagBase", "name, cast")):
17 return self.name.replace("-", "_")
20 def vim_rc_name(self):
22 if name == "line_length":
23 name = name.replace("_", "")
24 return "g:black_" + name
28 Flag(name="line_length", cast=int),
29 Flag(name="fast", cast=strtobool),
30 Flag(name="skip_string_normalization", cast=strtobool),
31 Flag(name="quiet", cast=strtobool),
32 Flag(name="skip_magic_trailing_comma", cast=strtobool),
33 Flag(name="preview", cast=strtobool),
37 def _get_python_binary(exec_prefix, pyver):
39 default = vim.eval("g:pymode_python").strip()
42 if default and os.path.exists(default):
44 if sys.platform[:3] == "win":
45 return exec_prefix / 'python.exe'
46 bin_path = exec_prefix / "bin"
47 exec_path = (bin_path / f"python{pyver[0]}.{pyver[1]}").resolve()
48 if exec_path.exists():
50 # It is possible that some environments may only have python3
51 exec_path = (bin_path / f"python3").resolve()
52 if exec_path.exists():
54 raise ValueError("python executable not found")
56 def _get_pip(venv_path):
57 if sys.platform[:3] == "win":
58 return venv_path / 'Scripts' / 'pip.exe'
59 return venv_path / 'bin' / 'pip'
61 def _get_virtualenv_site_packages(venv_path, pyver):
62 if sys.platform[:3] == "win":
63 return venv_path / 'Lib' / 'site-packages'
64 return venv_path / 'lib' / f'python{pyver[0]}.{pyver[1]}' / 'site-packages'
66 def _initialize_black_env(upgrade=False):
67 if vim.eval("g:black_use_virtualenv ? 'true' : 'false'") == "false":
69 print("Upgrade disabled due to g:black_use_virtualenv being disabled.")
70 print("Either use your system package manager (or pip) to upgrade black separately,")
71 print("or modify your vimrc to have 'let g:black_use_virtualenv = 1'.")
74 # Nothing needed to be done.
77 pyver = sys.version_info[:3]
79 print("Sorry, Black requires Python 3.8+ to run.")
82 from pathlib import Path
85 virtualenv_path = Path(vim.eval("g:black_virtualenv")).expanduser()
86 virtualenv_site_packages = str(_get_virtualenv_site_packages(virtualenv_path, pyver))
88 if not virtualenv_path.is_dir():
89 print('Please wait, one time setup for Black.')
90 _executable = sys.executable
91 _base_executable = getattr(sys, "_base_executable", _executable)
93 executable = str(_get_python_binary(Path(sys.exec_prefix), pyver))
94 sys.executable = executable
95 sys._base_executable = executable
96 print(f'Creating a virtualenv in {virtualenv_path}...')
97 print('(this path can be customized in .vimrc by setting g:black_virtualenv)')
98 venv.create(virtualenv_path, with_pip=True)
100 print('Encountered exception while creating virtualenv (see traceback below).')
101 print(f'Removing {virtualenv_path}...')
103 shutil.rmtree(virtualenv_path)
106 sys.executable = _executable
107 sys._base_executable = _base_executable
110 print('Installing Black with pip...')
112 print('Upgrading Black with pip...')
113 if first_install or upgrade:
114 subprocess.run([str(_get_pip(virtualenv_path)), 'install', '-U', 'black'], stdout=subprocess.PIPE)
115 print('DONE! You are all set, thanks for waiting ✨ 🍰 ✨')
117 print('Pro-tip: to upgrade Black in the future, use the :BlackUpgrade command and restart Vim.\n')
118 if virtualenv_site_packages not in sys.path:
119 sys.path.insert(0, virtualenv_site_packages)
122 if _initialize_black_env():
126 def get_target_version(tv):
127 if isinstance(tv, black.TargetVersion):
131 ret = black.TargetVersion[tv.upper()]
133 print(f"WARNING: Target version {tv!r} not recognized by Black, using default target")
138 kwargs allows you to override ``target_versions`` argument of
141 ``target_version`` needs to be cleaned because ``black.FileMode``
142 expects the ``target_versions`` argument to be a set of TargetVersion enums.
144 Allow kwargs["target_version"] to be a string to allow
145 to type it more quickly.
147 Using also target_version instead of target_versions to remain
148 consistent to Black's documentation of the structure of pyproject.toml.
151 configs = get_configs()
154 if "target_version" in kwargs:
155 target_version = kwargs["target_version"]
157 if not isinstance(target_version, (list, set)):
158 target_version = [target_version]
159 target_version = set(filter(lambda x: x, map(lambda tv: get_target_version(tv), target_version)))
160 black_kwargs["target_versions"] = target_version
162 mode = black.FileMode(
163 line_length=configs["line_length"],
164 string_normalization=not configs["skip_string_normalization"],
165 is_pyi=vim.current.buffer.name.endswith('.pyi'),
166 magic_trailing_comma=not configs["skip_magic_trailing_comma"],
167 preview=configs["preview"],
170 quiet = configs["quiet"]
172 buffer_str = '\n'.join(vim.current.buffer) + '\n'
174 new_buffer_str = black.format_file_contents(
176 fast=configs["fast"],
179 except black.NothingChanged:
181 print(f'Black: already well formatted, good job. (took {time.time() - start:.4f}s)')
182 except Exception as exc:
183 print(f'Black: {exc}')
185 current_buffer = vim.current.window.buffer
187 for i, tabpage in enumerate(vim.tabpages):
189 for j, window in enumerate(tabpage.windows):
190 if window.valid and window.buffer == current_buffer:
191 cursors.append((i, j, window.cursor))
192 vim.current.buffer[:] = new_buffer_str.split('\n')[:-1]
193 for i, j, cursor in cursors:
194 window = vim.tabpages[i].windows[j]
196 window.cursor = cursor
198 window.cursor = (len(window.buffer), 0)
200 print(f'Black: reformatted in {time.time() - start:.4f}s.')
203 filename = vim.eval("@%")
204 path_pyproject_toml = black.find_pyproject_toml((filename,))
205 if path_pyproject_toml:
206 toml_config = black.parse_pyproject_toml(path_pyproject_toml)
211 flag.var_name: toml_config.get(flag.name, flag.cast(vim.eval(flag.vim_rc_name)))
217 _initialize_black_env(upgrade=True)
220 print(f'Black, version {black.__version__} on Python {sys.version}.')
224 function black#Black(...)
227 let arg_list = split(arg, '=')
228 let kwargs[arg_list[0]] = arg_list[1]
232 kwargs = vim.eval("kwargs")
237 function black#BlackUpgrade()
241 function black#BlackVersion()