emoji.py 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. import sys
  2. from typing import TYPE_CHECKING, Literal, Optional, Union
  3. from ._emoji_replace import _emoji_replace
  4. from .jupyter import JupyterMixin
  5. from .segment import Segment
  6. from .style import Style
  7. if TYPE_CHECKING:
  8. from .console import Console, ConsoleOptions, RenderResult
  9. EmojiVariant = Literal["emoji", "text"]
  10. class NoEmoji(Exception):
  11. """No emoji by that name."""
  12. class Emoji(JupyterMixin):
  13. __slots__ = ["name", "style", "_char", "variant"]
  14. VARIANTS = {"text": "\ufe0e", "emoji": "\ufe0f"}
  15. def __init__(
  16. self,
  17. name: str,
  18. style: Union[str, Style] = "none",
  19. variant: Optional[EmojiVariant] = None,
  20. ) -> None:
  21. """A single emoji character.
  22. Args:
  23. name (str): Name of emoji.
  24. style (Union[str, Style], optional): Optional style. Defaults to None.
  25. Raises:
  26. NoEmoji: If the emoji doesn't exist.
  27. """
  28. from ._emoji_codes import EMOJI
  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. from ._emoji_codes import EMOJI
  61. columns = Columns(
  62. (f":{name}: {name}" for name in sorted(EMOJI.keys()) if "\u200d" not in name),
  63. column_first=True,
  64. )
  65. console.print(columns)
  66. if len(sys.argv) > 1:
  67. console.save_html(sys.argv[1])