Repolode
jupyterlab-contrib

jupyterlab-contrib/jupyterlab_code_formatter

black、isort、yapf、autopep8などのフォーマッターで、ノートブックのコードセルを整形できるJupyterLab拡張機能。

スター
907
フォーク
71
未解決の Issue
27
最終コミット
3 か月前

これは何?

jupyterlab_code_formatterは、エディターを離れずにノートブックのセルやファイルへコードフォーマッターを実行できるJupyterLabプラグインです。サーバー側のコンポーネントから外部のフォーマッターツールを呼び出すため、Pythonプロジェクトで普段使っているフォーマッターをJupyterLabから直接利用できます。

標準設定では、Pythonコードの整形にisortとblackを使用します。リポジトリに関連付けられたトピックにはautopep8、yapf、Rの整形もサポート対象として記載されており、設定オプションで使用するフォーマッターと実行方法を指定できます。pipでインストールした後、フォーマッター自体もインストールし、JupyterLabを再起動します。

このパッケージはPythonサーバー拡張機能とnpmフロントエンド拡張機能で構成されており、両方が有効になっているか確認するためのトラブルシューティング手順も用意されています。

主な機能

  • 01JupyterLab内でノートブックのセルやコードを整形できます。
  • 02blackやisortなどの外部フォーマッターを呼び出します。Pythonではisortとblackが標準設定です。
  • 03リポジトリのトピックによると、autopep8、yapf、Rのコード整形にも対応しています。
  • 04使用するフォーマッターと実行オプションを設定できます。
  • 05フロントエンドとサーバーの各コンポーネントをpip経由でインストールします。

ユースケース

  • データサイエンス用ノートブックの書式を統一してから共有する。
  • blackやisortのスタイルルールに沿って、JupyterLab内のPythonコードを整える。
  • Rのフォーマッターが利用可能な場合に、JupyterLabのセッションでRコードを整形する。

クイックスタート

  1. 1

    パッケージをインストールします

    pip install jupyterlab-code-formatter
  2. 2

    対応しているフォーマッターをインストールします(Pythonでは isort と black がデフォルトです)

    pip install black isort
  3. 3

    JupyterLabを再起動します

  4. 4

    プラグインを設定します(設定ドキュメントを参照してください)

収録されている特集

トピック

#jupyterlab#python#code-formatter#black#isort#yapf#jupyter-extension#autopep8#jupyterlab-extension#jupyterlab-extensions

よくある質問

jupyterlab_code_formatter とは?
black、isort、yapf、autopep8などのフォーマッターで、ノートブックのコードセルを整形できるJupyterLab拡張機能。 jupyterlab_code_formatterは、エディターを離れずにノートブックのセルやファイルへコードフォーマッターを実行できるJupyterLabプラグインです。サーバー側のコンポーネントから外部のフォーマッターツールを呼び出すため、Pythonプロジェクトで普段使っているフォーマッターをJupyterLabから直接利用できます。
jupyterlab_code_formatter は無料で使えますか?ライセンスは?
jupyterlab_code_formatter は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
jupyterlab_code_formatter は今もメンテナンスされていますか?
半年以内に更新あり。jupyterlab_code_formatter の最終コミットは 2026年8月7日 です。
jupyterlab_code_formatter は何に使えますか?
データサイエンス用ノートブックの書式を統一してから共有する。 blackやisortのスタイルルールに沿って、JupyterLab内のPythonコードを整える。 Rのフォーマッターが利用可能な場合に、JupyterLabのセッションでRコードを整形する。
jupyterlab_code_formatter のインストール方法は?
パッケージをインストールします: pip install jupyterlab-code-formatter 対応しているフォーマッターをインストールします(Pythonでは isort と black がデフォルトです): pip install black isort JupyterLabを再起動します プラグインを設定します(設定ドキュメントを参照してください)
jupyterlab_code_formatter はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/jupyterlab-contrib/jupyterlab_code_formatter

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト