Repository navigation
Expand file tree
/
Copy path__init__.py
More file actions
3067 lines (2663 loc) · 103 KB
/
Copy path__init__.py
File metadata and controls
3067 lines (2663 loc) · 103 KB
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
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Pretty-print tabular data."""
from collections import namedtuple
from collections.abc import Iterable, Sized
from html import escape as htmlescape
from itertools import chain, zip_longest as izip_longest
from functools import reduce, partial
import io
import re
import math
import textwrap
import dataclasses
from typing import (
Callable,
Tuple,
Union,
TypeVar,
List,
Dict,
Pattern,
Type,
Any,
Optional,
Sized,
Iterable,
)
from typing_extensions import Literal, TypedDict, Protocol
try:
import wcwidth # optional wide-character (CJK) support # type: ignore
except ImportError:
wcwidth = None
def _is_file(f):
return isinstance(f, io.IOBase)
__all__ = ["tabulate", "tabulate_formats", "simple_separated_format"]
try:
from .version import version as __version__ # noqa: F401 # type: ignore
except ImportError:
pass # running __init__.py as a script, AppVeyor pytests
# minimum extra space in headers
MIN_PADDING: int = 2
# Whether or not to preserve leading/trailing whitespace in data.
PRESERVE_WHITESPACE: bool = False
# TextWrapper breaks words longer than 'width'.
_BREAK_LONG_WORDS: bool = True
# TextWrapper is breaking hyphenated words.
_BREAK_ON_HYPHENS: bool = True
_DEFAULT_FLOATFMT: str = "g"
_DEFAULT_INTFMT: str = ""
_DEFAULT_MISSINGVAL: str = ""
# default align will be overwritten by "left", "center" or "decimal"
# depending on the formatter
_DEFAULT_ALIGN: str = "default"
# if True, enable wide-character (CJK) support
WIDE_CHARS_MODE: bool = wcwidth is not None
# Constant that can be used as part of passed rows to generate a separating line
# It is purposely an unprintable character, very unlikely to be used in a table
SEPARATING_LINE: str = "\001"
T_ALIGNS = List[str]
T_COLWIDTHS = List[Union[int, str]]
AST = TypeVar("AST", bound="AlignableString")
ALIGNMENT = TypedDict(
"ALIGNMENT",
{
"left": str,
"right": str,
"center": str,
"decimal": str,
},
)
ColWidths = TypedDict(
"ColWidths",
{
"colwidth": int,
},
)
ColAligns = TypedDict(
"ColAlign",
{
"colalign": str,
},
)
Line = namedtuple(
"Line",
[
"begin",
"hline",
"sep",
"end",
],
)
DataRow = namedtuple("DataRow", ["begin", "sep", "end"])
# A table structure is supposed to be:
#
# --- lineabove ---------
# headerrow
# --- linebelowheader ---
# datarow
# --- linebetweenrows ---
# ... (more datarows) ...
# --- linebetweenrows ---
# last datarow
# --- linebelow ---------
#
# TableFormat's line* elements can be
#
# - either None, if the element is not used,
# - or a Line tuple,
# - or a function: [col_widths], [col_alignments] -> string.
#
# TableFormat's *row elements can be
#
# - either None, if the element is not used,
# - or a DataRow tuple,
# - or a function: [cell_values], [col_widths], [col_alignments] -> string.
#
# padding (an integer) is the amount of white space around data values.
#
# with_header_hide:
#
# - either None, to display all table elements unconditionally,
# - or a list of elements not to be displayed if the table has column headers.
#
TableFormat = namedtuple(
"TableFormat",
[
"lineabove",
"linebelowheader",
"linebetweenrows",
"linebelow",
"headerrow",
"datarow",
"padding",
"with_header_hide",
],
)
class TableOptions(TypedDict):
colwidths_ignore: T_COLWIDTHS
colaligns_ignore: T_ALIGNS
class EscapeString(Protocol):
def __str__(self) -> str:
...
class Convertible(Protocol):
def __call__(self, string: Union[str, bytes]) -> Any:
...
class AlignableString(Protocol):
def __str__(self) -> str:
...
class IndexType(Protocol):
def __len__(self) -> int:
...
def __iter__(self) -> Iterable:
...
class HasLen(Protocol):
def __len__(self) -> int:
...
def _is_separating_line_values(value: str) -> bool:
return type(value) == str and value.strip() == SEPARATING_LINE
def _is_separating_line(row: Union[list, str]) -> Literal[True, False]:
row_type = type(row)
is_sl = (row_type == list or row_type == str) and (
(len(row) >= 1 and _is_separating_line_values(row[0]))
or (len(row) >= 2 and _is_separating_line_values(row[1]))
)
return is_sl
def _pipe_segment_with_colons(align: str, colwidth: int) -> str:
"""Return a segment of a horizontal line with optional colons which
indicate column's alignment (as in `pipe` output format)."""
w = colwidth
if align in ["right", "decimal"]:
return ("-" * (w - 1)) + ":"
elif align == "center":
return ":" + ("-" * (w - 2)) + ":"
elif align == "left":
return ":" + ("-" * (w - 1))
else:
return "-" * w
def _pipe_line_with_colons(colwidths: List[int], colaligns: List[str]) -> str:
"""Return a horizontal line with optional colons to indicate column's
alignment (as in `pipe` output format)."""
if not colaligns: # e.g. printing an empty data frame (github issue #15)
colaligns = [""] * len(colwidths)
segments = [_pipe_segment_with_colons(a, w) for a, w in zip(colaligns, colwidths)]
return "|" + "|".join(segments) + "|"
def _mediawiki_row_with_attrs(
separator: str,
cell_values: List[str],
colwidths: List[int],
colaligns: List[Literal["left", "right", "center", "decimal"]],
) -> str:
alignment: ALIGNMENT = {
"left": "",
"right": 'style="text-align: right;"| ',
"center": 'style="text-align: center;"| ',
"decimal": 'style="text-align: right;"| ',
}
# hard-coded padding _around_ align attribute and value together
# rather than padding parameter which affects only the value
values_with_attrs = [
" " + alignment.get(a, "") + c + " " for c, a in zip(cell_values, colaligns)
]
colsep = separator * 2
return (separator + colsep.join(values_with_attrs)).rstrip()
def _textile_row_with_attrs(
cell_values: List[str],
colwidths: List[int],
colaligns: List[
Union[
Literal["left"],
Literal["right"],
Literal["center"],
Literal["decimal"],
]
],
) -> str:
cell_values[0] += " "
alignment: ALIGNMENT = {
"left": "<.",
"right": ">.",
"center": "=.",
"decimal": ">.",
}
values = (alignment.get(a, "") + v for a, v in zip(colaligns, cell_values))
return "|" + "|".join(values) + "|"
def _html_begin_table_without_header(options: TableOptions) -> str:
# this table header will be suppressed if there is a header row
return "<table>\n<tbody>"
def _html_row_with_attrs(
celltag: str,
unsafe: bool,
cell_values: List[str],
colwidths: List[int],
colaligns: List[str],
) -> str:
alignment: ALIGNMENT = {
"left": "",
"right": ' style="text-align: right;"',
"center": ' style="text-align: center;"',
"decimal": ' style="text-align: right;"',
}
if unsafe:
values_with_attrs = [
"<{0}{1}>{2}</{0}>".format(celltag, alignment.get(a, ""), c)
for c, a in zip(cell_values, colaligns)
]
else:
values_with_attrs = [
"<{0}{1}>{2}</{0}>".format(celltag, alignment.get(a, ""), htmlescape(c))
for c, a in zip(cell_values, colaligns)
]
rowhtml = "<tr>{}</tr>".format("".join(values_with_attrs).rstrip())
if celltag == "th": # it's a header row, create a new table header
rowhtml = f"<table>\n<thead>\n{rowhtml}\n</thead>\n<tbody>"
return rowhtml
def _moin_row_with_attrs(
celltag: str,
cell_values: List[str],
colwidths: List[int],
colaligns: List[Literal["left", "right", "center", "decimal"]],
header: str = "",
) -> str:
alignment: ALIGNMENT = {
"left": "",
"right": '<style="text-align: right;">',
"center": '<style="text-align: center;">',
"decimal": '<style="text-align: right;">',
}
values_with_attrs = [
"{}{} {} ".format(celltag, alignment.get(a, ""), header + c + header)
for c, a in zip(cell_values, colaligns)
]
return "".join(values_with_attrs) + "||"
def _latex_line_begin_tabular(
colwidths: List[int],
colaligns: List[Literal["left", "right", "center", "decimal"]],
booktabs: bool = False,
longtable: bool = False,
) -> str:
alignment = {"left": "l", "right": "r", "center": "c", "decimal": "r"}
tabular_columns_fmt = "".join([alignment.get(a, "l") for a in colaligns])
return "\n".join(
[
("\\begin{tabular}{" if not longtable else "\\begin{longtable}{")
+ tabular_columns_fmt
+ "}",
"\\toprule" if booktabs else "\\hline",
]
)
def _asciidoc_row(is_header: bool, *args: Any):
"""handle header and data rows for asciidoc format"""
def make_header_line(is_header: bool, colwidths: List[int], colaligns: List[str]):
# generate the column specifiers
alignment: Dict[str, str] = {
"left": "<",
"right": ">",
"center": "^",
"decimal": ">",
}
# use the column widths generated by tabulate for the asciidoc column width specifiers
asciidoc_alignments = zip(
colwidths, [alignment[colalign] for colalign in colaligns]
)
asciidoc_column_specifiers = [
"{:d}{}".format(width, align) for width, align in asciidoc_alignments
]
header_list = ['cols="' + (",".join(asciidoc_column_specifiers)) + '"']
# generate the list of options (currently only "header")
options_list = []
if is_header:
options_list.append("header")
if options_list:
header_list += ['options="' + ",".join(options_list) + '"']
# generate the list of entries in the table header field
return "[{}]\n|====".format(",".join(header_list))
if len(args) == 2:
# two arguments are passed if called in the context of aboveline
# print the table header with column widths and optional header tag
return make_header_line(False, *args)
elif len(args) == 3:
# three arguments are passed if called in the context of dataline or headerline
# print the table line and make the aboveline if it is a header
cell_values, colwidths, colaligns = args
data_line = "|" + "|".join(cell_values)
if is_header:
return make_header_line(True, colwidths, colaligns) + "\n" + data_line
else:
return data_line
else:
raise ValueError(
" _asciidoc_row() requires two (colwidths, colaligns) "
+ "or three (cell_values, colwidths, colaligns) arguments) "
)
LATEX_ESCAPE_RULES: Dict[str, str] = {
r"&": r"\&",
r"%": r"\%",
r"$": r"\$",
r"#": r"\#",
r"_": r"\_",
r"^": r"\^{}",
r"{": r"\{",
r"}": r"\}",
r"~": r"\textasciitilde{}",
"\\": r"\textbackslash{}",
r"<": r"\ensuremath{<}",
r">": r"\ensuremath{>}",
}
def _latex_row(
cell_values: List[str],
colwidths: List[int],
colaligns: List[Literal["left", "center", "right"]],
escrules: Dict[str, str] = LATEX_ESCAPE_RULES,
):
def escape_char(c):
return escrules.get(c, c)
escaped_values = ["".join(map(escape_char, cell)) for cell in cell_values]
rowfmt = DataRow("", "&", "\\\\")
return _build_simple_row(escaped_values, rowfmt)
def _rst_escape_first_column(
rows: Union[List[List[Union[str, bytes]]], Any],
headers: List[Union[str, bytes]],
) -> Tuple[
List[List[Union[str, bytes, Literal[".."]]]], List[Union[str, bytes, Literal[".."]]]
]:
def escape_empty(val: Union[str, bytes]) -> Union[str, bytes, Literal[".."]]:
if isinstance(val, (str, bytes)) and not val.strip():
return ".."
else:
return val
new_headers = list(headers)
new_rows = []
if headers:
new_headers[0] = escape_empty(headers[0])
for row in rows:
new_row = list(row)
if new_row:
new_row[0] = escape_empty(row[0])
new_rows.append(new_row)
return new_rows, new_headers
_table_formats: Dict[str, TableFormat] = {
"simple": TableFormat(
lineabove=Line("", "-", " ", ""),
linebelowheader=Line("", "-", " ", ""),
linebetweenrows=None,
linebelow=Line("", "-", " ", ""),
headerrow=DataRow("", " ", ""),
datarow=DataRow("", " ", ""),
padding=0,
with_header_hide=["lineabove", "linebelow"],
),
"plain": TableFormat(
lineabove=None,
linebelowheader=None,
linebetweenrows=None,
linebelow=None,
headerrow=DataRow("", " ", ""),
datarow=DataRow("", " ", ""),
padding=0,
with_header_hide=None,
),
"grid": TableFormat(
lineabove=Line("+", "-", "+", "+"),
linebelowheader=Line("+", "=", "+", "+"),
linebetweenrows=Line("+", "-", "+", "+"),
linebelow=Line("+", "-", "+", "+"),
headerrow=DataRow("|", "|", "|"),
datarow=DataRow("|", "|", "|"),
padding=1,
with_header_hide=None,
),
"simple_grid": TableFormat(
lineabove=Line("┌", "─", "┬", "┐"),
linebelowheader=Line("├", "─", "┼", "┤"),
linebetweenrows=Line("├", "─", "┼", "┤"),
linebelow=Line("└", "─", "┴", "┘"),
headerrow=DataRow("│", "│", "│"),
datarow=DataRow("│", "│", "│"),
padding=1,
with_header_hide=None,
),
"rounded_grid": TableFormat(
lineabove=Line("╭", "─", "┬", "╮"),
linebelowheader=Line("├", "─", "┼", "┤"),
linebetweenrows=Line("├", "─", "┼", "┤"),
linebelow=Line("╰", "─", "┴", "╯"),
headerrow=DataRow("│", "│", "│"),
datarow=DataRow("│", "│", "│"),
padding=1,
with_header_hide=None,
),
"heavy_grid": TableFormat(
lineabove=Line("┏", "━", "┳", "┓"),
linebelowheader=Line("┣", "━", "╋", "┫"),
linebetweenrows=Line("┣", "━", "╋", "┫"),
linebelow=Line("┗", "━", "┻", "┛"),
headerrow=DataRow("┃", "┃", "┃"),
datarow=DataRow("┃", "┃", "┃"),
padding=1,
with_header_hide=None,
),
"mixed_grid": TableFormat(
lineabove=Line("┍", "━", "┯", "┑"),
linebelowheader=Line("┝", "━", "┿", "┥"),
linebetweenrows=Line("├", "─", "┼", "┤"),
linebelow=Line("┕", "━", "┷", "┙"),
headerrow=DataRow("│", "│", "│"),
datarow=DataRow("│", "│", "│"),
padding=1,
with_header_hide=None,
),
"double_grid": TableFormat(
lineabove=Line("╔", "═", "╦", "╗"),
linebelowheader=Line("╠", "═", "╬", "╣"),
linebetweenrows=Line("╠", "═", "╬", "╣"),
linebelow=Line("╚", "═", "╩", "╝"),
headerrow=DataRow("║", "║", "║"),
datarow=DataRow("║", "║", "║"),
padding=1,
with_header_hide=None,
),
"fancy_grid": TableFormat(
lineabove=Line("╒", "═", "╤", "╕"),
linebelowheader=Line("╞", "═", "╪", "╡"),
linebetweenrows=Line("├", "─", "┼", "┤"),
linebelow=Line("╘", "═", "╧", "╛"),
headerrow=DataRow("│", "│", "│"),
datarow=DataRow("│", "│", "│"),
padding=1,
with_header_hide=None,
),
"outline": TableFormat(
lineabove=Line("+", "-", "+", "+"),
linebelowheader=Line("+", "=", "+", "+"),
linebetweenrows=None,
linebelow=Line("+", "-", "+", "+"),
headerrow=DataRow("|", "|", "|"),
datarow=DataRow("|", "|", "|"),
padding=1,
with_header_hide=None,
),
"simple_outline": TableFormat(
lineabove=Line("┌", "─", "┬", "┐"),
linebelowheader=Line("├", "─", "┼", "┤"),
linebetweenrows=None,
linebelow=Line("└", "─", "┴", "┘"),
headerrow=DataRow("│", "│", "│"),
datarow=DataRow("│", "│", "│"),
padding=1,
with_header_hide=None,
),
"rounded_outline": TableFormat(
lineabove=Line("╭", "─", "┬", "╮"),
linebelowheader=Line("├", "─", "┼", "┤"),
linebetweenrows=None,
linebelow=Line("╰", "─", "┴", "╯"),
headerrow=DataRow("│", "│", "│"),
datarow=DataRow("│", "│", "│"),
padding=1,
with_header_hide=None,
),
"heavy_outline": TableFormat(
lineabove=Line("┏", "━", "┳", "┓"),
linebelowheader=Line("┣", "━", "╋", "┫"),
linebetweenrows=None,
linebelow=Line("┗", "━", "┻", "┛"),
headerrow=DataRow("┃", "┃", "┃"),
datarow=DataRow("┃", "┃", "┃"),
padding=1,
with_header_hide=None,
),
"mixed_outline": TableFormat(
lineabove=Line("┍", "━", "┯", "┑"),
linebelowheader=Line("┝", "━", "┿", "┥"),
linebetweenrows=None,
linebelow=Line("┕", "━", "┷", "┙"),
headerrow=DataRow("│", "│", "│"),
datarow=DataRow("│", "│", "│"),
padding=1,
with_header_hide=None,
),
"double_outline": TableFormat(
lineabove=Line("╔", "═", "╦", "╗"),
linebelowheader=Line("╠", "═", "╬", "╣"),
linebetweenrows=None,
linebelow=Line("╚", "═", "╩", "╝"),
headerrow=DataRow("║", "║", "║"),
datarow=DataRow("║", "║", "║"),
padding=1,
with_header_hide=None,
),
"fancy_outline": TableFormat(
lineabove=Line("╒", "═", "╤", "╕"),
linebelowheader=Line("╞", "═", "╪", "╡"),
linebetweenrows=None,
linebelow=Line("╘", "═", "╧", "╛"),
headerrow=DataRow("│", "│", "│"),
datarow=DataRow("│", "│", "│"),
padding=1,
with_header_hide=None,
),
"fancy_dottedline": TableFormat(
lineabove=Line("⋅", "⋯", "⋯", "⋅"),
linebelowheader=Line("⋮", "⋯", "⋯", "⋮"),
linebetweenrows=None,
linebelow=Line("⋅", "⋯", "⋯", "⋅"),
headerrow=DataRow("⋮", "⋮", "⋮"),
datarow=DataRow("⋮", "⋮", "⋮"),
padding=1,
with_header_hide=None,
),
"github": TableFormat(
lineabove=Line("|", "-", "|", "|"),
linebelowheader=Line("|", "-", "|", "|"),
linebetweenrows=None,
linebelow=None,
headerrow=DataRow("|", "|", "|"),
datarow=DataRow("|", "|", "|"),
padding=1,
with_header_hide=["lineabove"],
),
"pipe": TableFormat(
lineabove=_pipe_line_with_colons,
linebelowheader=_pipe_line_with_colons,
linebetweenrows=None,
linebelow=None,
headerrow=DataRow("|", "|", "|"),
datarow=DataRow("|", "|", "|"),
padding=1,
with_header_hide=["lineabove"],
),
"orgtbl": TableFormat(
lineabove=None,
linebelowheader=Line("|", "-", "+", "|"),
linebetweenrows=None,
linebelow=None,
headerrow=DataRow("|", "|", "|"),
datarow=DataRow("|", "|", "|"),
padding=1,
with_header_hide=None,
),
"jira": TableFormat(
lineabove=None,
linebelowheader=None,
linebetweenrows=None,
linebelow=None,
headerrow=DataRow("||", "||", "||"),
datarow=DataRow("|", "|", "|"),
padding=1,
with_header_hide=None,
),
"presto": TableFormat(
lineabove=None,
linebelowheader=Line("", "-", "+", ""),
linebetweenrows=None,
linebelow=None,
headerrow=DataRow("", "|", ""),
datarow=DataRow("", "|", ""),
padding=1,
with_header_hide=None,
),
"pretty": TableFormat(
lineabove=Line("+", "-", "+", "+"),
linebelowheader=Line("+", "-", "+", "+"),
linebetweenrows=None,
linebelow=Line("+", "-", "+", "+"),
headerrow=DataRow("|", "|", "|"),
datarow=DataRow("|", "|", "|"),
padding=1,
with_header_hide=None,
),
"psql": TableFormat(
lineabove=Line("+", "-", "+", "+"),
linebelowheader=Line("|", "-", "+", "|"),
linebetweenrows=None,
linebelow=Line("+", "-", "+", "+"),
headerrow=DataRow("|", "|", "|"),
datarow=DataRow("|", "|", "|"),
padding=1,
with_header_hide=None,
),
"rst": TableFormat(
lineabove=Line("", "=", " ", ""),
linebelowheader=Line("", "=", " ", ""),
linebetweenrows=None,
linebelow=Line("", "=", " ", ""),
headerrow=DataRow("", " ", ""),
datarow=DataRow("", " ", ""),
padding=0,
with_header_hide=None,
),
"mediawiki": TableFormat(
lineabove=Line(
'{| class="wikitable" style="text-align: left;"',
"",
"",
"\n|+ <!-- caption -->\n|-",
),
linebelowheader=Line("|-", "", "", ""),
linebetweenrows=Line("|-", "", "", ""),
linebelow=Line("|}", "", "", ""),
headerrow=partial(_mediawiki_row_with_attrs, "!"),
datarow=partial(_mediawiki_row_with_attrs, "|"),
padding=0,
with_header_hide=None,
),
"moinmoin": TableFormat(
lineabove=None,
linebelowheader=None,
linebetweenrows=None,
linebelow=None,
headerrow=partial(_moin_row_with_attrs, "||", header="'''"),
datarow=partial(_moin_row_with_attrs, "||"),
padding=1,
with_header_hide=None,
),
"youtrack": TableFormat(
lineabove=None,
linebelowheader=None,
linebetweenrows=None,
linebelow=None,
headerrow=DataRow("|| ", " || ", " || "),
datarow=DataRow("| ", " | ", " |"),
padding=1,
with_header_hide=None,
),
"html": TableFormat(
lineabove=_html_begin_table_without_header,
linebelowheader="",
linebetweenrows=None,
linebelow=Line("</tbody>\n</table>", "", "", ""),
headerrow=partial(_html_row_with_attrs, "th", False),
datarow=partial(_html_row_with_attrs, "td", False),
padding=0,
with_header_hide=["lineabove"],
),
"unsafehtml": TableFormat(
lineabove=_html_begin_table_without_header,
linebelowheader="",
linebetweenrows=None,
linebelow=Line("</tbody>\n</table>", "", "", ""),
headerrow=partial(_html_row_with_attrs, "th", True),
datarow=partial(_html_row_with_attrs, "td", True),
padding=0,
with_header_hide=["lineabove"],
),
"latex": TableFormat(
lineabove=_latex_line_begin_tabular,
linebelowheader=Line("\\hline", "", "", ""),
linebetweenrows=None,
linebelow=Line("\\hline\n\\end{tabular}", "", "", ""),
headerrow=_latex_row,
datarow=_latex_row,
padding=1,
with_header_hide=None,
),
"latex_raw": TableFormat(
lineabove=_latex_line_begin_tabular,
linebelowheader=Line("\\hline", "", "", ""),
linebetweenrows=None,
linebelow=Line("\\hline\n\\end{tabular}", "", "", ""),
headerrow=partial(_latex_row, escrules={}),
datarow=partial(_latex_row, escrules={}),
padding=1,
with_header_hide=None,
),
"latex_booktabs": TableFormat(
lineabove=partial(_latex_line_begin_tabular, booktabs=True),
linebelowheader=Line("\\midrule", "", "", ""),
linebetweenrows=None,
linebelow=Line("\\bottomrule\n\\end{tabular}", "", "", ""),
headerrow=_latex_row,
datarow=_latex_row,
padding=1,
with_header_hide=None,
),
"latex_longtable": TableFormat(
lineabove=partial(_latex_line_begin_tabular, longtable=True),
linebelowheader=Line("\\hline\n\\endhead", "", "", ""),
linebetweenrows=None,
linebelow=Line("\\hline\n\\end{longtable}", "", "", ""),
headerrow=_latex_row,
datarow=_latex_row,
padding=1,
with_header_hide=None,
),
"tsv": TableFormat(
lineabove=None,
linebelowheader=None,
linebetweenrows=None,
linebelow=None,
headerrow=DataRow("", "\t", ""),
datarow=DataRow("", "\t", ""),
padding=0,
with_header_hide=None,
),
"textile": TableFormat(
lineabove=None,
linebelowheader=None,
linebetweenrows=None,
linebelow=None,
headerrow=DataRow("|_. ", "|_.", "|"),
datarow=_textile_row_with_attrs,
padding=1,
with_header_hide=None,
),
"asciidoc": TableFormat(
lineabove=partial(_asciidoc_row, False),
linebelowheader=None,
linebetweenrows=None,
linebelow=Line("|====", "", "", ""),
headerrow=partial(_asciidoc_row, True),
datarow=partial(_asciidoc_row, False),
padding=1,
with_header_hide=["lineabove"],
),
}
tabulate_formats: List[str] = list(sorted(_table_formats.keys()))
# The table formats for which multiline cells will be folded into subsequent
# table rows. The key is the original format specified at the API. The value is
# the format that will be used to represent the original format.
multiline_formats: Dict[str, str] = {
"plain": "plain",
"simple": "simple",
"grid": "grid",
"simple_grid": "simple_grid",
"rounded_grid": "rounded_grid",
"heavy_grid": "heavy_grid",
"mixed_grid": "mixed_grid",
"double_grid": "double_grid",
"fancy_grid": "fancy_grid",
"pipe": "pipe",
"orgtbl": "orgtbl",
"jira": "jira",
"presto": "presto",
"pretty": "pretty",
"psql": "psql",
"rst": "rst",
"outline": "outline",
"simple_outline": "simple_outline",
"rounded_outline": "rounded_outline",
"heavy_outline": "heavy_outline",
"mixed_outline": "mixed_outline",
"double_outline": "double_outline",
"fancy_outline": "fancy_outline",
}
# TODO: Add multiline support for the remaining table formats:
# - mediawiki: Replace \n with <br>
# - moinmoin: TBD
# - youtrack: TBD
# - html: Replace \n with <br>
# - latex*: Use "makecell" package: In header, replace X\nY with
# \thead{X\\Y} and in data row, replace X\nY with \makecell{X\\Y}
# - tsv: TBD
# - textile: Replace \n with <br/> (must be well-formed XML)
_multiline_codes: Pattern[str] = re.compile(r"\r|\n|\r\n")
_multiline_codes_bytes: Pattern[bytes] = re.compile(b"\r|\n|\r\n")
# Handle ANSI escape sequences for both control sequence introducer (CSI) and
# operating system command (OSC). Both of these begin with 0x1b (or octal 033),
# which will be shown below as ESC.
#
# CSI ANSI escape codes have the following format, defined in section 5.4 of ECMA-48:
#
# CSI: ESC followed by the '[' character (0x5b)
# Parameter Bytes: 0..n bytes in the range 0x30-0x3f
# Intermediate Bytes: 0..n bytes in the range 0x20-0x2f
# Final Byte: a single byte in the range 0x40-0x7e
#
# Also include the terminal hyperlink sequences as described here:
# https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
#
# OSC 8 ; params ; uri ST display_text OSC 8 ;; ST
#
# Example: \x1b]8;;https://example.com\x5ctext to show\x1b]8;;\x5c
#
# Where:
# OSC: ESC followed by the ']' character (0x5d)
# params: 0..n optional key value pairs separated by ':' (e.g. foo=bar:baz=qux:abc=123)
# URI: the actual URI with protocol scheme (e.g. https://, file://, ftp://)
# ST: ESC followed by the '\' character (0x5c)
_esc: str = r"\x1b"
_csi: str = rf"{_esc}\["
_osc: str = rf"{_esc}\]"
_st: str = rf"{_esc}\\"
_ansi_escape_pat: str = rf"""
(
# terminal colors, etc
{_csi} # CSI
[\x30-\x3f]* # parameter bytes
[\x20-\x2f]* # intermediate bytes
[\x40-\x7e] # final byte
|
# terminal hyperlinks
{_osc}8; # OSC opening
(\w+=\w+:?)* # key=value params list (submatch 2)
; # delimiter
([^{_esc}]+) # URI - anything but ESC (submatch 3)
{_st} # ST
([^{_esc}]+) # link text - anything but ESC (submatch 4)
{_osc}8;;{_st} # "closing" OSC sequence
)
"""
_ansi_codes: Pattern[str] = re.compile(_ansi_escape_pat, re.VERBOSE)
_ansi_codes_bytes: Pattern[bytes] = re.compile(
_ansi_escape_pat.encode("utf8"), re.VERBOSE
)
_ansi_color_reset_code: str = "\033[0m"
_float_with_thousands_separators: Pattern[str] = re.compile(
r"^(([+-]?[0-9]{1,3})(?:,([0-9]{3}))*)?(?(1)\.[0-9]*|\.[0-9]+)?$"
)
def simple_separated_format(separator: str):
"""Construct a simple TableFormat with columns separated by a separator.
>>> tsv = simple_separated_format("\\t") ; \
tabulate([["foo", 1], ["spam", 23]], tablefmt=tsv) == 'foo \\t 1\\nspam\\t23'
True
"""
return TableFormat(
None,
None,
None,
None,
headerrow=DataRow("", separator, ""),
datarow=DataRow("", separator, ""),
padding=0,
with_header_hide=None,
)
def _isnumber_with_thousands_separator(string):
"""
>>> _isnumber_with_thousands_separator(".")
False
>>> _isnumber_with_thousands_separator("1")
True
>>> _isnumber_with_thousands_separator("1.")
True
>>> _isnumber_with_thousands_separator(".1")
True
>>> _isnumber_with_thousands_separator("1000")
False
>>> _isnumber_with_thousands_separator("1,000")
True
>>> _isnumber_with_thousands_separator("1,0000")
False
>>> _isnumber_with_thousands_separator("1,000.1234")
True
>>> _isnumber_with_thousands_separator(b"1,000.1234")
True
>>> _isnumber_with_thousands_separator("+1,000.1234")
True
>>> _isnumber_with_thousands_separator("-1,000.1234")
True
"""
try:
string = string.decode()
except (UnicodeDecodeError, AttributeError):
pass
return bool(re.match(_float_with_thousands_separators, string))
def _isconvertible(conv: type, string: Any) -> bool:
try:
conv(string)
return True
except (ValueError, TypeError):
return False
def _isnumber(string: Any) -> bool:
"""
>>> _isnumber("123.45")
True
>>> _isnumber("123")