Configure an interpreter using WSL

Fulfill the preliminary steps

1. Ensure that you have downloaded and installed Python on your computer.

2. Click the Windows button in the lower-left corner of the screen and start typing System Information. To ensure that your system works well with WSL, upgrade your Windows to the latest available version.

3. Install the Windows Subsystem for Linux and initialize your Linux distribution as described in the WSL Installation Guide.

4. If your Linux distribution doesn't come with rsync, you need to install it:

   sudo apt install rsync

Configure remote interpreter via WSL

1. Press Ctrl+Alt+S to open the project Settings/Preferences.

2. In the Settings/Preferences dialog Ctrl+Alt+S, select Project <project name> | Python Interpreter. Click the icon and select Add.

   

3. In the left-hand pane of the dialog, click WSL.

   

4. Select the Linux distribution and specify the path to the python executable in the selected Linux distribution. Typically, you should be looking for wsl.exe but you can specify any non default WSL distro.

Once done, the new interpreter will be added to your project, and the default mnt mappings will be set.

Note that with WSL you cannot create virtual environments: all packages you install will be added to the corresponding system interpreter. You will be asked to enter your sudo password.

Add a custom distribution

1. Open the %APPDATA%\JetBrains\<product><version>\config\options\wsl.distributions.xml file.

2. Add the descriptor element and provide settings to access your custom distribution. Note that the id value should be unique. For example:

   <!-- ... --> <descriptor> <id>Arch</id> <microsoft-id>Arch</microsoft-id> <executable-path>c:/linux/arch.exe</executable-path> <presentable-name>Arch</presentable-name> </descriptor> <!-- ... -->

   Consult the Windows registry to check the id and executable-path values.

   

3. Restart PyCharm and add your custom distribution as a remote interpreter as described above.

   

Configure Terminal

1. To run Terminal in WSL configuration, open project Settings/Preference (Ctrl+Alt+S) and go to Tools | Terminal.

2. Type wsl.exe in the Shell path field and click Ok.

   

3. Switch to the Terminal tool window and type any command to inspect the output.

   

Configure system settings to enable debugging

Perform the following steps to ensure that the debugger works properly:

1. Run the Windows PowerShell as administrator.

   

2. Execute the following command to allow connections using WSL:

   New-NetFirewallRule -DisplayName "WSL" -Direction Inbound -InterfaceAlias "vEthernet (WSL)" -Action Allow

3. Then execute the command to renew the firewall rules:

   Get-NetFirewallRule | where DisplayName -ILike "*PyCharm*" | Remove-NetFirewallRule

4. Now start the debugger session. When the Windows Firewall popup appears, select the Public networks checkbox.