PyCharm and PYTHONPATH

Question

I am new to PyCharm. I have a directory that I use for my PYTHONPATH: c:\test\my\scripts\. In this directory I have some modules I import. It works fine in my Python shell.

How do I add this directory path to PyCharm so I can import what is in that directory?

"You need to go to the Main PyCharm Preferences, which will ...." There is no longer such things as "Main PyCharm" or "Preferences" in 2018.1.4 Community Edition, see https://stackoverflow.com/questions/48947494/add-directory-to-python-path-in-pycharm — user1596683, Jul 09 '18 at 17:24

score 163 · Answer 1 · edited Jul 25 '19 at 00:35

163

Out of data, see Duane's answer below.

You need to go to the Main PyCharm Preferences, which will open up a separate window. In the left pane, choose Project:... > Project Interpreter. Now, in the main pane on the right, click the settings symbol (gear symbol) next to the field for "Project Interpreter". Choose More or Show All in the menu that pops up. Now in the final step, pick the interpreter you are using for this project and click on the tree symbol at the bottom of the window (hovering over the symbol reveals it as "Show paths for the selected interpreter"). Add your path by click in the "plus" symbol.

It took me ages to find, so I hope the detailed instructions will help. Further details are available in the PyCharm docs.

It is good practice to have __init__.py in each subfolder of the module you are looking to add, as well as making your project folder a 'Source Root'. Simply right-click on the folder in the path bar and choose 'Mark Directory as ...'

edited Jul 25 '19 at 00:35

jodag

15,363
3
40
56

answered Aug 18 '16 at 18:08

Hendrik F

3,290
3
18
22

6

Not sure why, but this is the first solution that has worked for me. – jds Aug 19 '16 at 20:31
4

I also would rather have chosen this one. It works. Thanks! – alisa Nov 08 '16 at 19:01
1

Correct answer. – ScoPi Sep 14 '17 at 17:33
@alisa You can change the most-helpful answer by just marking another one as the answer. – Brent Faust Oct 13 '17 at 19:41
There is no longer a **More** entry. Now there is **Add Local...**. Not sure of the next step. (Pycharm 2017.3.3 on MacOS) – Ray Salemi Mar 06 '18 at 22:12
7

Instead of the **More** entry, which doesn't exist anymore, you should now click on **Show All...** once you are in the project interpreter page and click on the settings icon. – Oriol Mirosa Mar 11 '18 at 22:25
Any suggestions for folks using Intellij with Python plugin? – Pratik Khadloya May 28 '20 at 13:13
Works like charm! Though it's weird that CLion uses this way of assigning paths to look for modules in. PYTHONPATH seems to be more trivial and known to everybody... – Oleksandr Novik Nov 27 '21 at 14:13

Duane · Answer 2 · 2020-01-20T05:40:58.103

80

For Pycharm Community 2019.3

File
Settings
Project
Project Interpreter
Cog in top right => Show all
Select the interpreter
On the right toolbar, there are 5 icons, bottom one looks like a folder tree, click it
Press plus +
Select directory, press OK

edited Jan 20 '20 at 05:40

answered Nov 23 '18 at 01:09

Duane

3,743
3
26
29

PyCharm 2018/03: there is no "folder tree" icon. – Danijel Mar 21 '19 at 10:10
1

Added the icon for clarity. From 2018.3.5 – Duane Mar 23 '19 at 03:23
1

In current version (2019.3.1) the cogwheel is in position "top right". – jMike Jan 19 '20 at 08:23
1

Where is the config file that storing such information? – zwcloud Jul 09 '20 at 06:26
no such icon anymore (2021.3.3 pro)... how was this dialog called? – grreeenn Apr 08 '22 at 00:03

alkalinity · Answer 3 · 2020-03-02T15:57:59.620

41

In PyCharm Community 2019.2/2019.3 (and probably other versions), you can simply:

right-click any folder in your project
select "Mark Directory As"
select "Sources Root"

Modules within that folder will now be available for import. Any number of folders can be so marked.

edited Mar 02 '20 at 15:57

answered Aug 14 '19 at 15:40

alkalinity

1,390
2
22
31

What about a local package which isn't part of the project? What would be the implications of including this foreign directory in the project and marking it as "Sources Root"? – YvesgereY Feb 08 '21 at 13:56
1

@YvesgereY Assuming you can see the directory in the first place (can you?) I don't see a problem with that. So far as I know, 'Sources Root' doesn't have any special meaning but to use that directory for resolving imports – alkalinity Feb 08 '21 at 21:35

PyCharm and PYTHONPATH

3 Answers3

Linked

Related