Unresolved reference issue in PyCharm

Question

I have a directory structure

├── simulate.py
├── src
│   ├── networkAlgorithm.py
│   ├── ...

And I can access the network module with sys.path.insert().

import sys
import os.path
sys.path.insert(0, "./src")
from networkAlgorithm import *

However, pycharm complains that it cannot access the module. How can I teach pycham to resolve the reference?

enter image description here

Yes in order for python to identify packages: http://stackoverflow.com/questions/42094723/pycharm-marking-a-folder-as-sources-root-is-not-recursive-for-subfolders/ — rnoodle, Feb 10 '17 at 16:48
I renamed the class name and continue working on it. When i hit run, there was this error, totally forgot renaming and tried looking for pycharm suggestions during import. Damn, suggestions are case sensitive! - New to python!! — Vignesh Paramasivam, Apr 09 '19 at 18:01

score 934 · Accepted Answer · edited Nov 01 '20 at 17:58

934

Manually adding it as you have done is indeed one way of doing this, but there is a simpler method, and that is by simply telling pycharm that you want to add the src folder as a source root, and then adding the sources root to your python path.

This way, you don't have to hard code things into your interpreter's settings:

Add src as a source content root:

enter image description here

Then make sure to add add sources to your PYTHONPATH under:

Preferences ~ Build, Execution, Deployment ~ Console ~ Python Console

enter image description here

Now imports will be resolved:

enter image description here

This way, you can add whatever you want as a source root, and things will simply work. If you unmarked it as a source root however, you will get an error:

enter image description here

After all this don't forget to restart. In PyCharm menu select: File --> Invalidate Caches / Restart

edited Nov 01 '20 at 17:58

Alan W. Smith

21,861
3
64
88

answered Jan 20 '14 at 18:59

Games Brainiac

71,327
31
126
185

21

This also works if you're using the Python plugin with IntelliJ. – rob mayoff Feb 27 '14 at 00:56
13

This solution works. The problem of it is that when another programmer retrieves the code from svn, she has to do the same settings again to get rid of the "unresolved reference" error prompt. – Ben Lin Mar 20 '14 at 18:00
@BenLin True, however for all other solutions you would have to do the same. – Games Brainiac Mar 20 '14 at 22:19
2

@GamesBrainiac, the solution is that the IDE can parse "sys.path.insert(0, "./src")" add that into PYTHONPATH for this specific file, then give proper syntax analysis. – Ben Lin Mar 21 '14 at 16:33
2

You also need to make sure your content root path is correct. In pycharm 5 you can find this in Preferences -> Project -> Project Structure. – lps Nov 24 '15 at 18:18
1

Strangely, sub-directories are not taken into account. For example, if under `src`, we have `views` folder inside which I have `myview.py`, I still receive unresolved reference error when trying `from src.views.myview import `... – SexyBeast Jun 02 '16 at 22:47
Just for the record: if you're using django, the root folder should be that one named `projectName` with the `manage.py` inside (not that one with virtual env etc.) – thicolares Apr 30 '17 at 16:10
1

