There are many ways to import a Python file, all with their pros and cons.
Don't just hastily pick the first import strategy that works for you, or else you'll have to rewrite the codebase later on when you find it doesn't meet your needs.
I'll start out explaining the easiest example #1, then I'll move toward the most professional and robust example #7
Example 1, Import a Python module with Python interpreter:
Put this in /home/el/foo/fox.py:
def what_does_the_fox_say(): print("vixens cry")Get into the Python interpreter:
el@apollo:/home/el/foo$ python Python 2.7.3 (default, Sep 26 2013, 20:03:06) >>> import fox >>> fox.what_does_the_fox_say() vixens cryYou imported fox through the Python interpreter, invoked the Python function
what_does_the_fox_say()from within fox.py.
Example 2, Use execfile or (exec in Python 3) in a script to execute the other Python file in place:
Put this in /home/el/foo2/mylib.py:
def moobar(): print("hi")Put this in /home/el/foo2/main.py:
execfile("/home/el/foo2/mylib.py") moobar()run the file:
el@apollo:/home/el/foo$ python main.py hiThe function moobar was imported from mylib.py and made available in main.py
Example 3, Use from ... import ... functionality:
Put this in /home/el/foo3/chekov.py:
def question(): print("where are the nuclear wessels?")Put this in /home/el/foo3/main.py:
from chekov import question question()Run it like this:
el@apollo:/home/el/foo3$ python main.py where are the nuclear wessels?If you defined other functions in chekov.py, they would not be available unless you
import *
Example 4, Import riaa.py if it's in a different file location from where it is imported
Put this in /home/el/foo4/stuff/riaa.py:
def watchout(): print("computers are transforming into a noose and a yoke for humans")Put this in /home/el/foo4/main.py:
import sys import os sys.path.append(os.path.abspath("/home/el/foo4/stuff")) from riaa import * watchout()Run it:
el@apollo:/home/el/foo4$ python main.py computers are transforming into a noose and a yoke for humansThat imports everything in the foreign file from a different directory.
Example 5, use os.system("python yourfile.py")
import os
os.system("python yourfile.py")
Example 6, import your file via piggybacking the Python startuphook:
This example used to work for both Python 2 and Python 3, but now only works for Python 2. Python 3 got rid of this user startuphook feature set, because it was abused by low-skill Python library writers, using it to impolitely inject their code into the global namespace, before all user-defined programs. If you want this to work for Python 3, you'll have to get more creative. If I tell you how to do it, Python developers will disable that feature set as well, so you're on your own.
See: https://docs.python.org/2/library/user.html
Put this code into your home directory in ~/.pythonrc.py
class secretclass:
def secretmessage(cls, myarg):
return myarg + " is if.. up in the sky, the sky"
secretmessage = classmethod( secretmessage )
def skycake(cls):
return "cookie and sky pie people can't go up and "
skycake = classmethod( skycake )
Put this code into your main.py (can be anywhere):
import user
msg = "The only way skycake tates good"
msg = user.secretclass.secretmessage(msg)
msg += user.secretclass.skycake()
print(msg + " have the sky pie! SKYCAKE!")
Run it, you should get this:
$ python main.py
The only way skycake tates good is if.. up in the sky,
the skycookie and sky pie people can't go up and have the sky pie!
SKYCAKE!
If you get an error here: ModuleNotFoundError: No module named 'user' then it means you're using Python 3, startuphooks are disabled there by default.
Credit for this jist goes to: https://github.com/docwhat/homedir-examples/blob/master/python-commandline/.pythonrc.py Send along your up-boats.
Example 7, Most Robust: Import files in Python with the bare import command:
Make a new directory
/home/el/foo5/Make a new directory
/home/el/foo5/herpMake an empty file named
__init__.pyunder herp:el@apollo:/home/el/foo5/herp$ touch __init__.py el@apollo:/home/el/foo5/herp$ ls __init__.pyMake a new directory /home/el/foo5/herp/derp
Under derp, make another
__init__.pyfile:el@apollo:/home/el/foo5/herp/derp$ touch __init__.py el@apollo:/home/el/foo5/herp/derp$ ls __init__.pyUnder /home/el/foo5/herp/derp make a new file called
yolo.pyPut this in there:def skycake(): print("SkyCake evolves to stay just beyond the cognitive reach of " + "the bulk of men. SKYCAKE!!")The moment of truth, Make the new file
/home/el/foo5/main.py, put this in there;from herp.derp.yolo import skycake skycake()Run it:
el@apollo:/home/el/foo5$ python main.py SkyCake evolves to stay just beyond the cognitive reach of the bulk of men. SKYCAKE!!The empty
__init__.pyfile communicates to the Python interpreter that the developer intends this directory to be an importable package.
If you want to see my post on how to include ALL .py files under a directory see here: https://stackoverflow.com/a/20753073/445131
Answer from Eric Leschinski on Stack OverflowThere are many ways to import a Python file, all with their pros and cons.
Don't just hastily pick the first import strategy that works for you, or else you'll have to rewrite the codebase later on when you find it doesn't meet your needs.
I'll start out explaining the easiest example #1, then I'll move toward the most professional and robust example #7
Example 1, Import a Python module with Python interpreter:
Put this in /home/el/foo/fox.py:
def what_does_the_fox_say(): print("vixens cry")Get into the Python interpreter:
el@apollo:/home/el/foo$ python Python 2.7.3 (default, Sep 26 2013, 20:03:06) >>> import fox >>> fox.what_does_the_fox_say() vixens cryYou imported fox through the Python interpreter, invoked the Python function
what_does_the_fox_say()from within fox.py.
Example 2, Use execfile or (exec in Python 3) in a script to execute the other Python file in place:
Put this in /home/el/foo2/mylib.py:
def moobar(): print("hi")Put this in /home/el/foo2/main.py:
execfile("/home/el/foo2/mylib.py") moobar()run the file:
el@apollo:/home/el/foo$ python main.py hiThe function moobar was imported from mylib.py and made available in main.py
Example 3, Use from ... import ... functionality:
Put this in /home/el/foo3/chekov.py:
def question(): print("where are the nuclear wessels?")Put this in /home/el/foo3/main.py:
from chekov import question question()Run it like this:
el@apollo:/home/el/foo3$ python main.py where are the nuclear wessels?If you defined other functions in chekov.py, they would not be available unless you
import *
Example 4, Import riaa.py if it's in a different file location from where it is imported
Put this in /home/el/foo4/stuff/riaa.py:
def watchout(): print("computers are transforming into a noose and a yoke for humans")Put this in /home/el/foo4/main.py:
import sys import os sys.path.append(os.path.abspath("/home/el/foo4/stuff")) from riaa import * watchout()Run it:
el@apollo:/home/el/foo4$ python main.py computers are transforming into a noose and a yoke for humansThat imports everything in the foreign file from a different directory.
Example 5, use os.system("python yourfile.py")
import os
os.system("python yourfile.py")
Example 6, import your file via piggybacking the Python startuphook:
This example used to work for both Python 2 and Python 3, but now only works for Python 2. Python 3 got rid of this user startuphook feature set, because it was abused by low-skill Python library writers, using it to impolitely inject their code into the global namespace, before all user-defined programs. If you want this to work for Python 3, you'll have to get more creative. If I tell you how to do it, Python developers will disable that feature set as well, so you're on your own.
See: https://docs.python.org/2/library/user.html
Put this code into your home directory in ~/.pythonrc.py
class secretclass:
def secretmessage(cls, myarg):
return myarg + " is if.. up in the sky, the sky"
secretmessage = classmethod( secretmessage )
def skycake(cls):
return "cookie and sky pie people can't go up and "
skycake = classmethod( skycake )
Put this code into your main.py (can be anywhere):
import user
msg = "The only way skycake tates good"
msg = user.secretclass.secretmessage(msg)
msg += user.secretclass.skycake()
print(msg + " have the sky pie! SKYCAKE!")
Run it, you should get this:
$ python main.py
The only way skycake tates good is if.. up in the sky,
the skycookie and sky pie people can't go up and have the sky pie!
SKYCAKE!
If you get an error here: ModuleNotFoundError: No module named 'user' then it means you're using Python 3, startuphooks are disabled there by default.
Credit for this jist goes to: https://github.com/docwhat/homedir-examples/blob/master/python-commandline/.pythonrc.py Send along your up-boats.
Example 7, Most Robust: Import files in Python with the bare import command:
Make a new directory
/home/el/foo5/Make a new directory
/home/el/foo5/herpMake an empty file named
__init__.pyunder herp:el@apollo:/home/el/foo5/herp$ touch __init__.py el@apollo:/home/el/foo5/herp$ ls __init__.pyMake a new directory /home/el/foo5/herp/derp
Under derp, make another
__init__.pyfile:el@apollo:/home/el/foo5/herp/derp$ touch __init__.py el@apollo:/home/el/foo5/herp/derp$ ls __init__.pyUnder /home/el/foo5/herp/derp make a new file called
yolo.pyPut this in there:def skycake(): print("SkyCake evolves to stay just beyond the cognitive reach of " + "the bulk of men. SKYCAKE!!")The moment of truth, Make the new file
/home/el/foo5/main.py, put this in there;from herp.derp.yolo import skycake skycake()Run it:
el@apollo:/home/el/foo5$ python main.py SkyCake evolves to stay just beyond the cognitive reach of the bulk of men. SKYCAKE!!The empty
__init__.pyfile communicates to the Python interpreter that the developer intends this directory to be an importable package.
If you want to see my post on how to include ALL .py files under a directory see here: https://stackoverflow.com/a/20753073/445131
importlib was added to Python 3 to programmatically import a module.
import importlib
moduleName = input('Enter module name:')
importlib.import_module(moduleName)
The .py extension should be removed from moduleName. The function also defines a package argument for relative imports.
In python 2.x:
- Just
import filewithout the .py extension - A folder can be marked as a package, by adding an empty
__init__.pyfile - You can use the
__import__function, which takes the module name (without extension) as a string extension
pmName = input('Enter module name:')
pm = __import__(pmName)
print(dir(pm))
Type help(__import__) for more details.
So I am working with some old code I wrote and it occurred to me that I could clean things up by moving several functions defined in my single Python file to a "methods" file, where all of the functions written in the "methods" file would be accessible in "main". I am not sure what the best way to do this is. I have considered adding something like the following to "main":
import sys
import os
sys.path.append(os.path.abspath("C:\<file_path>"))
from <methods_file> import *
But I haven't had any luck. Any suggestions on an easy clean way to do this? Thanks in advance.
Import files directly from file location - Ideas - Discussions on Python.org
How do I import from a file in the current directory in Python 3? - Stack Overflow
Importing python files from different folder
how to import a file in python?
In python 3 all imports are absolute unless a relative path is given to perform the import from. You will either need to use an absolute or relative import.
Absolute import:
from parent.file import ClassName
Relative import:
from . file import ClassName
# look for the module file in same directory as the current module
Try import it this way:
from .file import ClassName
See here more info on "Guido's decision" on imports in python 3 and complete example on how to import in python 3.
Sorry, I've read multiple answers, but just can't get this to work...
Let's say I have this project structure:
--project
--files_1
--file_1.py
--files_2
--file_2.pyHow can I import classes from file_2.py into file_1.py?Thank you for the help.
If I have a file called "functions.py", I can use import functions.py in a program to import any functions to that program. However, if "function.py" is not in the same folder as the program, I cannot import it. Using import ./../path/to/functions.py does not work either.
Is there any way to import a file to another, if they are not in the same directory?
Thank you.
Note: This answer was intended for a very specific question. For most programmers coming here from a search engine, this is not the answer you are looking for. Typically you would structure your files into packages (see other answers) instead of modifying the search path.
By default, you can't. When importing a file, Python only searches the directory that the entry-point script is running from and sys.path which includes locations such as the package installation directory (it's actually a little more complex than this, but this covers most cases).
However, you can add to the Python path at runtime:
# some_file.py
import sys
# caution: path[0] is reserved for script path (or '' in REPL)
sys.path.insert(1, '/path/to/application/app/folder')
import file
There is nothing wrong with:
from application.app.folder.file import func_name
Just make sure folder also contains an __init__.py. This allows it to be included as a package. I am not sure why the other answers talk about PYTHONPATH.