6fd854ed9f
# Description
This PR introduces a `ByteStream` type which is a `Read`-able stream of
bytes. Internally, it has an enum over three different byte stream
sources:
```rust
pub enum ByteStreamSource {
Read(Box<dyn Read + Send + 'static>),
File(File),
Child(ChildProcess),
}
```
This is in comparison to the current `RawStream` type, which is an
`Iterator<Item = Vec<u8>>` and has to allocate for each read chunk.
Currently, `PipelineData::ExternalStream` serves a weird dual role where
it is either external command output or a wrapper around `RawStream`.
`ByteStream` makes this distinction more clear (via `ByteStreamSource`)
and replaces `PipelineData::ExternalStream` in this PR:
```rust
pub enum PipelineData {
Empty,
Value(Value, Option<PipelineMetadata>),
ListStream(ListStream, Option<PipelineMetadata>),
ByteStream(ByteStream, Option<PipelineMetadata>),
}
```
The PR is relatively large, but a decent amount of it is just repetitive
changes.
This PR fixes #7017, fixes #10763, and fixes #12369.
This PR also improves performance when piping external commands. Nushell
should, in most cases, have competitive pipeline throughput compared to,
e.g., bash.
| Command | Before (MB/s) | After (MB/s) | Bash (MB/s) |
| -------------------------------------------------- | -------------:|
------------:| -----------:|
| `throughput \| rg 'x'` | 3059 | 3744 | 3739 |
| `throughput \| nu --testbin relay o> /dev/null` | 3508 | 8087 | 8136 |
# User-Facing Changes
- This is a breaking change for the plugin communication protocol,
because the `ExternalStreamInfo` was replaced with `ByteStreamInfo`.
Plugins now only have to deal with a single input stream, as opposed to
the previous three streams: stdout, stderr, and exit code.
- The output of `describe` has been changed for external/byte streams.
- Temporary breaking change: `bytes starts-with` no longer works with
byte streams. This is to keep the PR smaller, and `bytes ends-with`
already does not work on byte streams.
- If a process core dumped, then instead of having a `Value::Error` in
the `exit_code` column of the output returned from `complete`, it now is
a `Value::Int` with the negation of the signal number.
# After Submitting
- Update docs and book as necessary
- Release notes (e.g., plugin protocol changes)
- Adapt/convert commands to work with byte streams (high priority is
`str length`, `bytes starts-with`, and maybe `bytes ends-with`).
- Refactor the `tee` code, Devyn has already done some work on this.
---------
Co-authored-by: Devyn Cairns <devyn.cairns@gmail.com>
144 lines
4.9 KiB
Rust
144 lines
4.9 KiB
Rust
use crate::dataframe::values::{Column, NuDataFrame, NuExpression};
|
|
use nu_engine::command_prelude::*;
|
|
|
|
#[derive(Clone)]
|
|
pub struct LazyFillNA;
|
|
|
|
impl Command for LazyFillNA {
|
|
fn name(&self) -> &str {
|
|
"dfr fill-nan"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Replaces NaN values with the given expression."
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.required(
|
|
"fill",
|
|
SyntaxShape::Any,
|
|
"Expression to use to fill the NAN values",
|
|
)
|
|
.input_output_type(
|
|
Type::Custom("dataframe".into()),
|
|
Type::Custom("dataframe".into()),
|
|
)
|
|
.category(Category::Custom("lazyframe".into()))
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Fills the NaN values with 0",
|
|
example: "[1 2 NaN 3 NaN] | dfr into-df | dfr fill-nan 0",
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(
|
|
vec![Column::new(
|
|
"0".to_string(),
|
|
vec![
|
|
Value::test_int(1),
|
|
Value::test_int(2),
|
|
Value::test_int(0),
|
|
Value::test_int(3),
|
|
Value::test_int(0),
|
|
],
|
|
)],
|
|
None,
|
|
)
|
|
.expect("Df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},
|
|
Example {
|
|
description: "Fills the NaN values of a whole dataframe",
|
|
example: "[[a b]; [0.2 1] [0.1 NaN]] | dfr into-df | dfr fill-nan 0",
|
|
result: Some(
|
|
NuDataFrame::try_from_columns(
|
|
vec![
|
|
Column::new(
|
|
"a".to_string(),
|
|
vec![Value::test_float(0.2), Value::test_float(0.1)],
|
|
),
|
|
Column::new(
|
|
"b".to_string(),
|
|
vec![Value::test_int(1), Value::test_int(0)],
|
|
),
|
|
],
|
|
None,
|
|
)
|
|
.expect("Df for test should not fail")
|
|
.into_value(Span::test_data()),
|
|
),
|
|
},
|
|
]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let fill: Value = call.req(engine_state, stack, 0)?;
|
|
let value = input.into_value(call.head)?;
|
|
|
|
if NuExpression::can_downcast(&value) {
|
|
let expr = NuExpression::try_from_value(value)?;
|
|
let fill = NuExpression::try_from_value(fill)?.into_polars();
|
|
let expr: NuExpression = expr.into_polars().fill_nan(fill).into();
|
|
|
|
Ok(PipelineData::Value(
|
|
NuExpression::into_value(expr, call.head),
|
|
None,
|
|
))
|
|
} else {
|
|
let val_span = value.span();
|
|
let frame = NuDataFrame::try_from_value(value)?;
|
|
let columns = frame.columns(val_span)?;
|
|
let dataframe = columns
|
|
.into_iter()
|
|
.map(|column| {
|
|
let column_name = column.name().to_string();
|
|
let values = column
|
|
.into_iter()
|
|
.map(|value| {
|
|
let span = value.span();
|
|
match value {
|
|
Value::Float { val, .. } => {
|
|
if val.is_nan() {
|
|
fill.clone()
|
|
} else {
|
|
value
|
|
}
|
|
}
|
|
Value::List { vals, .. } => {
|
|
NuDataFrame::fill_list_nan(vals, span, fill.clone())
|
|
}
|
|
_ => value,
|
|
}
|
|
})
|
|
.collect::<Vec<Value>>();
|
|
Column::new(column_name, values)
|
|
})
|
|
.collect::<Vec<Column>>();
|
|
Ok(PipelineData::Value(
|
|
NuDataFrame::try_from_columns(dataframe, None)?.into_value(call.head),
|
|
None,
|
|
))
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::super::super::test_dataframe::test_dataframe;
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
test_dataframe(vec![Box::new(LazyFillNA {})])
|
|
}
|
|
}
|