File: test_markup.py

package info (click to toggle)
ansimarkup 2.1.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 156 kB
  • sloc: python: 546; makefile: 4
file content (291 lines) | stat: -rw-r--r-- 10,784 bytes parent folder | download | duplicates (2)
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
# flake8: noqa

import io

from pytest import raises, mark
from colorama import Style as S, Fore as F, Back as B

from ansimarkup import AnsiMarkup, MismatchedTag, UnbalancedTag
from ansimarkup import parse as p, strip as s


def test_flat():
    assert p("<b>1</b>") == p("<bold>1</bold>") == S.BRIGHT + "1" + S.RESET_ALL
    assert p("<d>1</d>") == p("<dim>1</dim>") == S.DIM + "1" + S.RESET_ALL

    assert p("<b>1</b><d>2</d>") == S.BRIGHT + "1" + S.RESET_ALL + S.DIM + "2" + S.RESET_ALL
    assert p("<b>1</b>2<d>3</d>") == S.BRIGHT + "1" + S.RESET_ALL + "2" + S.DIM + "3" + S.RESET_ALL


def test_flat_colors():
    assert p("<r>1</r>") == p("<red>1</red>") == p("<fg red>1</fg red>") == F.RED + "1" + S.RESET_ALL
    assert p("<R>1</R>") == p("<RED>1</RED>") == p("<bg red>1</bg red>") == B.RED + "1" + S.RESET_ALL

    assert p("<r,y>1</r,y>") == p("<red,yellow>1</red,yellow>") == F.RED + B.YELLOW + "1" + S.RESET_ALL
    assert (
        p("<b,r,y>1</b,r,y>")
        == p("<bold,red,yellow>1</bold,red,yellow>")
        == S.BRIGHT + F.RED + B.YELLOW + "1" + S.RESET_ALL
    )
    assert p("<b,r,>1</b,r,>") == p("<bold,red,>1</bold,red,>") == S.BRIGHT + F.RED + "1" + S.RESET_ALL

    assert p("<fg RED>1</fg RED>") == "<fg RED>1</fg RED>"
    assert p("<fg light-blue2>1</fg light-blue2>") == "<fg light-blue2>1</fg light-blue2>"

    assert p("<bg ,red>1</bg ,red>") == "<bg ,red>1</bg ,red>"
    assert p("<bg red,>1</bg red,>") == "<bg red,>1</bg red,>"
    assert p("<bg a,z>1</bg a,z>") == "<bg a,z>1</bg a,z>"
    assert p("<bg blue,yelllow>1</bg blue,yelllow>") == "<bg blue,yelllow>1</bg blue,yelllow>"
    assert p("<bg r, y>1</bg r, y>") == "<bg r, y>1</bg r, y>"

    assert p("<>1</>") == "<>1</>"
    assert p("</>1</>") == "</>1</>"
    assert p("<,>1</,>") == "<,>1</,>"
    assert p("<,,>1</,,>") == "<,,>1</,,>"
    assert p("<z,z>1</z,z>") == "<z,z>1</z,z>"
    assert p("<z,z,z>1</z,z,z>") == "<z,z,z>1</z,z,z>"

    assert p("<red,RED>1</red,RED>") == "<red,RED>1</red,RED>"
    assert p("<bold,red>1</bold,red>") == "<bold,red>1</bold,red>"
    assert p("<b,red,RED>1</b,red,RED>") == "<b,red,RED>1</b,red,RED>"
    assert p("<b,red,bold>1</b,red,bold>") == "<b,red,bold>1</b,red,bold>"
    assert p("<b,,>1</b,,>") == "<b,,>1</b,,>"
    assert p("<b,a,>1</b,a,>") == "<b,a,>1</b,a,>"
    assert p("<b,,z>1</b,,z>") == "<b,,z>1</b,,z>"


