pincer.objects.app.mentionable

Complexity

Total Complexity

2

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	Mentionable.is_role()	0	4	1
A	Mentionable.is_user()	0	4	1

# Copyright Pincer 2021-Present

Missing module docstring

# Full MIT License can be found in `LICENSE` at the project root.

from dataclasses import dataclass
from typing import Optional


from ...objects.guild.role import Role
from ...objects.user.user import User


@dataclass
class Mentionable:
    """
    Represents the Mentionable type

    user : Optional[:class:`~pincer.objects.user.user.User`]
        User object returned from a discord interaction
    role: Optional[:class:`~pincer.objects.guild.role.Role`]
        Role object returned from a discord interaction
    """
    user: Optional[User] = None
    role: Optional[Role] = None

    @property
    def is_user(self):
        """Returns true if the Mentionable object has a User"""
        return self.user is not None

    @property
    def is_role(self):
        """Returns true if the Mentionable object has a Role"""
        return self.role is not None