Typing Stubs for Emoji

2.1.0.3 · active · verified Tue Apr 14

`types-emoji` provides static type checking definitions for the popular `emoji` Python library. It enables type checkers like MyPy to understand the types used in `emoji.emojize()`, `emoji.demojize()`, and other functions, improving code reliability and developer experience. This package is part of the `typeshed` project, which maintains external type annotations for numerous Python libraries and the standard library. `types-emoji` follows the release cadence of `typeshed`, which is often independent of the runtime `emoji` library's release schedule.

Warnings

gotcha `types-emoji` provides only type hints for static analysis. To execute Python code that uses emoji functionalities, you must also install the actual `emoji` runtime library (e.g., `pip install emoji`).
Fix: Ensure both `types-emoji` and `emoji` are installed in your environment.
breaking As `types-emoji` is part of `typeshed`, any version bump might introduce changes to type annotations that could cause your code to fail type checking, even if the underlying `emoji` runtime library remains unchanged. This can happen due to more precise type definitions or bug fixes in stubs.
Fix: Ideally, align the version bounds of `types-emoji` with your `emoji` runtime library version. Regularly update your type checker and stubs, addressing any new type errors as they arise, or pin `types-emoji` to a specific version if strict stability is required for type checking.
gotcha Emoji shortcodes in `emoji.emojize()` and `emoji.demojize()` default to English. If you intend to use shortcodes from other languages (e.g., Spanish, Portuguese, French) or enable a broader set of aliases, you must explicitly provide the `language` argument (e.g., `language='es'` or `language='alias'`).
Fix: Pass the appropriate `language` argument to `emojize()` or `demojize()` if you are not using English shortcodes or require alias support.
gotcha Some emojis have different Unicode presentation styles (e.g., text vs. emoji presentation). For explicit control over the output, `emoji.emojize()` supports a `variant` argument (e.g., `variant='emoji_type'`).
Fix: Use the `variant` argument if a specific emoji presentation is desired, especially when dealing with mixed environments or older systems.

Install

pip install types-emoji Install typing stubs
pip install emoji Install runtime library (required for execution)

Imports

emoji
```
import emoji
```
emojize
```
from emoji import emojize
```
The `emojize` function is part of the `emoji` module, not a top-level import.
demojize
```
from emoji import demojize
```
The `demojize` function is part of the `emoji` module, not a top-level import.

Quickstart

This quickstart demonstrates basic usage of the `emoji` library's core functions: `emojize` to convert text shortcodes into Unicode emojis, `demojize` to reverse this process, `is_emoji` to detect emojis, and how to use language-specific shortcodes or presentation variants.

import emoji
import os

# Example 1: Convert shortcode to emoji
text_with_emoji = emoji.emojize("Python is fun :red_heart:")
print(f"Emojized: {text_with_emoji}")

# Example 2: Convert emoji to shortcode
text_with_shortcode = emoji.demojize("Python is fun ❤️")
print(f"Demojized: {text_with_shortcode}")

# Example 3: Check if a string contains an emoji
has_emoji = emoji.is_emoji("👍")
print(f"Is '👍' an emoji? {has_emoji}")

# Example 4: Using language-specific shortcodes (e.g., Spanish)
spanish_text_emojized = emoji.emojize("Python es :pulgar_hacia_arriba:", language='es')
print(f"Spanish emojized: {spanish_text_emojized}")

spanish_text_demojized = emoji.demojize("Python es 👍", language='es')
print(f"Spanish demojized: {spanish_text_demojized}")

# Example 5: Using variant for emoji presentation (if supported)
heart_emoji_type = emoji.emojize("Python is fun :red_heart:", variant="emoji_type")
print(f"Heart emoji type: {heart_emoji_type}")

view raw JSON →