5

我们还没有准备好用black自动格式化整个源代码。

但有时我想black -S通过 PyCharm 在一个区域上执行。

文档中有一个提示如何在整个文件上运行black（或black -S（我喜欢的））。但 ...

如何仅在选定区域上运行黑色？

4

2 回答 2

4

在 PyCharm IDE 中的代码区域上使用Python Black可以通过将其实现为外部工具来完成。目前黑色有两个主要选项来选择要格式化的代码

  1. 在整个模块上运行 Black，在 CLI 上将其指定为[SRC]...
  2. -c, --code TEXT 使用该选项在 CLI 上将代码区域作为字符串传递。

以下实现显示了如何使用第二个选项来执行此操作。原因是对整个模块应用黑色可能会改变行数，从而使通过选择开始和结束行号来选择代码区域的工作变得更加复杂。

可以实现第一个选项，但需要在 Black 格式化整个模块后将初始代码区域映射到最终代码区域。

让我们以下面的代码为例，它有许多明显的 PEP-8 违规（缺少空格和空行）：

"""
long multi-line
comment
"""
def foo(token:int=None)->None:
  a=token+1

class bar:
  foo:int=None
  
def the_simple_test():
    """the_simple_test"""
    pass

步骤1。

在 IDE 中使用 Black作为外部工具可以通过转到File > Tools > External Tools并单击Add或Edit图标进行配置。

感兴趣的是从 PyCharm IDE 将正确的宏（参见第 3 点“带有宏的参数”）传递给调用 Black 并进行必要处理的自定义脚本。即你需要宏

  • FilePath - File Path
  • SelectionStartLine - Selected text start line number
  • SelectionEndLine - Select text end line number
  • PyInterpreterDirectory - The directory containing the Python interpreter selected for the project

但有时我想通过 PyCharm 在一个区域上执行 black -S。

您想作为参数传递的任何其他Black CLI 选项最好放在参数列表的末尾。

由于您可能在特定的 venv 上安装了 Black，因此该示例还使用了PyInterpreterDirectory宏。

屏幕截图说明了上述内容：

在此处输入图像描述

第2步。

您需要实现一个脚本来调用 Black 并与 IDE 交互。以下是一个工作示例。需要注意的是：

  1. 如评论所述，四行是特定于 OS/shell 的（将它们适应您的环境应该很简单）。
  2. 一些细节可以进一步调整，例如，实现做出了简单的选择。
import os
import pathlib
import tempfile
import subprocess
import sys

def region_to_str(file_path: pathlib.Path, start_line: int, end_line: int) -> str:

    file = open(file_path)
    str_build = list()

    for line_number, line in enumerate(file, start=1):
        if line_number > end_line:
            break
        elif line_number < start_line:
            continue
        else:
            str_build.append(line)

    return "".join(str_build)

def black_to_clipboard(py_interpeter, black_cli_options, code_region_str):

    py_interpreter_path = pathlib.Path(py_interpeter) / "python.exe"  # OS specific, .exe for Windows.

    proc = subprocess.Popen([py_interpreter_path, "-m", "black", *black_cli_options,
                             "-c", code_region_str], stdout=subprocess.PIPE)

    try:
        outs, errs = proc.communicate(timeout=15)
    except TimeoutExpired:
        proc.kill()
        outs, errs = proc.communicate()

    # By default Black outputs binary, decodes to default Python module utf-8 encoding.
    result = outs.decode('utf-8').replace('\r','')  # OS specific, remove \r from \n\r Windows new-line.

    tmp_dir_name = tempfile.gettempdir()
    tmp_file = tempfile.gettempdir() + "\\__run_black_tmp.txt"  # OS specific, escaped path separator.

    with open(tmp_file, mode='w+', encoding='utf-8', errors='strict') as out_file:
        out_file.write(result + '\n')

    command = 'clip < ' + str(tmp_file)  # OS specific, send result to clipboard for copy-paste.
    os.system(command)

def main(argv: list[str] = sys.argv[1:]) -> int:
    """External tool script to run black on a code region.

    Args:
        argv[0] (str): Path to module containing code region.
        argv[1] (str): Code region start line.
        argv[2] (str): Code region end line.
        argv[3] (str): Path to venv /Scripts directory.
        argv[4:] (str): Black CLI options.
    """
    # print(argv)
    lines_as_str = region_to_str(argv[0], int(argv[1]), int(argv[2]))
    black_to_clipboard(argv[3], argv[4:], lines_as_str)

if __name__ == "__main__":
    main(sys.argv[1:])

步骤 3。

困难的部分已经完成。让我们使用新功能。

通常在编辑器中选择您想要的行作为代码区域。必须强调这一点，因为前一个SelectionStartLine和SelectionEndLine宏需要选择才能工作。（见下一个截图）。

第4步。

运行之前实现的外部工具。这可以通过右键单击编辑器并选择External Tools > the_name_of_your_external_tool.

在此处输入图像描述

步骤 5。

只需粘贴（屏幕截图显示运行外部工具并按 后的结果Ctrl + v）。第 2 步中的实现将Black 的输出复制到操作系统的剪贴板，这似乎是更可取的解决方案，因为这样您在编辑器中更改文件Undo Ctrl + z也可以工作。通过在编辑器外以编程方式覆盖文件来更改文件会不太无缝，并且可能需要在编辑器内刷新它。

在此处输入图像描述

步骤 6。

您可以录制前面步骤的宏并将其与键盘快捷键相关联，以便在一次击键中获得上述功能（类似于复制粘贴Ctrl + c+ Ctrl + v）。

在此处输入图像描述

结束笔记。

  1. 如果您需要调试第 2 步中的功能，也可以使用与外部工具配置相同的宏来配置运行配置。

  2. 使用剪贴板时，请务必注意字符编码可以跨层更改。我决定clip直接从一个临时文件中使用并读入它，这是为了避免在命令行上将代码字符串传递给 Black，因为默认情况下 CMD Windows 编码不是 UTF-8。（对于 Linux 用户，这应该更简单，但可能取决于您的系统设置。）

  3. 一个重要的注意事项是，您可以在没有缩进级别的更广泛上下文的情况下选择代码区域。这意味着，例如，如果您只在一个类中选择 2 个方法，它们将被传递给 Black 并使用模块级函数的缩进级别进行格式化。如果您小心选择具有适当范围的代码区域，这应该不是问题。这也可以通过传递步骤 1SelectionStartColumn - Select text start column number中的附加宏并将该数量的空格添加到步骤 2脚本中的每一行来轻松解决。（理想情况下，这样的功能将由 Black 作为 CLI 选项实现。）在任何情况下，如果需要，使用将区域置于其适当的缩进级别是很容易的。Tab

  4. 问题的主要主题是如何将 Black 与代码区域的 PyCharm IDE 集成，因此演示第二个选项应该足以解决问题，因为在大多数情况下，第一个选项只会增加特定于实现的复杂性。（答案已经足够长了。实施第一个选项的细节将为 Black 项目提供一个很好的功能/拉取请求。）

于 2021-05-01T11:03:36.303 回答
1

我对此进行了研究，因为它实际上看起来很有趣，并且我得出的结论是您可以使用：

black -S and_your_file_path

或者：

black -c and_a_string

格式化作为字符串传入的代码。我也会关注这个线程，因为它看起来很有趣。
我也会对此做更多的研究，如果我发现了什么，我会告诉你的。

于 2021-02-08T14:37:52.617 回答