Coverage for src / puzzletree / cli / messages / warning.py: 100.00%

1"""CLI warning message panels.""" 

2 

3from rich.console import Console (empty)

4from rich.panel import Panel (empty)

5from rich.text import Text (empty)

6 

7from puzzletree.cli.messages.capability import supports_unicode_markdown (empty)

8 

9 

10def warning_panel(message: str, console: Console | None = None) -> Panel: (empty)

11 """Build a yellow Panel with title "Warning" (optionally with Unicode when supported). 

12 

13 The message body is always rendered as plain Text, not Markdown, so file paths, 

14 underscores, and special characters in user-provided warning messages are not 

15 interpreted as formatting. 

16 

17 Args: 

18 message: The warning message body. 

19 console: Rich Console; when supported, title may use Unicode (e.g. ⚠). 

20 Defaults to None. 

21 

22 Returns: 

23 A yellow-bordered Panel suitable for console.print(). 

24 

25 Examples: 

26 Panel (plain text; terminal uses yellow border):: 

27 

28 ╭─ Warning ─────────────────────────────╮ 

29 │ File already exists: /path/to/file │ 

30 │ Use --force to overwrite. │ 

31 ╰───────────────────────────────────────╯ 

32 """ 

33 use_unicode = supports_unicode_markdown(console) (empty)

34 title = "⚠ Warning" if use_unicode else "Warning" (empty)

35 body = Text(message, style="yellow") (empty)

36 return Panel(body, title=title, border_style="yellow") (empty)