Importing from a relative path in Python

Question

I have a folder for my client code, a folder for my server code, and a folder for code that is shared between them

Proj/
    Client/
        Client.py
    Server/
        Server.py
    Common/
        __init__.py
        Common.py

How do I import Common.py from Server.py and Client.py?

Solution 1

EDIT Nov 2014 (3 years later):

Python 2.6 and 3.x supports proper relative imports, where you can avoid doing anything hacky. With this method, you know you are getting a relative import rather than an absolute import. The '..' means, go to the directory above me:

from ..Common import Common

As a caveat, this will only work if you run your python as a module, from outside of the package. For example:

python -m Proj

Original hacky way

This method is still commonly used in some situations, where you aren't actually ever 'installing' your package. For example, it's popular with Django users.

You can add Common/ to your sys.path (the list of paths python looks at to import things):

import sys, os
sys.path.append(os.path.join(os.path.dirname(__file__), '..', 'Common'))
import Common

os.path.dirname(__file__) just gives you the directory that your current python file is in, and then we navigate to 'Common/' the directory and import 'Common' the module.

Solution 2

Funny enough, a same problem I just met, and I get this work in following way:

combining with linux command ln , we can make thing a lot simper:

1. cd Proj/Client
2. ln -s ../Common ./

3. cd Proj/Server
4. ln -s ../Common ./

And, now if you want to import some_stuff from file: Proj/Common/Common.py into your file: Proj/Client/Client.py, just like this:

# in Proj/Client/Client.py
from Common.Common import some_stuff

And, the same applies to Proj/Server, Also works for setup.py process, a same question discussed here, hope it helps !

Solution 3

Don't do relative import.

From PEP8:

Relative imports for intra-package imports are highly discouraged.

Put all your code into one super package (i.e. "myapp") and use subpackages for client, server and common code.

Update: "Python 2.6 and 3.x supports proper relative imports (...)". See Dave's answers for more details.

Solution 4

Doing a relative import is absolulutely OK! Here's what little 'ol me does:

#first change the cwd to the script path
scriptPath = os.path.realpath(os.path.dirname(sys.argv[0]))
os.chdir(scriptPath)

#append the relative location you want to import from
sys.path.append("../common")

#import your module stored in '../common'
import common.py

Solution 5

The default import method is already "relative", from the PYTHONPATH. The PYTHONPATH is by default, to some system libraries along with the folder of the original source file. If you run with -m to run a module, the current directory gets added to the PYTHONPATH. So if the entry point of your program is inside of Proj, then using import Common.Common should work inside both Server.py and Client.py.

Don't do a relative import. It won't work how you want it to.

View more solutions

Comments

[moooeeeep]

Related: stackoverflow.com/q/72852/1025391

[Jabba]

Imagine that you add some code to the end of the client and server after the 'if __name__ == "__main__":' line. That is, you want to be able to use them as stand-alone scripts. How to do it properly? I think it's a perfectly common use case that should be supported. Why is it discouraged?

[Tom Wilson]

I am surprised that "Don't do it" is the accepted answer for a "how do I..." question (well, except for Rails <g>.) There are occasional reasons to do this. I use a solution similar to what Dave suggests.

[CarlH]

But you better know where sys.argv[0] is actually pointing - it (prolly) isn't the directory you were in when you started python.

[Sascha Gottfried]

Do not modify python modules path manually, may be only for quick hacks. Learning Python package management using distutils, setuptools etc. is usually a required skill that will solve problems like that.

[Sascha Gottfried]

This is a quick hack, with lot of pitfalls. But the question was not even better.

[Dave]

@SaschaGottfried totally agree, although if you're not making a distributable package, it probably won't matter. For example, in Django you never really install your app with distutils, so the above method is an easy hack. But anyways I've edited the answer with what I would do these days.

[Michał Šrajer]

@TomWilson: It's not pure "don't do it" answer. There is "do it this way" below.

[Austin A]

Someone should tell the guys over at Numpy! They use a TON of relative imports!

[shrewmouse]

Thanks for answering the actual question instead of preaching about proper technique. There are plenty of good reasons to do relative imports.

[moooeeeep]

This answer is not applicable to current versions of Python. The quoted part is no longer to be found in PEP 8. Nowadays it reads like: "explicit relative imports are an acceptable alternative to absolute imports, especially when dealing with complex package layouts where using absolute imports would be unnecessarily verbose"

[pretzlstyle]

If this is true, why are the top answers not saying this? Will this work or not?

[jxramos]

how would you go up more than one level?

[John Neuhaus]

In my case, a third-party GUI testing application uses python scripts for implementing steps, and the scripts are imported such that I can't use proper relative imports. There is no project-level variable for the top directory for me to use absolute paths in the python, and it needs to run in a CI environment where hardcoded absolute paths are the devil.

[John Neuhaus]

This clearly written, but the original hack in Dave's answer is better because it uses __file__ to get the proper relation from the current file

[WattsInABox]

to go up one more level, use an additional dot for each level. @jxramos ex: from ...myfile goes to ../../myfile

[Aaron John Sabu]

@WattsInABox how would you go up and go to a file in a different directory, say the equivalent of ../../mydir2/myfile?

[Vincenzooo]

it would clearly be a poor design choice, but it would be useful for example in code refactoring when I want to access the same routines from different places and compare different versions without needs of moving or copying files.