emojiΒΆ

Release v2.11.1. (Installation)

emoji supports Python 3.6+. The last version to support Python 2.7 and 3.5 was v2.4.0.

Usage and ExamplesΒΆ

The main purpose of this package is converting Unicode emoji to emoji names and vice versa with emojize() and demojize().

The entire set of Emoji codes as defined by the Unicode consortium is supported in addition to a bunch of aliases. By default, only the official list is enabled but doing emoji.emojize(language='alias') enables both the full list and aliases.

>>> print(emoji.emojize('Python is :thumbs_up:'))
Python is πŸ‘
>>> print(emoji.emojize('Python is :thumbsup:', language='alias'))
Python is πŸ‘
>>> print(emoji.demojize('Python is πŸ‘'))
Python is :thumbs_up:
>>> print(emoji.emojize("Python is fun :red_heart:", variant="text_type"))
Python is fun ❀︎
>>> print(emoji.emojize("Python is fun :red_heart:", variant="emoji_type"))
Python is fun ❀️

LanguagesΒΆ

By default, the language is English (language='en') but also supported languages are:

Spanish ('es'), Portuguese ('pt'), Italian ('it'), French ('fr'), German ('de'), Farsi/Persian ('fa')

>>> print(emoji.emojize('Python es :pulgar_hacia_arriba:', language='es'))
Python es πŸ‘
>>> print(emoji.demojize('Python es πŸ‘', language='es'))
Python es :pulgar_hacia_arriba:
>>> print(emoji.emojize("Python Γ© :polegar_para_cima:", language='pt'))
Python Γ© πŸ‘
>>> print(emoji.demojize("Python Γ© πŸ‘", language='pt'))
Python Γ© :polegar_para_cima:

Extracting emojiΒΆ

The function analyze() finds all emoji in string and yields the emoji together with its position and the available meta information about the emoji.

analyze() returns a generator that yields each emoji, so you need to iterate or convert the output to a list.

>>> first_token = next(emoji.analyze('Python is πŸ‘'))
Token(chars='πŸ‘', value=EmojiMatch(πŸ‘, 10:11))
>>> emoji_match = first_token.value
EmojiMatch(πŸ‘, 10:11)
>>> emoji_match.data
{'en': ':thumbs_up:', 'status': 2, 'E': 0.6, 'alias': [':thumbsup:', ':+1:'], 'variant': True, 'de': ':daumen_hoch:', 'es': ':pulgar_hacia_arriba:', 'fr': ':pouce_vers_le_haut:', 'ja': ':ァムズをップ:', 'ko': ':올린_엄지:', 'pt': ':polegar_para_cima:', 'it': ':pollice_in_su:', 'fa': ':ΩΎΨ³Ω†Ψ―ΫŒΨ―Ω†:', 'id': ':jempol_ke_atas:', 'zh': ':ζ‹‡ζŒ‡ε‘δΈŠ:'}
>>> list(emoji.analyze('A πŸ‘©β€πŸš€ aboard a πŸš€'))
[Token(chars='πŸ‘©\u200dπŸš€', value=EmojiMatch(πŸ‘©β€πŸš€, 2:5)), Token(chars='πŸš€', value=EmojiMatch(πŸš€, 15:16))]
>>> list(emoji.analyze('AπŸ‘©β€πŸš€BπŸš€', non_emoji=True))
[Token(chars='A', value='A'), Token(chars='πŸ‘©\u200dπŸš€', value=EmojiMatch(πŸ‘©β€πŸš€, 1:4)), Token(chars='B', value='B'), Token(chars='πŸš€', value=EmojiMatch(πŸš€, 5:6))]

The parameter join_emoji controls whether non-RGI emoji are handled as a single token or as multiple emoji:

>>> list(emoji.analyze('πŸ‘¨β€πŸ‘©πŸΏβ€πŸ‘§πŸ»β€πŸ‘¦πŸΎ', join_emoji=True))
[Token(chars='πŸ‘¨\u200dπŸ‘©πŸΏ\u200dπŸ‘§πŸ»\u200dπŸ‘¦πŸΎ', value=EmojiMatchZWJNonRGI(πŸ‘¨β€πŸ‘©πŸΏβ€πŸ‘§πŸ»β€πŸ‘¦πŸΎ, 0:10))]

>>> list(emoji.analyze('πŸ‘¨β€πŸ‘©πŸΏβ€πŸ‘§πŸ»β€πŸ‘¦πŸΎ', join_emoji=False))
[Token(chars='πŸ‘¨', value=EmojiMatch(πŸ‘¨, 0:1)), Token(chars='πŸ‘©πŸΏ', value=EmojiMatch(πŸ‘©πŸΏ, 2:4)), Token(chars='πŸ‘§πŸ»', value=EmojiMatch(πŸ‘§πŸ», 5:7)), Token(chars='πŸ‘¦πŸΎ', value=EmojiMatch(πŸ‘¦πŸΎ, 8:10))]

The function emoji_list() finds all emoji in string and their position. Keep in mind that an emoji can span over multiple characters:

