-
Notifications
You must be signed in to change notification settings - Fork 70
/
diff.rs
439 lines (389 loc) · 17.4 KB
/
diff.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
static USAGE: &str = r#"
Find the difference between two CSVs with ludicrous speed.
Note that diff does not support stdin. A file path is required for both arguments.
Examples:
Find the difference between two CSVs:
qsv diff left.csv right.csv
Find the difference between two CSVs. The right CSV has no headers:
qsv diff left.csv --no-headers-right right-noheaders.csv
Find the difference between two CSVs. The left CSV uses a tab as the delimiter:
qsv diff --delimiter-left '\t' left.csv right-tab.tsv
# or ';' as the delimiter
qsv diff --delimiter-left ';' left.csv right-semicolon.csv
Find the difference between two CSVs. The output CSV uses a tab as the delimiter
and is written to a file:
qsv diff -o diff-tab.tsv --delimiter-output '\t' left.csv right.csv
# or ';' as the delimiter
qsv diff -o diff-semicolon.csv --delimiter-output ';' left.csv right.csv
Find the difference between two CSVs, comparing records that have the same values
in the first two columns:
qsv diff --key 0,1 left.csv right.csv
Find the difference between two CSVs, comparing records that have the same values
in the first two columns and sort the result by the first two columns:
qsv diff -k 0,1 --sort-columns 0,1 left.csv right.csv
Find the difference between two CSVs, but do not output equal field values
in the result (equal field values are replaced with the empty string). Key
field values _will_ appear in the output:
qsv diff --drop-equal-fields left.csv right.csv
Find the difference between two CSVs, but do not output headers in the result:
qsv diff --no-headers-output left.csv right.csv
Find the difference between two CSVs. Both CSVs have no headers, but the result should have
headers, so generic headers will be used in the form of: _col_1, _col_2, etc.:
qsv diff --no-headers-left --no-headers-right left.csv right.csv
For more examples, see https://github.com/jqnatividad/qsv/blob/master/tests/test_diff.rs
Usage:
qsv diff [options] [<input-left>] [<input-right>]
qsv diff --help
diff options:
--no-headers-left When set, the first row will be considered as part of
the left CSV to diff. (When not set, the
first row is the header row and will be skipped during
the diff. It will always appear in the output.)
--no-headers-right When set, the first row will be considered as part of
the right CSV to diff. (When not set, the
first row is the header row and will be skipped during
the diff. It will always appear in the output.)
--no-headers-output When set, the diff result won't have a header row in
it's output. If not set and both CSVs have no headers,
headers in the result will be: _col_1,_col_2, etc.
--delimiter-left <arg> The field delimiter for reading CSV data on the left.
Must be a single character. (default: ,)
--delimiter-right <arg> The field delimiter for reading CSV data on the right.
Must be a single character. (default: ,)
--delimiter-output <arg> The field delimiter for writing the CSV diff result.
Must be a single character. (default: ,)
-k, --key <arg...> The column indices that uniquely identify a record
as a comma separated list of indices, e.g. 0,1,2
or column names, e.g. name,age.
Note that when selecting columns by name, only the
left CSV's headers are used to match the column names
and it is assumed that the right CSV has the same
selected column names in the same order as the left CSV.
(default: 0)
--sort-columns <arg...> The column indices by which the diff result should be
sorted as a comma separated list of indices, e.g. 0,1,2
or column names, e.g. name,age.
Records in the diff result that are marked as "modified"
("delete" and "add" records that have the same key,
but have different content) will always be kept together
in the sorted diff result and so won't be sorted
independently from each other.
Note that when selecting columns by name, only the
left CSV's headers are used to match the column names
and it is assumed that the right CSV has the same
selected column names in the same order as the left CSV.
--drop-equal-fields Drop values of equal fields in modified rows of the CSV
diff result (and replace them with the empty string).
Key field values will not be dropped.
-j, --jobs <arg> The number of jobs to run in parallel.
When not set, the number of jobs is set to the number
of CPUs detected.
Common options:
-h, --help Display this message
-o, --output <file> Write output to <file> instead of stdout.
"#;
use std::io::{self, Write};
use csv::ByteRecord;
use csv_diff::{
csv_diff::CsvByteDiffBuilder, csv_headers::Headers, diff_result::DiffByteRecords,
diff_row::DiffByteRecord,
};
use serde::Deserialize;
use super::rename::rename_headers_all_generic;
use crate::{
clitypes::CliError,
config::{Config, Delimiter},
util, CliResult,
};
#[derive(Deserialize)]
struct Args {
arg_input_left: Option<String>,
arg_input_right: Option<String>,
flag_output: Option<String>,
flag_jobs: Option<usize>,
flag_no_headers_left: bool,
flag_no_headers_right: bool,
flag_no_headers_output: bool,
flag_delimiter_left: Option<Delimiter>,
flag_delimiter_right: Option<Delimiter>,
flag_delimiter_output: Option<Delimiter>,
flag_key: Option<String>,
flag_sort_columns: Option<String>,
flag_drop_equal_fields: bool,
}
pub fn run(argv: &[&str]) -> CliResult<()> {
let args: Args = util::get_args(USAGE, argv)?;
let rconfig_left = Config::new(&args.arg_input_left)
.delimiter(args.flag_delimiter_left)
.no_headers(args.flag_no_headers_left);
let rconfig_right = Config::new(&args.arg_input_right)
.delimiter(args.flag_delimiter_right)
.no_headers(args.flag_no_headers_right);
if rconfig_left.is_stdin() || rconfig_right.is_stdin() {
return fail_incorrectusage_clierror!(
"diff does not support stdin. A file path is required for both arguments."
);
}
let mut csv_rdr_left = rconfig_left.reader()?;
let mut csv_rdr_right = rconfig_right.reader()?;
let headers_left = csv_rdr_left.byte_headers()?;
let headers_right = csv_rdr_right.byte_headers()?;
let primary_key_cols: Vec<usize> = match args.flag_key {
None => vec![0],
Some(s) => {
// check if the key is a comma separated list of numbers
if s.chars().all(|c: char| c.is_numeric() || c == ',') {
s.split(',')
.map(str::parse::<usize>)
.collect::<Result<Vec<_>, _>>()
.map_err(|err| CliError::Other(err.to_string()))?
} else {
// check if the key is a comma separated list of column names
let left_key_indices = s
.split(',')
.enumerate()
.map(|(index, col_name)| {
headers_left
.iter()
.position(|h| h == col_name.as_bytes())
.ok_or_else(|| {
CliError::Other(format!(
"Column name '{col_name}' not found on left CSV"
))
})
.map(|pos| pos + index + 1)
})
.collect::<Result<Vec<usize>, _>>()?;
// now check if the right CSV has the same selected colnames in the same locations
let right_key_indices = s
.split(',')
.enumerate()
.map(|(index, col_name)| {
headers_right
.iter()
.position(|h| h == col_name.as_bytes())
.ok_or_else(|| {
CliError::Other(format!(
"Column name '{col_name}' not found on right CSV"
))
})
.map(|pos| pos + index + 1)
})
.collect::<Result<Vec<usize>, _>>()?;
if left_key_indices != right_key_indices {
return fail_incorrectusage_clierror!(
"Column names on left and right CSVs do not match.\nUse `qsv select` to \
reorder the columns on the right CSV to match the order of the left \
CSV.\nThe key column indices on the left CSV are in index \
locations:\n{left_key_indices:?}\nand on the right CSV \
are:\n{right_key_indices:?}",
);
}
left_key_indices
}
},
};
let sort_cols = args
.flag_sort_columns
.map(|s| {
// check if the sort columns are a comma separated list of numbers
if s.chars().all(|c: char| c.is_numeric() || c == ',') {
s.split(',')
.map(str::parse::<usize>)
.collect::<Result<Vec<_>, _>>()
.map_err(|err| CliError::Other(err.to_string()))
} else {
// check if the sort columns is a comma separated list of column names
let left_sort_indices = s
.split(',')
.enumerate()
.map(|(index, col_name)| {
headers_left
.iter()
.position(|h| h == col_name.as_bytes())
.ok_or_else(|| {
CliError::Other(format!(
"Column name '{col_name}' not found on left CSV"
))
})
.map(|pos| pos + index + 1)
})
.collect::<Result<Vec<usize>, _>>()?;
Ok(left_sort_indices)
}
})
.transpose()?;
let wtr = Config::new(&args.flag_output)
.delimiter(args.flag_delimiter_output)
.writer()?;
// set RAYON_NUM_THREADS
util::njobs(args.flag_jobs);
let Ok(csv_diff) = CsvByteDiffBuilder::new()
.primary_key_columns(primary_key_cols.clone())
.build()
else {
return fail_clierror!("Cannot instantiate diff");
};
let mut diff_byte_records = csv_diff
.diff(csv_rdr_left.into(), csv_rdr_right.into())
.try_to_diff_byte_records()?;
match sort_cols {
Some(sort_cols) => {
diff_byte_records
.sort_by_columns(sort_cols)
.map_err(|e| CliError::Other(e.to_string()))?;
},
None => {
diff_byte_records.sort_by_line();
},
}
let mut csv_diff_writer = CsvDiffWriter::new(
wtr,
args.flag_no_headers_output,
args.flag_drop_equal_fields,
primary_key_cols,
);
Ok(csv_diff_writer.write_diff_byte_records(diff_byte_records)?)
}
struct CsvDiffWriter<W: Write> {
csv_writer: csv::Writer<W>,
no_headers: bool,
drop_equal_fields: bool,
key_fields: Vec<usize>,
}
impl<W: Write> CsvDiffWriter<W> {
fn new(
csv_writer: csv::Writer<W>,
no_headers: bool,
drop_equal_fields: bool,
key_fields: impl IntoIterator<Item = usize>,
) -> Self {
Self {
csv_writer,
no_headers,
drop_equal_fields,
key_fields: key_fields.into_iter().collect(),
}
}
fn write_headers(&mut self, headers: &Headers, num_columns: Option<&usize>) -> csv::Result<()> {
match (headers.headers_left(), headers.headers_right()) {
(Some(lbh), Some(_rbh)) => {
// currently, `diff` can only handle two CSVs that have the same
// headers ordering, so in this case we can either choose the left
// or right headers, because both are the same
if !self.no_headers {
lbh.write_diffresult_header(&mut self.csv_writer)?;
}
},
(Some(bh), None) | (None, Some(bh)) => {
if !self.no_headers {
bh.write_diffresult_header(&mut self.csv_writer)?;
}
},
(None, None) => {
if let (Some(&num_cols), false) = (num_columns.filter(|&&c| c > 0), self.no_headers)
{
let headers_generic = rename_headers_all_generic(num_cols);
let mut new_rdr = csv::Reader::from_reader(headers_generic.as_bytes());
let new_headers = new_rdr.byte_headers()?;
new_headers.write_diffresult_header(&mut self.csv_writer)?;
}
},
}
Ok(())
}
fn write_diff_byte_records(&mut self, diff_byte_records: DiffByteRecords) -> io::Result<()> {
self.write_headers(
diff_byte_records.headers(),
diff_byte_records.num_columns().as_ref(),
)?;
for dbr in diff_byte_records {
self.write_diff_byte_record(&dbr)?;
}
self.csv_writer.flush()?;
Ok(())
}
fn write_diff_byte_record(&mut self, diff_byte_record: &DiffByteRecord) -> csv::Result<()> {
let add_sign: &[u8] = &b"+"[..];
let remove_sign: &[u8] = &b"-"[..];
match diff_byte_record {
DiffByteRecord::Add(add) => {
let mut vec = vec![add_sign];
vec.extend(add.byte_record());
self.csv_writer.write_record(vec)
},
DiffByteRecord::Modify {
delete,
add,
field_indices,
} => {
let vec_del = if self.drop_equal_fields {
self.fill_modified_and_drop_equal_fields(
remove_sign,
delete.byte_record(),
field_indices.as_slice(),
)
} else {
let mut tmp = vec![remove_sign];
tmp.extend(delete.byte_record());
tmp
};
self.csv_writer.write_record(vec_del)?;
let vec_add = if self.drop_equal_fields {
self.fill_modified_and_drop_equal_fields(
add_sign,
add.byte_record(),
field_indices.as_slice(),
)
} else {
let mut tmp = vec![add_sign];
tmp.extend(add.byte_record());
tmp
};
self.csv_writer.write_record(vec_add)
},
DiffByteRecord::Delete(del) => {
let mut vec = vec![remove_sign];
vec.extend(del.byte_record());
self.csv_writer.write_record(vec)
},
}
}
fn fill_modified_and_drop_equal_fields<'a>(
&self,
prefix: &'a [u8],
byte_record: &'a ByteRecord,
modified_field_indices: &[usize],
) -> Vec<&'a [u8]> {
let mut vec_to_fill = {
// We start out with all fields set to an empty byte slice
// (which end up as our equal fields).
let mut tmp = vec![&b""[..]; byte_record.len() + 1 /* + 1, because we need to store our additional prefix*/];
tmp.as_mut_slice()[0] = prefix;
tmp
};
// key field values and modified field values should appear in the output
for &key_field in self.key_fields.iter().chain(modified_field_indices) {
// + 1 here, because of the prefix value (see above)
vec_to_fill[key_field + 1] = &byte_record[key_field];
}
vec_to_fill
}
}
trait WriteDiffResultHeader {
fn write_diffresult_header<W: Write>(&self, csv_writer: &mut csv::Writer<W>)
-> csv::Result<()>;
}
impl WriteDiffResultHeader for csv::ByteRecord {
fn write_diffresult_header<W: Write>(
&self,
csv_writer: &mut csv::Writer<W>,
) -> csv::Result<()> {
if !self.is_empty() {
let mut new_header = vec![&b"diffresult"[..]];
new_header.extend(self);
csv_writer.write_record(new_header)?;
}
Ok(())
}
}