80

I am a beginner with Python. Before I start, here's my Python folder structure

-project
----src
------model
--------order.py
------hello-world.py

Under src I have a folder named model which has a Python file called order.py which contents follow:

class SellOrder(object):
    def __init__(self,genericName,brandName):
        self.genericName = genericName
        self.brandName = brandName

Next my hello-world.py is inside the src folder, one level above order.py:

import model.order.SellOrder

order = SellOrder("Test","Test")

print order.brandName

Whenever I run python hello-world.py it results in the error

Traceback (most recent call last):
  File "hello-world.py", line 1, in <module>
    import model.order.SellOrder
ImportError: No module named model.order.SellOrder

Is there anything I missed?

Jemshit Iskenderov
  • 8,415
  • 5
  • 60
  • 98
user962206
  • 14,657
  • 59
  • 168
  • 267
  • what should be the contents if __init__.py? – user962206 May 15 '16 at 00:12
  • https://docs.python.org/2/tutorial/modules.html#packages – Padraic Cunningham May 15 '16 at 00:16
  • `__init__.py` can be empty or can contain code. it is common for projects to expose their primary / public classes at the package level. In your case you could add `from model.order import SellOrder` so that other code can do `from project import Sellorder` instead of `from project.model.order import SellOrder`. – miraculixx May 15 '16 at 03:46

11 Answers11

61

All modules in Python have to have a certain directory structure. You can find details here.

Create an empty file called __init__.py under the model directory, such that your directory structure would look something like that:

.
└── project
    └── src
        ├── hello-world.py
        └── model
            ├── __init__.py
            └── order.py

Also in your hello-world.py file change the import statement to the following:

from model.order import SellOrder

That should fix it

P.S.: If you are placing your model directory in some other location (not in the same directory branch), you will have to modify the python path using sys.path.

RafazZ
  • 3,251
  • 2
  • 19
  • 38
  • 14
    also it's considered good practice not to have a `src` directory. that makes sense too because if you import your code somewhere else you should be able to `import project.model` and not `project.src.model`. – miraculixx May 15 '16 at 00:57
  • Very late to this thread, but I have the exact same structure as above, and using the solution above, I still can only run my program (`locust -f src\main.py ...`) if I use `from src.module.submodule import main`. Even with __init__.py in place. Maybe my `cwd` should be inside `src`? – Guy Feb 08 '22 at 08:30
  • 2
    this doesn't seem to be working. I have `__init__.py` in every folder but it still cannot be imported. Pycharm didn't show up with any errors, but the terminal kept showing up errors. – Dekriel May 03 '22 at 13:05
  • For some reason it works when I run the python file. But when executing the same commands in the interactive mode, it does not work. Very intriguing. – Eduardo Reis May 11 '22 at 15:58
12

If it's your root module just add it to PYTHONPATH (PyCharm usually does that)

export PYTHONPATH=$PYTHONPATH:<root module path>

for Docker:

ENV PYTHONPATH="${PYTHONPATH}:<root module path in container>"
Sergey Luchko
  • 2,616
  • 3
  • 27
  • 46
8

you need a file named __init__.py (two underscores on each side) in every folder in the hierarchy, so one in src/ and one in model/. This is what python looks for to know that it should access a particular folder. The files are meant to contain initialization instructions but even if you create them empty this will solve it.

2

You need to make sure the module is installed for all versions of python

You can check to see if a module is installed for python by running:

pip uninstall moduleName

If it is installed, it will ask you if you want to delete it or not. My issue was that it was installed for python, but not for python3. To check to see if a module is installed for python3, run:

python3 -m pip uninstall moduleName

After doing this, if you find that a module is not installed for one or both versions, use these two commands to install the module.

  • pip install moduleName
  • python3 -m pip install moduleName
Walker Sutton
  • 384
  • 1
  • 4
  • 7
2

It's easier if you use this code

python3 -m module.sub_module

For example:

python3 -m entrypoint.settings
Mushfirat Mohaimin
  • 1,503
  • 2
  • 6
  • 20
1

After trying to add the path using:

pip show

on command prompt and using

sys.path.insert(0, "/home/myname/pythonfiles")

and didn't work. Also got SSL error when trying to install the module again using conda this time instead of pip.

I simply copied the module that wasn't found from the path "Mine was in

C:\Users\user\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.7_qbz5n2kfra8p0\LocalCache\local-packages\Python37\site-packages 

so I copied it to 'C:\Users\user\Anaconda3\Lib\site-packages'

aviboy2006
  • 7,334
  • 5
  • 24
  • 43
1

100% Working solution:

Just add your project root directory to environment variable: PYTHONPATH. so for the below project structure, just add Rootdir path(For e.g: add E:\Projects\Rootdir) in PYTHONPATH.

Rootdir
└── pkg2
    ├── b.py
    ├── c.py
     └── pkg2
      ├── b.py
      ├── c.py
    
Bharti Jha
  • 31
  • 4
0

I had same error. For those who run python scripts on different servers, please check if the python path is correctly specified in shebang. For me on each server it was located in different dirs.

lpkej
  • 487
  • 5
  • 17
  • 2
    That's why you should never use `#!/usr/bin/python` but `#!/usr/bin/env python` (or `#!/usr/bin/env python3` for Python3, or possibly `#!/usr/bin/env python3.8` for a specific version). This will also work when using virtual environments, while the first form won't. – wovano Aug 22 '20 at 10:02
0

I only use Python as a secondary language and probably made a newbie-error. I had similar problem and my error was calling:

import requests

I got the error

ModuleNotFoundError: No module named 'requests.adapters'; 'requests' is not a package

Turns out the file I created in the same folder named "requests.py" made a conflict. Renaming the file made it work again.

Titken
  • 51
  • 4
-1

if you are using python 3 then try the below command. I was facing similar issue , this fixed my problem

pip3 install

Anushree Garg
  • 74
  • 1
  • 2
-7

you need to import the function so the program know what that is here is example:

import os 
import pyttsx3

i had the same problem first then i import the function and it work so i would really recommend to try it