How to import a python class from a file in a different folder?

Question

I have the following file structure:

├───common
│       hdfs.py
│       impala.py
│       pandasUtils.py
│       proxy.py
│       stringUtils.py
│       __init__.py
│
├───tests
│   └───unitTests
│           test_stringUtils.py
│           __init__.py

From tests/unitTests/test_stringUtils.py, I want to import the file common/stringUtils.py

I tried the following:

import unittest
from common.stringUtils import StringUtils

But I have the following error: Unable to import 'common.stringUtils'.

Is there a way to import a file without dealing with sys path or doing anything different from "import from" ?(30 years and still looks like an early access game)

from common import stringUtils than use stringUtils.StringUtils ? — pippo1980, Feb 24 '21 at 15:56
Doesn't this work in your case? https://stackoverflow.com/questions/4383571/importing-files-from-different-folder — Rishabh Kumar, Feb 24 '21 at 15:56
import sys sys.path.append("..") # Adds higher directory to python modules path. — pippo1980, Feb 24 '21 at 16:00

score 2 · Accepted Answer · answered Feb 24 '21 at 16:03

2

Use PYTHONPATH. For example

PYTHONPATH=. python tests/unitTests/test_stringUtils.py

or

PYTHONPATH=.. python unitTests/test_stringUtils.py

answered Feb 24 '21 at 16:03

ghchoi

4,812
4
30
53

More generally, `common` is a package you want to use from the test script. Ensure that the directly *containing* `common` is on your Python path. – chepner Feb 24 '21 at 16:07
With frim common.stringUtils, this works fine. But isn't there a way to NOT have to say "hey use this path" ? – Itération 122442 Feb 25 '21 at 09:21
@FlorianCastelain Well, you can put it into the Python package folder which is already in `PYTHONPATH` technically. Or, you should use `sys.path`. Either way, you should tell Python where files are. – ghchoi Feb 25 '21 at 10:07

How to import a python class from a file in a different folder?

1 Answers1