使用Ruff改善Python编程风格

译文
开发 前端
Ruff的700多个内置代码检查(lint)规则已用Rust重新实现以提高速度,并提供了全面的代码检查和格式化,以强制执行干净一致的Python代码。

译者 | 布加迪

审校 | 重楼

Ruff简介

Ruff是一个用Rust编写的运行速度极快的Python代码检查器和格式化器,旨在取代和改Flake8Blackisort等现有工具它将性能提升了10倍至100倍,同时通过700多个内置规则和重新实现的流行插件保持奇偶校验。

图1.从头开始检查CPython代码库图1.从头开始检查CPython代码库

RuffPython 3.12兼容,支持现代 Python。它还提供自动修复支持、缓存和编辑器集成。Ruff一代码库友好,用于PandasFastAPI各大开源项目由于集速度、功能和可用性于一体Ruff代码检查、格式化和自动修复集成到统一的工具中,速度比现有的工具快几个数量级。

Ruff入门

我们可以使用PIP轻松安装Ruff

pip install ruff

为了测试Ruff运行起来有多容易多快速,我们可以使用DagHub存储库kingabzpro/Yoga-Pose-Classification。您可以克隆它,也可以使用自己的项目进行格式化。

图2. 项目结构图2. 项目结构

首先,我们将对项目运行代码检查。您也可以单个文件运行代码检查,只需把“.”换成文件位置。

ruff check .

Ruff已经确定了9个错误和1个可修复的错误。为了修复这个错误,我们将使用--fix标志。

ruff check --fix

正如您所,它修复了1个可修复的错误。

要格式化项目,我们可以使用ruff format命令。

$ ruff format .
>>> 3 files reformatted

Ruff代码检查器和格式化器对代码进行了大量更改。但是我们为什么需要这些工具答案很简单——它们有利于执行编码标准和约定。因此,您和您的团队可以专注于代码的重要方面。此外,它们有助于提高代码的质量、可维护性和安全性。

检查和格式化Jupyter Notebooks

要在项目中使用Ruff for Jupyter Notebooks,您必须创建“ruff.toml”文件,并添加以下代码

extend-include = ["*.ipynb"]

您还可以对pyproject .toml”执行相同的操

之后,重新运行命令,看看它是否对Jupyter notebook文件进行了更改。

2个文件被重新格式化,我们有2个Notebook文件

$ ruff format .
>>> 2 files reformatted, 3 files left unchanged

我们还通过再次运行check命令修复这些文件中的问题。

$ ruff check --fix .
>>> Found 51 errors (6 fixed, 45 remaining).

最后的结果是惊人的。它在不破坏代码的情况下进行了所有必要的更改。

Ruff配置

很容易为Jupyter Notebooks配置Ruff,只需编辑“ruff.toml”文件来调整代码检查器和格式化器设置。请查看配置Ruff文档以了解更多详细信息。

target-version = "py311"
extend-include = ["*.ipynb"]
line-length = 80

[lint]
extend-select = [
 "UP", # pyupgrade
 "D", # pydocstyle
]

[lint.pydocstyle]
convention = "google"

GitHub Action和预提交钩子

发人员和团队可以通过“ruff -pre-commit将Ruff用作预提交钩子

- repo: https://github.com/astral-sh/ruff-pre-commit
 # Ruff version.
 rev: v0.1.5
 hooks:
 # Run the linter.
 - id: ruff
 args: [ --fix ]
 # Run the formatter.
 - id: ruff-format

它还可以通过“ruff-action”用作GitHub Action

name: Ruff
on: [ push, pull_request ]
jobs:
 ruff:
 runs-on: ubuntu-latest
 steps:
 - uses: actions/checkout@v3
 - uses: chartboost/ruff-action@v1

Ruff VSCode扩展

Ruff最讨人喜欢的方面是VSCode扩展。它简化了格式化和代码检查,因而不需要第三方扩展。只需在扩展市场上搜索Ruff即可安装它。

我已经配置了“setting.json”,以便在保存时格式化。

结语

Ruff提供了速度飞快代码检查和格式化,使Python代码更干净、更一致。Ruff从Flake8、isort和pyupgrade等流行工具中汲取灵感,通过Rust重新实现700多个内置规则来提高性能,从而实现了一套全面的编码最佳实践。精挑细选的规则集专注于捕捉错误和关键的风格问题,又不过度挑剔。

与预提交钩子、GitHub Actions和VSCode等编辑器无缝集成使用户可以将Ruff轻松整合到现代Python工作流中。无与伦比的速度和精心设计的规则集使Ruff成为重视快速反馈、干净代码和团队顺畅协作的Python开发人员的必备工具。Ruff通过将强大的功能与出色的性能相结合,为Python代码检查和格式化设了新的标准。

原文标题:Enhance Your Python Coding Style with Ruff,作者:Abid Ali Awan

责任编辑:华轩 来源: 51CTO
相关推荐

2020-06-02 08:54:47

编程语言C语言程序员

2017-02-13 13:14:07

2011-07-27 14:10:43

javascript

2020-07-17 19:36:26

Python编程代码

2017-01-12 14:55:50

JavaScript编程

2015-09-22 10:04:38

GoogleJava编程

2013-07-10 11:32:57

编码风格

2023-04-24 13:29:46

2012-03-22 17:16:24

Java

2023-08-14 14:04:14

JavaScript函数式编程

2021-05-28 09:10:40

JavaScript性能GPU

2021-05-28 05:34:06

Golang语言编程

2017-12-14 14:32:30

.Net内存代码

2010-03-16 16:47:58

Java编程语言

2020-12-01 06:53:37

GPUJavaScript

2020-05-06 07:32:05

物联网IOT企业

2020-11-23 15:49:28

物联网

2018-09-08 09:25:05

编程语言PythonVS Code

2023-04-12 08:00:00

人工智能ChatGPTPython

2013-07-23 15:11:41

流行编程风格
点赞
收藏

51CTO技术栈公众号