def test_xterm_color():
    assert p("<fg 200>1</fg 200>") == "\x1b[38;5;200m" "1" "\x1b[0m"
    assert p("<bg 100><fg 200>1") == "\x1b[48;5;100m" "\x1b[38;5;200m" "1"

    assert p("<fg 256>1") == "<fg 256>1"
    assert p("<bg 256>1</bg 256>") == "<bg 256>1</bg 256>"
    assert p("<bg 12 >1</bg 12 >") == "<bg 12 >1</bg 12 >"
    assert p("<bg 2222>1</bg 2222>") == "<bg 2222>1</bg 2222>"


def test_xterm_hex():
    assert p("<fg #ff0000>1") == p("<fg #FF0000>1") == "\x1b[38;2;255;0;0m" "1"
    assert p("<bg #00A000><fg #ff0000>1") == "\x1b[48;2;0;160;0m" "\x1b[38;2;255;0;0m" "1"
    assert p("<fg #F12>1</fg #F12>") == p("<fg #F12F12>1</fg #F12F12>") == "\x1b[38;2;241;47;18m" + "1" + S.RESET_ALL

    assert p("<fg #>1</fg #>") == "<fg #>1</fg #>"
    assert p("<bg #12>1</bg #12>") == "<bg #12>1</bg #12>"
    assert p("<fg #1234567>1</fg #1234567>") == "<fg #1234567>1</fg #1234567>"
    assert p("<bg #E7G>1</bg #E7G>") == "<bg #E7G>1</bg #E7G>"
    assert p("<fg #F2D1GZ>1</fg #F2D1GZ>") == "<fg #F2D1GZ>1</fg #F2D1GZ>"


def test_xterm_rgb():
    assert p("<fg 255,0,0>1") == p("<fg #ff0000>1") == "\x1b[38;2;255;0;0m" "1"
    assert p("<bg 0,160,0><fg 255,0,0>1") == p("<bg #00A000><fg #ff0000>1") == "\x1b[48;2;0;160;0m" "\x1b[38;2;255;0;0m" "1"  # fmt: skip

    assert p("<fg>1</fg>") == "<fg>1</fg>"
    assert p("<fg >1</fg >") == "<fg >1</fg >"
    assert p("<fg ,>1</fg ,>") == "<fg ,>1</fg ,>"
    assert p("<fg ,,>1</fg ,,>") == "<fg ,,>1</fg ,,>"
    assert p("<fg ,,,>1</fg ,,,>") == "<fg ,,,>1</fg ,,,>"
    assert p("<fg 1,2,>1</fg 1,2,>") == "<fg 1,2,>1</fg 1,2,>"
    assert p("<fg 256,120,120>1</fg 256,120,120>") == "<fg 256,120,120>1</fg 256,120,120>"


def test_nested():
    assert (
        p("0<b>1<d>2</d>3</b>4")
        ==
        "0" + S.BRIGHT + "1" + S.DIM + "2" + S.RESET_ALL + S.BRIGHT + "3" + S.RESET_ALL + "4"
    )  # fmt: skip
    assert (
        p("<d>0<b>1<d>2</d>3</b>4</d>")
        ==
        S.DIM + "0" + S.BRIGHT + "1" + S.DIM + "2" + S.RESET_ALL + S.DIM + S.BRIGHT + "3" + S.RESET_ALL + S.DIM + "4" + S.RESET_ALL
    )  # fmt: skip


def test_mismatched_error():
    with raises(MismatchedTag):
        p("<b>1</d>")

    with raises(MismatchedTag):
        p("</b>")

    with raises(MismatchedTag):
        p("<b>1</b></b>")

    with raises(MismatchedTag):
        p("<red><b>1</b></b></red>")

    with raises(MismatchedTag):
        p("<tag>1</b>")


def test_unbalanced_error():
    with raises(UnbalancedTag):
        p("<r><Y>1</r>2</Y>")

    with raises(UnbalancedTag):
        p("<r><r><Y>1</r>2</Y></r>")

    with raises(UnbalancedTag):
        p("<r><Y><r></r></r></Y>")


def test_strict_parsing():
    am = AnsiMarkup(strict=True)

    with raises(MismatchedTag):
        am.parse("<b>")

    with raises(MismatchedTag):
        am.parse("<Y><b></b>")

    with raises(MismatchedTag):
        am.parse("<b><b></b>")


def test_unknown_tags():
    assert p("<tag>1</tag>") == "<tag>1</tag>"
    assert p("<tag>") == "<tag>"
    assert p("</tag>") == "</tag>"

    assert p("<b>1</b><tag>2</tag>") == S.BRIGHT + "1" + S.RESET_ALL + "<tag>2</tag>"
    assert p("<tag>1</tag><b>2</b>") == "<tag>1</tag>" + S.BRIGHT + "2" + S.RESET_ALL

    assert (
        p("<b>1</b><tag>2</tag><b>3</b>")
        == S.BRIGHT + "1" + S.RESET_ALL + "<tag>2</tag>" + S.BRIGHT + "3" + S.RESET_ALL
    )
    assert p("<tag>1</tag><b>2</b><tag>3</tag>") == "<tag>1</tag>" + S.BRIGHT + "2" + S.RESET_ALL + "<tag>3</tag>"

    assert p("<b><tag>1</tag></b>") == S.BRIGHT + "<tag>1</tag>" + S.RESET_ALL
    assert p("<tag><b>1</b></tag>") == "<tag>" + S.BRIGHT + "1" + S.RESET_ALL + "</tag>"

    assert p("<b><tag>1</tag>") == S.BRIGHT + "<tag>1</tag>"
    assert p("<tag>1</tag><b>") == "<tag>1</tag>" + S.BRIGHT

    assert p("<b><tag>") == S.BRIGHT + "<tag>"
    assert p("<tag><b>") == "<tag>" + S.BRIGHT

    assert p("<b></tag>") == S.BRIGHT + "</tag>"
    assert p("</tag><b>") == "</tag>" + S.BRIGHT


def test_strip(am):
    assert s("<b>1</b>2<d>3</d>") == "123"
    assert s("<bold,red,yellow>1</bold,red,yellow>") == "1"
    assert s("<r><tag>1</tag></r>") == "<tag>1</tag>"
    assert s("<tag><r>1</r></tag>") == "<tag>1</tag>"
    assert s("<tag><r>1</tag></r>") == "<tag>1</tag>"
    assert s("<r><b>1</r></b>") == "1"
    assert s("<fg red>1<fg red>") == "1"

    am = AnsiMarkup(tags={"red": "<red>", "b,g,r": "<b,g,r>", "fg 1,2,3": "</fg 1,2,3>"})
    assert am.strip("<red>1</red><b,g,r>2</b,g,r><fg 1,2,3>3</fg 1,2,3>") == "123"


def test_options():
    am = AnsiMarkup(always_reset=True)
    assert am.parse("<b>1") == S.BRIGHT + "1" + S.RESET_ALL

    am = AnsiMarkup(always_reset=False)
    assert am.parse("<b>1") == S.BRIGHT + "1"


def test_usertags():
    user_tags = {"info": F.GREEN + S.BRIGHT, "info1": p("<g><b>"), "call": lambda: F.BLUE + B.RED}
    am = AnsiMarkup(tags=user_tags)

    assert am.parse("<info>1</info>") == F.GREEN + S.BRIGHT + "1" + S.RESET_ALL
    assert am.parse("<info>1</info>") == am.parse("<info1>1</info1>")
    assert am.parse("<call>1</call>") == F.BLUE + B.RED + "1" + S.RESET_ALL
    assert am.strip("<info1>1</info1>") == "1"


def test_tag_chars():
    with raises(ValueError):
        am = AnsiMarkup(tag_sep="{")

    with raises(ValueError):
        am = AnsiMarkup(tag_sep="(-)")

    with raises(ValueError):
        am = AnsiMarkup(tag_sep="qq")

    am = AnsiMarkup(tag_sep="{}")

    r1 = p("0<b>1<d>2</d>3</b>4")
    r2 = am.parse("0{b}1{d}2{/d}3{/b}4")
    assert r1 == r2 == "0" + S.BRIGHT + "1" + S.DIM + "2" + S.RESET_ALL + S.BRIGHT + "3" + S.RESET_ALL + "4"

    assert s("<b>1</b>") == am.strip("{b}1{/b}") == "1"


