/
_core.py
519 lines (394 loc) · 14 KB
/
_core.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
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
"""
.. codeauthor:: Tsuyoshi Hombashi <tsuyoshi.hombashi@gmail.com>
"""
import re
from collections import OrderedDict, namedtuple
from typing import Any, Dict, List, Optional, Sequence
import dataproperty as dp
import typepy
from dataproperty.typing import TypeHint
from typepy import Nan
from ._constant import PatternMatch
from ._converter import to_value_matrix
from ._logger import logger
class TableData:
"""
Class to represent a table data structure.
:param table_name: Name of the table.
:param headers: Table header names.
:param rows: Data of the table.
"""
def __init__(
self,
table_name: Optional[str],
headers: Sequence[str],
rows: Sequence,
dp_extractor: Optional[dp.DataPropertyExtractor] = None,
type_hints: Optional[Sequence[TypeHint]] = None,
max_workers: Optional[int] = None,
):
self.__table_name = table_name
self.__value_matrix = None # type: Optional[Sequence]
self.__value_dp_matrix = None # type: Optional[Sequence[Sequence[dp.DataProperty]]]
if rows:
self.__rows = rows
else:
self.__rows = []
if dp_extractor:
self.__dp_extractor = dp_extractor
else:
self.__dp_extractor = dp.DataPropertyExtractor()
if type_hints:
self.__dp_extractor.column_type_hints = type_hints
self.__dp_extractor.strip_str_header = '"'
if max_workers:
self.__dp_extractor.max_workers = max_workers
if not headers:
self.__dp_extractor.headers = []
else:
self.__dp_extractor.headers = headers
def __repr__(self) -> str:
element_list = ["table_name={}".format(self.table_name)]
try:
element_list.append("headers=[{}]".format(", ".join(self.headers)))
except TypeError:
element_list.append("headers=None")
element_list.extend(["cols={}".format(self.num_columns), "rows={}".format(self.num_rows)])
return ", ".join(element_list)
def __eq__(self, other) -> bool:
return self.equals(other, cmp_by_dp=False)
def __ne__(self, other) -> bool:
return not self.equals(other, cmp_by_dp=False)
@property
def table_name(self) -> Optional[str]:
"""
:return: Name of the table.
:rtype: str
"""
return self.__table_name
@table_name.setter
def table_name(self, value: Optional[str]) -> None:
self.__table_name = value
@property
def headers(self) -> List[str]:
"""Get the table header names.
Returns:
|list| or |tuple|: Table header names.
"""
return self.__dp_extractor.headers
@property
def rows(self) -> Sequence:
"""Original rows of tabular data.
Returns:
|list| or |tuple|: Table rows.
"""
return self.__rows
@property
def value_matrix(self) -> Sequence:
"""Converted rows of tabular data.
Returns:
|list| or |tuple|: Table rows.
"""
if self.__value_matrix:
return self.__value_matrix
self.__value_matrix = [
[value_dp.data for value_dp in value_dp_list] for value_dp_list in self.value_dp_matrix
]
return self.__value_matrix
@property
def has_value_dp_matrix(self) -> bool:
return self.__value_dp_matrix is not None
@property
def max_workers(self) -> int:
return self.__dp_extractor.max_workers
@max_workers.setter
def max_workers(self, value: Optional[int]) -> None:
self.__dp_extractor.max_workers = value
@property
def num_rows(self) -> Optional[int]:
"""
:return:
Number of rows in the tabular data.
|None| if the ``rows`` is neither list nor tuple.
:rtype: int
"""
try:
return len(self.rows)
except TypeError:
return None
@property
def num_columns(self) -> Optional[int]:
if typepy.is_not_empty_sequence(self.headers):
return len(self.headers)
try:
return len(self.rows[0])
except TypeError:
return None
except IndexError:
return 0
@property
def value_dp_matrix(self) -> Sequence[Sequence[dp.DataProperty]]:
"""
:return: DataProperty for table data.
:rtype: list
"""
if self.__value_dp_matrix is None:
self.__value_dp_matrix = self.__dp_extractor.to_dp_matrix(
to_value_matrix(self.headers, self.rows)
)
return self.__value_dp_matrix
@property
def header_dp_list(self) -> List[dp.DataPropertyExtractor]:
return self.__dp_extractor.to_header_dp_list()
@property
def column_dp_list(self) -> List[dp.ColumnDataProperty]:
return self.__dp_extractor.to_column_dp_list(self.value_dp_matrix)
@property
def dp_extractor(self) -> dp.DataPropertyExtractor:
return self.__dp_extractor
def is_empty_header(self) -> bool:
"""
:return: |True| if the data :py:attr:`.headers` is empty.
:rtype: bool
"""
return typepy.is_empty_sequence(self.headers)
def is_empty_rows(self) -> bool:
"""
:return: |True| if the tabular data has no rows.
:rtype: bool
"""
return self.num_rows == 0
def is_empty(self) -> bool:
"""
:return:
|True| if the data :py:attr:`.headers` or
:py:attr:`.value_matrix` is empty.
:rtype: bool
"""
return any([self.is_empty_header(), self.is_empty_rows()])
def equals(self, other, cmp_by_dp: bool = True) -> bool:
if cmp_by_dp:
return self.__equals_dp(other)
return self.__equals_raw(other)
def __equals_base(self, other) -> bool:
compare_item_list = [self.table_name == other.table_name]
if self.num_rows is not None:
compare_item_list.append(self.num_rows == other.num_rows)
return all(compare_item_list)
def __equals_raw(self, other) -> bool:
if not self.__equals_base(other):
return False
if self.headers != other.headers:
return False
for lhs_row, rhs_row in zip(self.rows, other.rows):
if len(lhs_row) != len(rhs_row):
return False
if not all(
[
lhs == rhs
for lhs, rhs in zip(lhs_row, rhs_row)
if not Nan(lhs).is_type() and not Nan(rhs).is_type()
]
):
return False
return True
def __equals_dp(self, other) -> bool:
if not self.__equals_base(other):
return False
if self.header_dp_list != other.header_dp_list:
return False
if (self.value_dp_matrix is None and other) or (self.value_dp_matrix and other is None):
return False
for lhs_list, rhs_list in zip(self.value_dp_matrix, other.value_dp_matrix):
if len(lhs_list) != len(rhs_list):
return False
if any([lhs != rhs for lhs, rhs in zip(lhs_list, rhs_list)]):
return False
return True
def in_tabledata_list(self, other: Sequence, cmp_by_dp: bool = True) -> bool:
for table_data in other:
if self.equals(table_data, cmp_by_dp=cmp_by_dp):
return True
return False
def validate_rows(self) -> None:
"""
:raises ValueError:
"""
invalid_row_idx_list = []
for row_idx, row in enumerate(self.rows):
if isinstance(row, (list, tuple)) and len(self.headers) != len(row):
invalid_row_idx_list.append(row_idx)
if isinstance(row, dict):
if not all([header in row for header in self.headers]):
invalid_row_idx_list.append(row_idx)
if not invalid_row_idx_list:
return
for invalid_row_idx in invalid_row_idx_list:
logger.debug(
"invalid row (line={}): {}".format(invalid_row_idx, self.rows[invalid_row_idx])
)
raise ValueError(
"table header length and row length are mismatch:\n"
+ " header(len={}): {}\n".format(len(self.headers), self.headers)
+ " # of miss match rows: {} ouf of {}\n".format(
len(invalid_row_idx_list), self.num_rows
)
)
def as_dict(self, default_key: str = "table") -> "Dict[str, List[OrderedDict[str, Any]]]":
"""
Args:
default_key:
Key of a returning dictionary when the ``table_name`` is empty.
Returns:
dict: Table data as a |dict| instance.
Sample Code:
.. code:: python
from tabledata import TableData
TableData(
"sample",
["a", "b"],
[[1, 2], [3.3, 4.4]]
).as_dict()
Output:
.. code:: json
{'sample': [OrderedDict([('a', 1), ('b', 2)]), OrderedDict([('a', 3.3), ('b', 4.4)])]}
""" # noqa
dict_body = []
for row in self.value_matrix:
if not row:
continue
values = [
(header, value) for header, value in zip(self.headers, row) if value is not None
]
if not values:
continue
dict_body.append(OrderedDict(values))
table_name = self.table_name
if not table_name:
table_name = default_key
return {table_name: dict_body}
def as_tuple(self):
"""
:return: Rows of the table.
:rtype: list of |namedtuple|
:Sample Code:
.. code:: python
from tabledata import TableData
records = TableData(
"sample",
["a", "b"],
[[1, 2], [3.3, 4.4]]
).as_tuple()
for record in records:
print(record)
:Output:
.. code-block:: none
Row(a=1, b=2)
Row(a=Decimal('3.3'), b=Decimal('4.4'))
"""
Row = namedtuple("Row", self.headers)
for value_dp_list in self.value_dp_matrix:
if typepy.is_empty_sequence(value_dp_list):
continue
row = Row(*[value_dp.data for value_dp in value_dp_list])
yield row
def as_dataframe(self):
"""
:return: Table data as a ``pandas.DataFrame`` instance.
:rtype: pandas.DataFrame
:Sample Code:
.. code-block:: python
from tabledata import TableData
TableData(
"sample",
["a", "b"],
[[1, 2], [3.3, 4.4]]
).as_dataframe()
:Output:
.. code-block:: none
a b
0 1 2
1 3.3 4.4
:Dependency Packages:
- `pandas <https://pandas.pydata.org/>`__
"""
import pandas
dataframe = pandas.DataFrame(self.value_matrix)
if not self.is_empty_header():
dataframe.columns = self.headers
return dataframe
def transpose(self):
return TableData(
self.table_name,
self.headers,
[row for row in zip(*self.rows)],
max_workers=self.max_workers,
)
def filter_column(
self,
patterns: Optional[str] = None,
is_invert_match: bool = False,
is_re_match: bool = False,
pattern_match: PatternMatch = PatternMatch.OR,
):
logger.debug(
"filter_column: patterns={}, is_invert_match={}, "
"is_re_match={}, pattern_match={}".format(
patterns, is_invert_match, is_re_match, pattern_match
)
)
if not patterns:
return self
match_header_list = []
match_column_matrix = []
if pattern_match == PatternMatch.OR:
match_method = any
elif pattern_match == PatternMatch.AND:
match_method = all
else:
raise ValueError("unknown matching: {}".format(pattern_match))
for header, column in zip(self.headers, zip(*self.rows)):
is_match_list = []
for pattern in patterns:
is_match = self.__is_match(header, pattern, is_re_match)
is_match_list.append(
any([is_match and not is_invert_match, not is_match and is_invert_match])
)
if match_method(is_match_list):
match_header_list.append(header)
match_column_matrix.append(column)
logger.debug(
"filter_column: table={}, match_header_list={}".format(
self.table_name, match_header_list
)
)
return TableData(
self.table_name,
match_header_list,
list(zip(*match_column_matrix)),
max_workers=self.max_workers,
)
@staticmethod
def from_dataframe(
dataframe,
table_name: str = "",
type_hints: Optional[Sequence[TypeHint]] = None,
max_workers: Optional[int] = None,
):
"""
Initialize TableData instance from a pandas.DataFrame instance.
:param pandas.DataFrame dataframe:
:param str table_name: Table name to create.
"""
return TableData(
table_name,
list(dataframe.columns.values),
dataframe.values.tolist(),
type_hints=type_hints,
max_workers=max_workers,
)
@staticmethod
def __is_match(header: str, pattern: str, is_re_match: bool) -> bool:
if is_re_match:
return re.search(pattern, header) is not None
return header == pattern