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
|
"""Pytest fixtures and constants for terminaltexteffects package."""
from __future__ import annotations
from typing import TYPE_CHECKING, Any, Literal
import pytest
from terminaltexteffects.effects import (
effect_beams,
effect_binarypath,
effect_blackhole,
effect_bouncyballs,
effect_bubbles,
effect_burn,
effect_colorshift,
effect_crumble,
effect_decrypt,
effect_errorcorrect,
effect_expand,
effect_fireworks,
effect_highlight,
effect_laseretch,
effect_matrix,
effect_middleout,
effect_orbittingvolley,
effect_overflow,
effect_pour,
effect_print,
effect_rain,
effect_random_sequence,
effect_rings,
effect_scattered,
effect_slice,
effect_slide,
effect_smoke,
effect_spotlights,
effect_spray,
effect_swarm,
effect_sweep,
effect_synthgrid,
effect_thunderstorm,
effect_unstable,
effect_vhstape,
effect_waves,
effect_wipe,
)
from terminaltexteffects.engine.terminal import TerminalConfig
from terminaltexteffects.utils import geometry
from terminaltexteffects.utils.argutils import CharacterGroup
from terminaltexteffects.utils.easing import (
EasingFunction,
in_back,
in_bounce,
in_circ,
in_cubic,
in_elastic,
in_expo,
in_out_back,
in_out_bounce,
in_out_circ,
in_out_cubic,
in_out_elastic,
in_out_expo,
in_out_quad,
in_out_quart,
in_out_quint,
in_out_sine,
in_quad,
in_quart,
in_quint,
in_sine,
out_back,
out_bounce,
out_circ,
out_cubic,
out_elastic,
out_expo,
out_quad,
out_quart,
out_quint,
out_sine,
)
from terminaltexteffects.utils.graphics import Color, Gradient
if TYPE_CHECKING:
from collections.abc import Generator
from terminaltexteffects.engine.base_effect import BaseEffect
INPUT_EMPTY = ""
INPUT_SINGLE_CHAR = "a"
INPUT_SINGLE_COLUMN = """
a
b
c
d
e
f"""
INPUT_SINGLE_ROW = "abcdefg"
INPUT_LARGE = """
0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ
123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0
23456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01
3456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ012
456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123
56789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234
6789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ012345
789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456
89abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567
9abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ012345678
"""
INPUT_MEDIUM = """
0123456789abcdefg
123456789abcdefgh
23456789abcdefghi
3456789abcdefghij
456789abcdefghijk"""
INPUT_TABS = """Tabs\tTabs\t\tTabs\t\t\tTabs"""
CANVAS_TEST_INPUT = """TL!!!!!!!!!!!!!!!!!!!!!TOP*********************TR
+ <----50----> #
+ | #
+ | #
L ^ | R
E | | I
F MID 13 | CENTER MID G
T | | H
- v | T
- | @
- | @
- | @
BL--------------------BOTTOM...................BR"""
COLOR_SEQUENCES = (
"\x1b[38;5;231m....\x1b[39m....| \x1b[38;5;95m\x1b[48;5;128mggggggg\x1b[0m \x1b[38;5;180mggggggg "
"\x1b[38;5;146m:gggggg; \x1b[38;5;64mggggggg \x1b[38;5;182mggggggg \x1b[38;5;195m:gggggg; "
"\x1b[38;5;214mggggggg \x1b[38;5;146m;gggggg \x1b[38;5;174mggggggg \x1b[0m"
)
TEST_INPUTS = {
"empty": INPUT_EMPTY,
"single_char": INPUT_SINGLE_CHAR,
"single_column": INPUT_SINGLE_COLUMN,
"single_row": INPUT_SINGLE_ROW,
"medium": INPUT_MEDIUM,
"tabs": INPUT_TABS,
"large": INPUT_LARGE,
"canvas": CANVAS_TEST_INPUT,
"color_sequences": COLOR_SEQUENCES,
}
EFFECTS = [
effect_beams.Beams,
effect_binarypath.BinaryPath,
effect_blackhole.Blackhole,
effect_bouncyballs.BouncyBalls,
effect_bubbles.Bubbles,
effect_burn.Burn,
effect_colorshift.ColorShift,
effect_crumble.Crumble,
effect_decrypt.Decrypt,
effect_errorcorrect.ErrorCorrect,
effect_expand.Expand,
effect_fireworks.Fireworks,
effect_highlight.Highlight,
effect_laseretch.LaserEtch,
effect_matrix.Matrix,
effect_middleout.MiddleOut,
effect_orbittingvolley.OrbittingVolley,
effect_overflow.Overflow,
effect_pour.Pour,
effect_print.Print,
effect_rain.Rain,
effect_random_sequence.RandomSequence,
effect_rings.Rings,
effect_scattered.Scattered,
effect_slice.Slice,
effect_slide.Slide,
effect_smoke.Smoke,
effect_spotlights.Spotlights,
effect_spray.Spray,
effect_thunderstorm.Thunderstorm,
effect_swarm.Swarm,
effect_sweep.Sweep,
effect_synthgrid.SynthGrid,
effect_unstable.Unstable,
effect_vhstape.VHSTape,
effect_waves.Waves,
effect_wipe.Wipe,
]
EASING_FUNCTIONS = [
in_sine,
out_sine,
in_out_sine,
in_quad,
out_quad,
in_out_quad,
in_cubic,
out_cubic,
in_out_cubic,
in_quart,
out_quart,
in_out_quart,
in_quint,
out_quint,
in_out_quint,
in_expo,
out_expo,
in_out_expo,
in_circ,
out_circ,
in_out_circ,
in_elastic,
out_elastic,
in_out_elastic,
in_back,
out_back,
in_out_back,
in_bounce,
out_bounce,
in_out_bounce,
]
ANCHORS = ["sw", "s", "se", "e", "ne", "n", "nw", "w", "c"]
@pytest.fixture(autouse=True)
def clear_lru_cache() -> Generator[None, Any, None]:
"""Fixture to clear the LRU caches for geometry functions."""
yield
geometry.find_coords_on_circle.cache_clear() # type: ignore[attr-defined]
geometry.find_coords_in_circle.cache_clear() # type: ignore[attr-defined]
geometry.find_coords_in_rect.cache_clear() # type: ignore[attr-defined]
geometry.extrapolate_along_ray.cache_clear() # type: ignore[attr-defined]
geometry.find_coord_on_bezier_curve.cache_clear() # type: ignore[attr-defined]
geometry.find_coord_on_line.cache_clear() # type: ignore[attr-defined]
geometry.find_length_of_bezier_curve.cache_clear() # type: ignore[attr-defined]
geometry.find_length_of_line.cache_clear() # type: ignore[attr-defined]
geometry.find_normalized_distance_from_center.cache_clear() # type: ignore[attr-defined]
@pytest.fixture
def input_data(request: pytest.FixtureRequest) -> str:
"""Fixture to provide input data for tests."""
return TEST_INPUTS[request.param]
@pytest.fixture(params=EFFECTS)
def effect(request: pytest.FixtureRequest) -> BaseEffect:
"""Fixture to provide effect instances for tests."""
return request.param
@pytest.fixture(params=EASING_FUNCTIONS)
def easing_function_1(request: pytest.FixtureRequest) -> EasingFunction:
"""Fixture to provide the first easing function for tests."""
return request.param
@pytest.fixture(params=EASING_FUNCTIONS)
def easing_function_2(request: pytest.FixtureRequest) -> EasingFunction:
"""Fixture to provide the second easing function for tests."""
return request.param
@pytest.fixture(params=[True, False])
def no_color(request: pytest.FixtureRequest) -> bool:
"""Fixture to provide a boolean indicating whether to disable color."""
return request.param
@pytest.fixture(params=[True, False])
def xterm_colors(request: pytest.FixtureRequest) -> bool:
"""Fixture to provide a boolean indicating whether to use xterm colors."""
return request.param
@pytest.fixture(params=ANCHORS)
def canvas_anchor(request: pytest.FixtureRequest) -> str:
"""Fixture to provide canvas anchor positions for tests."""
return request.param
@pytest.fixture(params=ANCHORS)
def text_anchor(request: pytest.FixtureRequest) -> str:
"""Fixture to provide text anchor positions for tests."""
return request.param
@pytest.fixture(params=[(60, 30), (25, 8)], ids=["60x30", "25x8"])
def canvas_dimensions(request: pytest.FixtureRequest) -> tuple[int, int]:
"""Fixture to provide canvas dimensions for tests."""
return request.param
@pytest.fixture
def terminal_config_with_color_options(xterm_colors: bool, no_color: bool) -> TerminalConfig: # noqa: FBT001
"""Fixture to provide terminal configuration with color options."""
terminal_config = TerminalConfig._build_config()
terminal_config.xterm_colors = xterm_colors
terminal_config.no_color = no_color
terminal_config.frame_rate = 0
return terminal_config
@pytest.fixture
def terminal_config_default_no_framerate() -> TerminalConfig:
"""Fixture to provide terminal configuration with default settings and no frame rate."""
terminal_config = TerminalConfig._build_config()
terminal_config.frame_rate = 0
return terminal_config
@pytest.fixture
def terminal_config_with_anchoring(
canvas_dimensions: tuple[int, int],
canvas_anchor: Literal["sw", "s", "se", "e", "ne", "n", "nw", "w", "c"],
text_anchor: Literal["sw", "s", "se", "e", "ne", "n", "nw", "w", "c"],
) -> TerminalConfig:
"""Fixture to provide terminal configuration with anchoring options."""
terminal_config = TerminalConfig._build_config()
terminal_config.frame_rate = 0
terminal_config.canvas_width = canvas_dimensions[0]
terminal_config.canvas_height = canvas_dimensions[1]
terminal_config.anchor_canvas = canvas_anchor
terminal_config.anchor_text = text_anchor
return terminal_config
@pytest.fixture(params=[(Color("#000000"), Color("#ff00ff"), Color("#0ffff0")), (Color("#ff0fff"),)])
def gradient_stops(request: pytest.FixtureRequest) -> tuple[Color, ...]:
"""Fixture to provide gradient stops for tests."""
return request.param
@pytest.fixture(params=[(1,), (4,), (1, 3)])
def gradient_steps(request: pytest.FixtureRequest) -> tuple[int, ...]:
"""Fixture to provide gradient steps for tests."""
return request.param
@pytest.fixture(params=[1, 4])
def gradient_frames(request: pytest.FixtureRequest) -> int:
"""Fixture to provide gradient frames for tests."""
return request.param
@pytest.fixture(
params=[
Gradient.Direction.DIAGONAL,
Gradient.Direction.HORIZONTAL,
Gradient.Direction.VERTICAL,
Gradient.Direction.RADIAL,
],
)
def gradient_direction(request: pytest.FixtureRequest) -> Gradient.Direction:
"""Fixture to provide gradient direction for tests."""
return request.param
@pytest.fixture(params=[True, False])
def bool_arg(request: pytest.FixtureRequest) -> bool:
"""Fixture to provide boolean arguments for tests."""
return request.param
@pytest.fixture(params=list(CharacterGroup))
def character_group(request: pytest.FixtureRequest) -> CharacterGroup:
"""Fixture to provide CharacterGroup arguments for tests."""
return request.param
|