Terminal
Module: terminaltexteffects.engine.terminal
A class for managing the terminal state and output.
Attributes:
Name | Type | Description |
---|---|---|
config |
TerminalConfig
|
Configuration for the terminal. |
canvas |
Canvas
|
The canvas in the terminal. |
character_by_input_coord |
dict[Coord, EffectCharacter]
|
A dictionary of characters by their input coordinates. |
Methods:
Name | Description |
---|---|
get_piped_input |
Gets the piped input from stdin. |
prep_canvas |
Prepares the terminal for the effect by adding empty lines and hiding the cursor. |
restore_cursor |
Restores the cursor visibility. |
get_characters |
Get a list of all EffectCharacters in the terminal with an optional sort. |
get_characters_grouped |
Get a list of all EffectCharacters grouped by the specified CharacterGroup grouping. |
get_character_by_input_coord |
Get an EffectCharacter by its input coordinates. |
set_character_visibility |
Set the visibility of a character. |
get_formatted_output_string |
Get the formatted output string based on the current terminal state. |
print |
Prints the current terminal state to stdout while preserving the cursor position. |
Source code in terminaltexteffects/engine/terminal.py
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 |
|
CharacterGroup
Bases: Enum
An enum specifying character groupings.
Attributes:
Name | Type | Description |
---|---|---|
COLUMN_LEFT_TO_RIGHT |
Group characters by column from left to right. |
|
COLUMN_RIGHT_TO_LEFT |
Group characters by column from right to left. |
|
ROW_TOP_TO_BOTTOM |
Group characters by row from top to bottom. |
|
ROW_BOTTOM_TO_TOP |
Group characters by row from bottom to top. |
|
DIAGONAL_TOP_LEFT_TO_BOTTOM_RIGHT |
Group characters by diagonal from top left to bottom right. |
|
DIAGONAL_BOTTOM_LEFT_TO_TOP_RIGHT |
Group characters by diagonal from bottom left to top right. |
|
DIAGONAL_TOP_RIGHT_TO_BOTTOM_LEFT |
Group characters by diagonal from top right to bottom left. |
|
DIAGONAL_BOTTOM_RIGHT_TO_TOP_LEFT |
Group characters by diagonal from bottom right to top left. |
|
CENTER_TO_OUTSIDE_DIAMONDS |
Group characters by distance from the center to the outside in diamond shapes. |
|
OUTSIDE_TO_CENTER_DIAMONDS |
Group characters by distance from the outside to the center in diamond shapes. |
Source code in terminaltexteffects/engine/terminal.py
CharacterSort
Bases: Enum
An enum for specifying character sorts.
Attributes:
Name | Type | Description |
---|---|---|
RANDOM |
Random order. |
|
TOP_TO_BOTTOM_LEFT_TO_RIGHT |
Top to bottom, left to right. |
|
TOP_TO_BOTTOM_RIGHT_TO_LEFT |
Top to bottom, right to left. |
|
BOTTOM_TO_TOP_LEFT_TO_RIGHT |
Bottom to top, left to right. |
|
BOTTOM_TO_TOP_RIGHT_TO_LEFT |
Bottom to top, right to left. |
|
OUTSIDE_ROW_TO_MIDDLE |
Outside row to middle. |
|
MIDDLE_ROW_TO_OUTSIDE |
Middle row to outside. |
Source code in terminaltexteffects/engine/terminal.py
ColorSort
Bases: Enum
An enum for specifying color sorts for the colors derived from the input text ansi sequences.
Attributes:
Name | Type | Description |
---|---|---|
LEAST_TO_MOST |
Sort colors from least to most frequent. |
|
MOST_TO_LEAST |
Sort colors from most to least frequent. |
|
RANDOM |
Random order. |
Source code in terminaltexteffects/engine/terminal.py
__init__(input_data, config=None)
Initialize the Terminal.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
input_data
|
str
|
The input data to be displayed in the terminal. |
required |
config
|
TerminalConfig
|
Configuration for the terminal. Defaults to None. |
None
|
Source code in terminaltexteffects/engine/terminal.py
add_character(symbol, coord)
Add a character to the terminal for printing.
Used to create characters that are not in the input data.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
symbol
|
str
|
symbol to add |
required |
coord
|
Coord
|
(Coord): set character's input coordinates |
required |
Returns:
Name | Type | Description |
---|---|---|
EffectCharacter |
EffectCharacter
|
the character that was added |
Source code in terminaltexteffects/engine/terminal.py
enforce_framerate()
Enforce the frame rate set in the terminal config.
Frame rate is enforced by sleeping if the time since the last frame is shorter than the expected frame delay.
Source code in terminaltexteffects/engine/terminal.py
get_character_by_input_coord(coord)
Get an EffectCharacter by its input coordinates.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
coord
|
Coord
|
input coordinates of the character |
required |
Returns:
Type | Description |
---|---|
EffectCharacter | None
|
EffectCharacter | None: the character at the specified coordinates, or None if no character is found |
Source code in terminaltexteffects/engine/terminal.py
get_characters(*, input_chars=True, inner_fill_chars=False, outer_fill_chars=False, added_chars=False, sort=CharacterSort.TOP_TO_BOTTOM_LEFT_TO_RIGHT)
Get a list of all EffectCharacters in the terminal with an optional sort.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
input_chars
|
bool
|
whether to include input characters. Defaults to True. |
True
|
inner_fill_chars
|
bool
|
whether to include inner fill characters. Defaults to False. |
False
|
outer_fill_chars
|
bool
|
whether to include outer fill characters. Defaults to False. |
False
|
added_chars
|
bool
|
whether to include added characters. Defaults to False. |
False
|
sort
|
CharacterSort
|
order to sort the characters. Defaults to CharacterSort.TOP_TO_BOTTOM_LEFT_TO_RIGHT. |
TOP_TO_BOTTOM_LEFT_TO_RIGHT
|
Returns:
Type | Description |
---|---|
list[EffectCharacter]
|
list[EffectCharacter]: list of EffectCharacters in the terminal |
Source code in terminaltexteffects/engine/terminal.py
get_characters_grouped(grouping=CharacterGroup.ROW_TOP_TO_BOTTOM, *, input_chars=True, inner_fill_chars=False, outer_fill_chars=False, added_chars=False)
Get a list of all EffectCharacters grouped by the specified CharacterGroup grouping.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
grouping
|
CharacterGroup
|
order to group the characters. Defaults to ROW_TOP_TO_BOTTOM. |
ROW_TOP_TO_BOTTOM
|
input_chars
|
bool
|
whether to include input characters. Defaults to True. |
True
|
inner_fill_chars
|
bool
|
whether to include inner fill characters. Defaults to False. |
False
|
outer_fill_chars
|
bool
|
whether to include outer fill characters. Defaults to False. |
False
|
added_chars
|
bool
|
whether to include added characters. Defaults to False. |
False
|
Returns:
Type | Description |
---|---|
list[list[EffectCharacter]]
|
list[list[EffectCharacter]]: list of lists of EffectCharacters in the terminal. Inner lists correspond to groups as specified in the grouping. |
Source code in terminaltexteffects/engine/terminal.py
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 |
|
get_formatted_output_string()
Get the formatted output string based on the current terminal state.
This method updates the internal terminal representation state before returning the formatted output string.
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
The formatted output string. |
Source code in terminaltexteffects/engine/terminal.py
get_input_colors(sort=ColorSort.MOST_TO_LEAST)
Get a list of colors derived from the input text ansi sequences with an optional sort.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
sort
|
ColorSort
|
Sort the colors. Defaults to ColorSort.MOST_TO_LEAST. |
MOST_TO_LEAST
|
Raises:
Type | Description |
---|---|
ValueError
|
If an invalid sort option is provided. |
Returns:
Type | Description |
---|---|
list[Color]
|
list[Color]: list of Colors |
Source code in terminaltexteffects/engine/terminal.py
get_piped_input()
staticmethod
Get the piped input from stdin.
This method checks if there is any piped input from the standard input (stdin). If there is no piped input, it returns an empty string. If there is piped input, it reads the input data from stdin and returns it as a string.
The sys.stdin.isatty()
check is used to determine if the program is being run interactively
or if there is piped input. When the program is run interactively, sys.stdin.isatty()
returns True,
indicating that there is no piped input. In this case, the method returns an empty string.
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
The piped input from stdin as a string, or an empty string if there is no piped input. |
Source code in terminaltexteffects/engine/terminal.py
move_cursor_to_top()
Restores the cursor position to the top of the canvas.
Source code in terminaltexteffects/engine/terminal.py
prep_canvas()
Prepare the terminal for the effect by adding empty lines and hiding the cursor.
Source code in terminaltexteffects/engine/terminal.py
print(output_string)
Print the current terminal state to stdout while preserving the cursor position.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
output_string
|
str
|
The string to be printed. |
required |
Source code in terminaltexteffects/engine/terminal.py
restore_cursor(end_symbol='\n')
Restores the cursor visibility and prints the end_symbol.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
end_symbol
|
str
|
The symbol to print after the effect has completed. Defaults to newline. |
'\n'
|
Source code in terminaltexteffects/engine/terminal.py
set_character_visibility(character, is_visible)
Set the visibility of a character.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
character
|
EffectCharacter
|
the character to set visibility for |
required |
is_visible
|
bool
|
whether the character should be visible |
required |