Module zenora.models.guild

Classes

class Guild (*, id, unavailable: bool = False, name: str, features: List[str], emojis: List[dict] = [], description: Optional[str] = None, vanity_url_code: Optional[str] = None, icon: Optional[str] = None, splash: Optional[str] = None, discovery_splash: Optional[str] = None, owner: Optional[bool] = None, joined_at: Optional[str] = None, permissions: Optional[str] = None, member_count: Optional[int] = None, widget_enabled: Optional[bool] = None, widget_channel_id=None, large: Optional[bool] = None, members: Optional[List[dict]] = None, channels: Optional[List[dict]] = None, threads: Optional[List[dict]] = None, presences: Optional[List[dict]] = None, max_presences: Optional[int] = None, max_members: Optional[int] = None, owner_id=None, region: Optional[str] = None, roles: Optional[List[dict]] = None, verification_level: Optional[Literal[0, 1, 2, 3, 4]] = None, nsfw_level: Optional[Literal[0, 1, 2, 3]] = None, mfa_level: Optional[Literal[0, 1]] = None)

An object representing a guild/server on Discord

Method generated by attrs for class Guild.

Expand source code

@attr.s(slots=True, kw_only=True)
class Guild(GuildPreview, GuildOptional):
    """An object representing a guild/server on Discord"""

    owner_id: Optional[Snowflake] = attr.ib(
        default=None, converter=convert_snowflake
    )
    """The guild owner's ID"""

    region: Optional[str] = attr.ib(default=None)
    """The guild's voice server region"""

    roles: Optional[List[dict]] = attr.ib(default=None)
    """A list of guild role objects, dont have a model at the moment"""

    verification_level: Optional[Literal[0, 1, 2, 3, 4]] = attr.ib(default=None)
    """The guild's verification level"""

    nsfw_level: Optional[Literal[0, 1, 2, 3]] = attr.ib(default=None)
    """The guild's NSFW level"""

    mfa_level: Optional[Literal[0, 1]] = attr.ib(default=None)
    """The guild's multi-factor authentication level"""

Ancestors

• GuildPreview
• GuildBase
• GuildOptional

Instance variables

var mfa_level : Optional[Literal[0, 1]]

The guild's multi-factor authentication level

var nsfw_level : Optional[Literal[0, 1, 2, 3]]

The guild's NSFW level

var owner_id : Optional[Snowflake]

The guild owner's ID

var region : Optional[str]

The guild's voice server region

var roles : Optional[List[dict]]

A list of guild role objects, dont have a model at the moment

var verification_level : Optional[Literal[0, 1, 2, 3, 4]]

The guild's verification level

Inherited members

• GuildPreview:
  • description
  • discovery_splash
  • emojis
  • features
  • icon
  • icon_url
  • icon_url_as
  • id
  • name
  • splash
  • unavailable
  • vanity_url_code
• GuildOptional:
  • channels
  • is_owner
  • joined_at
  • large
  • max_members
  • max_presences
  • member_count
  • members
  • owner
  • permissions
  • presences
  • threads
  • widget_channel_id
  • widget_enabled

class GuildBase (*, id, unavailable: bool = False)

Method generated by attrs for class GuildBase.

Expand source code

@attr.s(slots=True, kw_only=True)
class GuildBase:
    __str__ = get__str__

    id: Snowflake = attr.ib(converter=convert_snowflake)
    """ID of the guild"""

    unavailable: bool = attr.ib(default=False)
    """Whether the guild is unavailable or not"""

Subclasses

• GuildPreview

Instance variables

var id : Snowflake

ID of the guild

var unavailable : bool

Whether the guild is unavailable or not

class GuildOptional (owner: Optional[bool] = None, joined_at: Optional[str] = None, permissions: Optional[str] = None, member_count: Optional[int] = None, widget_enabled: Optional[bool] = None, widget_channel_id=None, large: Optional[bool] = None, members: Optional[List[dict]] = None, channels: Optional[List[dict]] = None, threads: Optional[List[dict]] = None, presences: Optional[List[dict]] = None, max_presences: Optional[int] = None, max_members: Optional[int] = None)

Method generated by attrs for class GuildOptional.

Expand source code

@attr.s
class GuildOptional:
    owner: Optional[bool] = attr.ib(default=None)
    """Whether the user is the guild's owner or not"""

    joined_at: Optional[str] = attr.ib(default=None)
    """ISO8601 timestamp for when the user joined the guild"""

    permissions: Optional[str] = attr.ib(default=None)
    """Total permissions for the user in the guild"""

    member_count: Optional[int] = attr.ib(default=None)
    """Total number of members in the guild"""

    widget_enabled: Optional[bool] = attr.ib(default=None)
    """Whether the server widget is enabled or not"""

    widget_channel_id: Optional[Snowflake] = attr.ib(
        default=None, converter=convert_snowflake
    )
    """The server widget's channel ID"""

    large: Optional[bool] = attr.ib(default=None)
    """Whether the guild is "large" or not"""

    members: Optional[List[dict]] = attr.ib(default=None)
    """A list of the guild's members, has no model at the moment"""

    channels: Optional[List[dict]] = attr.ib(default=None)
    """A list of the guild's channels, has no model at the moment"""

    threads: Optional[List[dict]] = attr.ib(default=None)
    """A list of the guild's threads, has no model at the moment"""

    presences: Optional[List[dict]] = attr.ib(default=None)
    """A list of partial presence update objects, has no model at the moment"""

    max_presences: Optional[int] = attr.ib(default=None)
    """The maximum number of presences for the guild"""

    max_members: Optional[int] = attr.ib(default=None)
    """The maximum number of members for the guild"""

    @property
    def is_owner(self) -> Optional[bool]:
        """Whether the user is the guild's owner or not"""
        return self.owner

