Skip to content

Sweep

Demo

Quick Start

sweep.py
import terminaltexteffects as tte
from terminaltexteffects.effects.effect_sweep import Sweep

effect = Sweep("YourTextHere")
effect.effect_config.final_gradient_direction = tte.Gradient.Direction.HORIZONTAL
with effect.terminal_output() as terminal:
    for frame in effect:
        terminal.print(frame)

Sweep across the canvas to reveal uncolored text, reverse sweep to color the text.

Classes:

Name Description
Sweep

Sweep across the canvas to reveal uncolored text, reverse sweep to color the text.
SweepConfig

Configuration for the Sweep effect.
SweepIterator

Iterator for the Sweep effect.

Sweep

Bases: BaseEffect[SweepConfig]

Sweep across the canvas to reveal uncolored text, reverse sweep to color the text.

Source code in terminaltexteffects/effects/effect_sweep.py 
212
213
214
215
216
217
218
219
220
221
class Sweep(BaseEffect[SweepConfig]):
    """Sweep across the canvas to reveal uncolored text, reverse sweep to color the text."""

    @property
    def _config_cls(self) -> type[SweepConfig]:
        return SweepConfig

    @property
    def _iterator_cls(self) -> type[SweepIterator]:
        return SweepIterator

SweepConfig dataclass

Bases: BaseConfig

Sweep effect configuration dataclass.

Source code in terminaltexteffects/effects/effect_sweep.py 
 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
@dataclass
class SweepConfig(BaseConfig):
    """Sweep effect configuration dataclass."""

    parser_spec: ParserSpec = ParserSpec(
        name="sweep",
        help="Sweep across the canvas to reveal uncolored text, reverse sweep to color the text.",
        description="sweep | Sweep across the canvas to reveal uncolored text, reverse sweep to color the text.",
        epilog=(
            f"{argutils.EASING_EPILOG}Example: terminaltexteffects sweep --sweep-symbols '█' '▓' '▒' '░' "
            "--first-sweep-direction "
            "column_right_to_left --second-sweep-direction column_left_to_right --final-gradient-stops 8A008A "
            "00D1FF ffffff --final-gradient-steps 8 8 8 --final-gradient-direction vertical"
        ),
    )

    sweep_symbols: tuple[str, ...] = ArgSpec(
        name="--sweep-symbols",
        type=argutils.Symbol.type_parser,
        nargs="+",
        action=argutils.TupleAction,
        default=("█", "▓", "▒", "░"),
        metavar=argutils.Symbol.METAVAR,
        help="Space separated list of symbols to use for the sweep shimmer.",
    )  # pyright: ignore[reportAssignmentType]
    "tuple[str, ...] | str : Tuple of symbols to use for the sweep shimmer."

    first_sweep_direction: CharacterGroup = ArgSpec(
        name="--first-sweep-direction",
        default=CharacterGroup.COLUMN_RIGHT_TO_LEFT,
        type=argutils.CharacterGroupArg.type_parser,
        help="Direction of the first sweep, revealing uncolored characters.",
    )  # pyright: ignore[reportAssignmentType]
    "CharacterGroup : Direction of the first sweep, revealing uncolored characters."

    second_sweep_direction: CharacterGroup = ArgSpec(
        name="--second-sweep-direction",
        default=CharacterGroup.COLUMN_LEFT_TO_RIGHT,
        type=argutils.CharacterGroupArg.type_parser,
        help="Direction of the second sweep, coloring the characters.",
    )  # pyright: ignore[reportAssignmentType]
    "CharacterGroup : Direction of the second sweep, coloring the characters."

    final_gradient_stops: tuple[tte.Color, ...] = ArgSpec(
        name="--final-gradient-stops",
        type=argutils.ColorArg.type_parser,
        nargs="+",
        action=argutils.TupleAction,
        default=(tte.Color("#8A008A"), tte.Color("#00D1FF"), tte.Color("#ffffff")),
        metavar=argutils.ColorArg.METAVAR,
        help="Space separated, unquoted, list of colors for the character gradient (applied from bottom to top). "
        "If only one color is provided, the characters will be displayed in that color.",
    )  # pyright: ignore[reportAssignmentType]
    "tuple[Color, ...]: Space separated, unquoted, list of colors for the character gradient "
    "(applied from bottom to top). If only one color is provided, the characters will be displayed in that color."

    final_gradient_steps: tuple[int, ...] | int = ArgSpec(
        name="--final-gradient-steps",
        type=argutils.PositiveInt.type_parser,
        nargs="+",
        action=argutils.TupleAction,
        default=8,
        metavar=argutils.PositiveInt.METAVAR,
        help="Space separated, unquoted, list of the number of gradient steps to use. More steps will create a "
        "smoother and longer gradient animation.",
    )  # pyright: ignore[reportAssignmentType]
    "tuple[int, ...] | int: Space separated, unquoted, list of the number of gradient steps to use. More steps will "
    "create a smoother and longer gradient animation."

    final_gradient_direction: tte.Gradient.Direction = ArgSpec(
        name="--final-gradient-direction",
        type=argutils.GradientDirection.type_parser,
        default=tte.Gradient.Direction.VERTICAL,
        metavar=argutils.GradientDirection.METAVAR,
        help="Direction of the final gradient.",
    )  # pyright: ignore[reportAssignmentType]
    "Gradient.Direction : Direction of the final gradient."

