Python Black for Emacs 使用教程

Python Black for Emacs 使用教程

blacken Python Black for Emacs 项目地址: https://gitcode.com/gh_mirrors/bl/blacken

1. 项目目录结构及介绍

blacken 项目是一个将 Python 的 Black 代码格式化工具集成到 Emacs 编辑器中的 Emacs Lisp 包。项目目录结构如下：

• .github/：存放与 GitHub 相关的配置文件。
• .gitignore：定义 Git 忽略的文件和目录。
• Eask：与 Eask 相关的文件（Eask 是一个 Emacs 的任务运行器）。
• LICENSE：项目使用的许可证文件，本项目采用 GPL-3.0 许可。
• Makefile：构建项目时使用的 Makefile 文件。
• README.md：项目的说明文件。
• blacken.el：项目的主体 Emacs Lisp 文件，包含代码格式化功能。

2. 项目的启动文件介绍

blacken.el 是项目的启动文件，它是 Emacs Lisp 编写的。当你在 Emacs 中加载这个文件时，它提供了以下功能：

• blacken-buffer：格式化当前 Python 缓冲区。
• blacken-mode：在 Python 缓冲区中启用自动格式化，每次保存时都会运行。

启动 blacken 的方式通常是在你的 Emacs 配置文件中添加以下代码：

(require 'blacken)

如果你希望在每次打开 Python 文件时自动启用 blacken-mode，可以添加：

(add-hook 'python-mode-hook 'blacken-mode)

3. 项目的配置文件介绍

blacken 支持一些自定义选项来改变 Black 的行为。这些选项可以在你的 Emacs 配置文件中进行设置：

• blacken-allow-py36：允许在所有输入文件中使用 Python 3.6 特有的语法。
• blacken-skip-string-normalization：不规范化字符串引号或前缀。
• blacken-fast-unsafe：跳过临时的健全性检查。
• blacken-line-length：Black 强制的最大行长度。

以下是一个配置示例：

(custom-set-variables
 '(blacken-allow-py36 t)
 '(blacken-skip-string-normalization t)
 '(blacken-fast-unsafe t)
 '(blacken-line-length 80))

确保在 Emacs 中加载 blacken.el 文件之后设置这些变量，以便它们生效。通过自定义这些选项，你可以调整 Black 格式化 Python 代码的方式以满足个人偏好或项目要求。

blacken Python Black for Emacs 项目地址: https://gitcode.com/gh_mirrors/bl/blacken