You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

92 line
2.3 KiB

  1. import sys
  2. from typing import TYPE_CHECKING, Optional, Union, Literal
  3. from .jupyter import JupyterMixin
  4. from .segment import Segment
  5. from .style import Style
  6. from ._emoji_codes import EMOJI
  7. from ._emoji_replace import _emoji_replace
  8. if TYPE_CHECKING:
  9. from .console import Console, ConsoleOptions, RenderResult
  10. EmojiVariant = Literal["emoji", "text"]
  11. class NoEmoji(Exception):
  12. """No emoji by that name."""
  13. class Emoji(JupyterMixin):
  14. __slots__ = ["name", "style", "_char", "variant"]
  15. VARIANTS = {"text": "\uFE0E", "emoji": "\uFE0F"}
  16. def __init__(
  17. self,
  18. name: str,
  19. style: Union[str, Style] = "none",
  20. variant: Optional[EmojiVariant] = None,
  21. ) -> None:
  22. """A single emoji character.
  23. Args:
  24. name (str): Name of emoji.
  25. style (Union[str, Style], optional): Optional style. Defaults to None.
  26. Raises:
  27. NoEmoji: If the emoji doesn't exist.
  28. """
  29. self.name = name
  30. self.style = style
  31. self.variant = variant
  32. try:
  33. self._char = EMOJI[name]
  34. except KeyError:
  35. raise NoEmoji(f"No emoji called {name!r}")
  36. if variant is not None:
  37. self._char += self.VARIANTS.get(variant, "")
  38. @classmethod
  39. def replace(cls, text: str) -> str:
  40. """Replace emoji markup with corresponding unicode characters.
  41. Args:
  42. text (str): A string with emojis codes, e.g. "Hello :smiley:!"
  43. Returns:
  44. str: A string with emoji codes replaces with actual emoji.
  45. """
  46. return _emoji_replace(text)
  47. def __repr__(self) -> str:
  48. return f"<emoji {self.name!r}>"
  49. def __str__(self) -> str:
  50. return self._char
  51. def __rich_console__(
  52. self, console: "Console", options: "ConsoleOptions"
  53. ) -> "RenderResult":
  54. yield Segment(self._char, console.get_style(self.style))
  55. if __name__ == "__main__": # pragma: no cover
  56. import sys
  57. from rich.columns import Columns
  58. from rich.console import Console
  59. console = Console(record=True)
  60. columns = Columns(
  61. (f":{name}: {name}" for name in sorted(EMOJI.keys()) if "\u200D" not in name),
  62. column_first=True,
  63. )
  64. console.print(columns)
  65. if len(sys.argv) > 1:
  66. console.save_html(sys.argv[1])