-
Notifications
You must be signed in to change notification settings - Fork 11
/
tablib_dataset.go
745 lines (642 loc) · 19.6 KB
/
tablib_dataset.go
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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
// Package tablib is a format-agnostic tabular Dataset library, written in Go.
// It allows you to import, export, and manipulate tabular data sets.
// Advanced features include, dynamic columns, tags & filtering, and seamless format import & export.
package tablib
import (
"fmt"
"sort"
"time"
)
// Dataset represents a set of data, which is a list of data and header for each column.
type Dataset struct {
// EmptyValue represents the string value to b output if a field cannot be
// formatted as a string during output of certain formats.
EmptyValue string
headers []string
data [][]interface{}
tags [][]string
constraints []ColumnConstraint
rows int
cols int
ValidationErrors []ValidationError
}
// DynamicColumn represents a function that can be evaluated dynamically
// when exporting to a predefined format.
type DynamicColumn func([]interface{}) interface{}
// ColumnConstraint represents a function that is bound as a constraint to
// the column so that it can validate its value
type ColumnConstraint func(interface{}) bool
// ValidationError holds the position of a value in the Dataset that have failed
// to validate a constraint.
type ValidationError struct {
Row int
Column int
}
// NewDataset creates a new Dataset.
func NewDataset(headers []string) *Dataset {
return NewDatasetWithData(headers, nil)
}
// NewDatasetWithData creates a new Dataset.
func NewDatasetWithData(headers []string, data [][]interface{}) *Dataset {
d := &Dataset{"", headers, data, make([][]string, 0), make([]ColumnConstraint,
len(headers)), len(data), len(headers), nil}
return d
}
// Headers return the headers of the Dataset.
func (d *Dataset) Headers() []string {
return d.headers
}
// Width returns the number of columns in the Dataset.
func (d *Dataset) Width() int {
return d.cols
}
// Height returns the number of rows in the Dataset.
func (d *Dataset) Height() int {
return d.rows
}
// Append appends a row of values to the Dataset.
func (d *Dataset) Append(row []interface{}) error {
if len(row) != d.cols {
return ErrInvalidDimensions
}
d.data = append(d.data, row)
d.tags = append(d.tags, make([]string, 0))
d.rows++
return nil
}
// AppendTagged appends a row of values to the Dataset with one or multiple tags
// for filtering purposes.
func (d *Dataset) AppendTagged(row []interface{}, tags ...string) error {
if err := d.Append(row); err != nil {
return err
}
d.tags[d.rows-1] = tags[:]
return nil
}
// AppendValues appends a row of values to the Dataset.
func (d *Dataset) AppendValues(row ...interface{}) error {
return d.Append(row[:])
}
// AppendValuesTagged appends a row of values to the Dataset with one or multiple tags
// for filtering purposes.
func (d *Dataset) AppendValuesTagged(row ...interface{}) error {
if len(row) < d.cols {
return ErrInvalidDimensions
}
var tags []string
for _, tag := range row[d.cols:] {
if tagStr, ok := tag.(string); ok {
tags = append(tags, tagStr)
} else {
return ErrInvalidTag
}
}
return d.AppendTagged(row[:d.cols], tags...)
}
// Insert inserts a row at a given index.
func (d *Dataset) Insert(index int, row []interface{}) error {
if index < 0 || index >= d.rows {
return ErrInvalidRowIndex
}
if len(row) != d.cols {
return ErrInvalidDimensions
}
ndata := make([][]interface{}, 0, d.rows+1)
ndata = append(ndata, d.data[:index]...)
ndata = append(ndata, row)
ndata = append(ndata, d.data[index:]...)
d.data = ndata
d.rows++
ntags := make([][]string, 0, d.rows+1)
ntags = append(ntags, d.tags[:index]...)
ntags = append(ntags, make([]string, 0))
ntags = append(ntags, d.tags[index:]...)
d.tags = ntags
return nil
}
// InsertValues inserts a row of values at a given index.
func (d *Dataset) InsertValues(index int, values ...interface{}) error {
return d.Insert(index, values[:])
}
// InsertTagged inserts a row at a given index with specific tags.
func (d *Dataset) InsertTagged(index int, row []interface{}, tags ...string) error {
if err := d.Insert(index, row); err != nil {
return err
}
d.Insert(index, row)
d.tags[index] = tags[:]
return nil
}
// Tag tags a row at a given index with specific tags.
// Returns ErrInvalidRowIndex if the row does not exist.
func (d *Dataset) Tag(index int, tags ...string) error {
if index < 0 || index >= d.rows {
return ErrInvalidRowIndex
}
for _, tag := range tags {
if !isTagged(tag, d.tags[index]) {
d.tags[index] = append(d.tags[index], tag)
}
}
return nil
}
// Tags returns the tags of a row at a given index.
// Returns ErrInvalidRowIndex if the row does not exist.
func (d *Dataset) Tags(index int) ([]string, error) {
if index < 0 || index >= d.rows {
return nil, ErrInvalidRowIndex
}
return d.tags[index], nil
}
// AppendColumn appends a new column with values to the Dataset.
func (d *Dataset) AppendColumn(header string, cols []interface{}) error {
if len(cols) != d.rows {
return ErrInvalidDimensions
}
d.headers = append(d.headers, header)
d.constraints = append(d.constraints, nil) // no constraint by default
d.cols++
for i, e := range d.data {
d.data[i] = append(e, cols[i])
}
return nil
}
// AppendConstrainedColumn appends a constrained column to the Dataset.
func (d *Dataset) AppendConstrainedColumn(header string, constraint ColumnConstraint, cols []interface{}) error {
err := d.AppendColumn(header, cols)
if err != nil {
return err
}
d.constraints[d.cols-1] = constraint
return nil
}
// AppendColumnValues appends a new column with values to the Dataset.
func (d *Dataset) AppendColumnValues(header string, cols ...interface{}) error {
return d.AppendColumn(header, cols[:])
}
// AppendDynamicColumn appends a dynamic column to the Dataset.
func (d *Dataset) AppendDynamicColumn(header string, fn DynamicColumn) {
d.headers = append(d.headers, header)
d.constraints = append(d.constraints, nil)
d.cols++
for i, e := range d.data {
d.data[i] = append(e, fn)
}
}
// ConstrainColumn adds a constraint to a column in the Dataset.
func (d *Dataset) ConstrainColumn(header string, constraint ColumnConstraint) {
i := indexOfColumn(header, d)
if i != -1 {
d.constraints[i] = constraint
}
}
// InsertColumn insert a new column at a given index.
func (d *Dataset) InsertColumn(index int, header string, cols []interface{}) error {
if index < 0 || index >= d.cols {
return ErrInvalidColumnIndex
}
if len(cols) != d.rows {
return ErrInvalidDimensions
}
d.insertHeader(index, header)
// for each row, insert the column
for i, r := range d.data {
row := make([]interface{}, 0, d.cols)
row = append(row, r[:index]...)
row = append(row, cols[i])
row = append(row, r[index:]...)
d.data[i] = row
}
return nil
}
// InsertDynamicColumn insert a new dynamic column at a given index.
func (d *Dataset) InsertDynamicColumn(index int, header string, fn DynamicColumn) error {
if index < 0 || index >= d.cols {
return ErrInvalidColumnIndex
}
d.insertHeader(index, header)
// for each row, insert the column
for i, r := range d.data {
row := make([]interface{}, 0, d.cols)
row = append(row, r[:index]...)
row = append(row, fn)
row = append(row, r[index:]...)
d.data[i] = row
}
return nil
}
// InsertConstrainedColumn insert a new constrained column at a given index.
func (d *Dataset) InsertConstrainedColumn(index int, header string,
constraint ColumnConstraint, cols []interface{}) error {
err := d.InsertColumn(index, header, cols)
if err != nil {
return err
}
d.constraints[index] = constraint
return nil
}
// insertHeader inserts a header at a specific index.
func (d *Dataset) insertHeader(index int, header string) {
headers := make([]string, 0, d.cols+1)
headers = append(headers, d.headers[:index]...)
headers = append(headers, header)
headers = append(headers, d.headers[index:]...)
d.headers = headers
constraints := make([]ColumnConstraint, 0, d.cols+1)
constraints = append(constraints, d.constraints[:index]...)
constraints = append(constraints, nil)
constraints = append(constraints, d.constraints[index:]...)
d.constraints = constraints
d.cols++
}
// ValidFailFast returns whether the Dataset is valid regarding constraints that have
// been previously set on columns.
func (d *Dataset) ValidFailFast() bool {
valid := true
for column, constraint := range d.constraints {
if constraint != nil {
for row, val := range d.Column(d.headers[column]) {
cellIsValid := true
switch val.(type) {
case DynamicColumn:
cellIsValid = constraint((val.(DynamicColumn))(d.data[row]))
default:
cellIsValid = constraint(val)
}
if !cellIsValid {
valid = false
break
}
}
}
}
if valid {
d.ValidationErrors = make([]ValidationError, 0)
}
return valid
}
// Valid returns whether the Dataset is valid regarding constraints that have
// been previously set on columns.
// Its behaviour is different of ValidFailFast in a sense that it will validate the whole
// Dataset and all the validation errors will be available by using Dataset.ValidationErrors
func (d *Dataset) Valid() bool {
d.ValidationErrors = make([]ValidationError, 0)
valid := true
for column, constraint := range d.constraints {
if constraint != nil {
for row, val := range d.Column(d.headers[column]) {
cellIsValid := true
switch val.(type) {
case DynamicColumn:
cellIsValid = constraint((val.(DynamicColumn))(d.data[row]))
default:
cellIsValid = constraint(val)
}
if !cellIsValid {
d.ValidationErrors = append(d.ValidationErrors,
ValidationError{Row: row, Column: column})
valid = false
}
}
}
}
return valid
}
// HasAnyConstraint returns whether the Dataset has any constraint set.
func (d *Dataset) HasAnyConstraint() bool {
hasConstraint := false
for _, constraint := range d.constraints {
if constraint != nil {
hasConstraint = true
break
}
}
return hasConstraint
}
// ValidSubset return a new Dataset containing only the rows validating their
// constraints. This is similar to what Filter() does with tags, but with constraints.
// If no constraints are set, it returns the same instance.
// Note: The returned Dataset is free of any constraints, tags are conserved.
func (d *Dataset) ValidSubset() *Dataset {
return d.internalValidSubset(true)
}
// InvalidSubset return a new Dataset containing only the rows failing to validate their
// constraints.
// If no constraints are set, it returns the same instance.
// Note: The returned Dataset is free of any constraints, tags are conserved.
func (d *Dataset) InvalidSubset() *Dataset {
return d.internalValidSubset(false)
}
// internalValidSubset return a new Dataset containing only the rows validating their
// constraints or not depending on its parameter `valid`.
func (d *Dataset) internalValidSubset(valid bool) *Dataset {
if !d.HasAnyConstraint() {
return d
}
nd := NewDataset(d.headers)
nd.data = make([][]interface{}, 0)
ndRowIndex := 0
nd.tags = make([][]string, 0)
for i, row := range d.data {
keep := true
for j, val := range d.data[i] {
if d.constraints[j] != nil {
switch val.(type) {
case DynamicColumn:
if valid {
keep = d.constraints[j]((val.(DynamicColumn))(row))
} else {
keep = !d.constraints[j]((val.(DynamicColumn))(row))
}
default:
if valid {
keep = d.constraints[j](val)
} else {
keep = !d.constraints[j](val)
}
}
}
if valid && !keep {
break
}
}
if keep {
nd.data = append(nd.data, make([]interface{}, 0, nd.cols))
nd.data[ndRowIndex] = append(nd.data[ndRowIndex], row...)
nd.tags = append(nd.tags, make([]string, 0, nd.cols))
nd.tags[ndRowIndex] = append(nd.tags[ndRowIndex], d.tags[i]...)
ndRowIndex++
}
}
nd.cols = d.cols
nd.rows = ndRowIndex
return nd
}
// Stack stacks two Dataset by joining at the row level, and return new combined Dataset.
func (d *Dataset) Stack(other *Dataset) (*Dataset, error) {
if d.Width() != other.Width() {
return nil, ErrInvalidDimensions
}
nd := NewDataset(d.headers)
nd.cols = d.cols
nd.rows = d.rows + other.rows
nd.tags = make([][]string, 0, nd.rows)
nd.tags = append(nd.tags, d.tags...)
nd.tags = append(nd.tags, other.tags...)
nd.data = make([][]interface{}, 0, nd.rows)
nd.data = append(nd.data, d.data...)
nd.data = append(nd.data, other.data...)
return nd, nil
}
// StackColumn stacks two Dataset by joining them at the column level, and return new combined Dataset.
func (d *Dataset) StackColumn(other *Dataset) (*Dataset, error) {
if d.Height() != other.Height() {
return nil, ErrInvalidDimensions
}
nheaders := d.headers
nheaders = append(nheaders, other.headers...)
nd := NewDataset(nheaders)
nd.cols = d.cols + nd.cols
nd.rows = d.rows
nd.data = make([][]interface{}, nd.rows, nd.rows)
nd.tags = make([][]string, nd.rows, nd.rows)
for i := range d.data {
nd.data[i] = make([]interface{}, 0, nd.cols)
nd.data[i] = append(nd.data[i], d.data[i]...)
nd.data[i] = append(nd.data[i], other.data[i]...)
nd.tags[i] = make([]string, 0, nd.cols)
nd.tags[i] = append(nd.tags[i], d.tags[i]...)
nd.tags[i] = append(nd.tags[i], other.tags[i]...)
}
return nd, nil
}
// Column returns all the values for a specific column
// returns nil if column is not found.
func (d *Dataset) Column(header string) []interface{} {
colIndex := indexOfColumn(header, d)
if colIndex == -1 {
return nil
}
values := make([]interface{}, d.rows)
for i, e := range d.data {
switch e[colIndex].(type) {
case DynamicColumn:
values[i] = e[colIndex].(DynamicColumn)(e)
default:
values[i] = e[colIndex]
}
}
return values
}
// Row returns a map representing a specific row of the Dataset.
// returns tablib.ErrInvalidRowIndex if the row cannot be found
func (d *Dataset) Row(index int) (map[string]interface{}, error) {
if index < 0 || index >= d.rows {
return nil, ErrInvalidRowIndex
}
row := make(map[string]interface{})
for i, e := range d.data[index] {
switch e.(type) {
case DynamicColumn:
row[d.headers[i]] = e.(DynamicColumn)(d.data[index])
default:
row[d.headers[i]] = e
}
}
return row, nil
}
// Rows returns an array of map representing a set of specific rows of the Dataset.
// returns tablib.ErrInvalidRowIndex if the row cannot be found.
func (d *Dataset) Rows(index ...int) ([]map[string]interface{}, error) {
for _, i := range index {
if i < 0 || i >= d.rows {
return nil, ErrInvalidRowIndex
}
}
rows := make([]map[string]interface{}, 0, len(index))
for _, i := range index {
row, _ := d.Row(i)
rows = append(rows, row)
}
return rows, nil
}
// Slice returns a new Dataset representing a slice of the orignal Dataset like a slice of an array.
// returns tablib.ErrInvalidRowIndex if the lower or upper bound is out of range.
func (d *Dataset) Slice(lower, upperNonInclusive int) (*Dataset, error) {
if lower > upperNonInclusive || lower < 0 || upperNonInclusive > d.rows {
return nil, ErrInvalidRowIndex
}
rowCount := upperNonInclusive - lower
cols := d.cols
nd := NewDataset(d.headers)
nd.data = make([][]interface{}, 0, rowCount)
nd.tags = make([][]string, 0, rowCount)
nd.rows = upperNonInclusive - lower
j := 0
for i := lower; i < upperNonInclusive; i++ {
nd.data = append(nd.data, make([]interface{}, 0, cols))
nd.data[j] = make([]interface{}, 0, cols)
nd.data[j] = append(nd.data[j], d.data[i]...)
nd.tags = append(nd.tags, make([]string, 0, cols))
nd.tags[j] = make([]string, 0, cols)
nd.tags[j] = append(nd.tags[j], d.tags[i]...)
j++
}
return nd, nil
}
// Filter filters a Dataset, returning a fresh Dataset including only the rows
// previously tagged with one of the given tags. Returns a new Dataset.
func (d *Dataset) Filter(tags ...string) *Dataset {
nd := NewDataset(d.headers)
for rowIndex, rowValue := range d.data {
for _, filterTag := range tags {
if isTagged(filterTag, d.tags[rowIndex]) {
nd.AppendTagged(rowValue, d.tags[rowIndex]...) // copy tags
}
}
}
return nd
}
// Sort sorts the Dataset by a specific column. Returns a new Dataset.
func (d *Dataset) Sort(column string) *Dataset {
return d.internalSort(column, false)
}
// SortReverse sorts the Dataset by a specific column in reverse order. Returns a new Dataset.
func (d *Dataset) SortReverse(column string) *Dataset {
return d.internalSort(column, true)
}
func (d *Dataset) internalSort(column string, reverse bool) *Dataset {
nd := NewDataset(d.headers)
pairs := make([]entryPair, 0, nd.rows)
for i, v := range d.Column(column) {
pairs = append(pairs, entryPair{i, v})
}
var how sort.Interface
// sort by column
switch pairs[0].value.(type) {
case string:
how = byStringValue(pairs)
case int:
how = byIntValue(pairs)
case int64:
how = byInt64Value(pairs)
case uint64:
how = byUint64Value(pairs)
case float64:
how = byFloatValue(pairs)
case time.Time:
how = byTimeValue(pairs)
default:
// nothing
}
if !reverse {
sort.Sort(how)
} else {
sort.Sort(sort.Reverse(how))
}
// now iterate on the pairs and add the data sorted to the new Dataset
for _, p := range pairs {
nd.AppendTagged(d.data[p.index], d.tags[p.index]...)
}
return nd
}
// Transpose transposes a Dataset, turning rows into columns and vice versa,
// returning a new Dataset instance. The first row of the original instance
// becomes the new header row. Tags, constraints and dynamic columns are lost
// in the returned Dataset.
// TODO
func (d *Dataset) Transpose() *Dataset {
newHeaders := make([]string, 0, d.cols+1)
newHeaders = append(newHeaders, d.headers[0])
for _, c := range d.Column(d.headers[0]) {
newHeaders = append(newHeaders, d.asString(c))
}
nd := NewDataset(newHeaders)
nd.data = make([][]interface{}, 0, d.cols)
for i := 1; i < d.cols; i++ {
nd.data = append(nd.data, make([]interface{}, 0, d.rows))
nd.data[i-1] = make([]interface{}, 0, d.rows)
nd.data[i-1] = append(nd.data[i-1], d.headers[i])
nd.data[i-1] = append(nd.data[i-1], d.Column(d.headers[i])...)
}
nd.rows = d.cols - 1
return nd
}
// DeleteRow deletes a row at a specific index
func (d *Dataset) DeleteRow(row int) error {
if row < 0 || row >= d.rows {
return ErrInvalidRowIndex
}
d.data = append(d.data[:row], d.data[row+1:]...)
d.rows--
return nil
}
// DeleteColumn deletes a column from the Dataset.
func (d *Dataset) DeleteColumn(header string) error {
colIndex := indexOfColumn(header, d)
if colIndex == -1 {
return ErrInvalidColumnIndex
}
d.cols--
d.headers = append(d.headers[:colIndex], d.headers[colIndex+1:]...)
// remove the column
for i := range d.data {
d.data[i] = append(d.data[i][:colIndex], d.data[i][colIndex+1:]...)
}
return nil
}
func indexOfColumn(header string, d *Dataset) int {
for i, e := range d.headers {
if e == header {
return i
}
}
return -1
}
// Dict returns the Dataset as an array of map where each key is a column.
func (d *Dataset) Dict() []interface{} {
back := make([]interface{}, d.rows)
for i, e := range d.data {
m := make(map[string]interface{}, d.cols-1)
for j, c := range d.headers {
switch e[j].(type) {
case DynamicColumn:
m[c] = e[j].(DynamicColumn)(e)
default:
m[c] = e[j]
}
}
back[i] = m
}
return back
}
// Records returns the Dataset as an array of array where each entry is a string.
// The first row of the returned 2d array represents the columns of the Dataset.
func (d *Dataset) Records() [][]string {
records := make([][]string, d.rows+1 /* +1 for header */)
records[0] = make([]string, d.cols)
for j, e := range d.headers {
records[0][j] = e
}
for i, e := range d.data {
rowIndex := i + 1
j := 0
records[rowIndex] = make([]string, d.cols)
for _, v := range e {
vv := v
switch v.(type) {
case DynamicColumn:
vv = v.(DynamicColumn)(e)
default:
// nothing
}
records[rowIndex][j] = d.asString(vv)
j++
}
}
return records
}
// ffs
func justLetMeKeepFmt() {
fmt.Printf("")
}