From 6b42c2b8c9f9bd666120a2c19b8da509fe477f27 Mon Sep 17 00:00:00 2001 From: Antonio Ossa-Guerra Date: Mon, 26 Sep 2022 18:45:34 -0300 Subject: [PATCH] Add option to format Jupyter Notebooks in GitHub Action (#3282) To run the formatter on Jupyter Notebooks, Black must be installed with an extra dependency (`black[jupyter]`). This commit adds an optional argument to install Black with this dependency when using the official GitHub Action [1]. To enable the formatter on Jupyter Notebooks, just add `jupyter: true` as an argument. Feature requested at [2]. [1]: https://black.readthedocs.io/en/stable/integrations/github_actions.html [2]: https://github.com/psf/black/issues/3280 Signed-off-by: Antonio Ossa Guerra --- AUTHORS.md | 1 + CHANGES.md | 2 ++ action.yml | 6 ++++++ action/main.py | 7 ++++++- docs/integrations/github_actions.md | 5 +++++ 5 files changed, 20 insertions(+), 1 deletion(-) diff --git a/AUTHORS.md b/AUTHORS.md index 5336062..f2d599d 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -29,6 +29,7 @@ Multiple contributions by: - [Andrey](mailto:dyuuus@yandex.ru) - [Andy Freeland](mailto:andy@andyfreeland.net) - [Anthony Sottile](mailto:asottile@umich.edu) +- [Antonio Ossa Guerra](mailto:aaossa+black@uc.cl) - [Arjaan Buijk](mailto:arjaan.buijk@gmail.com) - [Arnav Borbornah](mailto:arnavborborah11@gmail.com) - [Artem Malyshev](mailto:proofit404@gmail.com) diff --git a/CHANGES.md b/CHANGES.md index 6fb0990..c96d9a6 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -58,6 +58,8 @@ +- Update GitHub Action to support formatting of Jupyter Notebook files via a `jupyter` + option (#3282) - Update GitHub Action to support use of version specifiers (e.g. `<23`) for Black version (#3265) diff --git a/action.yml b/action.yml index cfa6ef9..35705e9 100644 --- a/action.yml +++ b/action.yml @@ -12,6 +12,11 @@ inputs: description: "Source to run Black. Default: '.'" required: false default: "." + jupyter: + description: + "Set this option to true to include Jupyter Notebook files. Default: false" + required: false + default: false black_args: description: "[DEPRECATED] Black input arguments." required: false @@ -38,6 +43,7 @@ runs: # TODO: Remove once https://github.com/actions/runner/issues/665 is fixed. INPUT_OPTIONS: ${{ inputs.options }} INPUT_SRC: ${{ inputs.src }} + INPUT_JUPYTER: ${{ inputs.jupyter }} INPUT_BLACK_ARGS: ${{ inputs.black_args }} INPUT_VERSION: ${{ inputs.version }} pythonioencoding: utf-8 diff --git a/action/main.py b/action/main.py index 03228cb..ff9d411 100644 --- a/action/main.py +++ b/action/main.py @@ -9,6 +9,7 @@ ENV_PATH = ACTION_PATH / ".black-env" ENV_BIN = ENV_PATH / ("Scripts" if sys.platform == "win32" else "bin") OPTIONS = os.getenv("INPUT_OPTIONS", default="") SRC = os.getenv("INPUT_SRC", default="") +JUPYTER = os.getenv("INPUT_JUPYTER") == "true" BLACK_ARGS = os.getenv("INPUT_BLACK_ARGS", default="") VERSION = os.getenv("INPUT_VERSION", default="") @@ -17,7 +18,11 @@ run([sys.executable, "-m", "venv", str(ENV_PATH)], check=True) version_specifier = VERSION if VERSION and VERSION[0] in "0123456789": version_specifier = f"=={VERSION}" -req = f"black[colorama]{version_specifier}" +if JUPYTER: + extra_deps = "[colorama,jupyter]" +else: + extra_deps = "[colorama]" +req = f"black{extra_deps}{version_specifier}" pip_proc = run( [str(ENV_BIN / "python"), "-m", "pip", "install", req], stdout=PIPE, diff --git a/docs/integrations/github_actions.md b/docs/integrations/github_actions.md index d77b969..12bcb21 100644 --- a/docs/integrations/github_actions.md +++ b/docs/integrations/github_actions.md @@ -39,6 +39,10 @@ or just the version number if you want an exact version. The action defaults to latest release available on PyPI. Only versions available from PyPI are supported, so no commit SHAs or branch names. +If you want to include Jupyter Notebooks, _Black_ must be installed with the `jupyter` +extra. Installing the extra and including Jupyter Notebook files can be configured via +`jupyter` (default is `false`). + You can also configure the arguments passed to _Black_ via `options` (defaults to `'--check --diff'`) and `src` (default is `'.'`) @@ -49,6 +53,7 @@ Here's an example configuration: with: options: "--check --verbose" src: "./src" + jupyter: true version: "21.5b1" ``` -- 2.39.5