final_gradient_direction = ArgSpec(name='--final-gradient-direction', type=(argutils.GradientDirection.type_parser), default=(tte.Gradient.Direction.VERTICAL), metavar=(argutils.GradientDirection.METAVAR), help='Direction of the final gradient.') class-attribute instance-attribute

Gradient.Direction : Direction of the final gradient.

final_gradient_steps = ArgSpec(name='--final-gradient-steps', type=(argutils.PositiveInt.type_parser), nargs='+', action=(argutils.TupleAction), default=8, metavar=(argutils.PositiveInt.METAVAR), help='Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and longer gradient animation.') class-attribute instance-attribute

tuple[int, ...] | int: Space separated, unquoted, list of the number of gradient steps to use. More steps will

final_gradient_stops = ArgSpec(name='--final-gradient-stops', type=(argutils.ColorArg.type_parser), nargs='+', action=(argutils.TupleAction), default=(tte.Color('#8A008A'), tte.Color('#00D1FF'), tte.Color('#ffffff')), metavar=(argutils.ColorArg.METAVAR), help='Space separated, unquoted, list of colors for the character gradient (applied from bottom to top). If only one color is provided, the characters will be displayed in that color.') class-attribute instance-attribute

tuple[Color, ...]: Space separated, unquoted, list of colors for the character gradient

first_sweep_direction = ArgSpec(name='--first-sweep-direction', default=(CharacterGroup.COLUMN_RIGHT_TO_LEFT), type=(argutils.CharacterGroupArg.type_parser), help='Direction of the first sweep, revealing uncolored characters.') class-attribute instance-attribute

CharacterGroup : Direction of the first sweep, revealing uncolored characters.

second_sweep_direction = ArgSpec(name='--second-sweep-direction', default=(CharacterGroup.COLUMN_LEFT_TO_RIGHT), type=(argutils.CharacterGroupArg.type_parser), help='Direction of the second sweep, coloring the characters.') class-attribute instance-attribute

CharacterGroup : Direction of the second sweep, coloring the characters.

sweep_symbols = ArgSpec(name='--sweep-symbols', type=(argutils.Symbol.type_parser), nargs='+', action=(argutils.TupleAction), default=('█', '▓', '▒', '░'), metavar=(argutils.Symbol.METAVAR), help='Space separated list of symbols to use for the sweep shimmer.') class-attribute instance-attribute

tuple[str, ...] | str : Tuple of symbols to use for the sweep shimmer.

SweepIterator

Bases: BaseEffectIterator[SweepConfig]

Iterator for the sweep effect.

