Fix import paths in simulation module
#838
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Prior to 93af28, the `simulation` directory was added to `PYTHONPATH` by
appending to `sys.path` at the start of each file, before submodules of
`simulation` such as `core` and `interfaces` were imported.
In 93af28, the calls to `sys.path.append` were moved below the import
block and so relative imports of `core` and `interfaces` no longer
resolve and the simulator fails to start with errors such as:
```
File "/home/scott/projects/streaming/.venv/lib64/python3.12/site-packages/streamlit/runtime/scriptrunner/exec_code.py", line 88, in exec_func_with_error_handling
result = func()
^^^^^^
File "/home/scott/projects/streaming/.venv/lib64/python3.12/site-packages/streamlit/runtime/scriptrunner/script_runner.py", line 579, in code_to_exec
exec(code, module.__dict__)
File "/home/scott/projects/streaming/simulation/interfaces/sim_ui.py", line 17, in <module>
from core.create_index import create_stream_index
ModuleNotFoundError: No module named 'core'
```
This commit prefixes the submodule imports with `simulation.` so the
imports can be resolved, and without needing to manipulate `sys.path`.
This works even when running the simulator outside the source
repository, as `setuptools.find_packages` is used in `setup.py` to find
the modules to package, and this finds the `simulation` module.
|
This looks reasonable to me right now, kicked off the tests to see if it breaks anthing else (linting having issues is a known issue). @snarayan21 to approve though |
snarayan21
approved these changes
Dec 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prior to 93af28, the
simulationdirectory was added toPYTHONPATHby appending tosys.pathat the start of each file, before submodules ofsimulationsuch ascoreandinterfaceswere imported.In 93af28, the calls to
sys.path.appendwere moved below the import block and so relative imports ofcoreandinterfacesno longer resolve and the simulator fails to start with errors such as:This commit prefixes the submodule imports with
simulation.so the imports can be resolved, and without needing to manipulatesys.path. This works even when running the simulator outside the source repository, assetuptools.find_packagesis used insetup.pyto find the modules to package, and this finds thesimulationmodule.