>>> emoji.emoji_list('Python is πŸ‘')
[{'match_start': 10, 'match_end': 11, 'emoji': 'πŸ‘'}]
>>> emoji.emoji_list('A πŸ‘©β€πŸš€ aboard a πŸš€')
[{'match_start': 2, 'match_end': 5, 'emoji': 'πŸ‘©β€πŸš€'}, {'match_start': 15, 'match_end': 16, 'emoji': 'πŸš€'}]

To retrieve the distinct set of emoji from a string, use distinct_emoji_list():

>>> emoji.distinct_emoji_list('Some emoji: 🌍, πŸ˜‚, πŸ˜ƒ, πŸ˜‚, 🌍, 🌦️')
['πŸ˜ƒ', 'πŸ˜‚', '🌦️', '🌍']

To count the number of emoji in a string, use emoji_count():

>>> emoji.emoji_count('Some emoji: 🌍, πŸ˜‚, πŸ˜ƒ, πŸ˜‚, 🌍, 🌦️')
6
>>> emoji.emoji_count('Some emoji: 🌍, πŸ˜‚, πŸ˜ƒ, πŸ˜‚, 🌍, 🌦️', unique=True)
4

You can check if a string is a single, valid emoji with is_emoji()

>>> emoji.is_emoji('🌍')
True
>>> emoji.is_emoji('πŸŒπŸ˜‚')
False
>>> emoji.is_emoji('test')
False

While dealing with emojis, it is generally a bad idea to look at individual characters. Unicode contains modifier characters, such as variation selectors, which are not emojis themselves and modify the preceding emoji instead. You can check if a string has only emojis in it with purely_emoji()

>>> '\U0001f600\ufe0f'
'πŸ˜€'
>>> emoji.is_emoji('\U0001f600\ufe0f')
False
>>> emoji.is_emoji('\U0001f600')
True
>>> emoji.is_emoji('\ufe0f')
False
>>> emoji.purely_emoji('\U0001f600\ufe0f')
True

To get more information about an emoji, you can look it up in the EMOJI_DATA dict:

pprint(emoji.EMOJI_DATA['🌍'])

{'E': 0.7,
 'alias': [':earth_africa:'],
 'de': ':globus_mit_europa_und_afrika:',
 'en': ':globe_showing_Europe-Africa:',
 'es': ':globo_terrΓ‘queo_mostrando_europa_y_Γ‘frica:',
 'fr': ':globe_tournΓ©_sur_l’afrique_et_l’europe:',
 'it': ':europa_e_africa:',
 'pt': ':globo_mostrando_europa_e_Γ‘frica:',
 'status': 2,
 'variant': True}

'E' is the Emoji version.

'status' is defined in STATUS. For example 2 corresponds to 'fully_qualified'. More information on the meaning can be found in the Unicode Standard http://www.unicode.org/reports/tr51/#Emoji_Variation_Selector_Notes

Replacing and removing emojiΒΆ

With replace_emoji() you can replace, filter, escape or remove emoji in a string:

>>> emoji.replace_emoji('Python is πŸ‘', replace='')
'Python is '

>>> emoji.replace_emoji('Python is πŸ‘', replace='πŸ‘Ž')
'Python is πŸ‘Ž'

>>> def unicode_escape(chars, data_dict):
>>>     return chars.encode('unicode-escape').decode()
>>> emoji.replace_emoji('Python is πŸ‘', replace=unicode_escape)
'Python is \U0001f44d'

>>> def xml_escape(chars, data_dict):
>>>     return chars.encode('ascii', 'xmlcharrefreplace').decode()
>>> emoji.replace_emoji('Python is πŸ‘', replace=xml_escape)
'Python is 👍'

>>> emoji.replace_emoji('Python is πŸ‘', replace=lambda chars, data_dict: chars.encode('ascii', 'namereplace').decode())
'Python is \N{THUMBS UP SIGN}'

>>> emoji.replace_emoji('Python is πŸ‘', replace=lambda chars, data_dict: data_dict['es'])
'Python is :pulgar_hacia_arriba:'

Emoji versionsΒΆ

The parameter version in replace_emoji() allows to replace only emoji above that Emoji version to prevent incompatibility with older platforms.

For the functions emojize() and demojize() the parameter version will replace emoji above the specified version with the value of the parameter handle_version. It defaults to an empty string, but can be set to any string or a function that returns a string.

For example the :croissant: πŸ₯ emoji was added in Emoji 3.0 (Unicode 9.0) in 2016 and :T-Rex: πŸ¦– was added later in Emoji 5.0 (Unicode 10.0) in 2017:

>>> emoji.replace_emoji('A πŸ¦– is eating a πŸ₯', replace='[Unsupported emoji]', version=1.0)
'A [Unsupported emoji] is eating a [Unsupported emoji]'

>>> emoji.replace_emoji('A πŸ¦– is eating a πŸ₯', replace=lambda chars, data_dict: data_dict['en'], version=3.0)
'A :T-Rex: is eating a πŸ₯'

>>> emoji.emojize('A :T-Rex: is eating a :croissant:', version=3.0)
'A  is eating a πŸ₯'

