-
Notifications
You must be signed in to change notification settings - Fork 192
/
headers.py
398 lines (291 loc) · 9.4 KB
/
headers.py
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
from __future__ import absolute_import, print_function, division
import itertools
from petl.compat import next, text_type
from petl.errors import FieldSelectionError
from petl.util.base import Table, asindices, rowgetter
def rename(table, *args, **kwargs):
"""
Replace one or more values in the table's header row. E.g.::
>>> import petl as etl
>>> table1 = [['sex', 'age'],
... ['m', 12],
... ['f', 34],
... ['-', 56]]
>>> # rename a single field
... table2 = etl.rename(table1, 'sex', 'gender')
>>> table2
+--------+-----+
| gender | age |
+========+=====+
| 'm' | 12 |
+--------+-----+
| 'f' | 34 |
+--------+-----+
| '-' | 56 |
+--------+-----+
>>> # rename multiple fields by passing dictionary as second argument
... table3 = etl.rename(table1, {'sex': 'gender', 'age': 'age_years'})
>>> table3
+--------+-----------+
| gender | age_years |
+========+===========+
| 'm' | 12 |
+--------+-----------+
| 'f' | 34 |
+--------+-----------+
| '-' | 56 |
+--------+-----------+
The field to rename can be specified as an index (i.e., integer representing
field position).
If any nonexistent fields are specified, the default behaviour is to raise
a `FieldSelectionError`. However, if `strict` keyword argument is `False`, any
nonexistent fields specified will be silently ignored.
"""
return RenameView(table, *args, **kwargs)
Table.rename = rename
class RenameView(Table):
def __init__(self, table, *args, **kwargs):
self.source = table
if len(args) == 0:
self.spec = dict()
elif len(args) == 1:
self.spec = args[0]
elif len(args) == 2:
self.spec = {args[0]: args[1]}
self.strict = kwargs.get('strict', True)
def __iter__(self):
return iterrename(self.source, self.spec, self.strict)
def __setitem__(self, key, value):
self.spec[key] = value
def iterrename(source, spec, strict):
it = iter(source)
try:
hdr = next(it)
except StopIteration:
hdr = []
flds = list(map(text_type, hdr))
if strict:
for x in spec:
if isinstance(x, int):
if x < 0 or x >= len(hdr):
raise FieldSelectionError(x)
elif x not in flds:
raise FieldSelectionError(x)
outhdr = [spec[i] if i in spec
else spec[f] if f in spec
else f
for i, f in enumerate(flds)]
yield tuple(outhdr)
for row in it:
yield tuple(row)
def setheader(table, header):
"""
Replace header row in the given table. E.g.::
>>> import petl as etl
>>> table1 = [['foo', 'bar'],
... ['a', 1],
... ['b', 2]]
>>> table2 = etl.setheader(table1, ['foofoo', 'barbar'])
>>> table2
+--------+--------+
| foofoo | barbar |
+========+========+
| 'a' | 1 |
+--------+--------+
| 'b' | 2 |
+--------+--------+
See also :func:`petl.transform.headers.extendheader`,
:func:`petl.transform.headers.pushheader`.
"""
return SetHeaderView(table, header)
Table.setheader = setheader
class SetHeaderView(Table):
def __init__(self, source, header):
self.source = source
self.header = header
def __iter__(self):
return itersetheader(self.source, self.header)
def itersetheader(source, header):
it = iter(source)
try:
next(it) # discard source header
except StopIteration:
pass # no previous header
yield tuple(header)
for row in it:
yield tuple(row)
def extendheader(table, fields):
"""
Extend header row in the given table. E.g.::
>>> import petl as etl
>>> table1 = [['foo'],
... ['a', 1, True],
... ['b', 2, False]]
>>> table2 = etl.extendheader(table1, ['bar', 'baz'])
>>> table2
+-----+-----+-------+
| foo | bar | baz |
+=====+=====+=======+
| 'a' | 1 | True |
+-----+-----+-------+
| 'b' | 2 | False |
+-----+-----+-------+
See also :func:`petl.transform.headers.setheader`,
:func:`petl.transform.headers.pushheader`.
"""
return ExtendHeaderView(table, fields)
Table.extendheader = extendheader
class ExtendHeaderView(Table):
def __init__(self, source, fields):
self.source = source
self.fields = fields
def __iter__(self):
return iterextendheader(self.source, self.fields)
def iterextendheader(source, fields):
it = iter(source)
try:
hdr = next(it)
except StopIteration:
hdr = []
outhdr = list(hdr)
outhdr.extend(fields)
yield tuple(outhdr)
for row in it:
yield tuple(row)
def pushheader(table, header, *args):
"""
Push rows down and prepend a header row. E.g.::
>>> import petl as etl
>>> table1 = [['a', 1],
... ['b', 2]]
>>> table2 = etl.pushheader(table1, ['foo', 'bar'])
>>> table2
+-----+-----+
| foo | bar |
+=====+=====+
| 'a' | 1 |
+-----+-----+
| 'b' | 2 |
+-----+-----+
The header row can either be a list or positional arguments.
"""
return PushHeaderView(table, header, *args)
Table.pushheader = pushheader
class PushHeaderView(Table):
def __init__(self, source, header, *args):
self.source = source
self.args = args
# if user passes header as a list, just use this and ignore args
if isinstance(header, (list, tuple)):
self.header = header
# otherwise,
elif len(args) > 0:
self.header = []
self.header.append(header) # first argument is named header
self.header.extend(args) # add the other positional arguments
else:
assert False, 'bad parameters'
def __iter__(self):
return iterpushheader(self.source, self.header)
def iterpushheader(source, header):
it = iter(source)
yield tuple(header)
for row in it:
yield tuple(row)
def skip(table, n):
"""
Skip `n` rows, including the header row. E.g.::
>>> import petl as etl
>>> table1 = [['#aaa', 'bbb', 'ccc'],
... ['#mmm'],
... ['foo', 'bar'],
... ['a', 1],
... ['b', 2]]
>>> table2 = etl.skip(table1, 2)
>>> table2
+-----+-----+
| foo | bar |
+=====+=====+
| 'a' | 1 |
+-----+-----+
| 'b' | 2 |
+-----+-----+
See also :func:`petl.transform.basics.skipcomments`.
"""
return SkipView(table, n)
Table.skip = skip
class SkipView(Table):
def __init__(self, source, n):
self.source = source
self.n = n
def __iter__(self):
return iterskip(self.source, self.n)
def iterskip(source, n):
return itertools.islice(source, n, None)
def prefixheader(table, prefix):
"""Prefix all fields in the table header."""
return PrefixHeaderView(table, prefix)
Table.prefixheader = prefixheader
class PrefixHeaderView(Table):
def __init__(self, table, prefix):
self.table = table
self.prefix = prefix
def __iter__(self):
it = iter(self.table)
try:
hdr = next(it)
except StopIteration:
return
outhdr = tuple((text_type(self.prefix) + text_type(f)) for f in hdr)
yield outhdr
for row in it:
yield row
def suffixheader(table, suffix):
"""Suffix all fields in the table header."""
return SuffixHeaderView(table, suffix)
Table.suffixheader = suffixheader
class SuffixHeaderView(Table):
def __init__(self, table, suffix):
self.table = table
self.suffix = suffix
def __iter__(self):
it = iter(self.table)
try:
hdr = next(it)
except StopIteration:
return
outhdr = tuple((text_type(f) + text_type(self.suffix)) for f in hdr)
yield outhdr
for row in it:
yield row
def sortheader(table, reverse=False, missing=None):
"""Re-order columns so the header is sorted.
.. versionadded:: 1.1.0
"""
return SortHeaderView(table, reverse, missing)
Table.sortheader = sortheader
class SortHeaderView(Table):
def __init__(self, table, reverse, missing):
self.table = table
self.reverse = reverse
self.missing = missing
def __iter__(self):
it = iter(self.table)
try:
hdr = next(it)
except StopIteration:
return
shdr = sorted(hdr)
indices = asindices(hdr, shdr)
transform = rowgetter(*indices)
# yield the transformed header
yield tuple(shdr)
# construct the transformed data
missing = self.missing
for row in it:
try:
yield transform(row)
except IndexError:
# row is short, let's be kind and fill in any missing fields
yield tuple(row[i] if i < len(row) else missing
for i in indices)