Subclasses

• Guild

Class variables

var channels : Optional[List[dict]]

A list of the guild's channels, has no model at the moment

var joined_at : Optional[str]

ISO8601 timestamp for when the user joined the guild

var large : Optional[bool]

Whether the guild is "large" or not

var max_members : Optional[int]

The maximum number of members for the guild

var max_presences : Optional[int]

The maximum number of presences for the guild

var member_count : Optional[int]

Total number of members in the guild

var members : Optional[List[dict]]

A list of the guild's members, has no model at the moment

var owner : Optional[bool]

Whether the user is the guild's owner or not

var permissions : Optional[str]

Total permissions for the user in the guild

var presences : Optional[List[dict]]

A list of partial presence update objects, has no model at the moment

var threads : Optional[List[dict]]

A list of the guild's threads, has no model at the moment

var widget_channel_id : Optional[Snowflake]

The server widget's channel ID

var widget_enabled : Optional[bool]

Whether the server widget is enabled or not

Instance variables

var is_owner : Optional[bool]

Whether the user is the guild's owner or not

Expand source code

@property
def is_owner(self) -> Optional[bool]:
    """Whether the user is the guild's owner or not"""
    return self.owner

class GuildPreview (name: str, features: List[str], emojis: List[dict] = [], description: Optional[str] = None, vanity_url_code: Optional[str] = None, icon: Optional[str] = None, splash: Optional[str] = None, discovery_splash: Optional[str] = None, *, id, unavailable: bool = False)

Method generated by attrs for class GuildPreview.

Expand source code

@attr.s(slots=True)
class GuildPreview(GuildBase):
    name: str = attr.ib()
    """The guild's name"""

    features: List[str] = attr.ib()
    """A list of guild features, dont have a model at the moment"""

    emojis: List[dict] = attr.ib(default=[])
    """A list of guild emojis, dont have a model at the moment"""

    description: Optional[str] = attr.ib(default=None)
    """The guild's description"""

    vanity_url_code: Optional[str] = attr.ib(default=None)
    """The vanity url code for the guild"""

    icon: Optional[str] = attr.ib(default=None)
    """The guild's icon image hash"""

    splash: Optional[str] = attr.ib(default=None)
    """The guild's splash image hash"""

    discovery_splash: Optional[str] = attr.ib(default=None)
    """The guild's discovery splash image hash"""

    @property
    def icon_url(self) -> Optional[str]:
        """Returns the user's avatar URL, only if the avatar hash exists"""
        if not self.icon:
            return None

        return f"{CDN_URL}{GUILD_ICON}/{self.id}/{self.icon}.png"

    def icon_url_as(
        self,
        format: Literal[".png", ".jpg", ".jpeg", ".webp", ".gif"] = ".png",
        size: int = 1024,
    ) -> Optional[str]:
        """Returns the guild's icon URL with a specific file format, only if the icon hash exists"""
        if not self.icon:
            return None
        elif format not in [".png", ".jpg", ".jpeg", ".webp", ".gif"]:
            raise Exception(f"Invalid avatar format: {format}")
        elif size % 16 != 0 or size > 1024:
            raise Exception(
                f"Invalid size {size}. Guild icon URL size must be a multiple of 16 up to 1024"
            )

        return (
            f"{CDN_URL}{GUILD_ICON}/{self.id}/{self.icon}{format}?size={size}"
        )

Ancestors

• GuildBase

Subclasses

• Guild

Instance variables

var description : Optional[str]

The guild's description

var discovery_splash : Optional[str]

The guild's discovery splash image hash

var emojis : List[dict]

A list of guild emojis, dont have a model at the moment

var features : List[str]

A list of guild features, dont have a model at the moment

var icon : Optional[str]

The guild's icon image hash

var icon_url : Optional[str]

Returns the user's avatar URL, only if the avatar hash exists

Expand source code

@property
def icon_url(self) -> Optional[str]:
    """Returns the user's avatar URL, only if the avatar hash exists"""
    if not self.icon:
        return None

    return f"{CDN_URL}{GUILD_ICON}/{self.id}/{self.icon}.png"

var name : str

The guild's name

var splash : Optional[str]

The guild's splash image hash

var vanity_url_code : Optional[str]

The vanity url code for the guild

Methods

def icon_url_as(self, format: Literal['.png', '.jpg', '.jpeg', '.webp', '.gif'] = '.png', size: int = 1024) ‑> Optional[str]

Returns the guild's icon URL with a specific file format, only if the icon hash exists

Expand source code

def icon_url_as(
    self,
    format: Literal[".png", ".jpg", ".jpeg", ".webp", ".gif"] = ".png",
    size: int = 1024,
) -> Optional[str]:
    """Returns the guild's icon URL with a specific file format, only if the icon hash exists"""
    if not self.icon:
        return None
    elif format not in [".png", ".jpg", ".jpeg", ".webp", ".gif"]:
        raise Exception(f"Invalid avatar format: {format}")
    elif size % 16 != 0 or size > 1024:
        raise Exception(
            f"Invalid size {size}. Guild icon URL size must be a multiple of 16 up to 1024"
        )

    return (
        f"{CDN_URL}{GUILD_ICON}/{self.id}/{self.icon}{format}?size={size}"
    )

Inherited members

• GuildBase:
  • id
  • unavailable