はじめに¶
Black を初めて使用しますか?ご心配なく、最適な開始場所を見つけました!
Black のコードスタイルは気に入っていますか?¶
いくつかのコードで Black を使用する前に、Black がどのようにコードをフォーマットするかを理解しておくことをお勧めします。Black は万人向けではなく、個人的に問題となるものが見つかる場合がありますが、それは問題ありません!現在の Black コードスタイルはこちらで説明されています。
オンラインで試してみる¶
また、José Padilla氏によって作成されたBlack Playgroundで、最小限の手間でBlackをオンラインで試すことができます。
インストール¶
Black は pip install black
を実行することでインストールできます。実行には Python 3.8 以降が必要です。Jupyter Notebook をフォーマットする場合は、pip install "black[jupyter]"
でインストールしてください。
pipx を使用している場合は、pipx install black
で Black をインストールできます。
最新の機能を待ちきれず、GitHub からインストールしたい場合は、以下を使用してください。
pip install git+https://github.com/psf/black
基本的な使用方法¶
すぐに適切なデフォルト設定で開始するには
black {source_file_or_directory}...
スクリプトとして実行できない場合は、パッケージとしてBlackを実行できます。
python -m black {source_file_or_directory}...
次のステップ¶
Black のコードスタイルを確認して Black を試してみましたか?素晴らしいですね、準備万端です。 使用方法と設定:基本 を読んで、Black の使用方法をさらに詳しく調べてみませんか。あるいは、プロジェクトへの Black の導入 ガイドを参照することもできます。