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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
|
"""ITerm2Image-specific tests"""
import io
from base64 import standard_b64decode
from contextlib import contextmanager
import pytest
from PIL import Image
from PIL.GifImagePlugin import GifImageFile
from PIL.PngImagePlugin import PngImageFile
from PIL.WebPImagePlugin import WebPImageFile
from term_image import ctlseqs
from term_image.exceptions import RenderError, StyleError, TermImageWarning
from term_image.image import iterm2
from term_image.image.iterm2 import ANIM, LINES, WHOLE, ITerm2Image
from .. import set_fg_bg_colors
from . import common
from .common import _size, get_actual_render_size, python_img, setup_common
ITerm2Image.read_from_file = False
def test_setup_common():
setup_common(ITerm2Image)
for name, obj in vars(common).items():
if name.endswith(("_All", "_Graphics")):
globals()[name] = obj
class TestProperties:
class TestJpegQuality:
def test_type_value(self):
try:
for value in (None, "100", 100.0, ()):
with pytest.raises(TypeError):
ITerm2Image.jpeg_quality = value
for value in (96, 100, 1000):
with pytest.raises(ValueError):
ITerm2Image.jpeg_quality = value
# Value range
ITerm2Image.jpeg_quality = -100
ITerm2Image.jpeg_quality = -2
ITerm2Image.jpeg_quality = -1
ITerm2Image.jpeg_quality = 0
ITerm2Image.jpeg_quality = 1
finally:
del ITerm2Image.jpeg_quality
def test_descendant(self):
A = ITerm2Image
class B(A):
pass
class C(B):
pass
assert A.jpeg_quality == -1
assert B.jpeg_quality == -1
assert C.jpeg_quality == -1
try:
A.jpeg_quality = 90
# descendant
assert A.jpeg_quality == 90
assert B.jpeg_quality == 90
assert C.jpeg_quality == 90
C.jpeg_quality = 70
# descent is broken by sub-subclass
assert A.jpeg_quality == 90
assert B.jpeg_quality == 90
assert C.jpeg_quality == 70
B.jpeg_quality = 80
# descent is broken by subclass
assert A.jpeg_quality == 90
assert B.jpeg_quality == 80
assert C.jpeg_quality == 70
B.jpeg_quality = 60
# changing for a class doesn't affect a subclass with the property set
assert A.jpeg_quality == 90
assert B.jpeg_quality == 60
assert C.jpeg_quality == 70
del C.jpeg_quality
# A subclass with the property unset uses that of its parent
assert A.jpeg_quality == 90
assert B.jpeg_quality == 60
assert C.jpeg_quality == 60
A.jpeg_quality = 50
# changing for a class doesn't affect a subclass with the property set
# or that subclass' subclass with the property unset
assert A.jpeg_quality == 50
assert B.jpeg_quality == 60
assert C.jpeg_quality == 60
del B.jpeg_quality
# A subclass and its subclass with the property unset use that of their
# parent
assert A.jpeg_quality == 50
assert B.jpeg_quality == 50
assert C.jpeg_quality == 50
del A.jpeg_quality
# Use default when there is no parent or all parents have the property
# unset
assert A.jpeg_quality == -1
assert B.jpeg_quality == -1
assert C.jpeg_quality == -1
finally:
del ITerm2Image.jpeg_quality
def test_class_wide_instance_specific(self):
A = ITerm2Image
class B(A):
pass
assert A.jpeg_quality == -1
assert B.jpeg_quality == -1
a1 = A(python_img)
a2 = A(python_img)
b1 = B(python_img)
b2 = B(python_img)
assert a1.jpeg_quality == -1
assert a2.jpeg_quality == -1
assert b1.jpeg_quality == -1
assert b2.jpeg_quality == -1
try:
A.jpeg_quality = 90
# Descendant class-wide
assert a1.jpeg_quality == 90
assert a2.jpeg_quality == 90
assert b1.jpeg_quality == 90
assert b2.jpeg_quality == 90
B.jpeg_quality = 80
# Direct class-wide
assert a1.jpeg_quality == 90
assert a2.jpeg_quality == 90
assert b1.jpeg_quality == 80
assert b2.jpeg_quality == 80
a2.jpeg_quality = 70
b2.jpeg_quality = 70
# Instance-specific overrides direct class-wide
assert a1.jpeg_quality == 90
assert a2.jpeg_quality == 70
assert b1.jpeg_quality == 80
assert b2.jpeg_quality == 70
del B.jpeg_quality
# Instance-specific overrides descendant class-wide
assert a1.jpeg_quality == 90
assert a2.jpeg_quality == 70
assert b1.jpeg_quality == 90
assert b2.jpeg_quality == 70
del a2.jpeg_quality
del b2.jpeg_quality
# Unset instance-specific falls back to class-wide
assert a1.jpeg_quality == 90
assert a2.jpeg_quality == 90
assert b1.jpeg_quality == 90
assert b2.jpeg_quality == 90
del A.jpeg_quality
# Unset instance-specific falls back to default when class-wide is unset
assert a1.jpeg_quality == -1
assert a2.jpeg_quality == -1
assert b1.jpeg_quality == -1
assert b2.jpeg_quality == -1
finally:
del ITerm2Image.jpeg_quality
def test_native_anim_max_bytes(self):
A = ITerm2Image
class B(A):
pass
a = A(python_img)
b = B(python_img)
default = 2 * 2**20
assert A.native_anim_max_bytes == default
assert B.native_anim_max_bytes == default
assert a.native_anim_max_bytes == default
assert b.native_anim_max_bytes == default
try:
for value in (None, "100", 100.0, ()):
with pytest.raises(TypeError):
ITerm2Image.native_anim_max_bytes = value
for value in (0, -1, -100):
with pytest.raises(ValueError):
ITerm2Image.native_anim_max_bytes = value
for instance in (a, b):
with pytest.raises(AttributeError):
instance.native_anim_max_bytes = 400
with pytest.raises(AttributeError):
del instance.native_anim_max_bytes
A.native_anim_max_bytes = 1
assert A.native_anim_max_bytes == 1
assert B.native_anim_max_bytes == 1
assert a.native_anim_max_bytes == 1
assert b.native_anim_max_bytes == 1
del B.native_anim_max_bytes
assert A.native_anim_max_bytes == default
assert B.native_anim_max_bytes == default
assert a.native_anim_max_bytes == default
assert b.native_anim_max_bytes == default
B.native_anim_max_bytes = 200
assert A.native_anim_max_bytes == 200
assert B.native_anim_max_bytes == 200
assert a.native_anim_max_bytes == 200
assert b.native_anim_max_bytes == 200
del A.native_anim_max_bytes
assert A.native_anim_max_bytes == default
assert B.native_anim_max_bytes == default
assert a.native_anim_max_bytes == default
assert b.native_anim_max_bytes == default
finally:
del ITerm2Image.native_anim_max_bytes
class TestReadFromFile:
def test_type_value(self):
try:
for value in (None, 1, "1", 1.0, ()):
with pytest.raises(TypeError):
ITerm2Image.read_from_file = value
ITerm2Image.read_from_file = True
ITerm2Image.read_from_file = False
finally:
ITerm2Image.read_from_file = False
def test_descendant(self):
A = ITerm2Image
class B(A):
pass
class C(B):
pass
try:
del ITerm2Image.read_from_file
assert A.read_from_file
assert B.read_from_file
assert C.read_from_file
A.read_from_file = False
# descendant
assert not A.read_from_file
assert not B.read_from_file
assert not C.read_from_file
C.read_from_file = True
# descent is broken by sub-subclass
assert not A.read_from_file
assert not B.read_from_file
assert C.read_from_file
B.read_from_file = True
# descent is broken by subclass
assert not A.read_from_file
assert B.read_from_file
assert C.read_from_file
B.read_from_file = False
# changing for a class doesn't affect a subclass with the property set
assert not A.read_from_file
assert not B.read_from_file
assert C.read_from_file
del C.read_from_file
# A subclass with the property unset uses that of its parent
assert not A.read_from_file
assert not B.read_from_file
assert not C.read_from_file
A.read_from_file = True
# changing for a class doesn't affect a subclass with the property set
# or that subclass' subclass with the property unset
assert A.read_from_file
assert not B.read_from_file
assert not C.read_from_file
del B.read_from_file
# A subclass and its subclass with the property unset use that of their
# parent
assert A.read_from_file
assert B.read_from_file
assert C.read_from_file
del A.read_from_file
# Use default when there is no parent or all parents have the property
# unset
assert A.read_from_file
assert B.read_from_file
assert C.read_from_file
finally:
ITerm2Image.read_from_file = False
def test_class_wide_instance_specific(self):
A = ITerm2Image
class B(A):
pass
a1 = A(python_img)
a2 = A(python_img)
b1 = B(python_img)
b2 = B(python_img)
try:
del ITerm2Image.read_from_file
assert A.read_from_file
assert B.read_from_file
assert a1.read_from_file
assert a2.read_from_file
assert b1.read_from_file
assert b2.read_from_file
A.read_from_file = False
# Descendant class-wide
assert not a1.read_from_file
assert not a2.read_from_file
assert not b1.read_from_file
assert not b2.read_from_file
B.read_from_file = True
# Direct class-wide
assert not a1.read_from_file
assert not a2.read_from_file
assert b1.read_from_file
assert b2.read_from_file
a2.read_from_file = True
b2.read_from_file = False
# Instance-specific overrides direct class-wide
assert not a1.read_from_file
assert a2.read_from_file
assert b1.read_from_file
assert not b2.read_from_file
b2.read_from_file = True
del B.read_from_file
# Instance-specific overrides descendant class-wide
assert not a1.read_from_file
assert a2.read_from_file
assert not b1.read_from_file
assert b2.read_from_file
del a2.read_from_file
del b2.read_from_file
# Unset instance-specific falls back to class-wide
assert not a1.read_from_file
assert not a2.read_from_file
assert not b1.read_from_file
assert not b2.read_from_file
del A.read_from_file
# Unset instance-specific falls back to default when class-wide is unset
assert a1.read_from_file
assert a2.read_from_file
assert b1.read_from_file
assert b2.read_from_file
finally:
ITerm2Image.read_from_file = False
def test_set_render_method():
try:
assert ITerm2Image._render_method == ITerm2Image._default_render_method == LINES
image = ITerm2Image(python_img)
assert image._render_method == ITerm2Image._default_render_method
# Case-insensitivity
assert ITerm2Image.set_render_method(WHOLE.upper()) is None
assert ITerm2Image.set_render_method(WHOLE.lower()) is None
assert ITerm2Image.set_render_method(LINES.upper()) is None
assert ITerm2Image.set_render_method(LINES.lower()) is None
assert ITerm2Image.set_render_method(ANIM.upper()) is None
assert ITerm2Image.set_render_method(ANIM.lower()) is None
# WHOLE
assert ITerm2Image.set_render_method(WHOLE) is None
assert ITerm2Image._render_method == WHOLE
assert image._render_method == WHOLE
assert image.set_render_method(LINES) is None
assert image._render_method == LINES
assert image.set_render_method(ANIM) is None
assert image._render_method == ANIM
assert image.set_render_method() is None
assert image._render_method == WHOLE
# LINES
assert ITerm2Image.set_render_method(LINES) is None
assert ITerm2Image._render_method == LINES
assert image._render_method == LINES
assert image.set_render_method(WHOLE) is None
assert image._render_method == WHOLE
assert image.set_render_method(ANIM) is None
assert image._render_method == ANIM
assert image.set_render_method() is None
assert image._render_method == LINES
# ANIM
assert ITerm2Image.set_render_method(ANIM) is None
assert ITerm2Image._render_method == ANIM
assert image._render_method == ANIM
assert image.set_render_method(WHOLE) is None
assert image._render_method == WHOLE
assert image.set_render_method(LINES) is None
assert image._render_method == LINES
assert image.set_render_method() is None
assert image._render_method == ANIM
# default
assert ITerm2Image.set_render_method(WHOLE) is None
assert ITerm2Image._render_method == WHOLE
assert image._render_method == WHOLE
assert ITerm2Image.set_render_method() is None
assert ITerm2Image._render_method == ITerm2Image._default_render_method
assert image._render_method == ITerm2Image._default_render_method
finally:
ITerm2Image._render_method = ITerm2Image._default_render_method
def test_style_format_spec():
for spec in (
" ",
"x",
"LW",
"WA",
"c1m0",
"0c",
"m2",
"m01",
"c-1",
"c10",
"c4m1",
" c1",
"m0 ",
" m1c3 ",
):
with pytest.raises(StyleError, match="format spec"):
ITerm2Image._check_style_format_spec(spec, spec)
for spec, args in (
("", {}),
("L", {"method": LINES}),
("W", {"method": WHOLE}),
("A", {"method": ANIM}),
("m0", {}),
("m1", {"mix": True}),
("c4", {}),
("c0", {"compress": 0}),
("c9", {"compress": 9}),
("Wm1c9", {"method": WHOLE, "mix": True, "compress": 9}),
):
assert ITerm2Image._check_style_format_spec(spec, spec) == args
class TestStyleArgs:
def test_unknown(self):
for args in ({"c": 1}, {"m": True}, {" ": None}, {"xxxx": True}):
with pytest.raises(StyleError, match="Unknown style-specific"):
ITerm2Image._check_style_args(args)
def test_method(self):
for value in (None, 1.0, (), [], 2):
with pytest.raises(TypeError):
ITerm2Image._check_style_args({"method": value})
for value in ("", " ", "cool"):
with pytest.raises(ValueError):
ITerm2Image._check_style_args({"method": value})
for value in (ANIM, LINES, WHOLE):
assert ITerm2Image._check_style_args({"method": value}) == {"method": value}
def test_mix(self):
for value in (0, 1.0, (), [], "2"):
with pytest.raises(TypeError):
ITerm2Image._check_style_args({"mix": value})
assert ITerm2Image._check_style_args({"mix": False}) == {}
assert ITerm2Image._check_style_args({"mix": True}) == {"mix": True}
def test_compress(self):
for value in (1.0, (), [], "2"):
with pytest.raises(TypeError):
ITerm2Image._check_style_args({"compress": value})
for value in (-1, 10):
with pytest.raises(ValueError):
ITerm2Image._check_style_args({"compress": value})
assert ITerm2Image._check_style_args({"compress": 4}) == {}
for value in range(1, 10):
if value != 4:
assert (
ITerm2Image._check_style_args({"compress": value})
== {"compress": value} # fmt: skip
)
def expand_control_data(control_data):
control_data = control_data.split(";")
control_codes = {tuple(code.split("=")) for code in control_data}
assert len(control_codes) == len(control_data)
return control_codes
def decode_image(data, term="", jpeg=False, anim=False, read_from_file=False):
fill_1, start, data = data.partition(ctlseqs.ITERM2_START)
assert start == ctlseqs.ITERM2_START
if term == "konsole":
assert fill_1 == ""
transmission, end, fill_2 = data.rpartition(ctlseqs.ST)
assert end == ctlseqs.ST
if term != "konsole":
assert fill_2 == ""
control_data, payload = transmission.split(":", 1)
control_codes = expand_control_data(control_data)
assert (
code in control_codes
for code in expand_control_data(
"preserveAspectRatio=0;inline=1"
+ ";doNotMoveCursor=1" * (term == "konsole")
)
)
compressed_image = standard_b64decode(payload.encode())
img = Image.open(io.BytesIO(compressed_image))
if anim:
assert isinstance(img, (GifImageFile, PngImageFile, WebPImageFile))
assert img.is_animated
if read_from_file or anim:
raw_image = None
else:
raw_image = img.tobytes()
if jpeg and img.mode != "RGBA":
assert img.format == "JPEG"
assert img.mode == "RGB"
else:
assert img.format == "PNG"
assert img.mode in {"RGB", "RGBA"}
return (
control_codes,
img.format,
img.mode,
compressed_image,
raw_image,
fill_2 if term == "konsole" else fill_1,
)
class TestRenderLines:
# Fully transparent image
# It's easy to predict it's pixel values
trans = ITerm2Image.from_file("tests/images/trans.png")
trans.height = _size
trans.set_render_method(LINES)
def render_image(self, alpha=0.0, *, m=False, c=4):
return self.trans._renderer(self.trans._render_image, alpha, mix=m, compress=c)
@staticmethod
def _test_image_size(image, term="", jpeg=False):
w, h = get_actual_render_size(image)
cols, lines = image.rendered_size
pixels_per_line = w * (h // lines)
size_control_data = f"width={cols},height=1"
render = str(image)
assert render.count("\n") + 1 == lines
for n, line in enumerate(render.splitlines(), 1):
control_codes, format, mode, _, raw_image, fill = decode_image(
line, term=term, jpeg=jpeg
)
assert (
code in control_codes for code in expand_control_data(size_control_data)
)
assert len(raw_image) == pixels_per_line * len(mode)
assert fill == (
ctlseqs.CURSOR_FORWARD % cols
if term == "konsole"
else ctlseqs.ERASE_CHARS % cols
if term == "wezterm"
else ""
)
def test_no_minimal_render_size(self):
image = ITerm2Image.from_file("tests/images/trans.png")
image.set_render_method(LINES)
lines_for_original_height = ITerm2Image._pixels_lines(
pixels=image.original_size[1]
)
# render size < original size; Uses render size
image.height = lines_for_original_height // 2
w, h = image._get_render_size()
assert get_actual_render_size(image) == (w, h)
for ITerm2Image._TERM in supported_terminals:
self._test_image_size(image, term=ITerm2Image._TERM)
# render size > original size; Uses render size
image.height = lines_for_original_height * 2
w, h = image._get_render_size()
assert get_actual_render_size(image) == (w, h)
for ITerm2Image._TERM in supported_terminals:
self._test_image_size(image, term=ITerm2Image._TERM)
def test_size(self):
for ITerm2Image._TERM in supported_terminals:
self._test_image_size(self.trans, term=ITerm2Image._TERM)
def test_raw_image_and_transparency(self):
ITerm2Image._TERM = ""
w, h = get_actual_render_size(self.trans)
pixels_per_line = w * (h // _size)
# Transparency enabled
render = self.render_image()
assert render == str(self.trans) == f"{self.trans:1.1}"
for line in render.splitlines():
_, format, mode, _, raw_image, _ = decode_image(line)
assert format == "PNG"
assert mode == "RGBA"
assert len(raw_image) == pixels_per_line * 4
assert raw_image.count(b"\0" * 4) == pixels_per_line
# Transparency disabled
render = self.render_image(None)
assert render == f"{self.trans:1.1#}"
for line in render.splitlines():
_, format, mode, _, raw_image, _ = decode_image(line)
assert format == "PNG"
assert mode == "RGB"
assert len(raw_image) == pixels_per_line * 3
assert raw_image.count(b"\0\0\0") == pixels_per_line
def test_raw_image_and_background_colour(self):
ITerm2Image._TERM = ""
w, h = get_actual_render_size(self.trans)
pixels_per_line = w * (h // _size)
# Terminal BG
for bg in ((0,) * 3, (100,) * 3, (255,) * 3, None):
set_fg_bg_colors(bg=bg)
pixel_bytes = bytes(bg or (0, 0, 0))
render = self.render_image("#")
assert render == f"{self.trans:1.1##}"
for line in render.splitlines():
_, format, mode, _, raw_image, _ = decode_image(line)
assert format == "PNG"
assert mode == "RGB"
assert len(raw_image) == pixels_per_line * 3
assert raw_image.count(pixel_bytes) == pixels_per_line
# red
render = self.render_image("#ff0000")
assert render == f"{self.trans:1.1#ff0000}"
for line in render.splitlines():
_, format, mode, _, raw_image, _ = decode_image(line)
assert format == "PNG"
assert mode == "RGB"
assert len(raw_image) == pixels_per_line * 3
assert raw_image.count(b"\xff\0\0") == pixels_per_line
# green
render = self.render_image("#00ff00")
assert render == f"{self.trans:1.1#00ff00}"
for line in render.splitlines():
_, format, mode, _, raw_image, _ = decode_image(line)
assert format == "PNG"
assert mode == "RGB"
assert len(raw_image) == pixels_per_line * 3
assert raw_image.count(b"\0\xff\0") == pixels_per_line
# blue
render = self.render_image("#0000ff")
assert render == f"{self.trans:1.1#0000ff}"
for line in render.splitlines():
_, format, mode, _, raw_image, _ = decode_image(line)
assert format == "PNG"
assert mode == "RGB"
assert len(raw_image) == pixels_per_line * 3
assert raw_image.count(b"\0\0\xff") == pixels_per_line
# white
render = self.render_image("#ffffff")
assert render == f"{self.trans:1.1#ffffff}"
for line in render.splitlines():
_, format, mode, _, raw_image, _ = decode_image(line)
assert format == "PNG"
assert mode == "RGB"
assert len(raw_image) == pixels_per_line * 3
assert raw_image.count(b"\xff" * 3) == pixels_per_line
def test_mix(self):
ITerm2Image._TERM = ""
cols = self.trans.rendered_width
for ITerm2Image._TERM in supported_terminals:
# mix = False (default)
render = self.render_image()
assert render == str(self.trans) == f"{self.trans:1.1+m0}"
for line in render.splitlines():
assert decode_image(line, term=ITerm2Image._TERM)[-1] == (
ctlseqs.CURSOR_FORWARD % cols
if ITerm2Image._TERM == "konsole"
else ctlseqs.ERASE_CHARS % cols
if ITerm2Image._TERM == "wezterm"
else ""
)
# mix = True
render = self.render_image(None, m=True)
assert render == f"{self.trans:1.1#+m1}"
for line in render.splitlines():
assert decode_image(line, term=ITerm2Image._TERM)[-1] == (
ctlseqs.CURSOR_FORWARD % cols
if ITerm2Image._TERM == "konsole"
else ""
)
def test_compress(self):
ITerm2Image._TERM = ""
# compress = 4 (default)
assert self.render_image() == str(self.trans) == f"{self.trans:1.1+c4}"
# compress = 0
assert self.render_image(None, c=0) == f"{self.trans:1.1#+c0}"
# compress = {1-9}
for value in range(1, 10):
assert self.render_image(None, c=value) == f"{self.trans:1.1#+c{value}}"
# Data size relativity
assert (
len(self.render_image(c=0))
> len(self.render_image(c=1))
> len(self.render_image(c=9))
)
def test_jpeg(self):
png_image = ITerm2Image.from_file("tests/images/trans.png")
jpeg_image = ITerm2Image.from_file("tests/images/vert.jpg")
png_image.set_render_method(LINES)
jpeg_image.set_render_method(LINES)
try:
ITerm2Image.jpeg_quality = 95
ITerm2Image._TERM = ""
# Will use PNG since the image has alpha
lines_for_original_height = ITerm2Image._pixels_lines(
pixels=png_image.original_size[1]
)
png_image.height = lines_for_original_height * 2
for ITerm2Image._TERM in supported_terminals:
self._test_image_size(png_image, term=ITerm2Image._TERM)
for line in str(png_image).splitlines():
_, format, mode, *_ = decode_image(line, term=ITerm2Image._TERM)
assert format == "PNG"
assert mode == "RGBA"
# Will use JPEG since the image has no alpha
lines_for_original_height = ITerm2Image._pixels_lines(
pixels=jpeg_image.original_size[1]
)
jpeg_image.height = lines_for_original_height * 2
for ITerm2Image._TERM in supported_terminals:
self._test_image_size(jpeg_image, term=ITerm2Image._TERM, jpeg=True)
for line in str(jpeg_image).splitlines():
_, format, mode, *_ = decode_image(
line, term=ITerm2Image._TERM, jpeg=True
)
assert format == "JPEG"
assert mode == "RGB"
# Will use JPEG since transparency is disabled
lines_for_original_height = ITerm2Image._pixels_lines(
pixels=jpeg_image.original_size[1]
)
jpeg_image.height = lines_for_original_height * 2
for ITerm2Image._TERM in supported_terminals:
self._test_image_size(png_image, term=ITerm2Image._TERM, jpeg=True)
for line in f"{png_image:1.1#}".splitlines():
_, format, mode, *_ = decode_image(
line, term=ITerm2Image._TERM, jpeg=True
)
assert format == "JPEG"
assert mode == "RGB"
# Compression level / Image data size
ITerm2Image.jpeg_quality = 0
jpeg_0 = str(jpeg_image)
ITerm2Image.jpeg_quality = 50
jpeg_50 = str(jpeg_image)
ITerm2Image.jpeg_quality = 95
jpeg_95 = str(jpeg_image)
assert len(jpeg_0) < len(jpeg_50) < len(jpeg_95)
finally:
del ITerm2Image.jpeg_quality
class TestRenderWhole:
# Fully transparent image
# It's easy to predict it's pixel values
trans = ITerm2Image.from_file("tests/images/trans.png")
trans.height = _size
trans.set_render_method(WHOLE)
def render_image(self, alpha=0.0, *, m=False, c=4):
return self.trans._renderer(self.trans._render_image, alpha, mix=m, compress=c)
@staticmethod
def _test_image_size(image, term="", jpeg=False, anim=False, read_from_file=False):
w, h = get_actual_render_size(image)
cols, lines = image.rendered_size
size_control_data = f"width={cols},height={lines}"
render = f"{image:1.1+A}" if anim else str(image)
assert render.count("\n") + 1 == lines
control_codes, format, mode, _, raw_image, fill = decode_image(
render, term=term, jpeg=jpeg, anim=anim, read_from_file=read_from_file
)
assert (
code in control_codes for code in expand_control_data(size_control_data)
)
if not (read_from_file or anim):
assert len(raw_image) == w * h * len(mode)
assert fill.count("\n") + 1 == lines
*fills, last_fill = fill.split("\n")
assert all(
line
== (
ctlseqs.ERASE_CHARS % cols * (term == "wezterm")
+ ctlseqs.CURSOR_FORWARD % cols
)
for line in fills
)
assert last_fill == (
ctlseqs.CURSOR_FORWARD % cols
if term == "konsole"
else (
ctlseqs.ERASE_CHARS % cols * (term == "wezterm")
+ ctlseqs.CURSOR_UP % (lines - 1) * (lines > 1)
)
)
def test_minimal_render_size(self):
image = ITerm2Image.from_file("tests/images/trans.png")
image.set_render_method(WHOLE)
lines_for_original_height = ITerm2Image._pixels_lines(
pixels=image.original_size[1]
)
# render size < original size; Uses render size
image.height = lines_for_original_height // 2
w, h = image._get_render_size()
assert get_actual_render_size(image) == (w, h)
for ITerm2Image._TERM in supported_terminals:
self._test_image_size(image, term=ITerm2Image._TERM)
# render size > original size; Uses original size
image.height = lines_for_original_height * 2
w, h = image._original_size
assert get_actual_render_size(image) == (w, h)
for ITerm2Image._TERM in supported_terminals:
self._test_image_size(image, term=ITerm2Image._TERM)
def test_size(self):
for ITerm2Image._TERM in supported_terminals:
self._test_image_size(self.trans, term=ITerm2Image._TERM)
def test_raw_image_and_transparency(self):
ITerm2Image._TERM = ""
w, h = get_actual_render_size(self.trans)
# Transparency enabled
render = self.render_image()
assert render == str(self.trans) == f"{self.trans:1.1}"
_, format, mode, _, raw_image, _ = decode_image(render)
assert format == "PNG"
assert mode == "RGBA"
assert len(raw_image) == w * h * 4
assert raw_image.count(b"\0" * 4) == w * h
# Transparency disabled
render = self.render_image(None)
assert render == f"{self.trans:1.1#}"
_, format, mode, _, raw_image, _ = decode_image(render)
assert format == "PNG"
assert mode == "RGB"
assert len(raw_image) == w * h * 3
assert raw_image.count(b"\0\0\0") == w * h
def test_raw_image_and_background_colour(self):
ITerm2Image._TERM = ""
w, h = get_actual_render_size(self.trans)
# Terminal BG
for bg in ((0,) * 3, (100,) * 3, (255,) * 3, None):
set_fg_bg_colors(bg=bg)
pixel_bytes = bytes(bg or (0, 0, 0))
render = self.render_image("#")
assert render == f"{self.trans:1.1##}"
_, format, mode, _, raw_image, _ = decode_image(render)
assert format == "PNG"
assert mode == "RGB"
assert len(raw_image) == w * h * 3
assert raw_image.count(pixel_bytes) == w * h
# red
render = self.render_image("#ff0000")
assert render == f"{self.trans:1.1#ff0000}"
_, format, mode, _, raw_image, _ = decode_image(render)
assert format == "PNG"
assert mode == "RGB"
assert len(raw_image) == w * h * 3
assert raw_image.count(b"\xff\0\0") == w * h
# green
render = self.render_image("#00ff00")
assert render == f"{self.trans:1.1#00ff00}"
_, format, mode, _, raw_image, _ = decode_image(render)
assert format == "PNG"
assert mode == "RGB"
assert len(raw_image) == w * h * 3
assert raw_image.count(b"\0\xff\0") == w * h
# blue
render = self.render_image("#0000ff")
assert render == f"{self.trans:1.1#0000ff}"
_, format, mode, _, raw_image, _ = decode_image(render)
assert format == "PNG"
assert mode == "RGB"
assert len(raw_image) == w * h * 3
assert raw_image.count(b"\0\0\xff") == w * h
# white
render = self.render_image("#ffffff")
assert render == f"{self.trans:1.1#ffffff}"
_, format, mode, _, raw_image, _ = decode_image(render)
assert format == "PNG"
assert mode == "RGB"
assert len(raw_image) == w * h * 3
assert raw_image.count(b"\xff" * 3) == w * h
def test_mix(self):
ITerm2Image._TERM = ""
cols, lines = self.trans.rendered_size
for ITerm2Image._TERM in supported_terminals:
# mix = False (default)
render = self.render_image()
assert render == str(self.trans) == f"{self.trans:1.1+m0}"
*fills, last_fill = decode_image(
render, term=ITerm2Image._TERM # fmt: skip
)[-1].splitlines()
assert all(
line
== (
ctlseqs.ERASE_CHARS % cols * (ITerm2Image._TERM == "wezterm")
+ ctlseqs.CURSOR_FORWARD % cols
)
for line in fills
)
assert last_fill == (
ctlseqs.CURSOR_FORWARD % cols
if ITerm2Image._TERM == "konsole"
else (
ctlseqs.ERASE_CHARS % cols * (ITerm2Image._TERM == "wezterm")
+ ctlseqs.CURSOR_UP % (lines - 1)
)
)
# mix = True
render = self.render_image(None, m=True)
assert render == f"{self.trans:1.1#+m1}"
*fills, last_fill = decode_image(
render, term=ITerm2Image._TERM # fmt: skip
)[-1].splitlines()
assert all(line == ctlseqs.CURSOR_FORWARD % cols for line in fills)
assert last_fill == (
ctlseqs.CURSOR_FORWARD % cols
if ITerm2Image._TERM == "konsole"
else ctlseqs.CURSOR_UP % (lines - 1)
)
def test_compress(self):
ITerm2Image._TERM = ""
# compress = 4 (default)
assert self.render_image() == str(self.trans) == f"{self.trans:1.1+c4}"
# compress = 0
assert self.render_image(None, c=0) == f"{self.trans:1.1#+c0}"
# compress = {1-9}
for value in range(1, 10):
assert self.render_image(None, c=value) == f"{self.trans:1.1#+c{value}}"
# Data size relativity
assert (
len(self.render_image(c=0))
> len(self.render_image(c=1))
> len(self.render_image(c=9))
)
def test_jpeg(self):
png_image = ITerm2Image.from_file("tests/images/trans.png")
jpeg_image = ITerm2Image.from_file("tests/images/vert.jpg")
png_image.set_render_method(WHOLE)
jpeg_image.set_render_method(WHOLE)
try:
ITerm2Image.jpeg_quality = 95
ITerm2Image._TERM = ""
# Will use PNG since the image has alpha
lines_for_original_height = ITerm2Image._pixels_lines(
pixels=png_image.original_size[1]
)
png_image.height = lines_for_original_height * 2
for ITerm2Image._TERM in supported_terminals:
self._test_image_size(png_image, term=ITerm2Image._TERM)
_, format, mode, *_ = decode_image(
str(png_image), term=ITerm2Image._TERM
)
assert format == "PNG"
assert mode == "RGBA"
# Will use JPEG since the image has no alpha
lines_for_original_height = ITerm2Image._pixels_lines(
pixels=jpeg_image.original_size[1]
)
jpeg_image.height = lines_for_original_height * 2
for ITerm2Image._TERM in supported_terminals:
self._test_image_size(jpeg_image, term=ITerm2Image._TERM, jpeg=True)
_, format, mode, *_ = decode_image(
str(jpeg_image), term=ITerm2Image._TERM, jpeg=True
)
assert format == "JPEG"
assert mode == "RGB"
# Will use JPEG since transparency is disabled
lines_for_original_height = ITerm2Image._pixels_lines(
pixels=jpeg_image.original_size[1]
)
jpeg_image.height = lines_for_original_height * 2
for ITerm2Image._TERM in supported_terminals:
self._test_image_size(png_image, term=ITerm2Image._TERM, jpeg=True)
_, format, mode, *_ = decode_image(
f"{png_image:1.1#}", term=ITerm2Image._TERM, jpeg=True
)
assert format == "JPEG"
assert mode == "RGB"
# Compression level / Image data size
ITerm2Image.jpeg_quality = 0
jpeg_0 = str(jpeg_image)
ITerm2Image.jpeg_quality = 50
jpeg_50 = str(jpeg_image)
ITerm2Image.jpeg_quality = 95
jpeg_95 = str(jpeg_image)
assert len(jpeg_0) < len(jpeg_50) < len(jpeg_95)
finally:
del ITerm2Image.jpeg_quality
class TestRenderAnim:
_test_image_size = staticmethod(TestRenderWhole._test_image_size)
with open("tests/images/elephant.png", "rb") as f:
apng_file = f.read()
apng_image = ITerm2Image.from_file("tests/images/elephant.png", height=_size)
with open("tests/images/lion.gif", "rb") as f:
gif_file = f.read()
gif_image = ITerm2Image.from_file("tests/images/lion.gif", height=_size)
with open("tests/images/anim.webp", "rb") as f:
webp_file = f.read()
webp_image = ITerm2Image.from_file("tests/images/anim.webp", height=_size)
img = Image.open("tests/images/lion.gif")
img_image = ITerm2Image(img, height=_size)
no_file_img = Image.open(open("tests/images/lion.gif", "rb"))
no_file_image = ITerm2Image(no_file_img, height=_size)
def render_native_anim(self, image):
return image._renderer(image._render_image, 0.0, method=ANIM)
# Reads from file when possible
def test_read_from_file(self):
for image, file in (
(self.apng_image, self.apng_file),
(self.webp_image, self.webp_file),
(self.gif_image, self.gif_file),
(self.img_image, self.gif_file),
):
for ITerm2Image._TERM in supported_terminals:
assert (
file
== decode_image(
self.render_native_anim(image),
term=ITerm2Image._TERM,
anim=True,
)[3]
)
self._test_image_size(image, term=ITerm2Image._TERM, anim=True)
# Re-encodes when image file is not accessible
def test_re_encode(self):
for ITerm2Image._TERM in supported_terminals:
assert (
self.gif_file
!= decode_image(
self.render_native_anim(self.no_file_image),
term=ITerm2Image._TERM,
anim=True,
)[3]
)
self._test_image_size(self.no_file_image, term=ITerm2Image._TERM, anim=True)
# No image file and unknown format
def test_unknown_format(self):
self.no_file_img.format = None
with pytest.raises(RenderError, match="native animation .* unknown format"):
self.render_native_anim(self.no_file_image)
# Image data size limit
def test_max_bytes(self):
ITerm2Image.native_anim_max_bytes = 300000
with pytest.warns(TermImageWarning, match="maximum for native animation"):
self.render_native_anim(self.apng_image)
self.render_native_anim(self.gif_image)
def test_read_from_file():
test_image_size = TestRenderWhole._test_image_size
with open("tests/images/trans.png", "rb") as f:
png_file = f.read()
png_image = ITerm2Image.from_file("tests/images/trans.png")
png_image.set_render_method(WHOLE)
with open("tests/images/vert.jpg", "rb") as f:
jpeg_file = f.read()
jpeg_image = ITerm2Image.from_file("tests/images/vert.jpg")
jpeg_image.set_render_method(WHOLE)
ITerm2Image.read_from_file = True
try:
ITerm2Image._TERM = ""
# manipulation is required since the mode is RGBA
lines_for_original_height = ITerm2Image._pixels_lines(
pixels=png_image.original_size[1]
)
png_image.height = lines_for_original_height * 2
assert png_file != decode_image(f"{png_image:1.1#}", term=ITerm2Image._TERM)[3]
# manipulation is not required since the mode is RGB
lines_for_original_height = ITerm2Image._pixels_lines(
pixels=jpeg_image.original_size[1]
)
jpeg_image.height = lines_for_original_height * 2
assert (
jpeg_file
== decode_image(
f"{jpeg_image:1.1#}", term=ITerm2Image._TERM, read_from_file=True
)[3]
)
for image, file in ((png_image, png_file), (jpeg_image, jpeg_file)):
lines_for_original_height = ITerm2Image._pixels_lines(
pixels=image.original_size[1]
)
# Will not be downscaled
image.height = lines_for_original_height * 2
for ITerm2Image._TERM in supported_terminals:
assert (
file
== decode_image(
str(image), term=ITerm2Image._TERM, read_from_file=True
)[3]
)
test_image_size(image, term=ITerm2Image._TERM, read_from_file=True)
# Will be downscaled
image.height = lines_for_original_height // 2
for ITerm2Image._TERM in supported_terminals:
assert file != decode_image(str(image), term=ITerm2Image._TERM)[3]
test_image_size(image, term=ITerm2Image._TERM)
finally:
ITerm2Image.read_from_file = False
class TestClear:
@contextmanager
def setup_buffer(self):
buf = io.StringIO()
tty_buf = io.BytesIO()
stdout_write = iterm2._stdout_write
write_tty = iterm2.write_tty
iterm2._stdout_write = buf.write
iterm2.write_tty = tty_buf.write
try:
yield buf, tty_buf
finally:
iterm2._stdout_write = stdout_write
iterm2.write_tty = write_tty
buf.close()
tty_buf.close()
def test_all(self):
_TERM = ITerm2Image._TERM
ITerm2Image._TERM = "konsole"
try:
with self.setup_buffer() as (buf, tty_buf):
ITerm2Image.clear(now=True)
assert buf.getvalue() == ""
assert tty_buf.getvalue() == ctlseqs.KITTY_DELETE_ALL_b
with self.setup_buffer() as (buf, tty_buf):
ITerm2Image.clear()
assert buf.getvalue() == ctlseqs.KITTY_DELETE_ALL
assert tty_buf.getvalue() == b""
finally:
ITerm2Image._TERM = _TERM
def test_cursor(self):
_TERM = ITerm2Image._TERM
ITerm2Image._TERM = "konsole"
try:
with self.setup_buffer() as (buf, tty_buf):
ITerm2Image.clear(cursor=True, now=True)
assert buf.getvalue() == ""
assert tty_buf.getvalue() == ctlseqs.KITTY_DELETE_CURSOR_b
with self.setup_buffer() as (buf, tty_buf):
ITerm2Image.clear(cursor=True)
assert buf.getvalue() == ctlseqs.KITTY_DELETE_CURSOR
assert tty_buf.getvalue() == b""
finally:
ITerm2Image._TERM = _TERM
def test_not_supported(self):
ITerm2Image._supported = False
try:
with self.setup_buffer() as (buf, tty_buf):
ITerm2Image.clear()
assert buf.getvalue() == ""
assert tty_buf.getvalue() == b""
ITerm2Image.clear(cursor=True)
assert buf.getvalue() == ""
assert tty_buf.getvalue() == b""
finally:
ITerm2Image._supported = True
def test_not_on_konsole(self):
_TERM = ITerm2Image._TERM
try:
for ITerm2Image._TERM in supported_terminals - {"konsole"}:
with self.setup_buffer() as (buf, tty_buf):
ITerm2Image.clear()
assert buf.getvalue() == ""
assert tty_buf.getvalue() == b""
ITerm2Image.clear(cursor=True)
assert buf.getvalue() == ""
assert tty_buf.getvalue() == b""
finally:
ITerm2Image._TERM = _TERM
supported_terminals = {"iterm2", "wezterm", "konsole"}
|