Ruff v0.16.0 – 大幅な新アップデート – デフォルトルールが59から413に増加
Ruff v0.16.0 – Significant new updates – 413 default rules up from 59 (astral.sh)
要約
Pythonの高速リンター兼フォーマッターであるRuffがバージョン0.16.0にアップデートされました。今回のリリースでは、デフォルトで有効になるルールが59から413に大幅に増加し、より多くの潜在的な問題を早期に検出できるようになりました。また、Markdownファイル内のPythonコードブロックのフォーマット機能や、新しい抑制コメント形式の導入など、開発者の利便性を向上させる機能が追加されています。
全文翻訳
Ruff v0.16.0 – 大幅なアップデート – デフォルトルールが59から413に増加
Ruff v0.16 (https://github.com/astral-sh/ruff) がリリースされました! PyPI からインストールするか、お好みのパッケージマネージャーでインストールしてください。
uv tool install ruff@latest
念のためお伝えすると、Ruff は Rust で書かれた非常に高速な Python リンターおよびフォーマッターです。 Ruff は、Black、Flake8(および多数のプラグイン)、isort、pydocstyle、pyupgrade などを置き換えることができ、個々のツールよりも数十倍から数百倍高速に実行されます。
v0.16 への移行 #
Ruff v0.16 には少数の破壊的変更が含まれていますが、ほとんどのユーザーはコードや設定に大きな変更を加えることなくアップデートできます。主な例外は以下の通りです。
より優れたデフォルトルールセット #
Ruff はデフォルトで有効になるルールを、以前のバージョンから 59 件から 413 件に増やしました。
Ruff のデフォルトルールセットが最後に変更された v0.1.0 以降、Ruff のルール数は 708 件から 968 件に増加しました。これらのルールの多くは、構文エラー や 即時の実行時エラー など、深刻な問題を検出しますが、以前はデフォルトで有効になっていませんでした。新しいルールセットにより、Ruff はこれらの問題やその他多くの問題を、Ruff の設定なしで注意喚起するようになります。すでに select や extend-select を使用している場合でも、これまで発見できなかった役立つルールに気づくきっかけとなることを願っています。
有効になっているルールの完全なリストは長すぎるためここに含めることはできませんが、新しい デフォルトルール ページで確認できます。ハイライトの一部には、人気の flake8-bugbear (B) および pyupgrade (UP) リンターのルール、そして私たち自身の RUF カテゴリのルールが含まれます。
これは主に拡張ですが、意見の分かれる pycodestyle (E) および pyflakes (F) ルールのうち 18 件がデフォルトセットから削除されました: E401, E402, E701, E702, E703, E711, E712, E713, E714, E721, E731, E741, E742, E743, F403, F405, F406, および F722。
古いデフォルトセットに戻したい場合は、この設定で簡単に古いルールを select できます。
[lint]
select = ["E4", "E7", "E9", "F"]
この作業は、長年の目標である ルールの再分類 と密接に関連していると考えており、この分野での今後の展開にご期待ください。
v0.16 の新機能 #
Ruff v0.16 には、以下にハイライトされたいくつかの新しく安定化された機能も含まれています。
Markdown コードブロックのフォーマット #
Ruff は Markdown ファイルに埋め込まれた Python コードブロックをフォーマットできるようになりました。
これらのファイルでは、Ruff v0.16 は python, py, python3, py3, pyi, または pycon の info string を持つ fenced code block をフォーマットします。pyi ブロックはスタブファイルのようにフォーマットされ、pycon ブロックは REPL セッションとしてフォーマットされ、その他は通常の Python ファイルフォーマットを使用します。例:
# README
Here's an example:
```py
import ruff
ruff_binary = (
ruff.find_ruff_bin()
)
```
ruff format を実行すると、以下のように再フォーマットされます。
[画像: Ruff formatter output showing a Markdown code block that would be reformatted]
Ruff は言語が波括弧で囲まれている場合(例: ```{python})も認識するため、Quarto ノートブックのフォーマットにも使用できます。Quarto ファイルで .qmd 拡張子を使用している場合は、extension マッピングを設定する必要がある場合があります。
フォーマットを抑制する必要がある場合は、いくつかのオプションがあります。抑制コメントをコードブロック内に表示したい場合は、コードブロック自体内に通常の fmt: off および fmt: on コメントを使用するか、同様の HTML コメントを使用してドキュメント全体の領域のフォーマットを無効にすることができます。
# README
<!-- fmt: off -->
```py
x = "this will be suppressed"
```
<!-- fmt: on -->
Markdown フォーマットを完全に抑制するには、通常の extend-exclude 設定を使用して、*.md のようなグロブで全ての Markdown ファイルを除外できます。
詳細については、完全なドキュメント を参照してください。
ruff: ignore コメントが新しい抑制機能を提供 #
Ruff は独自の抑制コメント形式を持つようになり、単独の行で使用できるようになりました。
v0.15 では、Ruff リンターは、上記で説明した fmt: off と fmt: on のペアと同様に、ペアになった ruff: disable および ruff: enable コメントを通じて範囲抑制メカニズムを獲得しました。
# ruff: disable[N803]
def foo(
legacyArg1,
legacyArg2,
legacyArg3,
legacyArg4,
): ...
# ruff: enable[N803]
Ruff v0.16 はこれを拡張し、さらに 2 つの ruff 抑制コメントを追加しました。ruff: ignore は、noqa のように、同じ行または次の論理行の診断を抑制するために使用できます。
import math # ruff: ignore[F401]
# ruff: ignore[N803]
def foo(
legacyArg1,
legacyArg2,
legacyArg3,
legacyArg4,
): ...
この場合、論理行は関数ヘッダー全体(def からコロンまで)にまたがるため、ruff: ignore は上記の disable/enable ペアと同じ N803 診断をすべて抑制します。
ruff: file-ignore コメントは、ruff: noqa コメントと同様に、ファイル全体の診断を抑制するために使用できます。
# ruff: file-ignore[F401] Allow unused imports in this file
import foo
import bar
import baz
この例が示すように、これらのコメントの種類ごとに、追加された理由を説明する「理由」を関連付けることができます。この場合、「このファイル内の未使用のインポートを許可する」です。
ruff: ignore コメントは、新しい --add-ignore CLI フラグで自動的に追加できます。また、プレビュー では、これらの ruff 抑制コメントすべてがコードではなくルール名をサポートします。
❯ echo 'import math' > try.py
❯ uvx ruff@latest check --preview --add-ignore try.py
Added 1 ignore comment.
❯ cat try.py
import math # ruff: ignore[unused-import]
これらのコメントの完全な仕様は、ドキュメント で確認できます。
check および format --check の出力に修正が表示されるように #
Ruff は、リンターおよびフォーマッターの修正による差分を、診断のレンダリング時に表示するようになりました。
check および format サブコマンドは、check --fix または format で修正を適用した変更を表示するために --diff フラグを長らくサポートしていましたが、これは通常の出力とは別であり、付随する説明的な診断を抑制していました。v0.16 では、利用可能な修正が、help サブ診断の下にレンダリングされるデフォルトの full 出力形式の一部として表示されるようになりました。
[画像: Ruff check output showing the diff for an unused-import fix]
format --check についても同様です。以下の入力の場合:
# example.py
if True:
pass
elif False:
pass
フォーマッターは以下を生成します。
[画像: Ruff formatter output showing the diff for an unformatted file]
format --check も、リンターがサポートする出力形式の全選択肢をサポートするようになりました。これにより、マシン可読の JSON 出力を取得したり、CI でアノテーションをレンダリングするために GitHub および GitLab が期待する形式を生成したりできます。サポートされている形式の完全なリストについては、CLI ヘルプまたはドキュメント を参照してください。
出力形式に関する最後の注意点として、v0.16 では JSON 出力に小さな破壊的変更があります。filename, location, end_location, fix.edits[].location, および fix.edits[].end_location フィールドは、デフォルトで空文字列と行 1、列 1 になるのではなく、null になる場合があります。これは Ruff の既存の診断の非常に少ない数に影響しますが、内部的な診断表現をより良く反映しており、将来のルールでより一般的になる可能性があります。
ルールの安定化 #
以下のルールが安定化され、プレビュー モードではなくなりました。
airflow3-incompatible-function-signature(AIR303)missing-copyright-notice(CPY001)unnecessary-from-float(FURB164)sorted-min-max(FURB192)implicit-string-concatenation-in-collection-literal(ISC004)log-exception-outside-except-handler(LOG004)invalid-bool-return-type(PLE0304)too-many-positional-arguments(PLR0917)stop-iteration-return(PLR1708)none-not-at-end-of-union(RUF036)access-annotations-from-class-dict(RUF063)duplicate-entry-in-dunder-all(RUF068)
その他の動作の安定化 #
このリリースでは、以前は プレビューモード でのみ利用可能だった追加の動作も安定化しています。
blind-except(BLE001) は、例外がcritical,error,exception以外のloggingメソッドでログに記録される場合に抑制されるようになりました。future-required-type-annotation(FA102) は、collections.abcなど、PEP 585 (https://peps.python.org/pep-0585/) 互換の API を追加でチェックするようになりました。f-string-in-get-text-func-call(INT001),format-in-get-text-func-call(INT002), およびprintf-in-get-text-func-call(INT003) は、gettextをbuiltins._に割り当てるなど、gettextモジュールの使用に関するその他の一般的な方法をチェックするようになりました。suspicious-url-open-usage(S310) は、より多くの偽陽性を回避するために、ローカル文字列リテラルのバインディングを解決するようになりました。snmp-insecure-version(S508) およびsnmp-weak-cryptography(S509) は、PySNMP の新しいバージョンの推奨 API をサポートするようになりました。typing-text-str-alias(UP019) は、typing.Textに加えてtyping_extensions.Textも認識するようになりました。
ありがとうございます! #
Ruff の プレビューモード に含まれる変更点に関するフィードバックを提供してくださった皆様、および貢献者の皆様に感謝いたします。Ruff を皆様と共に構築できることを光栄に思います!
GitHub で完全な変更履歴をご覧ください。
Astral — Ruff の背後にある企業 — についてもっと読む。
この記事の執筆には Zanie Blue, David Peter, Micha Reiser, Alex Waygood が貢献しました。