More Imports! - Delayed importing
A few methods to make late importing cleaner
| Branch | Status |
|---|---|
| master |  |
| dev |  |
Problem
Splitting code into modules is nice, but it can result in cyclic dependencies.
foos.py
from bars import bar
def foo():
bar()
bars.py
from foos import foo
def bar():
foo()
We are not concerned with the infinite recursion; this is only for demonstrating cyclic dependencies.
More Imports!
Solution #1: Use expect/export pattern
All your cyclic dependencies are covered with this one pattern: Break cycles by expecting a name in the first module, and let the second module export to the first when the value is available
foos.py
from mo_imports import expect
bar = expect("bar")
def foo():
bar()
bars.py
from mo_imports import export
from foos import foo
def bar():
foo()
export("bars", bar)
Benefits
- every
expectis verified to match with anexport(and visa-versa) - using an expected variable before
exportraises an error - code is run only once, at module load time, not later
- methods do not run import code
- all "imports" are at the top of the file
Solution #2: Use delay_import
Provide a proxy which is responsible for import upon first use of the module variable.
foos.py
from mo_imports import delay_import
bar = delay_import("bars.bar")
def foo():
bar()
bars.py
from foos import foo
def bar():
foo()
Benefits
- cleaner code
- costly imports are delayed until first use
WARNING
Requires any of
__call__,__getitem__,__getattr__to be called to trigger the import. This means sentinals, placeholders, and default values can NOT be imported usingdelay_import()
Other solutions
If you do not use mo-imports your import cycles can be broken using one of the following common patterns:
Bad Solution: Keep in single file
You can declare yet-another-module that holds the cycles
foosbars.py
def foo():
bar()
def bar():
foo()
but this breaks the code modularity
Bad Solution: Use end-of-file imports
During import, setup of the first module is paused while it imports a second. A bottom-of-file import will ensure the first module is mostly setup to be used by the second.
foos.py
def foo():
bar()
from bars import bar
bars.py
def bar():
foo()
from foos import foo
Linters do not like this pattern: You may miss imports, since these are hiding at the bottom.
Bad Solution: Inline import
Import the name only when it is needed
foos.py
def foo():
from bars import bar
bar()
bars.py
def bar():
from foos import foo
foo()
This is fine for rarely run code, but there is an undesirable overhead because import is checked everytime the method is run. You may miss imports because they are hiding inline rather than at the top of the file.
Bad Solution: Use the _late_import() pattern
When other bad solutions do not work work, then importing late is the remaining option
foos.py
from bars import bar
def foo():
bar()
bars.py
foo = None
def _late_import():
global foo
from foos import foo
_ = foo
def bar():
if not foo:
_late_import()
foo()
Placeholders variables are added, which linters complain about type. There is the added _late_import() method. You risk it is not run everywhere as needed. This has less overhead than an inline import, but there is still a check.
More on importing
Importing a complex modular library is still hard; the complexity comes from the the order other modules declare their imports; you have no control over which of your modules will be imported first. For example, one module may
from my_lib.bars import bar
from my_lib.foos import foo
another module may choose the opposite order
from my_lib.foos import foo
from my_lib.bars import bar
Ordering imports
With cyclic dependencies, ordering the imports can get tricky. Here are some rules
- choose your principle modules and the order you want them imported.
- your remaining modules are assumed to be imported in alphabetical order (as most linters prefer)
- use top level
__init__.pyto control the order of imports - encourage third party modules to use this top level module. for example
from my_lib import foo, bar
- finally, use
mo_importsto break cycles
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mo_imports-7.686.26234.tar.gz.
File metadata
- Download URL: mo_imports-7.686.26234.tar.gz
- Upload date:
- Size: 12.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a82ccbf5d8406eec79516d48995ff488aa6a096ac9f2bd98fb7fe1ca7e3ad378
|
|
| MD5 |
7b8ae46b72383298a69e42048c6c86d1
|
|
| BLAKE2b-256 |
eb9b00a71083b1e2269d1481d2cc0f9c50a8a8b55c1213ec67f702a9dea3013d
|
File details
Details for the file mo_imports-7.686.26234-py3-none-any.whl.
File metadata
- Download URL: mo_imports-7.686.26234-py3-none-any.whl
- Upload date:
- Size: 11.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.1.0 CPython/3.13.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2ab89f2c384e35d2d7140fda012c85a45f0512e0ffe8ad77d4e113f4ba192f73
|
|
| MD5 |
544de381a4766415729ed3e1701b4df4
|
|
| BLAKE2b-256 |
47ed88feee1b8e8590e16d363554b7b91651f22bebcef98bd3695cf934d3e48f
|
