mirror of
https://github.com/privatevoid-net/nix-super.git
synced 2024-11-28 08:36:15 +02:00
d13c63afa2
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.
120 lines
2.8 KiB
C++
120 lines
2.8 KiB
C++
#pragma once
|
|
/**
|
|
* @file
|
|
* @brief Options for printing Nix values.
|
|
*/
|
|
|
|
#include <limits>
|
|
|
|
namespace nix {
|
|
|
|
/**
|
|
* How errors should be handled when printing values.
|
|
*/
|
|
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,
|
|
};
|
|
|
|
/**
|
|
* Options for printing Nix values.
|
|
*/
|
|
struct PrintOptions
|
|
{
|
|
/**
|
|
* If true, output ANSI color sequences.
|
|
*/
|
|
bool ansiColors = false;
|
|
|
|
/**
|
|
* If true, force values.
|
|
*/
|
|
bool force = false;
|
|
|
|
/**
|
|
* If true and `force` is set, print derivations as
|
|
* `«derivation /nix/store/...»` instead of as attribute sets.
|
|
*/
|
|
bool derivationPaths = false;
|
|
|
|
/**
|
|
* If true, track which values have been printed and skip them on
|
|
* subsequent encounters. Useful for self-referential values.
|
|
*/
|
|
bool trackRepeated = true;
|
|
|
|
/**
|
|
* Maximum depth to evaluate to.
|
|
*/
|
|
size_t maxDepth = std::numeric_limits<size_t>::max();
|
|
|
|
/**
|
|
* Maximum number of attributes in attribute sets to print.
|
|
*
|
|
* Note that this is a limit for the entire print invocation, not for each
|
|
* attribute set encountered.
|
|
*/
|
|
size_t maxAttrs = std::numeric_limits<size_t>::max();
|
|
|
|
/**
|
|
* Maximum number of list items to print.
|
|
*
|
|
* Note that this is a limit for the entire print invocation, not for each
|
|
* list encountered.
|
|
*/
|
|
size_t maxListItems = std::numeric_limits<size_t>::max();
|
|
|
|
/**
|
|
* Maximum string length to print.
|
|
*/
|
|
size_t maxStringLength = std::numeric_limits<size_t>::max();
|
|
|
|
/**
|
|
* Indentation width for pretty-printing.
|
|
*
|
|
* If set to 0 (the default), values are not pretty-printed.
|
|
*/
|
|
size_t prettyIndent = 0;
|
|
|
|
/**
|
|
* How to handle errors encountered while printing values.
|
|
*/
|
|
ErrorPrintBehavior errors = ErrorPrintBehavior::Print;
|
|
|
|
/**
|
|
* True if pretty-printing is enabled.
|
|
*/
|
|
inline bool shouldPrettyPrint()
|
|
{
|
|
return prettyIndent > 0;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* `PrintOptions` for unknown and therefore potentially large values in error messages,
|
|
* to avoid printing "too much" output.
|
|
*/
|
|
static PrintOptions errorPrintOptions = PrintOptions {
|
|
.ansiColors = true,
|
|
.maxDepth = 10,
|
|
.maxAttrs = 10,
|
|
.maxListItems = 10,
|
|
.maxStringLength = 1024,
|
|
};
|
|
|
|
}
|