# SPDX-License-Identifier: GPL-3.0-or-later
"""
Module for a function to get emojis we want to filter from suggestions.
"""
# See: https://getemoji.com/
[docs]
def get_emojis_to_ignore() -> str:
"""
Return a list of emojis based on relationships that we want to remove from emoji suggestions.
Returns
-------
str
All emojis that should not be included in emoji suggestions.
"""
return """
🤰 🫃 🤱 👩🍼 👨🍼 👭 👬 👫 👩❤️👩 💑 👨❤️👨 👩❤️👨 👩❤️💋👩 💏 👨❤️💋👨 👩❤️💋👨 👨👩👦 👨👩👧 👨👩👧👦 👨👩👦👦 👨👩👧👧 👨👨👦 👨👨👧 👨👨👧👦 👨👨👦👦 👨👨👧👧 👩👩👦 👩👩👧 👩👩👧👦 👩👩👦👦 👩👩👧👧 👨👦 👨👦👦 👨👧 👨👧👦 👨👧👧 👩👦 👩👦👦 👩👧 👩👧👦 👩👧👧
🤰🏻 🫃🏻 🤱🏻 👩🏻🍼 👨🏻🍼 👭🏻 👬🏻 👫🏻
🤰🏼 🫃🏼 🤱🏼 👩🏼🍼 👨🏼🍼 👭🏼 👬🏼 👫🏼
🤰🏽 🫃🏽 🤱🏽 👩🏽🍼 👨🏽🍼 👭🏽 👬🏽 👫🏽
🤰🏾 🫃🏾 🤱🏾 👩🏾🍼 👨🏾🍼 👭🏾 👬🏾 👫🏾
🤰🏿 🫃🏿 🤱🏿 👩🏿🍼 👨🏿🍼 👭🏿 👬🏿 👫🏿
💑🏻 💑🏼 💑🏽 💑🏾 💑🏿 💏🏻 💏🏼 💏🏽 💏🏾 💏🏿 👨🏻❤️👨🏻 👨🏻❤️👨🏼 👨🏻❤️👨🏽 👨🏻❤️👨🏾 👨🏻❤️👨🏿 👨🏼❤️👨🏻 👨🏼❤️👨🏼 👨🏼❤️👨🏽 👨🏼❤️👨🏾 👨🏼❤️👨🏿 👨🏽❤️👨🏻 👨🏽❤️👨🏼 👨🏽❤️👨🏽 👨🏽❤️👨🏾 👨🏽❤️👨🏿 👨🏾❤️👨🏻 👨🏾❤️👨🏼 👨🏾❤️👨🏽 👨🏾❤️👨🏾 👨🏾❤️👨🏿 👨🏿❤️👨🏻 👨🏿❤️👨🏼 👨🏿❤️👨🏽 👨🏿❤️👨🏾 👨🏿❤️👨🏿 👩🏻❤️👨🏻 👩🏻❤️👨🏼 👩🏻❤️👨🏽 👩🏻❤️👨🏾 👩🏻❤️👨🏿 👩🏻❤️👩🏻 👩🏻❤️👩🏼 👩🏻❤️👩🏽 👩🏻❤️👩🏾 👩🏻❤️👩🏿 👩🏼❤️👨🏻 👩🏼❤️👨🏼 👩🏼❤️👨🏽 👩🏼❤️👨🏾 👩🏼❤️👨🏿 👩🏼❤️👩🏻 👩🏼❤️👩🏼 👩🏼❤️👩🏽 👩🏼❤️👩🏾 👩🏼❤️👩🏿 👩🏽❤️👨🏻 👩🏽❤️👨🏼 👩🏽❤️👨🏽 👩🏽❤️👨🏾 👩🏽❤️👨🏿 👩🏽❤️👩🏻 👩🏽❤️👩🏼 👩🏽❤️👩🏽 👩🏽❤️👩🏾 👩🏽❤️👩🏿 👩🏾❤️👨🏻 👩🏾❤️👨🏼 👩🏾❤️👨🏽 👩🏾❤️👨🏾 👩🏾❤️👨🏿 👩🏾❤️👩🏻 👩🏾❤️👩🏼 👩🏾❤️👩🏽 👩🏾❤️👩🏾 👩🏾❤️👩🏿 👩🏿❤️👨🏻 👩🏿❤️👨🏼 👩🏿❤️👨🏽 👩🏿❤️👨🏾 👩🏿❤️👨🏿 👩🏿❤️👩🏻 👩🏿❤️👩🏼 👩🏿❤️👩🏽 👩🏿❤️👩🏾 👩🏿❤️👩🏿 🧑🏻❤️🧑🏼 🧑🏻❤️🧑🏽 🧑🏻❤️🧑🏾 🧑🏻❤️🧑🏿 🧑🏼❤️🧑🏻 🧑🏼❤️🧑🏽 🧑🏼❤️🧑🏾 🧑🏼❤️🧑🏿 🧑🏽❤️🧑🏻 🧑🏽❤️🧑🏼 🧑🏽❤️🧑🏾 🧑🏽❤️🧑🏿 🧑🏾❤️🧑🏻 🧑🏾❤️🧑🏼 🧑🏾❤️🧑🏽 🧑🏾❤️🧑🏿 🧑🏿❤️🧑🏻 🧑🏿❤️🧑🏼 🧑🏿❤️🧑🏽 🧑🏿❤️🧑🏾 👨🏻❤️💋👨🏻 👨🏻❤️💋👨🏼 👨🏻❤️💋👨🏽 👨🏻❤️💋👨🏾 👨🏻❤️💋👨🏿 👨🏼❤️💋👨🏻 👨🏼❤️💋👨🏼 👨🏼❤️💋👨🏽 👨🏼❤️💋👨🏾 👨🏼❤️💋👨🏿 👨🏽❤️💋👨🏻 👨🏽❤️💋👨🏼 👨🏽❤️💋👨🏽 👨🏽❤️💋👨🏾 👨🏽❤️💋👨🏿 👨🏾❤️💋👨🏻 👨🏾❤️💋👨🏼 👨🏾❤️💋👨🏽 👨🏾❤️💋👨🏾 👨🏾❤️💋👨🏿 👨🏿❤️💋👨🏻 👨🏿❤️💋👨🏼 👨🏿❤️💋👨🏽 👨🏿❤️💋👨🏾 👨🏿❤️💋👨🏿 👩🏻❤️💋👨🏻 👩🏻❤️💋👨🏼 👩🏻❤️💋👨🏽 👩🏻❤️💋👨🏾 👩🏻❤️💋👨🏿 👩🏻❤️💋👩🏻 👩🏻❤️💋👩🏼 👩🏻❤️💋👩🏽 👩🏻❤️💋👩🏾 👩🏻❤️💋👩🏿 👩🏼❤️💋👨🏻 👩🏼❤️💋👨🏼 👩🏼❤️💋👨🏽 👩🏼❤️💋👨🏾 👩🏼❤️💋👨🏿 👩🏼❤️💋👩🏻 👩🏼❤️💋👩🏼 👩🏼❤️💋👩🏽 👩🏼❤️💋👩🏾 👩🏼❤️💋👩🏿 👩🏽❤️💋👨🏻 👩🏽❤️💋👨🏼 👩🏽❤️💋👨🏽 👩🏽❤️💋👨🏾 👩🏽❤️💋👨🏿 👩🏽❤️💋👩🏻 👩🏽❤️💋👩🏼 👩🏽❤️💋👩🏽 👩🏽❤️💋👩🏾 👩🏽❤️💋👩🏿 👩🏾❤️💋👨🏻 👩🏾❤️💋👨🏼 👩🏾❤️💋👨🏽 👩🏾❤️💋👨🏾 👩🏾❤️💋👨🏿 👩🏾❤️💋👩🏻 👩🏾❤️💋👩🏼 👩🏾❤️💋👩🏽 👩🏾❤️💋👩🏾 👩🏾❤️💋👩🏿 👩🏿❤️💋👨🏻 👩🏿❤️💋👨🏼 👩🏿❤️💋👨🏽 👩🏿❤️💋👨🏾 👩🏿❤️💋👨🏿 👩🏿❤️💋👩🏻 👩🏿❤️💋👩🏼 👩🏿❤️💋👩🏽 👩🏿❤️💋👩🏾 👩🏿❤️💋👩🏿 🧑🏻❤️💋🧑🏼 🧑🏻❤️💋🧑🏽 🧑🏻❤️💋🧑🏾 🧑🏻❤️💋🧑🏿 🧑🏼❤️💋🧑🏻 🧑🏼❤️💋🧑🏽 🧑🏼❤️💋🧑🏾 🧑🏼❤️💋🧑🏿 🧑🏽❤️💋🧑🏻 🧑🏽❤️💋🧑🏼 🧑🏽❤️💋🧑🏾 🧑🏽❤️💋🧑🏿 🧑🏾❤️💋🧑🏻 🧑🏾❤️💋🧑🏼 🧑🏾❤️💋🧑🏽 🧑🏾❤️💋🧑🏿 🧑🏿❤️💋🧑🏻 🧑🏿❤️💋🧑🏼 🧑🏿❤️💋🧑🏽 🧑🏿❤️💋🧑🏾
"""
[docs]
def get_emoji_codes_to_ignore() -> list[bytes]:
"""
Return a list of emojis codes based on relationships that we want to remove from emoji suggestions.
Returns
-------
list
All emoji codes that should be ignored in emoji processing.
"""
emojis_to_ignore = get_emojis_to_ignore()
return [e.encode("utf-8") for e in emojis_to_ignore.split(" ") if e != ""]