91 lines
1.8 KiB
Python
91 lines
1.8 KiB
Python
"""File for Group class."""
|
|
|
|
|
|
class Group:
|
|
"""Stores a group's information. Used just to pass sql query information around."""
|
|
|
|
def __init__(self, group_info: tuple) -> None:
|
|
"""
|
|
Default constructor for group class. Populates class from sql query results. Tuple order is important.
|
|
|
|
Args:
|
|
name (str): group's name
|
|
"""
|
|
self._id: int = group_info[0]
|
|
self._name: str = group_info[1]
|
|
self._channel_id: int = group_info[2]
|
|
self._guild_id: int = group_info[3]
|
|
self._message_id: int = group_info[4]
|
|
self._pad_length: int = group_info[5]
|
|
self._size = group_info[6]
|
|
|
|
@property
|
|
def id(self) -> int:
|
|
"""
|
|
Getter for id
|
|
|
|
Returns:
|
|
int: id
|
|
"""
|
|
return self._id
|
|
|
|
@property
|
|
def name(self) -> str:
|
|
"""
|
|
Getter for name.
|
|
|
|
Returns:
|
|
str: name
|
|
"""
|
|
return self._name
|
|
|
|
@property
|
|
def channel_id(self) -> int:
|
|
"""
|
|
Getter for channel id.
|
|
|
|
Returns:
|
|
int: channel id
|
|
"""
|
|
return self._channel_id
|
|
|
|
@property
|
|
def guild_id(self) -> int:
|
|
"""
|
|
Getter for guild id.
|
|
|
|
Returns:
|
|
int: guild id
|
|
"""
|
|
return self._guild_id
|
|
|
|
@property
|
|
def message_id(self) -> int:
|
|
"""
|
|
Getter for message id
|
|
|
|
Returns:
|
|
int: message id
|
|
"""
|
|
return self._message_id
|
|
|
|
@property
|
|
def pad_length(self) -> int:
|
|
"""
|
|
Getter for pad length.
|
|
|
|
Returns:
|
|
int: pad length
|
|
"""
|
|
return self._pad_length
|
|
|
|
@property
|
|
def size(self) -> int:
|
|
"""
|
|
Getter for size of group.
|
|
|
|
Returns:
|
|
int: Size of group
|
|
"""
|
|
return self._size
|