How to import a module from a different folder?

Question

I have a project which I want to structure like this:

myproject
├── api
│   ├── __init__.py
│   └── api.py
├── backend
│   ├── __init__.py
│   └── backend.py
├── models
│   ├── __init__.py
│   └── some_model.py
└── __init__.py

Now, I want to import the module some_model.py in both api.py and backend.py. How do I properly do this?

I tried:

from models import some_model

but that fails with ModuleNotFoundError: No module named 'models'.

I also tried:

from ..models import some_model

which gave me ValueError: attempted relative import beyond top-level package.

What am I doing wrong here? How can I import a file from a different directory, which is not a subdirectory?

Asked By: Gasp0de

||

Source

Answer 1

Firstly, this import statement:

from models import some_model

should be namespaced:

# in myproject/backend/backend.py or myproject/api/api.py
from myproject.models import some_model

Then you will need to get the directory which contains myproject, let’s call this /path/to/parent, into the sys.path list. You can do this temporarily by setting an environment variable:

export PYTHONPATH=/path/to/parent

Or, preferably, you can do it by writing a setup.py file and installing your package. Follow the PyPA packaging guide. After you have written your setup.py file, from within the same directory, execute this to setup the correct entries in sys.path:

pip install --editable .

Answered By: wim

Answer 2

Unfortunately, Python will only find your file if your file is in the systems path. But fear not! There is a way around this!

Using python’s sys module, we can add a directory to the path while Python is running just for the current run of the program. This will not affect any other Python programs run later.

You can do this by:

import sys
import os
sys.path.insert(0, os.path.abspath('relative/path/to/application/folder'))
import [file]

It is important to import sys and set the directory path before you import the file.

If your library is NOT close to the current directory, an absolute path could be simpler:

import sys
sys.path.insert(0, '/absolute/path/to/application/folder'))
import [file]

Yes, this is a hack. But it can be helpful as a short-term work-around.

Answered By: Jordan Mattiuzzo

Answer 3

I would lay out two approaches:

Simply import some_model via absolute importing:

from myproject.models import some_model

Note that the myproject should be treated as an module (i.e. having __init__.py)

Or

You can add the previous path to the sys.path which I use in such parallel level modules:

import sys
sys.path.append('../')

from models import some_model

Answered By: Benyamin Jafari

How to import a module from a different folder?

Question:

Answers: