How to import Python module in a package of the same name as the importing module?

Question

Suppose I have the following (project1 is on python path):

/project1/utils/utils.py def cool_function(): print "cool" /project1/backup/utils.py from utils.utils import cool_function

This throws "ImportError: No module named utils".

I assume this is because it is searching for utils.cool_function in backup.utils. Is there a rather than renaming the utils package? I think my naming convention makes sense, and is natural, so I'm reluctant to changing it. If that however is preferred and standard practice, I will rename it!

Thanks!

EDIT: I am using Python 2.7

Roman Bodnarchuk · Accepted Answer · 2012-01-16 14:05:26Z

2

You may use relative imports:

from ..utils.utils import cool_function

answered Jan 16, 2012 at 14:05

Roman Bodnarchuk

29.8k12 gold badges62 silver badges76 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

cammil Over a year ago

This doesnt work! Not sure why, I did try it myself before posting to SO.

David Poole Over a year ago

I tried with Python27 and get "ValueError: Attempted relative import beyond toplevel package"

AdamKG · Accepted Answer · 2012-01-16 14:05:25Z

1

If project1 is a package (parent dir is on sys.path and has an __init__.py), you can do from project1.utils.utils import cool_function. See also PEP328, which is new in python 2.5. If you're using 2.5 or later, from ..utils.utils import cool_function may also work.

answered Jan 16, 2012 at 14:05

AdamKG

14.1k3 gold badges41 silver badges48 bronze badges

4 Comments

Bogdan Over a year ago

I also think this is a good way to do it. Use project1 to differentiate between; project1.utils.utils and project1.backup.utils. If project1 is in sys.path as you say this will also help if you will want to run the project from some other folder like: python folder1/folder2/project1/run.py

cammil Over a year ago

Actually, /project1/ is on the path, so I can refer to backup or utils directly when importing. Should put them in a wrapper package?

AdamKG Over a year ago

In many cases it's a judgement call, but as a general rule I'd say yes - if you ever need to integrate this project with others, it'd be problem if they also have 'utils' or 'backup' top-level packages. That generally doesn't happen - but it's for this reason.

cammil Over a year ago

I'm inclined to agree. I've moved everything into a super package and I already feel better about it. Everything is imported using the root package name (e.g. project1.utils.utils) as suggested, and it all works now. Thanks everyone.

Rik Poggi · Accepted Answer · 2012-01-16 14:25:51Z

Works fine with me.

With the following project structure:

project/ |-- run.py `-- utils | |-- __init__.py | |-- utils.py |-- backup |-- __init__.py |-- utils.py

Where you call python3 run.py from the project directory.

Edit: Sorry I just saw that this does not apply to python-2.x.

Collectives™ on Stack Overflow

How to import Python module in a package of the same name as the importing module?

3 Answers 3

2 Comments

4 Comments

Comments

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

2 Comments

4 Comments

Comments

Related