Source code in terminaltexteffects/effects/effect_sweep.py 
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
class SweepIterator(BaseEffectIterator[SweepConfig]):
    """Iterator for the sweep effect."""

    def __init__(self, effect: Sweep) -> None:
        """Initialize the effect iterator."""
        super().__init__(effect)
        self.character_final_color_map: dict[tte.EffectCharacter, tte.ColorPair] = {}
        self.complete = False
        self.phase = "first sweep"
        self.easer: tte.easing.SequenceEaser
        self.build()

    def build(self) -> None:
        """Build the effect."""
        final_fg_gradient = tte.Gradient(
            *self.config.final_gradient_stops,
            steps=self.config.final_gradient_steps,
        )
        final_gradient_mapping = final_fg_gradient.build_coordinate_color_mapping(
            self.terminal.canvas.text_bottom,
            self.terminal.canvas.text_top,
            self.terminal.canvas.text_left,
            self.terminal.canvas.text_right,
            self.config.final_gradient_direction,
        )
        shades_of_gray = [
            tte.Color("#A0A0A0"),
            tte.Color("#808080"),
            tte.Color("#404040"),
            tte.Color("#202020"),
            tte.Color("#101010"),
        ]

        for character in self.terminal.get_characters(inner_fill_chars=True, outer_fill_chars=True):
            if not character.is_fill_character:
                self.character_final_color_map[character] = tte.ColorPair(
                    fg=final_gradient_mapping[character.input_coord],
                )
            initial_sweep_scn = character.animation.new_scene(scene_id="initial_sweep")
            for char in self.config.sweep_symbols:
                initial_sweep_scn.add_frame(
                    char,
                    5,
                    colors=tte.ColorPair(fg=random.choice(shades_of_gray)),
                )
            initial_sweep_scn.add_frame(character.input_symbol, 1, colors=tte.ColorPair("#808080"))
            second_sweep_scn = character.animation.new_scene(scene_id="second_sweep")
            for char in self.config.sweep_symbols:
                second_sweep_scn.add_frame(
                    char,
                    5,
                    colors=tte.ColorPair(fg=random.choice(final_fg_gradient.spectrum)),
                )
            second_sweep_scn.add_frame(
                character.input_symbol,
                1,
                colors=tte.ColorPair(
                    fg=final_gradient_mapping[character.input_coord] if not character.is_fill_character else "000000",
                ),
            )

        self.groups_first_sweep = self.terminal.get_characters_grouped(
            self.config.first_sweep_direction,
            inner_fill_chars=True,
            outer_fill_chars=True,
        )
        self.easer = tte.easing.SequenceEaser(
            sequence=self.groups_first_sweep,
            easing_function=tte.easing.in_out_circ,
        )
        self.groups_second_sweep = self.terminal.get_characters_grouped(
            self.config.second_sweep_direction,
            inner_fill_chars=True,
            outer_fill_chars=True,
        )

    def __next__(self) -> str:
        """Return the next frame in the effect."""
        while self.active_characters or not self.complete:
            self.easer.step()
            group: list[tte.EffectCharacter]
            for group in self.easer.added:
                for character in group:
                    if self.phase == "first sweep":
                        self.terminal.set_character_visibility(character, is_visible=True)
                    character.animation.activate_scene(
                        "initial_sweep" if self.phase == "first sweep" else "second_sweep",
                    )
                self.active_characters.update(group)
            if self.easer.is_complete() and self.phase == "first sweep":
                self.easer.sequence = self.groups_second_sweep
                self.easer.reset()
                self.phase = "second sweep"
            elif self.easer.is_complete() and self.phase == "second sweep":
                self.complete = True
            self.update()
            return self.frame
        raise StopIteration

__init__(effect)

Initialize the effect iterator.

Source code in terminaltexteffects/effects/effect_sweep.py 
115
116
117
118
119
120
121
122
def __init__(self, effect: Sweep) -> None:
    """Initialize the effect iterator."""
    super().__init__(effect)
    self.character_final_color_map: dict[tte.EffectCharacter, tte.ColorPair] = {}
    self.complete = False
    self.phase = "first sweep"
    self.easer: tte.easing.SequenceEaser
    self.build()

__next__()

