Emoji for Python

Warnings

• breaking Version 2.0.0 introduced breaking changes concerning non-English short codes. The names of emoji in non-English languages were updated to Unicode CLDR version 41, meaning some previously stored non-English :short-code-emoji: might no longer work or be ignored by `emojize()`.
  Fix: Review and update any stored or generated non-English emoji shortcodes according to the new Unicode CLDR version 41 definitions. Test `emojize()` behavior with affected languages.
• breaking The `get_emoji_regexp()` function was removed in version 2.0.0. The internal mechanism for scanning emojis no longer relies on regular expressions due to performance and accuracy issues with complex Unicode emoji sequences.
  Fix: If you used `get_emoji_regexp()` for removing emojis, switch to `replace_emoji()`. For extracting emojis, use `emoji.emoji_list()` or `emoji.analyze()` as replacements.
• breaking Support for Python 2.7, 3.4, and 3.5 was removed in version 2.5.0. The library now requires Python 3.8 or newer.
  Fix: Upgrade your Python environment to version 3.8 or newer. If stuck on older Python versions, use `emoji` v2.4.0 or earlier (e.g., `pip install 'emoji<2.5.0'`).
• gotcha Inconsistent emoji rendering across platforms and terminals. Emojis are Unicode characters, but their visual representation depends on the font support and rendering capabilities of the environment where the Python script is run.
  Fix: Ensure your terminal, operating system, and fonts support the specific Unicode emoji versions you are using. Test your output in target environments. This is often outside the library's direct control.
• gotcha Potential `UnicodeEncodeError` when handling emoji. This often occurs when text containing emojis is processed or written to a file/output stream using an encoding that does not support the full range of Unicode characters, such as ASCII instead of UTF-8.
  Fix: Always explicitly use 'utf-8' encoding when opening files, communicating with databases, or handling HTTP requests/responses that might contain emojis. For example, `open('file.txt', 'w', encoding='utf-8')`.
• gotcha Aliases (`language='alias'`) for `emojize()` and `demojize()` are specific to English. Using `language='alias'` with other languages might not produce expected results or could lead to warnings in older versions.
  Fix: When working with non-English languages, rely on the official CLDR shortcodes for those languages. Avoid mixing `language='alias'` with non-English `language` settings. Load specific language configurations as needed, e.g., `emoji.config.load_language('es')`.

Install

• pip install emoji Install latest version

Imports

• emoji

  import emoji

• emojize

  import emoji
  text_with_emoji = emoji.emojize('Python is :thumbs_up:')

  While 'from emoji import emojize' works, the common and recommended pattern for this library is to import the module itself and call functions as `emoji.emojize()` to avoid potential name collisions and align with documentation examples.
• demojize

  import emoji
  text_with_shortcodes = emoji.demojize('Python is 👍')

  See note for `emojize`.
• analyze

  import emoji
  emoji_data = list(emoji.analyze('Python is 👍'))

• replace_emoji

  import emoji
  clean_text = emoji.replace_emoji('Python is 👍', replace='')

Quickstart

The quickstart demonstrates the primary functions: `emojize` for converting text shortcodes to Unicode emojis, `demojize` for converting Unicode emojis back to shortcodes, `analyze` for extracting emoji information, and `replace_emoji` for substituting emojis with other strings.

import emoji

# Convert shortcodes to emoji
emojified_text = emoji.emojize('Python is fun :red_heart: :snake:')
print(f"Emojified: {emojified_text}")

# Convert emoji to shortcodes
demojified_text = emoji.demojize('Python is fun ❤️🐍')
print(f"Demojified: {demojified_text}")

# Analyze text for emojis
emojis_found = list(emoji.analyze('Hello 👋 world 🌍'))
print(f"Emojis found: {emojis_found}")

# Replace emojis with a custom string
text_without_emojis = emoji.replace_emoji('Hello 👋 world 🌍', replace='[emoji]')
print(f"Text without emojis: {text_without_emojis}")