Two Python modules require each other’s contents – can that work?

by

Modules can import each other cyclically, but there’s a catch. In the simple case, it should work by moving the import statements to the bottom of the file or not using the from syntax.

Here’s why that works:

When you import a module, Python first checks sys.modules. If it’s in there, it just imports from there. If it’s not there, it tries to import it in the normal way; basically, it finds the file and runs the stuff in it.

Running a module populates the module’s contents. For example, say we have this module, creatively named example_opener:

import webbrowser

def open_example():
    webbrowser.open('http://www.example.com/')

At the start, the module is empty. Then Python executes:

import webbrowser

After that, the module only contains webbrowser. Then Python executes this:

def open_example():
    webbrowser.open('http://www.example.com/')

Python creates open_example. Now the module contains webbrowser and open_example.

Say webbrowser contained this code:

from example_opener import open_example

def open(url):
    print url

Say example_opener is imported first. This code is executed:

import webbrowser

webbrowser has not yet been imported, so Python executes the contents of webbrowser:

from example_opener import open_example

example_opener has been imported, but not yet fully executed. Python doesn’t care. Python pulls the module out of sys.modules. At this point, example_opener is still empty. It hasn’t defined open_example yet, nor even completed importing webbrowser. Python can’t find open_example in example_opener, so it fails.

What if we imported open_example from the end of webbrowser and webbrowser from the end of example_opener? Python would start by executing this code:

def open_example():
    webbrowser.open('http://www.example.com/')

webbrowser does not exist yet, but it doesn’t matter until open_example is called. Now example_opener contains only open_example. It then executes:

import webbrowser

It has not been imported yet, so Python executes webbrowser. It starts:

def open(url):
    print url

It defines open. Then it executes:

from example_opener import open_example

example_opener is in sys.modules, so it uses that. example_opener contains open_example, so it succeeds. Python finishes importing webbrowser. That concludes importing webbrowser from example_opener. That’s the last thing in example_opener, so the import of example_opener finishes, successful, as well.

More Related Contents:

  1. What does if __name__ == "__main__": do?
  2. Importing installed package from script raises “AttributeError: module has no attribute” or “ImportError: cannot import name”
  3. How do I import a module given the full path?
  4. How to do relative imports in Python?
  5. How can I import other Python files?
  6. Installing python module within code
  7. What exactly is a “raw string regex” and how can you use it?
  8. How to write a Python module/package?
  9. Collapse multiple submodules to one Cython extension
  10. Can modules have properties the same way that objects can?
  11. What’s the difference between __builtin__ and __builtins__?
  12. Importing modules: __main__ vs import as module
  13. Importing installed package from script with the same name raises “AttributeError: module has no attribute” or “ImportError: cannot import name”
  14. How do I find out my PYTHONPATH using Python?
  15. How does python find a module file if the import statement only contains the filename?
  16. How to make global imports from a function?
  17. Python import modules from a higher level package
  18. Can’t install mysql-python (newer versions) in Windows
  19. What does if __name__ == “__main__”: do in Python?
  20. Prevent Python from caching the imported modules
  21. How can I import a module dynamically given the full path?
  22. How can I Install a Python module within code?
  23. How do I extend a python module? Adding new functionality to the `python-twitter` package
  24. ImportError: libSM.so.6: cannot open shared object file: No such file or directory
  25. Import python module NOT on path
  26. How to move all modules to new version of Python (from 3.6 to 3.7)
  27. How to properly use relative or absolute imports in Python modules?
  28. Importing a library from (or near) a script with the same name raises “AttributeError: module has no attribute” or an ImportError or NameError
  29. How can I do relative imports in Python?
  30. How to reload python module imported using `from module import *`

Leave a Comment