How to check if a module has been imported?
Solution 1:
Test for the module name in the sys.modules
dictionary:
import sys
modulename = 'datetime'
if modulename not in sys.modules:
print 'You have not imported the {} module'.format(modulename)
From the documenation:
This is a dictionary that maps module names to modules which have already been loaded.
Note that an import
statement does two things:
- if the module has never been imported before (== not present in
sys.modules
), then it is loaded and added tosys.modules
. - Bind 1 or more names in the current namespace that reference the module object or to objects that are members of the module namespace.
The expression modulename not in sys.modules
tests if step 1 has taken place. Testing for the result of step 2 requires knowing what exact import
statement was used as they set different names to reference different objects:
-
import modulename
setsmodulename = sys.modules['modulename']
-
import packagename.nestedmodule
setspackagename = sys.modules['packagename']
(no matter how many addional levels you add) -
import modulename as altname
setsaltname = sys.module['modulename']
-
import packagename.nestedmodule as altname
setsaltname = sys.modules['packagename.nestedmodule']
-
from somemodule import objectname
setsobjectname = sys.modules['somemodule'].objectname
-
from packagename import nestedmodulename
setsnestedmodulename = sys.modules['packagename.nestedmodulename']
(only when there was no object namednestedmodulename
in thepackagename
namespace before this import, an additional name for the nested module is added to the parent package namespace at this point) -
from somemodule import objectname as altname
setsaltname = sys.modules['somemodule'].objectname
-
from packagename import nestedmodulename as altname
setsaltname = sys.modules['packagename.nestedmodulename']
(only when there was no object namednestedmodulename
in thepackagename
namespace before this import, an additional name for the nested module is added to the parent package namespace at this point)
You can test if the name to which the imported object was bound exists in a given namespace:
# is this name visible in the current scope:
'importedname' in dir()
# or, is this a name in the globals of the current module:
'importedname' in globals()
# or, does the name exist in the namespace of another module:
'importedname' in globals(sys.modules['somemodule'])
This only tells you of the name exists (has been bound), not if it refers to a specific module or object from that module. You could further introspect that object or test if it’s the same object as what’s available in sys.modules
, if you need to rule out that the name has been set to something else entirely since then.
Solution 2:
To the sys.modules answers accepted, I'd add one caveat to be careful about renaming modules on import:
>>> import sys
>>> import datetime as dt
>>> 'dt' in sys.modules
False
>>> 'datetime' in sys.modules
True