forked from extern/nushell
remove the unfold command (#10773)
follow-up to: - https://github.com/nushell/nushell/pull/10771 > **Important** > wait for between 0.87 and 0.88 to land this # Description after deprecation comes the removal... this PR removes `unfold` in favor of `generate` 🥳 # User-Facing Changes users should use `generate` now, `unfold` will stop working. # Tests + Formatting # After Submitting
This commit is contained in:
Antoine Stevan
GitHub
parent
84cdc0d521
commit
dbdb1f6600
@ -381,7 +381,6 @@ pub fn add_shell_command_context(mut engine_state: EngineState) -> EngineState {
|
||||
Seq,
|
||||
SeqDate,
|
||||
SeqChar,
|
||||
Unfold, // deprecated
|
||||
Generate,
|
||||
};
|
||||
|
||||
|
||||
@ -3,11 +3,9 @@ mod generate;
|
||||
mod seq;
|
||||
mod seq_char;
|
||||
mod seq_date;
|
||||
mod unfold;
|
||||
|
||||
pub use cal::Cal;
|
||||
pub use generate::Generate;
|
||||
pub use seq::Seq;
|
||||
pub use seq_char::SeqChar;
|
||||
pub use seq_date::SeqDate;
|
||||
pub use unfold::Unfold;
|
||||
|
||||
@ -1,242 +0,0 @@
|
||||
use itertools::unfold;
|
||||
|
||||
use nu_engine::{eval_block_with_early_return, CallExt};
|
||||
use nu_protocol::ast::Call;
|
||||
use nu_protocol::engine::{Closure, Command, EngineState, Stack};
|
||||
use nu_protocol::{
|
||||
Category, Example, IntoInterruptiblePipelineData, IntoPipelineData, PipelineData, ShellError,
|
||||
Signature, Span, Spanned, SyntaxShape, Type, Value,
|
||||
};
|
||||
|
||||
#[derive(Clone)]
|
||||
pub struct Unfold;
|
||||
|
||||
impl Command for Unfold {
|
||||
fn name(&self) -> &str {
|
||||
"unfold"
|
||||
}
|
||||
|
||||
fn signature(&self) -> Signature {
|
||||
Signature::build("unfold")
|
||||
.input_output_types(vec![
|
||||
(Type::Nothing, Type::List(Box::new(Type::Any))),
|
||||
(
|
||||
Type::List(Box::new(Type::Any)),
|
||||
Type::List(Box::new(Type::Any)),
|
||||
),
|
||||
])
|
||||
.required("initial", SyntaxShape::Any, "initial value")
|
||||
.required(
|
||||
"closure",
|
||||
SyntaxShape::Closure(Some(vec![SyntaxShape::Any])),
|
||||
"generator function",
|
||||
)
|
||||
.allow_variants_without_examples(true)
|
||||
.category(Category::Generators)
|
||||
}
|
||||
|
||||
fn usage(&self) -> &str {
|
||||
"Generate a list of values by successively invoking a closure."
|
||||
}
|
||||
|
||||
fn extra_usage(&self) -> &str {
|
||||
r#"The generator closure accepts a single argument and returns a record
|
||||
containing two optional keys: 'out' and 'next'. Each invocation, the 'out'
|
||||
value, if present, is added to the stream. If a 'next' key is present, it is
|
||||
used as the next argument to the closure, otherwise generation stops.
|
||||
"#
|
||||
}
|
||||
|
||||
fn search_terms(&self) -> Vec<&str> {
|
||||
vec!["generate", "stream"]
|
||||
}
|
||||
|
||||
fn examples(&self) -> Vec<Example> {
|
||||
vec![
|
||||
Example {
|
||||
example: "unfold 0 {|i| if $i <= 10 { {out: $i, next: ($i + 2)} }}",
|
||||
description: "Generate a sequence of numbers",
|
||||
result: Some(Value::list(
|
||||
vec![
|
||||
Value::test_int(0),
|
||||
Value::test_int(2),
|
||||
Value::test_int(4),
|
||||
Value::test_int(6),
|
||||
Value::test_int(8),
|
||||
Value::test_int(10),
|
||||
],
|
||||
Span::test_data(),
|
||||
)),
|
||||
},
|
||||
Example {
|
||||
example: "unfold [0, 1] {|fib| {out: $fib.0, next: [$fib.1, ($fib.0 + $fib.1)]} } | first 10",
|
||||
description: "Generate a stream of fibonacci numbers",
|
||||
result: Some(Value::list(
|
||||
vec![
|
||||
Value::test_int(0),
|
||||
Value::test_int(1),
|
||||
Value::test_int(1),
|
||||
Value::test_int(2),
|
||||
Value::test_int(3),
|
||||
Value::test_int(5),
|
||||
Value::test_int(8),
|
||||
Value::test_int(13),
|
||||
Value::test_int(21),
|
||||
Value::test_int(34),
|
||||
],
|
||||
Span::test_data(),
|
||||
)),
|
||||
},
|
||||
]
|
||||
}
|
||||
|
||||
fn run(
|
||||
&self,
|
||||
engine_state: &EngineState,
|
||||
stack: &mut Stack,
|
||||
call: &Call,
|
||||
_input: PipelineData,
|
||||
) -> Result<PipelineData, ShellError> {
|
||||
nu_protocol::report_error_new(
|
||||
engine_state,
|
||||
&ShellError::GenericError(
|
||||
"Deprecated option".into(),
|
||||
"`unfold` is deprecated and will be removed in 0.88.".into(),
|
||||
Some(call.head),
|
||||
Some("Please use `generate` instead.".into()),
|
||||
vec![],
|
||||
),
|
||||
);
|
||||
|
||||
let initial: Value = call.req(engine_state, stack, 0)?;
|
||||
let capture_block: Spanned<Closure> = call.req(engine_state, stack, 1)?;
|
||||
let block_span = capture_block.span;
|
||||
let block = engine_state.get_block(capture_block.item.block_id).clone();
|
||||
let ctrlc = engine_state.ctrlc.clone();
|
||||
let engine_state = engine_state.clone();
|
||||
let mut stack = stack.captures_to_stack(capture_block.item.captures);
|
||||
let orig_env_vars = stack.env_vars.clone();
|
||||
let orig_env_hidden = stack.env_hidden.clone();
|
||||
let redirect_stdout = call.redirect_stdout;
|
||||
let redirect_stderr = call.redirect_stderr;
|
||||
|
||||
// A type of Option<S> is used to represent state. Invocation
|
||||
// will stop on None. Using Option<S> allows functions to output
|
||||
// one final value before stopping.
|
||||
let iter = unfold(Some(initial), move |state| {
|
||||
let arg = match state {
|
||||
Some(state) => state.clone(),
|
||||
None => return None,
|
||||
};
|
||||
|
||||
// with_env() is used here to ensure that each iteration uses
|
||||
// a different set of environment variables.
|
||||
// Hence, a 'cd' in the first loop won't affect the next loop.
|
||||
stack.with_env(&orig_env_vars, &orig_env_hidden);
|
||||
|
||||
if let Some(var) = block.signature.get_positional(0) {
|
||||
if let Some(var_id) = &var.var_id {
|
||||
stack.add_var(*var_id, arg.clone());
|
||||
}
|
||||
}
|
||||
|
||||
let (output, next_input) = match eval_block_with_early_return(
|
||||
&engine_state,
|
||||
&mut stack,
|
||||
&block,
|
||||
arg.into_pipeline_data(),
|
||||
redirect_stdout,
|
||||
redirect_stderr,
|
||||
) {
|
||||
// no data -> output nothing and stop.
|
||||
Ok(PipelineData::Empty) => (None, None),
|
||||
|
||||
Ok(PipelineData::Value(value, ..)) => {
|
||||
let span = value.span();
|
||||
match value {
|
||||
// {out: ..., next: ...} -> output and continue
|
||||
Value::Record { val, .. } => {
|
||||
let iter = val.into_iter();
|
||||
let mut out = None;
|
||||
let mut next = None;
|
||||
let mut err = None;
|
||||
|
||||
for (k, v) in iter {
|
||||
if k.eq_ignore_ascii_case("out") {
|
||||
out = Some(v);
|
||||
} else if k.eq_ignore_ascii_case("next") {
|
||||
next = Some(v);
|
||||
} else {
|
||||
let error = ShellError::GenericError(
|
||||
"Invalid block return".to_string(),
|
||||
format!("Unexpected record key '{}'", k),
|
||||
Some(span),
|
||||
None,
|
||||
Vec::new(),
|
||||
);
|
||||
err = Some(Value::error(error, block_span));
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if err.is_some() {
|
||||
(err, None)
|
||||
} else {
|
||||
(out, next)
|
||||
}
|
||||
}
|
||||
|
||||
// some other value -> error and stop
|
||||
_ => {
|
||||
let error = ShellError::GenericError(
|
||||
"Invalid block return".to_string(),
|
||||
format!("Expected record, found {}", value.get_type()),
|
||||
Some(span),
|
||||
None,
|
||||
Vec::new(),
|
||||
);
|
||||
|
||||
(Some(Value::error(error, block_span)), None)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Ok(other) => {
|
||||
let val = other.into_value(block_span);
|
||||
let error = ShellError::GenericError(
|
||||
"Invalid block return".to_string(),
|
||||
format!("Expected record, found {}", val.get_type()),
|
||||
Some(val.span()),
|
||||
None,
|
||||
Vec::new(),
|
||||
);
|
||||
|
||||
(Some(Value::error(error, block_span)), None)
|
||||
}
|
||||
|
||||
// error -> error and stop
|
||||
Err(error) => (Some(Value::error(error, block_span)), None),
|
||||
};
|
||||
|
||||
// We use `state` to control when to stop, not `output`. By wrapping
|
||||
// it in a `Some`, we allow the generator to output `None` as a valid output
|
||||
// value.
|
||||
*state = next_input;
|
||||
Some(output)
|
||||
});
|
||||
|
||||
Ok(iter.flatten().into_pipeline_data(ctrlc))
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod test {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn test_examples() {
|
||||
use crate::test_examples;
|
||||
|
||||
test_examples(Unfold {})
|
||||
}
|
||||
}
|
||||
@ -1,102 +0,0 @@
|
||||
use nu_test_support::{nu, pipeline};
|
||||
|
||||
#[test]
|
||||
fn unfold_no_next_break() {
|
||||
let actual =
|
||||
nu!("unfold 1 {|x| if $x == 3 { {out: $x}} else { {out: $x, next: ($x + 1)} }} | to nuon");
|
||||
|
||||
assert_eq!(actual.out, "[1, 2, 3]");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unfold_null_break() {
|
||||
let actual = nu!("unfold 1 {|x| if $x <= 3 { {out: $x, next: ($x + 1)} }} | to nuon");
|
||||
|
||||
assert_eq!(actual.out, "[1, 2, 3]");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unfold_allows_empty_output() {
|
||||
let actual = nu!(pipeline(
|
||||
r#"
|
||||
unfold 0 {|x|
|
||||
if $x == 1 {
|
||||
{next: ($x + 1)}
|
||||
} else if $x < 3 {
|
||||
{out: $x, next: ($x + 1)}
|
||||
}
|
||||
} | to nuon
|
||||
"#
|
||||
));
|
||||
|
||||
assert_eq!(actual.out, "[0, 2]");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unfold_allows_no_output() {
|
||||
let actual = nu!(pipeline(
|
||||
r#"
|
||||
unfold 0 {|x|
|
||||
if $x < 3 {
|
||||
{next: ($x + 1)}
|
||||
}
|
||||
} | to nuon
|
||||
"#
|
||||
));
|
||||
|
||||
assert_eq!(actual.out, "[]");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unfold_allows_null_state() {
|
||||
let actual = nu!(pipeline(
|
||||
r#"
|
||||
unfold 0 {|x|
|
||||
if $x == null {
|
||||
{out: "done"}
|
||||
} else if $x < 1 {
|
||||
{out: "going", next: ($x + 1)}
|
||||
} else {
|
||||
{out: "stopping", next: null}
|
||||
}
|
||||
} | to nuon
|
||||
"#
|
||||
));
|
||||
|
||||
assert_eq!(actual.out, "[going, stopping, done]");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unfold_allows_null_output() {
|
||||
let actual = nu!(pipeline(
|
||||
r#"
|
||||
unfold 0 {|x|
|
||||
if $x == 3 {
|
||||
{out: "done"}
|
||||
} else {
|
||||
{out: null, next: ($x + 1)}
|
||||
}
|
||||
} | to nuon
|
||||
"#
|
||||
));
|
||||
|
||||
assert_eq!(actual.out, "[null, null, null, done]");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unfold_disallows_extra_keys() {
|
||||
let actual = nu!("unfold 0 {|x| {foo: bar, out: $x}}");
|
||||
assert!(actual.err.contains("Invalid block return"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unfold_disallows_list() {
|
||||
let actual = nu!("unfold 0 {|x| [$x, ($x + 1)]}");
|
||||
assert!(actual.err.contains("Invalid block return"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unfold_disallows_primitive() {
|
||||
let actual = nu!("unfold 0 {|x| 1}");
|
||||
assert!(actual.err.contains("Invalid block return"));
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user