-
Notifications
You must be signed in to change notification settings - Fork 3
/
formatters.py
1768 lines (1530 loc) · 65.1 KB
/
formatters.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
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
#! /usr/bin/env python3
# vim: ts=4 filetype=python expandtab shiftwidth=4 softtabstop=4 syntax=python
#
# Copyright the Cluster Management Toolkit for Kubernetes contributors.
# SPDX-License-Identifier: MIT
"""
Format text as themearrays
"""
# pylint: disable=too-many-lines
import base64
import binascii
# ujson is much faster than json,
# but it might not be available
try:
import ujson as json
json_is_ujson = True # pylint: disable=invalid-name
# The exception raised by ujson when parsing fails is different
# from what json raises
DecodeException = ValueError
except ModuleNotFoundError:
import json # type: ignore
json_is_ujson = False # pylint: disable=invalid-name
DecodeException = json.decoder.JSONDecodeError # type: ignore
import re
import sys
from typing import Any, Callable, cast, Dict, List, Optional, Tuple, Union
try:
import yaml
except ModuleNotFoundError: # pragma: no cover
sys.exit("ModuleNotFoundError: Could not import yaml; "
"you may need to (re-)run `cmt-install` or `pip3 install PyYAML`; aborting.")
from cmttypes import deep_get, DictPath
import cmtlib
from cmtlib import split_msg, strip_ansicodes
from curses_helper import ThemeAttr, ThemeRef, ThemeStr, themearray_len
if json_is_ujson:
def json_dumps(obj: Dict) -> str:
"""
Dump Python object to JSON in text format; ujson version
Parameters:
obj (dict): The JSON object to dump
Returns:
(str): The serialized JSON object
"""
indent = 2
return json.dumps(obj, indent=indent, escape_forward_slashes=False)
else:
def json_dumps(obj: Dict) -> str:
"""
Dump Python object to JSON in text format; json version
Parameters:
obj (dict): The JSON object to dump
Returns:
(str): The serialized JSON object
"""
indent = 2
return json.dumps(obj, indent=indent)
def __str_representer(dumper: yaml.Dumper, data: Any) -> yaml.Node:
"""
Reformat yaml with |-style str
Parameters:
dumper: Opaque type internal to python-yaml
data: Opaque type internal to python-yaml
Returns:
(yaml.Node): Opaque type internal to python-yaml
"""
if "\n" in data:
return dumper.represent_scalar("tag:yaml.org,2002:str", data, style="|")
return dumper.represent_scalar("tag:yaml.org,2002:str", data)
# pylint: disable-next=too-many-locals,too-many-branches,too-many-statements
def format_markdown(lines: Union[str, List[str]],
**kwargs: Any) -> List[List[Union[ThemeRef, ThemeStr]]]:
"""
Markdown formatter; returns the text with syntax highlighting for a subset of Markdown
Parameters:
lines (str|[str]): A list of strings *or*
A string with newlines that should be split
**kwargs (dict[str, Any]): Keyword arguments
start ((str)): Start indicator(s)
include_start (bool): Include the start line
end ((str)): End indicator(s)
Returns:
([themearray]): A list of themearrays
"""
format_lookup = {
# codeblock, bold, italics
(False, False, False): ThemeAttr("types", "generic"),
(True, False, False): ThemeAttr("types", "markdown_code"),
(True, True, False): ThemeAttr("types", "markdown_code_bold"),
(True, False, True): ThemeAttr("types", "markdown_code_italics"),
(True, True, True): ThemeAttr("types", "markdown_code_bold_italics"),
(False, True, False): ThemeAttr("types", "markdown_bold"),
(False, False, True): ThemeAttr("types", "markdown_italics"),
(False, True, True): ThemeAttr("types", "markdown_bold_italics"),
}
dumps: List[List[Union[ThemeRef, ThemeStr]]] = []
start = deep_get(kwargs, DictPath("start"), None)
include_start = deep_get(kwargs, DictPath("include_start"), False)
strip_empty_start = deep_get(kwargs, DictPath("strip_empty_start"), False)
strip_empty_end = deep_get(kwargs, DictPath("strip_empty_end"), False)
end = deep_get(kwargs, DictPath("end"), None)
if isinstance(lines, str):
# Remove all commented-out blocks
lines = re.sub(r"<!--.*?-->", r"", lines, flags=re.DOTALL)
lines = split_msg(lines)
emptylines: List[Union[ThemeRef, ThemeStr]] = []
started = False
codeblock = ""
# pylint: disable-next=too-many-nested-blocks
for line in lines:
if started and end is not None and line.startswith(end):
break
if codeblock != "~~~":
codeblock = ""
# Skip past all non-start line until we reach the start
if not started and start is not None:
if not line.startswith(start):
continue
started = True
# This is the start line, but we don't want to include it
if not include_start:
continue
if not line:
emptylines.append(ThemeStr("", ThemeAttr("types", "generic")))
continue
if (not strip_empty_start or dumps) and emptylines:
dumps.append(emptylines)
emptylines = []
if line in ("~~~", "```"):
if codeblock == "":
codeblock = "~~~"
else:
codeblock = ""
continue
# For headers we are--for now--lazy
# Level 1 header
if line.startswith("# "):
tformat = ThemeAttr("types", "markdown_header_1")
line = line[len("# "):]
# Level 2 header
elif line.startswith("## "):
tformat = ThemeAttr("types", "markdown_header_2")
line = line[len("## "):]
# Level 3 header
elif line.startswith("### "):
tformat = ThemeAttr("types", "markdown_header_3")
line = line[len("### "):]
else:
tmpline: List[Union[ThemeRef, ThemeStr]] = []
if line.startswith(" ") and not codeblock:
tformat = ThemeAttr("types", "markdown_code")
codeblock = " "
if line.lstrip().startswith(("- ", "* ", "+ ")):
striplen = len(line) - len(line.lstrip())
if striplen:
tmpline.append(ThemeStr("".ljust(striplen), ThemeAttr("types", "generic")))
tmpline.append(ThemeRef("separators", "genericbullet"))
line = line[themearray_len(tmpline):]
tformat = ThemeAttr("types", "generic")
# Rescue backticks
line = line.replace("\\`", "<<<backtick>>>")
code_blocks = line.split("`")
for i, codesection in enumerate(code_blocks):
codesection = codesection.replace("<<<backtick>>>", "\\`")
# Toggle codeblock
if i and codeblock in ("`", ""):
if codeblock == "`":
codeblock = ""
else:
codeblock = "`"
# Assume consistent use of **/*/__/_
if "**" in codesection and codeblock == "":
bold_sections = codesection.split("**")
elif "__" in codesection and codeblock == "":
bold_sections = codesection.split("__")
else:
bold_sections = [codesection]
bold = True
for _j, section in enumerate(bold_sections):
if section.startswith("#### "):
section = section[len("#### "):]
bold = True
else:
bold = not bold
if (section.startswith("*") or " *" in section) and codeblock == "":
italics_sections = section.split("*")
elif (section.startswith("_") or " _" in section) and codeblock == "":
italics_sections = section.split("_")
else:
italics_sections = [section]
italics = True
for _k, italics_section in enumerate(italics_sections):
italics = not italics
if not italics_section:
continue
tmpline.append(ThemeStr(italics_section,
format_lookup[(codeblock != "", bold, italics)]))
dumps.append(tmpline)
continue
dumps.append([ThemeStr(line, tformat)])
continue
if not strip_empty_end and emptylines:
dumps.append(emptylines)
return dumps
# pylint: disable-next=unused-argument
def format_binary(lines: bytes, **kwargs: Any) -> List[List[Union[ThemeRef, ThemeStr]]]:
"""
Binary "formatter"; Just returns a message saying that binary views cannot be viewed
Parameters:
lines (bytes): Unused
kwargs (dict): unused
Returns:
([themearray]): A list of themearrays
"""
return [[ThemeStr("Binary file; cannot view", ThemeAttr("types", "generic"))]]
# pylint: disable=unused-argument
def format_none(lines: Union[str, List[str]],
**kwargs: Any) -> List[List[Union[ThemeRef, ThemeStr]]]:
"""
Noop formatter; returns the text without syntax highlighting
Parameters:
lines ([str]): A list of strings
*or*
lines (str): a string with newlines that should be split
kwargs (dict): unused
Returns:
([themearray]): A list of themearrays
"""
dumps: List[List[Union[ThemeRef, ThemeStr]]] = []
if isinstance(lines, str):
lines = split_msg(lines)
for line in lines:
dumps.append([ThemeStr(line, ThemeAttr("types", "generic"))])
return dumps
# pylint: disable-next=unused-argument
def format_ansible_line(line: str, **kwargs: Any) -> List[Union[ThemeRef, ThemeStr]]:
"""
Formats a single line of an Ansible play
Parameters:
line (str): a string
override_formatting (dict): Overrides instead of default formatting
Returns:
(themearray): A themearray
"""
override_formatting: Optional[Union[ThemeAttr, Dict]] = \
deep_get(kwargs, DictPath("override_formatting"))
tmpline: List[Union[ThemeRef, ThemeStr]] = []
if override_formatting is None:
formatting = ThemeAttr("types", "generic")
else:
formatting = cast(ThemeAttr, override_formatting)
tmpline += [
ThemeStr(line, formatting),
]
return tmpline
# pylint: disable-next=unused-argument
def format_diff_line(line: str, **kwargs: Any) -> List[Union[ThemeRef, ThemeStr]]:
"""
Formats a single line of a diff
Parameters:
line (str): a string
override_formatting (dict): Overrides instead of default formatting
kwargs (dict): Additional parameters
Returns:
(themearray): A themearray
"""
_override_formatting: Optional[Union[ThemeAttr, Dict]] = \
deep_get(kwargs, DictPath("override_formatting"))
indent = deep_get(kwargs, DictPath("indent"), "")
tmpline: List[Union[ThemeRef, ThemeStr]] = []
if line.startswith(f"{indent}+ "):
tmpline += [
ThemeStr(line, ThemeAttr("logview", "severity_diffplus")),
]
return tmpline
if line.startswith(f"{indent}- "):
tmpline += [
ThemeStr(line, ThemeAttr("logview", "severity_diffminus")),
]
return tmpline
tmpline += [
ThemeStr(line, ThemeAttr("logview", "severity_diffsame")),
]
return tmpline
# pylint: disable-next=too-many-locals,too-many-branches,too-many-statements
def format_yaml_line(line: str,
**kwargs: Any) -> Tuple[List[Union[ThemeRef, ThemeStr]],
List[List[Union[ThemeRef, ThemeStr]]]]:
"""
Formats a single line of YAML
Parameters:
line (str): a string
override_formatting (dict): Overrides instead of default formatting
kwargs (dict): Additional parameters
Returns:
(themearray): A themearray
([themearray]): A list of themearrays,
in case the YAML-line is expanded into multiple lines;
used when encountering keys belonging to expandd_newline_fields
"""
override_formatting: Optional[Union[ThemeAttr, Dict]] = \
deep_get(kwargs, DictPath("override_formatting"))
expand_newline_fields: Tuple[str] = deep_get(kwargs, DictPath("expand_newline_fields"), ())
value_strip_ansicodes: bool = deep_get(kwargs, DictPath("value_strip_ansicodes"), True)
value_expand_tabs: bool = deep_get(kwargs, DictPath("value_expand_tabs"), False)
remnants: List[List[Union[ThemeRef, ThemeStr]]] = []
if override_formatting is None:
override_formatting = {}
if isinstance(override_formatting, dict):
# Since we do not necessarily override all
# formatting we need to set defaults;
# doing it here instead of in the code makes
# it easier to change the defaults of necessary
generic_format = ThemeAttr("types", "generic")
comment_format = ThemeAttr("types", "yaml_comment")
key_format = ThemeAttr("types", "yaml_key")
value_format = ThemeAttr("types", "yaml_value")
list_format: Union[ThemeRef, ThemeStr] = ThemeRef("separators", "yaml_list")
separator_format = ThemeAttr("types", "yaml_separator")
reference_format = ThemeAttr("types", "yaml_reference")
anchor_format = ThemeAttr("types", "yaml_anchor")
elif isinstance(override_formatting, ThemeAttr):
# We just return the line unformatted
return [ThemeStr(line, override_formatting)], []
else:
raise TypeError(f"type(override_formatting) is {type(override_formatting)}; "
f"should be either {repr(ThemeAttr)} or {repr(dict)}")
tmpline: List[Union[ThemeRef, ThemeStr]] = []
# [whitespace]-<whitespace><value>
yaml_list_regex = re.compile(r"^(\s*)- (.*)")
# <key>:<whitespace><value>
# <key>:<whitespace>&<anchor>[<whitespace><value>]
# <key>: *<alias>
yaml_key_reference_value_regex = re.compile(r"^([^:]+)(:\s*)(&|\*|)([^\s]+)([\s]+.+|)")
if line.lstrip(" ").startswith("#"):
tmpline += [
ThemeStr(line, comment_format),
]
return tmpline, remnants
if line.lstrip(" ").startswith("- "):
tmp = yaml_list_regex.match(line)
if tmp is not None:
tmpline += [
ThemeStr(tmp[1], generic_format),
list_format,
]
line = tmp[2]
if not line:
return tmpline, remnants
# pylint: disable-next=too-many-nested-blocks
if line.endswith(":"):
_key_format = deep_get(override_formatting, DictPath(f"{line[:-1]}#key"), key_format)
tmpline += [
ThemeStr(f"{line[:-1]}", _key_format),
ThemeStr(":", separator_format),
]
else:
tmp = yaml_key_reference_value_regex.match(line)
if (tmp is not None
and (tmp[1].strip().startswith("\"") and tmp[1].strip().endswith("\"")
or (not tmp[1].strip().startswith("\"")
and not tmp[1].strip().endswith("\"")))):
key = tmp[1]
separator = tmp[2]
reference = tmp[3]
anchor = ""
value_or_anchor = tmp[4]
value = tmp[5]
if reference:
if value:
anchor = value_or_anchor
else:
anchor = value_or_anchor
value = ""
value_or_anchor = ""
else:
value = f"{value_or_anchor}{value}"
value_or_anchor = ""
_key_format = deep_get(override_formatting, DictPath(f"{key.strip()}#key"), key_format)
if value.strip() in ("{", "["):
_value_format = value_format
else:
_value_format = deep_get(override_formatting,
DictPath(f"{key.strip()}#value"), value_format)
if value_strip_ansicodes:
value = strip_ansicodes(value)
key_stripped = key.strip(" \"")
if key_stripped in expand_newline_fields:
split_value = split_msg(value.replace("\\n", "\n"))
value_line_indent = 0
for i, value_line in enumerate(split_value):
if value_expand_tabs:
tmp_split_value_line = value_line.replace("\\t", "\t").split("\t")
tmp_value_line = ""
for j, split_value_line_segment in enumerate(tmp_split_value_line):
tabsize = 0
if j < len(tmp_split_value_line):
tabsize = 8 - len(tmp_value_line) % 8
tmp_value_line += split_value_line_segment + "".ljust(tabsize)
value_line = tmp_value_line
if i == 0:
tmpline = [
ThemeStr(f"{key}", _key_format),
ThemeStr(f"{separator}", separator_format),
]
if reference:
tmpline.append(ThemeStr(f"{reference}", reference_format))
if anchor:
tmpline.append(ThemeStr(f"{anchor}", anchor_format))
tmpline.append(ThemeStr(f"{value_line}", _value_format))
value_line_indent = len(value_line) - len(value_line.lstrip(" \""))
else:
remnants.append([
ThemeStr("".ljust(value_line_indent
+ len(key + separator + reference)), _key_format),
ThemeStr(f"{value_line}", _value_format),
])
else:
if value_expand_tabs:
tmp_split_value = value.replace("\\t", "\t").split("\t")
tmp_value = ""
first = True
for j, split_value_segment in enumerate(tmp_split_value):
tabsize = 0
if j < len(tmp_split_value):
tabsize = 8 - len(tmp_value) % 8
if not first:
tmp_value += "".ljust(tabsize)
else:
first = False
tmp_value += split_value_segment
value = tmp_value
tmpline += [
ThemeStr(f"{key}", _key_format),
ThemeStr(f"{separator}", separator_format),
]
if reference:
tmpline.append(ThemeStr(f"{reference}", reference_format))
if anchor:
tmpline.append(ThemeStr(f"{anchor}", anchor_format))
if value:
tmpline.append(ThemeStr(f"{value}", _value_format))
else:
_value_format = deep_get(override_formatting, DictPath(f"{line}#value"), value_format)
tmpline += [
ThemeStr(f"{line}", _value_format),
]
return tmpline, remnants
# pylint: disable-next=too-many-branches
def format_yaml(lines: Union[str, List[str]],
**kwargs: Any) -> List[List[Union[ThemeRef, ThemeStr]]]:
"""
YAML formatter; returns the text with syntax highlighting for YAML
Parameters:
lines (str|[str]): A list of strings *or*
a string with newlines that should be split
**kwargs (Any): Additional parameters
Returns:
([themearray]): A list of themearrays
"""
dumps: List[List[Union[ThemeRef, ThemeStr]]] = []
indent = deep_get(cmtlib.cmtconfig, DictPath("Global#indent"), 2)
is_json = deep_get(kwargs, DictPath("json"), False)
if isinstance(lines, str):
if is_json:
try:
d = json.loads(lines)
lines = [json_dumps(d)]
except DecodeException:
return format_none(lines)
else:
lines = [lines]
generic_format = ThemeAttr("types", "generic")
override_formatting: Union[ThemeAttr, Dict] = deep_get(kwargs,
DictPath("override_formatting"), {})
if deep_get(kwargs, DictPath("raw"), False):
override_formatting = generic_format
yaml.add_representer(str, __str_representer)
for i, obj in enumerate(lines):
if isinstance(obj, dict):
if is_json:
split_dump = json.dumps(obj, indent=indent).splitlines()
else:
split_dump = yaml.dump(obj, default_flow_style=False,
indent=indent, width=sys.maxsize).splitlines()
else:
split_dump = obj.splitlines()
first = True
if (split_dump and "\n" not in obj
and split_dump[0].startswith("'") and split_dump[0].endswith("'")):
split_dump[0] = split_dump[0][1:-1]
for line in split_dump:
truncated = False
if len(line) >= 16384 - len(" [...] (Truncated)") - 1:
line = line[0:16384 - len(" [...] (Truncated)") - 1]
truncated = True
# This allows us to use the yaml formatter for json too
if first:
first = False
if line in ("|", "|-"):
continue
if not line:
continue
kwargs["override_formatting"] = override_formatting
tmpline: List[Union[ThemeRef, ThemeStr]] = []
remnants: List[List[Union[ThemeRef, ThemeStr]]] = []
tmpline, remnants = format_yaml_line(line, **kwargs)
if truncated:
tmpline += [ThemeStr(" [...] (Truncated)",
ThemeAttr("types", "yaml_key_error"))]
dumps.append(tmpline)
if remnants:
dumps += remnants
if i < len(lines) - 1:
dumps.append([ThemeStr("", generic_format)])
dumps.append([ThemeStr("", generic_format)])
dumps.append([ThemeStr("", generic_format)])
return dumps
def reformat_json(lines: Union[str, List[str]],
**kwargs: Any) -> List[List[Union[ThemeRef, ThemeStr]]]:
"""
Given a string representation of JSON, reformat it
Parameters:
lines (str|[str]): A list of strings *or*
a string with newlines that should be split
**kwargs (Any): Additional parameters
Returns:
([themearray]): A list of themearrays
"""
kwargs["json"] = True
return format_yaml(lines, **kwargs)
KEY_HEADERS: Tuple[str, ...] = (
"-----BEGIN CERTIFICATE-----",
"-----END CERTIFICATE-----",
"-----BEGIN CERTIFICATE REQUEST-----",
"-----END CERTIFICATE REQUEST-----",
"-----BEGIN PKCS7-----",
"-----END PKCS7-----",
"-----BEGIN OPENSSH PRIVATE KEY-----",
"-----END OPENSSH PRIVATE KEY-----",
"-----BEGIN SSH2 PUBLIC KEY-----",
"-----END SSH2 PUBLIC KEY-----",
"-----BEGIN PUBLIC KEY-----",
"-----END PUBLIC KEY-----",
"-----BEGIN PRIVATE KEY-----",
"-----END PRIVATE KEY-----",
"-----BEGIN DSA PRIVATE KEY-----",
"-----END DSA PRIVATE KEY-----",
"-----BEGIN RSA PRIVATE KEY-----",
"-----END RSA PRIVATE KEY-----",
"-----BEGIN EC PRIVATE KEY-----",
"-----END EC PRIVATE KEY-----",
)
def format_crt(lines: Union[str, List[str]],
**kwargs: Any) -> List[List[Union[ThemeRef, ThemeStr]]]:
"""
CRT formatter; returns the text with syntax highlighting for certificates
Parameters:
lines (list[str]): A list of strings
*or*
lines (str): A string with newlines that should be split
kwargs (dict): Unused
Returns:
list[themearray]: A list of themearrays
"""
dumps: List[List[Union[ThemeRef, ThemeStr]]] = []
if deep_get(kwargs, DictPath("raw"), False):
return format_none(lines)
if isinstance(lines, str):
lines = split_msg(lines)
for line in lines:
if line in KEY_HEADERS:
dumps.append([ThemeStr(line, ThemeAttr("types", "separator"))])
else:
dumps.append([ThemeStr(line, ThemeAttr("types", "generic"))])
return dumps
def format_haproxy(lines: Union[str, List[str]],
**kwargs: Any) -> List[List[Union[ThemeRef, ThemeStr]]]:
"""
HAProxy formatter; returns the text with syntax highlighting for HAProxy
Parameters:
lines (list[str]): A list of strings
*or*
lines (str): A string with newlines that should be split
kwargs (dict): Unused
Returns:
list[themearray]: A list of themearrays
"""
dumps: List[List[Union[ThemeRef, ThemeStr]]] = []
if isinstance(lines, str):
lines = split_msg(lines)
if deep_get(kwargs, DictPath("raw"), False):
return format_none(lines)
haproxy_section_regex = re.compile(r"^(\s*)(global|defaults|frontend|"
r"backend|listen|resolvers|mailers|peers)(\s*)(.*)")
haproxy_setting_regex = re.compile(r"^(\s*)(\S+)(\s+)(.+)")
for line in lines:
# Is it whitespace?
if not line.strip():
dumps.append([ThemeStr(line, ThemeAttr("types", "generic"))])
continue
# Is it a new section?
tmp = haproxy_section_regex.match(line)
if tmp is not None:
whitespace1 = tmp[1]
section = tmp[2]
whitespace2 = tmp[3]
label = tmp[4]
tmpline: List[Union[ThemeRef, ThemeStr]] = [
ThemeStr(whitespace1, ThemeAttr("types", "generic")),
ThemeStr(section, ThemeAttr("types", "haproxy_section")),
ThemeStr(whitespace2, ThemeAttr("types", "generic")),
ThemeStr(label, ThemeAttr("types", "haproxy_label")),
]
dumps.append(tmpline)
continue
# Is it settings?
tmp = haproxy_setting_regex.match(line)
if tmp is not None:
whitespace1 = tmp[1]
setting = tmp[2]
whitespace2 = tmp[3]
values = tmp[4]
tmpline = [
ThemeStr(whitespace1, ThemeAttr("types", "generic")),
ThemeStr(setting, ThemeAttr("types", "haproxy_setting")),
ThemeStr(whitespace2, ThemeAttr("types", "generic")),
ThemeStr(values, ThemeAttr("types", "generic")),
]
dumps.append(tmpline)
continue
# Unknown data; just append it unformatted
dumps.append([ThemeStr(line, ThemeAttr("types", "generic"))])
return dumps
# pylint: disable-next=too-many-locals,too-many-branches,too-many-statements
def format_caddyfile(lines: Union[str, List[str]],
**kwargs: Any) -> List[List[Union[ThemeRef, ThemeStr]]]:
"""
CaddyFile formatter; returns the text with syntax highlighting for CaddyFiles
Parameters:
lines (list[str]): A list of strings
*or*
lines (str): A string with newlines that should be split
kwargs (dict): Unused
Returns:
list[themearray]: A list of themearrays
"""
dumps: List[List[Union[ThemeRef, ThemeStr]]] = []
if deep_get(kwargs, DictPath("raw"), False):
return format_none(lines)
if isinstance(lines, str):
lines = split_msg(lines)
single_site = True
site = False
block_open_regex = re.compile(r"^(\s*)({)(.*)")
snippet_regex = re.compile(r"^(\s*)(\(.+?\))(.*)")
site_regex = re.compile(r"^(\s*)(\S+?)(\s+{\s*$|$)")
block_close_regex = re.compile(r"^(\s*)(}\s*$)")
matcher_regex = re.compile(r"^(\s*)(@.*?|\*/.*?)(\s.*)")
directive_regex = re.compile(r"^(\s*)(.+?)(\s.*|$)")
argument_regex = re.compile(r"^(.*?)(\s{\s*$|$)")
for line in lines:
tmpline: List[Union[ThemeRef, ThemeStr]] = []
# Empty line
if not line and not tmpline:
tmpline = [
ThemeStr("", ThemeAttr("types", "generic")),
]
directive = False
block_depth = 0
while line:
# Is this a comment?
if "#" in line:
tmpline += [
ThemeStr(line, ThemeAttr("types", "caddyfile_comment")),
]
line = ""
continue
# Are we opening a block?
tmp = block_open_regex.match(line)
if tmp is not None:
block_depth += 1
if tmp[1]:
tmpline += [
ThemeStr(tmp[1], ThemeAttr("types", "caddyfile_block")),
]
tmpline += [
ThemeStr(tmp[2], ThemeAttr("types", "caddyfile_block")),
]
line = tmp[3]
if site:
single_site = False
continue
# Is this a snippet?
tmp = snippet_regex.match(line)
if tmp is not None:
if tmp[1]:
tmpline += [
ThemeStr(tmp[1], ThemeAttr("types", "caddyfile_snippet")),
]
tmpline += [
ThemeStr(tmp[2], ThemeAttr("types", "caddyfile_snippet")),
]
line = tmp[3]
continue
# Is this a site?
tmp = site_regex.match(line)
if tmp is not None:
if not block_depth and not site and (single_site or "{" in tmp[3]):
if tmp[1]:
tmpline += [
ThemeStr(tmp[1], ThemeAttr("types", "caddyfile_site")),
]
tmpline += [
ThemeStr(tmp[2], ThemeAttr("types", "caddyfile_site")),
]
line = tmp[3]
site = True
single_site = False
continue
# Are we closing a block?
tmp = block_close_regex.match(line)
if tmp is not None:
block_depth -= 1
if tmp[1]:
tmpline += [
ThemeStr(tmp[1], ThemeAttr("types", "caddyfile_block")),
]
tmpline += [
ThemeStr(tmp[2], ThemeAttr("types", "caddyfile_block")),
]
line = ""
continue
# Is this a matcher?
tmp = matcher_regex.match(line)
if tmp is not None:
if tmp[1]:
tmpline += [
ThemeStr(tmp[1], ThemeAttr("types", "caddyfile_matcher")),
]
tmpline += [
ThemeStr(tmp[2], ThemeAttr("types", "caddyfile_matcher")),
]
line = tmp[3]
continue
# Is this a directive?
if not directive:
tmp = directive_regex.match(line)
if tmp is not None:
if tmp[1]:
tmpline += [
ThemeStr(tmp[1], ThemeAttr("types", "caddyfile_directive")),
]
tmpline += [
ThemeStr(tmp[2], ThemeAttr("types", "caddyfile_directive")),
]
line = tmp[3]
directive = True
continue
else:
# OK, we have a directive already, and this is not a matcher or a block,
# which means that it is an argument
tmp = argument_regex.match(line)
if tmp is not None:
tmpline += [
ThemeStr(tmp[1], ThemeAttr("types", "caddyfile_argument")),
]
line = tmp[2]
continue
dumps.append(tmpline)
return dumps
def format_mosquitto(lines: Union[str, List[str]],
**kwargs: Any) -> List[List[Union[ThemeRef, ThemeStr]]]:
"""
Mosquitto formatter; returns the text with syntax highlighting for Mosquitto
Parameters:
lines (list[str]): A list of strings
*or*
lines (str): A string with newlines that should be split
kwargs (dict): Unused
Returns:
list[themearray]: A list of themearrays
"""
dumps: List[List[Union[ThemeRef, ThemeStr]]] = []
if isinstance(lines, str):
lines = split_msg(lines)
if deep_get(kwargs, DictPath("raw"), False):
return format_none(lines)
mosquitto_variable_regex = re.compile(r"^(\S+)(\s)(.+)")
for line in lines:
# Is it whitespace?
if not line.strip():
dumps.append([ThemeStr(line, ThemeAttr("types", "generic"))])
continue
# Is it a comment?
if line.startswith("#"):
dumps.append([ThemeStr(line, ThemeAttr("types", "mosquitto_comment"))])
continue
# Is it a variable + value?
tmp = mosquitto_variable_regex.match(line)
if tmp is not None:
variable = tmp[1]
whitespace = tmp[2]
value = tmp[3]
tmpline: List[Union[ThemeRef, ThemeStr]] = [
ThemeStr(variable, ThemeAttr("types", "mosquitto_variable")),
ThemeStr(whitespace, ThemeAttr("types", "generic")),
ThemeStr(value, ThemeAttr("types", "generic")),
]
dumps.append(tmpline)
continue
# Unknown data; just append it unformatted
dumps.append([ThemeStr(line, ThemeAttr("types", "generic"))])
return dumps
# pylint: disable-next=too-many-branches
def format_nginx(lines: Union[str, List[str]],
**kwargs: Any) -> List[List[Union[ThemeRef, ThemeStr]]]:
"""
NGINX formatter; returns the text with syntax highlighting for NGINX
Parameters:
lines (list[str]): A list of strings
*or*
lines (str): A string with newlines that should be split
kwargs (dict): Unused
Returns:
list[themearray]: A list of themearrays
"""
dumps: List[List[Union[ThemeRef, ThemeStr]]] = []
if deep_get(kwargs, DictPath("raw"), False):
return format_none(lines)
if isinstance(lines, str):
lines = split_msg(lines)
key_regex = re.compile(r"^(\s*)(#.*$|}|\S+|$)(.+;|.+{|)(\s*#.*$|)")
for line in lines:
dump: List[Union[ThemeRef, ThemeStr]] = []
if not line.strip():
if not dump:
dump += [
ThemeStr("", ThemeAttr("types", "generic"))
]
dumps.append(dump)
continue
# key {
# key value[ value...];
# key value[ value...] {
tmp = key_regex.match(line)
if tmp is not None:
if tmp[1]:
dump += [
ThemeStr(tmp[1], ThemeAttr("types", "generic")), # whitespace
]
if tmp[2]:
if tmp[2] == "}":
dump += [
ThemeStr(tmp[2], ThemeAttr("types", "generic")), # block end
]
elif tmp[2].startswith("#"):
dump += [
ThemeStr(tmp[2], ThemeAttr("types", "nginx_comment"))