Return the next frame in the effect.

Source code in terminaltexteffects/effects/effect_sweep.py 
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
def __next__(self) -> str:
    """Return the next frame in the effect."""
    while self.active_characters or not self.complete:
        self.easer.step()
        group: list[tte.EffectCharacter]
        for group in self.easer.added:
            for character in group:
                if self.phase == "first sweep":
                    self.terminal.set_character_visibility(character, is_visible=True)
                character.animation.activate_scene(
                    "initial_sweep" if self.phase == "first sweep" else "second_sweep",
                )
            self.active_characters.update(group)
        if self.easer.is_complete() and self.phase == "first sweep":
            self.easer.sequence = self.groups_second_sweep
            self.easer.reset()
            self.phase = "second sweep"
        elif self.easer.is_complete() and self.phase == "second sweep":
            self.complete = True
        self.update()
        return self.frame
    raise StopIteration

build()

Build the effect.

Source code in terminaltexteffects/effects/effect_sweep.py 
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
def build(self) -> None:
    """Build the effect."""
    final_fg_gradient = tte.Gradient(
        *self.config.final_gradient_stops,
        steps=self.config.final_gradient_steps,
    )
    final_gradient_mapping = final_fg_gradient.build_coordinate_color_mapping(
        self.terminal.canvas.text_bottom,
        self.terminal.canvas.text_top,
        self.terminal.canvas.text_left,
        self.terminal.canvas.text_right,
        self.config.final_gradient_direction,
    )
    shades_of_gray = [
        tte.Color("#A0A0A0"),
        tte.Color("#808080"),
        tte.Color("#404040"),
        tte.Color("#202020"),
        tte.Color("#101010"),
    ]

    for character in self.terminal.get_characters(inner_fill_chars=True, outer_fill_chars=True):
        if not character.is_fill_character:
            self.character_final_color_map[character] = tte.ColorPair(
                fg=final_gradient_mapping[character.input_coord],
            )
        initial_sweep_scn = character.animation.new_scene(scene_id="initial_sweep")
        for char in self.config.sweep_symbols:
            initial_sweep_scn.add_frame(
                char,
                5,
                colors=tte.ColorPair(fg=random.choice(shades_of_gray)),
            )
        initial_sweep_scn.add_frame(character.input_symbol, 1, colors=tte.ColorPair("#808080"))
        second_sweep_scn = character.animation.new_scene(scene_id="second_sweep")
        for char in self.config.sweep_symbols:
            second_sweep_scn.add_frame(
                char,
                5,
                colors=tte.ColorPair(fg=random.choice(final_fg_gradient.spectrum)),
            )
        second_sweep_scn.add_frame(
            character.input_symbol,
            1,
            colors=tte.ColorPair(
                fg=final_gradient_mapping[character.input_coord] if not character.is_fill_character else "000000",
            ),
        )

    self.groups_first_sweep = self.terminal.get_characters_grouped(
        self.config.first_sweep_direction,
        inner_fill_chars=True,
        outer_fill_chars=True,
    )
    self.easer = tte.easing.SequenceEaser(
        sequence=self.groups_first_sweep,
        easing_function=tte.easing.in_out_circ,
    )
    self.groups_second_sweep = self.terminal.get_characters_grouped(
        self.config.second_sweep_direction,
        inner_fill_chars=True,
        outer_fill_chars=True,
    )

get_effect_resources()

Get the command, effect class, and configuration class for the effect.

Returns:

Type Description
tuple[str, type[BaseEffect], type[BaseConfig]]

tuple[str, type[BaseEffect], type[BaseConfig]]: The command name, effect class, and configuration class.
Source code in terminaltexteffects/effects/effect_sweep.py 
23
24
25
26
27
28
29
30
def get_effect_resources() -> tuple[str, type[BaseEffect], type[BaseConfig]]:
    """Get the command, effect class, and configuration class for the effect.

    Returns:
        tuple[str, type[BaseEffect], type[BaseConfig]]: The command name, effect class, and configuration class.

    """
    return "sweep", Sweep, SweepConfig