Print top-level errors normally in nix repl
#10209
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
Previously, errors while printing values in `nix repl` would be printed
in `«error: ...»` brackets rather than displayed normally:
```
nix-repl> legacyPackages.aarch64-darwin.pythonPackages.APScheduler
«error: Package ‘python-2.7.18.7’ in /nix/store/6s0m1qc31zw3l3kq0q4wd5cp3lqpkq0q-source/pkgs/development/interpreters/python/cpython/2.7/default.nix:335 is marked as insecure, refusing to evaluate.»
```
Now, errors will be displayed normally if they're emitted at the
top-level of an expression:
```
nix-repl> legacyPackages.aarch64-darwin.pythonPackages.APScheduler
error:
… in the condition of the assert statement
at /nix/store/6s0m1qc31zw3l3kq0q4wd5cp3lqpkq0q-source/lib/customisation.nix:268:17:
267| in commonAttrs // {
268| drvPath = assert condition; drv.drvPath;
| ^
269| outPath = assert condition; drv.outPath;
… in the left operand of the OR (||) operator
at /nix/store/6s0m1qc31zw3l3kq0q4wd5cp3lqpkq0q-source/pkgs/development/interpreters/python/passthrufun.nix:28:45:
27| if lib.isDerivation value then
28| lib.extendDerivation (valid value || throw "${name} should use `buildPythonPackage` or `toPythonModule` if it is to be part of the Python packages set.") {} value
| ^
29| else
(stack trace truncated; use '--show-trace' to show the full trace)
error: Package ‘python-2.7.18.7’ in /nix/store/6s0m1qc31zw3l3kq0q4wd5cp3lqpkq0q-source/pkgs/development/interpreters/python/cpython/2.7/default.nix:335 is marked as insecure, refusing to evaluate.
```
Errors emitted in nested structures (like e.g. when printing `nixpkgs`)
will still be printed in brackets.
github-actions
bot
added
the
repl
thufschmitt
reviewed
Mar 11, 2024
Comment on lines
+14
to
+32
| enum class ErrorPrintBehavior { | ||
| /** | ||
| * Print the first line of the error in brackets: `«error: oh no!»` | ||
| */ | ||
| Print, | ||
| /** | ||
| * Throw the error to the code that attempted to print the value, instead | ||
| * of suppressing it it. | ||
| */ | ||
| Throw, | ||
| /** | ||
| * Only throw the error if encountered at the top level of the expression. | ||
| * | ||
| * This will cause expressions like `builtins.throw "uh oh!"` to throw | ||
| * errors, but will print attribute sets and other nested structures | ||
| * containing values that error (like `nixpkgs`) normally. | ||
| */ | ||
| ThrowTopLevel, | ||
| }; |
There was a problem hiding this comment.
What's the reason for this (hidden) configurability?
There was a problem hiding this comment.
Do the comments not make it clear enough? Let me know how I can improve it. Output snipped for brevity, but basically if the whole expression errors we want to print the error message normally, but in nested structures like attribute sets or lists we want to show error messages for specific attributes (to get a good overview for structures like nixpkgs):
nix-repl> pkgs.pythonPackages.APScheduler
error:
… in the condition of the assert statement
at /nix/store/wmj6j3afrvqxsjpad47nrad1vrwmykrg-source/lib/customisation.nix:268:17
… in the left operand of the OR (||) operator
at /nix/store/wmj6j3afrvqxsjpad47nrad1vrwmykrg-source/pkgs/development/interpreters/python/passthrufun.nix:28:45
(stack trace truncated; use '--show-trace' to show the full trace)
error: Package ‘python-2.7.18.7’ in /nix/store/wmj6j3afrvqxsjpad47nrad1vrwmykrg-source/pkgs/development/interpreters/python/cpython/2.7/default.nix:335 is marked as insecure, refusing to evaluate.
Known issues:
- Python 2.7 has reached its end of life after 2020-01-01. See https://www.python.org/doc/sunset-python-2/.
You can install it anyway by allowing this package, using the
following methods:
a) To temporarily allow all insecure packages, you can use an environment
variable for a single invocation of the nix tools:
$ export NIXPKGS_ALLOW_INSECURE=1
Note: When using `nix shell`, `nix build`, `nix develop`, etc with a flake,
then pass `--impure` in order to allow use of environment variables.
...
nix-repl> pkgs.pythonPackages
{
APScheduler = «error: Package ‘python-2.7.18.7’ in /nix/store/wmj6j3afrvqxsjpad47nrad1vrwmykrg-source/pkgs/development/interpreters/python/cpython/2.7/default.nix:335 is marked as insecure, refusing to evaluate.»;
BTrees = «error: Package ‘python-2.7.18.7’ in /nix/store/wmj6j3afrvqxsjpad47nrad1vrwmykrg-source/pkgs/development/interpreters/python/cpython/2.7/default.nix:335 is marked as insecure, refusing to evaluate.»;
Babel = «error: Package ‘python-2.7.18.7’ in /nix/store/wmj6j3afrvqxsjpad47nrad1vrwmykrg-source/pkgs/development/interpreters/python/cpython/2.7/default.nix:335 is marked as insecure, refusing to evaluate.»;
error: interrupted by the user
There was a problem hiding this comment.
Oh sorry, I missed the bit about this not being repl-specific. Forget about my comment.
(I guess we're never using the Throw variant, but it doesn't harm to have it either)
thufschmitt
approved these changes
Mar 11, 2024
Comment on lines
+14
to
+32
| enum class ErrorPrintBehavior { | ||
| /** | ||
| * Print the first line of the error in brackets: `«error: oh no!»` | ||
| */ | ||
| Print, | ||
| /** | ||
| * Throw the error to the code that attempted to print the value, instead | ||
| * of suppressing it it. | ||
| */ | ||
| Throw, | ||
| /** | ||
| * Only throw the error if encountered at the top level of the expression. | ||
| * | ||
| * This will cause expressions like `builtins.throw "uh oh!"` to throw | ||
| * errors, but will print attribute sets and other nested structures | ||
| * containing values that error (like `nixpkgs`) normally. | ||
| */ | ||
| ThrowTopLevel, | ||
| }; |
There was a problem hiding this comment.
Oh sorry, I missed the bit about this not being repl-specific. Forget about my comment.
(I guess we're never using the Throw variant, but it doesn't harm to have it either)
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.
Previously, errors while printing values in
nix replwould be printed in«error: ...»brackets rather than displayed normally:Now, errors will be displayed normally if they're emitted at the top-level of an expression:
Errors emitted in nested structures (like e.g. when printing
nixpkgs) will still be printed in brackets.Priorities and Process
Add 👍 to pull requests you find important.
The Nix maintainer team uses a GitHub project board to schedule and track reviews.