>>> emoji.emojize('A :T-Rex: is eating a :croissant:', version=3.0, handle_version='[Unsupported emoji]')
'A [Unsupported emoji] is eating a πŸ₯'

>>> emoji.demojize('A πŸ¦– is eating a πŸ₯', version=3.0)
'A  is eating a :croissant:'

>>> emoji.replace_emoji('A πŸ¦– is eating a πŸ₯', replace='', version=5.0)
'A πŸ¦– is eating a πŸ₯'

You can find the version of an emoji with version():

>>> emoji.version('πŸ₯')
3
>>> emoji.version('πŸŒοΈβ€β™€οΈ')
4
>>> emoji.version('πŸ¦–')
5

Non-RGI ZWJ emojiΒΆ

Some emoji contain multiple persons and each person can have an individual skin tone.

Unicode supports Multi-Person Skin Tones as of Emoji 11.0. Skin tones can be add to the nine characters known as Multi-Person Groupings.

Multi-person groups with different skin tones can be represented with Unicode, but are not yet RGI (recommended for general interchange). This means Unicode.org recommends not to show them in emoji keyboards. However some browser and platforms already support some of them:

A family emoji πŸ‘¨β€πŸ‘©πŸΏβ€πŸ‘§πŸ»β€πŸ‘¦πŸΎ with four different skin tone values

The emoji πŸ‘¨β€πŸ‘©πŸΏβ€πŸ‘§πŸ»β€πŸ‘¦πŸΎ as it appears in Firefox on Windows 11ΒΆ

It consists of eleven Unicode characters, four person emoji, four different skin tones joined together by three \u200d Zero-Width Joiner:

  1. πŸ‘¨ :man:

  2. 🏽 :medium_skin_tone:

  3. \u200d

  4. πŸ‘© :woman:

  5. 🏿 :dark_skin_tone:

  6. \u200d

  7. πŸ‘§ :girl:

  8. 🏻 :light_skin_tone:

  9. \u200d

  10. πŸ‘¦ :boy:

  11. 🏾 :medium-dark_skin_tone:

On platforms that don’t support it, it might appear as separate emoji: πŸ‘¨πŸ½πŸ‘©πŸΏπŸ‘§πŸ»πŸ‘¦πŸΎ

In the module configuration config you can control how such emoji are handled.

Migrating to version 2.0.0ΒΆ

There a two major, breaking changes in version 2.0.0

non-English short codesΒΆ

The names of emoji in non-English languages have changed, because the data files were updated to the new version 41. See https://cldr.unicode.org/index/downloads.

That means some :short-code-emoji: with non-English names will no longer work in 2.0.0. emojize() will ignore the old codes.

This may be a problem if you have previously stored :short-code-emoji: with non-English names for example in a database or if your users have stored them.

Regular expressionΒΆ

The function get_emoji_regexp() was removed in 2.0.0. Internally the module no longer uses a regular expression when scanning for emoji in a string (e.g. in demojize()).

The regular expression was slow in Python 3 and it failed to correctly find certain combinations of long emoji (emoji consisting of multiple Unicode codepoints).

If you used the regular expression to remove emoji from strings, you can use replace_emoji() as shown in the examples above.

If you want to extract emoji from strings, you can use emoji_list() as a replacement.

If you want to keep using a regular expression despite its problems, you can create the expression yourself like this:

import re
import emoji

def get_emoji_regexp():
    # Sort emoji by length to make sure multi-character emojis are
    # matched first
    emojis = sorted(emoji.EMOJI_DATA, key=len, reverse=True)
    pattern = '(' + '|'.join(re.escape(u) for u in emojis) + ')'
    return re.compile(pattern)

exp = get_emoji_regexp()
print(exp.sub(repl='[emoji]', string='A πŸŒοΈβ€β™€οΈ is eating a πŸ₯'))

Output:

A [emoji] is eating a [emoji]

Common problemsΒΆ

UnicodeWarning: Unicode unequal comparison failed to convert both arguments to Unicode - interpreting them as being unequal

This exception is thrown in Python 2.7 if you passed a str string instead of a unicode string. You should only pass Unicode strings to this module.

See https://python.readthedocs.io/en/v2.7.2/howto/unicode.html#the-unicode-type for more information on Unicode in Python 2.7.

The API documentationΒΆ

Reference documentation of all functions and properties in the module:

API Reference

Functions:

emojize()

Replace emoji names with Unicode codes

demojize()

Replace Unicode emoji with emoji shortcodes

analyze()

Find Unicode emoji in a string

replace_emoji()

Replace Unicode emoji with a customizable string

emoji_list()

Location of all emoji in a string

distinct_emoji_list()

Distinct list of emojis in the string

emoji_count()

Number of emojis in a string

is_emoji()

Check if a string/character is a single emoji

purely_emoji()

Check if a string contains only emojis

version()

Find Unicode/Emoji version of an emoji

Module variables:

EMOJI_DATA

Dict of all emoji

STATUS

Dict of Unicode/Emoji status

config

Module wide configuration

Classes:

EmojiMatch

EmojiMatchZWJ

EmojiMatchZWJNonRGI

Token

Indices and tablesΒΆ