pip._vendor.rich.emoji.Emoji Class Reference

Inheritance diagram for pip._vendor.rich.emoji.Emoji:

Collaboration diagram for pip._vendor.rich.emoji.Emoji:

Public Member Functions
None	__init__ (self, str name, Union[str, Style] style="none", Optional[EmojiVariant] variant=None)
str	replace (cls, str text)
str	__repr__ (self)
str	__str__ (self)
"RenderResult"	__rich_console__ (self, "Console" console, "ConsoleOptions" options)

Public Attributes
	name
	style
	variant

Static Public Attributes
dict	VARIANTS = {"text": "\uFE0E", "emoji": "\uFE0F"}

Protected Attributes
	_char

Additional Inherited Members
Protected Member Functions inherited from pip._vendor.rich.jupyter.JupyterMixin
Dict[str, str]	_repr_mimebundle_ ("ConsoleRenderable" self, Sequence[str] include, Sequence[str] exclude, **Any kwargs)

Constructor & Destructor Documentation

__init__()

None pip._vendor.rich.emoji.Emoji.__init__	(		self,
		str	name,
		Union[str, Style]	style = "none",
		Optional[EmojiVariant]	variant = None
	)

A single emoji character.

Args:
    name (str): Name of emoji.
    style (Union[str, Style], optional): Optional style. Defaults to None.

Raises:
    NoEmoji: If the emoji doesn't exist.

Member Function Documentation

replace()

str pip._vendor.rich.emoji.Emoji.replace	(		cls,
		str	text
	)

Replace emoji markup with corresponding unicode characters.

Args:
    text (str): A string with emojis codes, e.g. "Hello :smiley:!"

Returns:
    str: A string with emoji codes replaces with actual emoji.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/rich/emoji.py