def test_tag_chars_conflicting():
    assert p("<r>2 > 1</r>") == F.RED + "2 > 1" + S.RESET_ALL
    assert p("<r>1 < 2</r>") == F.RED + "1 < 2" + S.RESET_ALL
    assert p("<r>1 </ 2</r>") == F.RED + "1 </ 2" + S.RESET_ALL
    assert s("<r>2 > 1</r>") == "2 > 1"
    assert s("<r>1 < 2</r>") == "1 < 2"
    assert s("<r>1 </ 2</r>") == "1 </ 2"

    assert p("{: <10}<r>1</r>") == "{: <10}" + F.RED + "1" + S.RESET_ALL
    assert p("{: </10}<r>1</r>") == "{: </10}" + F.RED + "1" + S.RESET_ALL
    assert s("{: <10}<r>1</r>") == "{: <10}1"
    assert s("{: </10}<r>1</r>") == "{: </10}1"

    assert p("<r>1</r>{: >10}") == F.RED + "1" + S.RESET_ALL + "{: >10}"
    assert s("<r>1</r>{: >10}") == "1{: >10}"

    assert p("<1<r>2</r>3>") == "<1" + F.RED + "2" + S.RESET_ALL + "3>"
    assert p("</1<r>2</r>3>") == "</1" + F.RED + "2" + S.RESET_ALL + "3>"
    assert p("<1<r>2 < 3</r>4>") == "<1" + F.RED + "2 < 3" + S.RESET_ALL + "4>"
    assert p("<1<r>2 </ 3</r>4>") == "<1" + F.RED + "2 </ 3" + S.RESET_ALL + "4>"
    assert p("<1<r>3 > 2</r>4>") == "<1" + F.RED + "3 > 2" + S.RESET_ALL + "4>"
    assert s("<1<r>2</r>3>") == "<123>"
    assert s("</1<r>2</r>3>") == "</123>"
    assert s("<1<r>2 < 3</r>4>") == "<12 < 34>"
    assert s("<1<r>2 </ 3</r>4>") == "<12 </ 34>"
    assert s("<1<r>3 > 2</r>4>") == "<13 > 24>"


def test_string_method(am):
    assert len(am.ansistring("A <b>bold</b> tag.")) == len("A bold tag.")
    assert len(am.ansistring("<fg 256,120,120>1</fg 256,120,120>")) == len("<fg 256,120,120>1</fg 256,120,120>")
    assert (
        len(am.ansistring("<b,r,y>1</b,r,y>"))
        == len(am.ansistring("<bold,red,yellow>1</bold,red,yellow>"))
        == len("1")
    )  # fmt: skip


def test_string_method_delta(am):
    markup = am.ansistring("<b>abc</b>")
    assert markup.delta == 8

    a = "| {:{width}} |".format("abc", width=28)
    b = "| {:{width}} |".format(markup, width=(28 + markup.delta))
    assert len(a) == (len(b) - markup.delta)


def test_raw(am):
    a = am.parse("<b><r>", am.raw("</b</r>RAW"), "</r></b>")
    b = S.BRIGHT + F.RED + "</b</r>RAW" + S.RESET_ALL + S.BRIGHT + S.RESET_ALL
    assert a == b

    with raises(MismatchedTag):
        am.parse('<l type="V">2.0</l>')
    am.parse(am.raw('<l type="V">2.0</l>')) == '<l type="V">2.0</l>'


def test_ansiprint(am):
    f = io.StringIO()
    am.ansiprint("<b>BOLD</b>", file=f, end="")
    assert f.getvalue() == am.parse("<b>BOLD</b>") == S.BRIGHT + "BOLD" + S.RESET_ALL

    f = io.StringIO()
    am.ansiprint("<b>BOLD", "<r>BOLDRED", file=f, end="")
    assert f.getvalue() == am.parse("<b>BOLD", " ", "<r>BOLDRED")

    f = io.StringIO()
    am.ansiprint("<b><r>", am.raw("</b</r>RAW"), "</r></b>", file=f, end="")
    assert " </b</r>RAW " in f.getvalue()