Skip to content

Commit

Permalink
Document ModuleNotFoundError (#443)
Browse files Browse the repository at this point in the history
* Document ModuleNotFoundError

Poetry does not lock down information about the build system used to
build dependencies. As such poetry2nix cannot automatically figure out
build inputs. nix-community/poetry2nix#568

This documents how to help poetry2nix out with figuring out buildinputs.

* Use path syntax for including the overrides.nix

* Use generic placeholder
  • Loading branch information
erooke authored Mar 4, 2023
1 parent e09d72a commit e4dac9b
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions docs/documentation/how-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,51 @@ kernel.python.python-with-numpy.projectDir = ./my-custom-python;
Eventually, you will see the recognizable messages from JupyterLab in your terminal.
Open up the Web UI in your browser and use your custom kernel.

??? question "Did something go wrong?"

If nix fails to build a kernel with an error like the following.

```shell
error: builder for '/nix/store/y44r14sxadnk0pccy8ciz8p1g6wpwbzq-python3.10-pathspec-0.11.0.drv' failed with exit code 2;
last 10 log lines:
> File "<frozen importlib._bootstrap>", line 1050, in _gcd_import
> File "<frozen importlib._bootstrap>", line 1027, in _find_and_load
> File "<frozen importlib._bootstrap>", line 992, in _find_and_load_unlocked
> File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
> File "<frozen importlib._bootstrap>", line 1050, in _gcd_import
> File "<frozen importlib._bootstrap>", line 1027, in _find_and_load
> File "<frozen importlib._bootstrap>", line 1004, in _find_and_load_unlocked
> ModuleNotFoundError: No module named 'flit_core'
```

There is some python package with a build dependency that poetry2nix is
unaware about. To fix this you need to tell jupyenv about the dependency
through an override. Create an `overrides.nix`.

```nix title="overrides.nix"
final: prev: let
addNativeBuildInputs = drvName: inputs: {
"${drvName}" = prev.${drvName}.overridePythonAttrs (
old: {
nativeBuildInputs = (old.nativeBuildInputs or []) ++ inputs;
}
);
};
in
{} // addNativeBuildInputs "pathspec" [final.flit-core]
```

Note we used `"pathspec"` here as that was the package which generated the
error and `final.flit-core` as that was the missing module. Add the override
to your kernel.

```nix title="kernels.nix"
kernel.python.<yourKernelName>.overrides = ./overrides.nix;
```

Start the jupyter environment with `nix run`.


### Julia kernel

The Julia kernel requires some stateful operations to work properly.
Expand Down

0 comments on commit e4dac9b

Please sign in to comment.