跳至内容

fmt

新功能在 0.20.0 中

在项目上运行代码格式化程序。此命令是 format 的别名。

有关如何配置 Ruff 的更多信息，请查看 Ruff 配置文档。

示例

要格式化代码并写回文件

$ rye fmt
1 file reformatted, 231 files left unchanged

仅检查代码是否需要格式化

$ rye fmt --check
Would reformat: src/my_project/utils.py
1 file would be reformatted, 231 files already formatted

要将额外参数传递给底层的 ruff 格式化程序，请使用 --

$ rye fmt -- --diff
--- src/my_project/utils.py
+++ src/my_project/utils.py
@@ -2,5 +2,4 @@


 def foo():
-
     pass

1 file would be reformatted, 231 files already formatted

格式化特定文件

rye fmt src/foo.py

参数

  • [PATHS]... 要 lint 的文件或目录列表。如果未提供，将格式化所有文件。

  • [EXTRA_ARGS]... 传递给格式化程序的额外参数。

    这些参数将直接转发到底层的格式化程序（当前始终为 ruff）。请注意，额外参数必须使用 -- 标记与其他参数隔开。

选项

  • -a, --all: 格式化工作区中的所有包

  • -p, --package <PACKAGE>: 格式化特定包

  • --pyproject <PYPROJECT_TOML>: 使用此 pyproject.toml 文件

  • --check: 在检查模式下运行格式化

  • -v, --verbose: 启用详细诊断

  • -q, --quiet: 关闭所有输出

  • -h, --help: 打印帮助（使用“-h”查看摘要）