Commit f167a89
committed
A short term fix for editable mode install failed to import root level module such as exir
Summary:
Fixes #9558.
The `src/executorch/exir` file exists primarily due to the limitations of `pip install` in editable mode. Specifically, `pip install -e .` does not recognize `<executorch root>/exir` (or any root level directory with a `__init__.py`) as a valid package module because of the presence of `<executorch root>/exir/__init__.py`. See the following GitHub issue for details: [Issue #9558](#9558).
To work around this limitation, a symlink is used. With this symlink and this package entry in `pyproject.toml`:
```toml
[tool.setuptools.package-dir]
...
"executorch" = "src/executorch"
```
We are telling `pip install -e .` to treat `src/executorch` as the root of the `executorch` package and hence mapping `executorch.exir` to `src/executorch/exir`.
This allows us to perform `pip install -e .` successfully and enables the execution of the following command:
```bash
python -c "from executorch.exir import CaptureConfig"
```
Test Plan:
```bash
./install_executorch.sh --pybind --editable
python -c "from executorch.exir import CaptureConfig"
```
Reviewers:
Subscribers:
Tasks:
Tags:1 parent b66c319 commit f167a89
2 files changed
+2
-1
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
97 | 97 | | |
98 | 98 | | |
99 | 99 | | |
100 | | - | |
| 100 | + | |
101 | 101 | | |
102 | 102 | | |
103 | 103 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
0 commit comments