DatabricksノートブックでPythonセルのフォーマットをサポートしました

Posted at 2022-10-23

何のことかと思われるかもしれませんが、こちらです。

とりあえず、該当のセクションの翻訳を。後で下のマニュアルの翻訳にマージします。

コードセルのフォーマット

Databricksでは、ノートブックのセルにあるPythonとSQLのコードをクイックかつ簡単にフォーマットするツールを提供しています。これらのツールによって、コードがフォーマットされた状態を維持し、どのノートブックにおいても同じコーディング規約を強制する助けとなります。

プレビュー
この機能はパブリックプレビューです。

Databricksランタイム11.2以降では、ノートブック内のコードをフォーマットするためにBlackを使用します。ノートブックはクラスターにアタッチされている必要があり、ノートブックがアタッチされているクラスター上でBlackが実行されます。

コードをフォーマットするにはノートブックのCan Edit権限が必要となります。

以下の方法で、フォーマッターを起動することができます。

単一セルのフォーマット
- キーボードショートカット：Cmd+Shift+Fを押します。
- コマンドコンテキストメニュー
  - SQLセルのフォーマット：SQLセルのコマンドコンテキストドロップダウンメニューのFormat SQLを選択します。このメニュー項目はSQLノートブックセルか%sql言語マジックを持つセルでのみ表示されます。
  - Pythonセルのフォーマット：PythonセルのコマンドコンテキストドロップダウンメニューのFormat Pythonを選択します。このメニュー項目はPythonノートブックセルか%python言語マジックを持つセルでのみ表示されます。
複数セルのフォーマット

複数のセルを選択し、Edit > Format Cell(s) を選択します。1つ以上の言語のセルを選択した場合には、PythonとSQLのセルがフォーマットされます。これには%sqlや%pythonを使用しているものも含まれます。
ノートブック内のすべてのPythonとSQLセルのフォーマット

Edit > Format Notebookを選択します。1つ以上の言語のセルが含まれている場合には、PythonとSQLのセルがフォーマットされます。これには%sqlや%pythonを使用しているものも含まれます。

Blackは4スペースのインデントに対してPEP 8を強制します。インデントの設定はできません。
SQL UDFの中に埋め込まれたPython文字列のフォーマットはサポートされていません。同様に、Python UDF内のSQL文字列のフォーマットもサポートされていません。

Databricksランタイム11.2以降のクラスターを起動して、ノートブックをアタッチします。

フォーマットしたいセルに移動してコンテキストメニューを展開します。Pythonをフォーマットを選択します。特に14行に注目していてください。個人的にはこの状態は耐えられません。

綺麗にフォーマットされました！

ノートブック全体をフォーマットするには編集 > ノートブックをフォーマットを選択します。

フォーマッターを用いることで、共通のコード規約を強制できるとチーム間でのコード共有が捗ると思います。