how to use the tool on windows

[ssamdani-1729]

I'm wondering how I can make this work on a windows version of Pycharm. I have installed the black tool in a conda virtual environment and this same virtual environment is being used by PyCharm.

[neulaender]

As the tool needs to be installed in /usr/local/bin/black I guess there is no way for windows. You might try the ubuntu-shell for windows?

[ghost]

You can configure the pycharm plugin from pycharm's file -> settings -> tools menu. There you can set the path to the black executable.

You can also setup an external tool hook in pycharm, also in settings > tools. However this won't use the plugin but will run the tool directly.

[JosXa]

I would love to see either of the following two things in order to make the plugin work on windows:

• Make the PyCharm Black plugin settings global, instead of a per-project basis
• Detect if PyCharm is running on Windows, and if so, provide something like C:\Program Files\Python36\Scripts\black.exe as the default path

(obviously the 1st being the easier option).

[denis-roy]

As per Black's documentation section on integrations, no plugin is required to use Black in PyCharm.

Here's a working procedure for v19.10b1.dev49 which is the current latest at the date of this post:

---

PyCharm/IntelliJ IDEA Integration

Install Black

$ pip install black

Locate your Black installation folder

On macOS / Linux / BSD:

$ which black
/usr/local/bin/black        
^-possible location-^

On Windows:

$ where black
%LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe
^-possible location-^

Open External tools in PyCharm/IntelliJ IDEA

On macOS:

PyCharm -> Preferences -> Tools -> External Tools

On Windows / Linux / BSD:

File -> Settings -> Tools -> External Tools

Add Black as an external tool

Click the + icon to add a new external tool with the following values:

• Name: Black
• Description: Black is the uncompromising Python code formatter.
• Program: <path to your local installation>
• Arguments: "$FilePath$"

Usage

Format the currently opened file by selecting Tools -> External Tools -> black. Alternatively, you can set a keyboard shortcut by navigating to Preferences or Settings -> Keymap -> External Tools -> External Tools - Black

Optionally, run Black on every file save

⚠ Make sure you have the File Watcher plugin installed.

Go to Preferences or Settings -> Tools -> File Watchers and click + to add a new watcher:

• Name: Black
• File type: Python
• Program: <path to your local installation>
• Arguments: $FilePath$
• Output paths to refresh: $FilePath$
• Working directory: $ProjectFileDir$
• Uncheck Auto-save edited files to trigger the watcher