unimoji 2.0.0
Accurately remove and replace emojis in text strings
License: Apache-2.0
Requires Python: >=3.8
Keywords: emoji, emojis, nlp, natural langauge processing, unicode, unicode-emoji

# unimoji

Accurately find or remove [emojis](https://en.wikipedia.org/wiki/Emoji) from a blob of text using
the latest data from the Unicode Consortium's [emoji code repository](https://unicode.org/Public/emoji/).

This library is based on the excellent work of [Brad Solomon](https://github.com/bsolomon1124/) and has been updated to support the latest Unicode emoji specifications with performance optimizations.

[![License](https://img.shields.io/github/license/pxawtyy/unimoji.svg)](https://github.com/pxawtyy/unimoji/blob/master/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/unimoji.svg)](https://pypi.org/project/unimoji/)
[![Status](https://img.shields.io/pypi/status/unimoji.svg)](https://pypi.org/project/unimoji/)
[![Python](https://img.shields.io/pypi/pyversions/unimoji.svg)](https://pypi.org/project/unimoji)

-------

## About

`unimoji` is an updated and optimized version of the original [demoji](https://github.com/bsolomon1124/demoji) library by Brad Solomon. This library provides enhanced Unicode emoji support with the latest emoji specifications and improved performance.

**Key improvements over demoji:**
- **Unicode 17.0 support** - Latest emoji specifications (5200+ emojis)
- **Performance optimizations** - Faster `replace_with_desc()` with O(n) complexity
- **Modern Python support** - Python 3.8+ with type hints
- **Reduced dependencies** - No external runtime dependencies
- **Maintained API compatibility** - Easy drop-in replacement

**Credits:** Special thanks to Brad Solomon for the original `demoji` library which serves as the foundation for this project.

## Installation

```bash
pip install unimoji
```

### Migrating from demoji

`unimoji` is a drop-in replacement for `demoji`. Simply replace your imports:

```python
# Old
import demoji

# New
import unimoji as demoji  # or
import unimoji
```

## Basic Usage

`unimoji` exports several text-related functions for find-and-replace functionality with emojis:

```python
>>> tweet = """\
... #startspreadingthenews yankees win great start by 🎅🏾 going 5strong innings with 5k’s🔥 🐂
... solo homerun 🌋🌋 with 2 solo homeruns and👹 3run homerun… 🤡 🚣🏼 👨🏽‍⚖️ with rbi’s … 🔥🔥
... 🇲🇽 and 🇳🇮 to close the game🔥🔥!!!….
... WHAT A GAME!!..
... """
>>> unimoji.findall(tweet)
{
    "🔥": "fire",
    "🌋": "volcano",
    "👨🏽\u200d⚖️": "man judge: medium skin tone",
    "🎅🏾": "Santa Claus: medium-dark skin tone",
    "🇲🇽": "flag: Mexico",
    "👹": "ogre",
    "🤡": "clown face",
    "🇳🇮": "flag: Nicaragua",
    "🚣🏼": "person rowing boat: medium-light skin tone",
    "🐂": "ox",
}
```

See [below](#reference) for function API.

## Command-line Use

You can use `unimoji` or `python -m unimoji` to replace emojis
in file(s) or stdin with their `:code:` equivalents:

```bash
$ cat out.txt
All done! ✨ 🍰 ✨
$ unimoji out.txt
All done! :sparkles: :shortcake: :sparkles:

$ echo 'All done! ✨ 🍰 ✨' | unimoji
All done! :sparkles: :shortcake: :sparkles:

$ unimoji -
we didnt start the 🔥
we didnt start the :fire:
```

## Reference

```python
findall(string: str) -> Dict[str, str]
```

Find emojis within `string`.  Return a mapping of `{emoji: description}`.

```python
findall_list(string: str, desc: bool = True) -> List[str]
```

Find emojis within `string`.  Return a list (with possible duplicates).

If `desc` is True, the list contains description codes.  If `desc` is False, the list contains emojis.

```python
replace(string: str, repl: str = "") -> str
```

Replace emojis in `string` with `repl`.

```python
replace_with_desc(string: str, sep: str = ":") -> str
```

Replace emojis in `string` with their description codes.  The codes are surrounded by `sep`.

```python
last_downloaded_timestamp() -> datetime.datetime
```

Show the timestamp of last download for the emoji data bundled with the package.

## Footnote: Emoji Sequences

Numerous emojis that look like single Unicode characters are actually multi-character sequences.  Examples:

- The keycap 2️⃣ is actually 3 characters, U+0032 (the ASCII digit 2), U+FE0F (variation selector), and U+20E3 (combining enclosing keycap).
- The flag of Scotland 7 component characters, `b'\\U0001f3f4\\U000e0067\\U000e0062\\U000e0073\\U000e0063\\U000e0074\\U000e007f'` in full esaped notation.

(You can see any of these through `s.encode("unicode-escape")`.)

`unimoji` is careful to handle this and should find the full sequences rather than their incomplete subcomponents.

The way it does this it to sort emoji codes by their length, and then compile a concatenated regular expression that will greedily search for longer emojis first, falling back to shorter ones if not found.  This is not by any means a super-optimized way of searching as it has O(N<sup>2</sup>) properties, but the focus is on accuracy and completeness.

```python
>>> from pprint import pprint
>>> seq = """\
... I bet you didn't know that 🙋, 🙋‍♂️, and 🙋‍♀️ are three different emojis.
... """
>>> pprint(seq.encode('unicode-escape'))  # Python 3
(b"I bet you didn't know that \\U0001f64b, \\U0001f64b\\u200d\\u2642\\ufe0f,"
 b' and \\U0001f64b\\u200d\\u2640\\ufe0f are three different emojis.\\n')
```