I had to make my "trunk" folder (in SVN) the Source Root. Then it worked for me. When I tried the folder above that; it didn't work for some odd reason. – Joe Dec 04 '17 at 18:42
This works great. I just had to add multiple folders as source route. thanks – Aqib Mumtaz May 15 '18 at 07:36
The solution provided by @robmayoff works, too. Installed Python plugins and the issue has gone away. Thanks – AlexPes Sep 06 '18 at 11:00
In `IntelliJ IDEA 2016+` this option has been relocated; see [**@AeroHil**'s answer](https://stackoverflow.com/a/43433438/3679900) – y2k-shubham Oct 03 '18 at 07:11
What is the difference if you do the second step of adding sources to PYTHONPATH or not? Are both step 1 (add src as source content root) and step 2 (add sources to PYTHONPATH) necessary under all circumstances? – Gandalf Saxe Dec 27 '18 at 22:58
2

Damn I just want to mark this answer as a life saver! – H. Arponen Jul 06 '20 at 20:10
why was this a problem? – Stéphane Bruckert Oct 31 '20 at 22:46

score 58 · Answer 2 · answered Jan 10 '17 at 23:23

58

check for __init__.py file in src folder
add the src folder as a source root
Then make sure to add add sources to your PYTHONPATH (see above)
in PyCharm menu select: File --> Invalidate Caches / Restart

answered Jan 10 '17 at 23:23

Ukr

1,463
13
13

14

This very last step was the only thing missing in my solution. The accepted answer might add this to it. – aimbire Nov 14 '17 at 19:41
without the last step mentioned here, the accepted answer is not working. Accepted answer should add this step as well/ – santhosh kumar Jun 08 '20 at 10:12

AeroHil · Answer 3 · 2017-09-01T16:51:58.173

29

If anyone is still looking at this, the accepted answer still works for PyCharm 2016.3 when I tried it. The UI might have changed, but the options are still the same.

ie. Right click on your root folder --> 'Mark Directory As' --> Source Root

edited Sep 01 '17 at 16:51

answered Apr 16 '17 at 03:36

AeroHil

559
6
5

3

So many complex answers in this discussion. The solution presented here worked for me so easily. – May 27 '19 at 04:39

mehdi · Answer 4 · 2016-12-12T13:08:39.610

18

After testing all workarounds, i suggest you to take a look at Settings -> Project -> project dependencies and re-arrange them.

pycharm prefrence

edited Dec 12 '16 at 13:08

answered Dec 12 '16 at 13:03

mehdi

181
1
4

This works perfectly for me. I have installed `pygame` there and not more unresolved reference issue! – Michal Przybylowicz Apr 14 '19 at 08:00

score 15 · Answer 5 · answered Jan 20 '14 at 17:18

15

Normally, $PYTHONPATH is used to teach python interpreter to find necessary modules. PyCharm needs to add the path in Preference.

enter image description here

answered Jan 20 '14 at 17:18

prosseek

155,475
189
518
818

score 6 · Answer 6 · answered Mar 15 '17 at 09:31

6

Generally, this is a missing package problem, just place the caret at the unresolved reference and press Alt+Enter to reveal the options, then you should know how to solve it.

answered Mar 15 '17 at 09:31

Ch_y

310
1
4
14

score 4 · Answer 7 · answered Feb 17 '18 at 14:38

4

Install via PyCharm (works with Community Edition). Open up Settings > Project > Project Interpreter then click the green + icon in the screenshot below. In the 2nd dialogue that opens, enter the package name and click the 'Install Package' button.

answered Feb 17 '18 at 14:38

danday74

38,089
29
169
214

score 4 · Answer 8 · edited May 16 '18 at 14:34

After following the accepted answer, doing the following solved it for me:

File → Settings → Project <your directory/project> → Project Dependencies

Chose the directory/project where your file that has unresolved imports resides and check the box to tell Pycharm that that project depends on your other project.

My folder hierarcy is slightly different from the one in the question. Mine is like this

├── MyDirectory  
│     └── simulate.py  
├── src  
│     ├── networkAlgorithm.py  
│     ├── ...

Telling Pycharm that src depends on MyDirectory solved the issue for me!

score 4 · Answer 9 · answered Dec 09 '19 at 10:19

Although all the answers are really helpful, there's one tiny piece of information that should be explained explicitly:

Essentially, a project with multiple hierarchical directories work as a package with some attributes.
To import custom local created Classes, we need to navigate to the directory containing .py file and create an __init__.py (empty) file there.

Why this helps is because this file is required to make Python treat the directory as containing packages. Cheers!

score 2 · Answer 10 · answered Mar 11 '15 at 10:12

2

Many a times what happens is that the plugin is not installed. e.g.

If you are developing a django project and you do not have django plugin installed in pyCharm, it says error 'unresolved reference'. Refer: https://www.jetbrains.com/pycharm/help/resolving-references.html

answered Mar 11 '15 at 10:12

Ranjeet

372
2
10

Had to combine this + the accepted answer(https://stackoverflow.com/a/21241988/6448384). – Karuhanga Nov 07 '19 at 10:41

score 2 · Answer 11 · answered Sep 04 '19 at 17:34

2

This worked for me: Top Menu -> File -> Invalidate Caches/Restart

answered Sep 04 '19 at 17:34

Gershon Herczeg

2,983
20
33

score 2 · Answer 12 · 2020-07-26T10:16:08.470

2

--> Right-click on the directory where your files are located in PyCharm
Go to the --> Mark Directory as
Select the --> Source Root

your problem will be solved

edited Jul 26 '20 at 10:16

answered Jun 27 '20 at 03:18

score 1 · Answer 13 · answered Jun 26 '16 at 08:28

Please check if you are using the right interpreter that you are supposed to. I was getting error "unresolved reference 'django' " to solve this I changed Project Interpreter (Changed Python 3 to Python 2.7) from project settings: Select Project, go to File -> Settings -> Project: -> Project Interpreter -> Brows and Select correct version or Interpreter (e.g /usr/bin/python2.7).

score 1 · Answer 14 · answered Apr 13 '19 at 12:03

1

In my case the problem was I was using Virtual environment which didn't have access to global site-packages. Thus, the interpreter was not aware of the newly installed packages.

To resolve the issue, just edit or recreate your virtual interpreter and tick the Inherit global site-packages option.

answered Apr 13 '19 at 12:03

Dan

393
2
10

Doesnt this have undesirable consequences and defeat one reason to use a virtual environement? That is, if you take that environment somewhere and those global site-packages are installed, then you are in trouble. Thats what i thought. – theStud54 Oct 22 '19 at 19:55

score 1 · Answer 15 · answered Apr 24 '20 at 08:59

1

Done in PyCharm 2019.3.1 Right-click on your src folder -> "Mark Directory as" -> Click-on "Excluded" and your src folder should be blue.

answered Apr 24 '20 at 08:59

Burhan U Din

11
1

score 1 · Answer 16 · answered Aug 17 '20 at 09:24

1

I was also using a virtual environment like Dan above, however I was able to add an interpreter in the existing environment, therefore not needing to inherit global site packages and therefore undo what a virtual environment is trying to achieve.

answered Aug 17 '20 at 09:24

Tabs

11
1

score 0 · Answer 17 · answered Jun 17 '20 at 08:23

0

For me, adding virtualenv (venv)'s site-packages path to the paths of the interpreter works. Finally!

answered Jun 17 '20 at 08:23

weaming

3,467
1
14
11

score 0 · Answer 18 · answered Jun 26 '20 at 15:56

I tried everything here twice and even more. I finally solved it doing something I hadn't seen anywhere online. If you go to Settings>Editor>File Types there is an 'Ignore Files and folders' line at the bottom. In my case, I was ignoring 'venv', which is what I always name my virtual environments. So I removed venv; from the list of directories to ignore and VOILA!! I was FINALLY able to fix this problem. Literally all of my import problems were fixed for the project.

BTW, I had installed each and every package using PyCharm, and not through a terminal. (Meaning, by going to Settings>Interpreter...). I had invalidated cache, changed 'Source Root', restarted PyCharm, refreshed my interpreters paths, changed interpreters, deleted my venv... I tried everything. This finally worked. Obviously there are multiple problems going on here with different people, so this may not work for you, but it's definitely worth a shot if nothing else has worked, and easy to reverse if it doesn't.

score 0 · Answer 19 · answered Jan 25 '21 at 22:01

For my case :

Directory0
    ├── Directory1
    │     └── file1.py  
    ├── Directory2
    │     ├── file2.py

Into file1, I have :

from Directory2 import file2

which trows an "unresolved reference Directory2".

I resolved it by:

marking the parent directory Directory0 as "Source Root" like said above

AND

putting my cursor on another line on the file where I had the error so that it takes my modification into account

It is silly but if I don't do the second action, the error still appears and can make you think that you didn't resolve the issue by marking the parent directory as Source Root.

score 0 · Answer 20 · answered Mar 19 '21 at 00:46

There are several reasons why this could be happening. Below are several steps that fixes the majority of those cases:

.idea caching issue

Some .idea issue causing the IDE to show error while the code still runs correctly. Solution:

close the project and quick PyCharm
delete the .idea folder where the project is. note that it is a hidden folder and you might not be aware of its existence in your project directory.
start PyCharm and recreate the project

imports relative not to project folder

Relative imports while code root folder is not the same as the project folder. Solution:

Find the folder that relative imports require in the project explorer
right click and mark it as "Source Root"

Editor not marking init.py as Python but as Text

Which is the most illusive of all the cases. Here, for some reason, PyCharm considers all __init__.py files not to be python files, and thus ignores them during code analysis. To fix this:

Open PyCharm settings
Navigate to Editor -> File Types
Find Python and add __init__.py to the list of python files

or

Find Text and delete __init__.py from the list of text files

score -1 · Answer 21 · edited Jan 07 '19 at 15:50

-1

Pycharm uses venv. In the venv's console you should install the packages explicitly or go in settings -> project interpreter -> add interpreter -> inherit global site-packages.

edited Jan 07 '19 at 15:50

Félix Gagnon-Grenier

7,344
10
45
58

answered Dec 04 '17 at 10:09

yunus

1,821
1
10
11

zaid.mohammed · Answer 22 · 2019-11-22T22:55:08.527

-1

The easiest way to fix it is by doing the following in your pyCharm software:

Click on: File > Settings > (Project: your project name) > Project Interpreter >

then click on the "+" icon on the right side to search for the package you want and install it.

Enjoy coding !!!

edited Nov 22 '19 at 22:55

answered Nov 22 '19 at 18:08

zaid.mohammed

1
3

1

Welcome to Stack Overflow, and thanks for your answer. Whilst this may be correct, in the future please avoid posting images or links to other sites without context or further details. The link may stop working at some point, making this answer less useful for other users. – CyberJacob Nov 22 '19 at 18:14
@CyberJacob Thank you very much, and thanks a lot for your advice, I've edited the answer by removing the image and adding text instead. – zaid.mohammed Nov 22 '19 at 23:01

score -2 · Answer 23 · answered Sep 18 '19 at 07:36

-2

In newer versions of pycharm u can do simply by right clicking on the directory or python package from which you want to import a file, then click on 'Mark Directory As' -> 'Sources Root'

answered Sep 18 '19 at 07:36

Shravan Kumar

181
1
2
5

Unresolved reference issue in PyCharm

23 Answers23

Linked

Related