Emot: Emoji and Emoticon Detection

Common errors

• ImportError: cannot import name 'UNICODE_EMO' from 'emot.emo_unicode'

  cause Attempting to import internal module components directly which are not part of the public API or have been removed/renamed in newer versions.
  fix Avoid direct imports from internal modules. Use the top-level `emot` module and its documented methods, typically after initializing the `emot.core.emot()` object for versions 3.0 and above. Correct usage is `import emot`.

• TypeError: 'module' object is not callable (e.g., emot.emoji(text) fails)

  cause Attempting to call `emot.emoji()` or `emot.emoticons()` directly on the imported module in versions 3.0 and later.
  fix For `emot` v3.0+, you must first initialize an `emot` object: `emot_obj = emot.core.emot()`. Then, call the methods on this object: `emot_obj.emoji(text)`.

Warnings

• breaking The return type of `emoji()` and `emoticons()` methods changed significantly in v2.0. It shifted from a list of dictionaries to a single dictionary where keys (like 'value', 'location', 'mean') hold lists, and a new boolean 'flag' was introduced.
  Fix: Update your code to expect a dictionary output and access keys like `result['value']` instead of iterating over a list of dictionaries.
• breaking Starting from v3.0, `emot` requires explicit object instantiation via `emot.core.emot()`. Direct calls like `emot.emoji(text)` are no longer supported. Additionally, Python 2.x support was dropped, requiring Python 3.x.
  Fix: Change `import emot` to `emot_obj = emot.core.emot()` and then call methods using `emot_obj.emoji(text)`. Ensure your environment uses Python 3.x.
• gotcha Emojis with skin tone modifiers (e.g., 👨🏽) might be incorrectly parsed as two separate emojis (e.g., '👨' and ':medium_skin_tone:') leading to double-counting or unexpected results.
  Fix: Implement post-processing logic to filter out skin tone modifiers if they are not desired as individual detections. For example, check if the 'mean' field contains ':_skin_tone:' and remove such entries.

Install

• pip install emot --upgrade Install latest version

Imports

• emot
  wrong:

  from emot.emo_unicode import UNICODE_EMO, EMOTICONS

  correct:

  import emot

  Direct import from internal modules like `emo_unicode` is not part of the public API and can break between versions. Use the main `emot` module.

Quickstart

Initialize the `emot` object and then use its `emoji()` or `emoticons()` methods to detect and extract symbols from a given string. The methods return a dictionary containing lists for 'value', 'location', 'mean', and a 'flag' indicating presence.

import emot

# Initialize the emot object (required since v3.0)
emot_obj = emot.core.emot()

text_with_emojis = "I love python 👨 🙂 ❤️"
text_with_emoticons = "Hello there :-) :D"
text_without_emotions = "No emotions here."

# Detect emojis
result_emoji = emot_obj.emoji(text_with_emojis)
print("Emoji detection:", result_emoji)
# Expected output for v3.1: {'value': ['👨', '🙂', '❤'], 'location': [[14, 15], [16, 17], [18, 19]], 'mean': [':man:', ':slightly_smiling_face:', ':red_heart:'], 'flag': True}

# Detect emoticons
result_emoticon = emot_obj.emoticons(text_with_emoticons)
print("Emoticon detection:", result_emoticon)
# Expected output for v3.1: {'value': [':-)', ':D'], 'location': [[12, 15], [16, 18]], 'mean': ['Happy face smiley', 'Grinning face'], 'flag': True}

# Handle text without emotions
result_none = emot_obj.emoji(text_without_emotions)
print("No emotions detection:", result_none)
# Expected output for v3.1: {'value': [], 'location': [], 'mean': [], 'flag': False}