Emojis LibraryΒΆ

This part of the documentation covers all Emojis library functions.

Sample CodeΒΆ

>>> import emojis

>>> emojis.encode('This is a message with emojis :smile: :snake:')
'This is a message with emojis πŸ˜„ 🐍'

>>> emojis.decode('This is a message with emojis πŸ˜„ 🐍')
'This is a message with emojis :smile: :snake:'

>>> emojis.get('Prefix πŸ˜„ 🐍 πŸ˜„ 🐍 Sufix')
{'πŸ˜„', '🐍'}

>>> emojis.count('πŸ˜„ 🐍 πŸ˜„ 🐍')
4

>>> emojis.count('πŸ˜„ 🐍 πŸ˜„ 🐍', unique=True)
2

>>> emojis.db.get_emoji_by_alias('snake')
Emoji(aliases=['snake'], emoji='🐍', tags=[], category='Animals & Nature', unicode_version='6.0')

>>> emojis.db.get_categories()
{'Activities', 'Travel & Places', 'Smileys & Emotion', 'Symbols', 'Food & Drink', 'Animals & Nature', 'People & Body', 'Objects', 'Flags'}

Main FunctionsΒΆ

emojis.encode(msg)ΒΆ

Encode Emoji aliases into unicode Emoji values.

Parameters:msg – String to encode.
Return type:str

Usage:

>>> import emojis
>>> emojis.encode('This is a message with emojis :smile: :snake:')
'This is a message with emojis πŸ˜„ 🐍'
emojis.decode(msg)ΒΆ

Decode unicode Emoji values into Emoji aliases.

Parameters:msg – String to decode.
Return type:str

Usage:

>>> import emojis
>>> emojis.decode('This is a message with emojis πŸ˜„ 🐍')
'This is a message with emojis :smile: :snake:'
emojis.get(msg)ΒΆ

Returns unique Emojis in the given string.

Parameters:msg – String to search for Emojis.
Return type:set
emojis.iter(msg)ΒΆ

Iterates over all Emojis found in the message.

Parameters:msg – String to search for Emojis.
Return type:iterator
emojis.count(msg, unique=False)ΒΆ

Returns Emoji count in the given string.

Parameters:
  • msg – String to search for Emojis.
  • unique – (optional) Boolean, return unique values only.
Return type:

int

Database FunctionsΒΆ

emojis.db.get_emoji_aliases()ΒΆ

Returns all Emojis as a dict (key = alias, value = unicode).

Return type:dict
emojis.db.get_emoji_by_code(code)ΒΆ

Returns Emoji by Unicode code.

Parameters:code – Emoji Unicode code.
Return type:emojis.db.Emoji
emojis.db.get_emoji_by_alias(alias)ΒΆ

Returns Emoji by alias.

Parameters:alias – Emoji alias.
Return type:emojis.db.Emoji
emojis.db.get_emojis_by_tag(tag)ΒΆ

Returns all Emojis from selected tag.

Parameters:tag – Tag name to filter (case-insensitive).
Return type:iter
emojis.db.get_emojis_by_category(category)ΒΆ

Returns all Emojis from selected category.

Parameters:tag – Category name to filter (case-insensitive).
Return type:iter
emojis.db.get_tags()ΒΆ

Returns all tags available.

Return type:set
emojis.db.get_categories()ΒΆ

Returns all categories available.

Return type:set