Aller au contenu

Ue

UeService

Service de gestion des UEs, avec leurs rôles, salons et catégories.

Warning

Faire correspondre les noms des UEs tels qu'ils peuvent apparaitre dans la configuration, les noms des rôles et les noms des salons, peut demander une certaine gymnastique entre majuscules et minuscules.

C'est pourquoi il est important de garder en tête les conventions suivantes :

  • les noms dans la configuration sont en majuscules (GE21, MATH01, PHYS11...)
  • les noms des rôles sont en majuscules (GE21, MATH01, PHYS11...)
  • les noms des salons sont en minuscules (ge21, math01, phys11...)
  • les noms des catégories sont en majuscules (ME, CS, TM...)
Source code in etuutt_bot/services/ue.py 
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
class UeService:
    """Service de gestion des UEs, avec leurs rôles, salons et catégories.

    Warning:
        Faire correspondre les noms des UEs tels qu'ils peuvent apparaitre
        dans la configuration, les noms des rôles et les noms des salons,
        peut demander une certaine gymnastique entre majuscules et minuscules.

        C'est pourquoi il est important de garder en tête les conventions suivantes :

        - les noms dans la configuration sont en majuscules (GE21, MATH01, PHYS11...)
        - les noms des rôles sont en majuscules (GE21, MATH01, PHYS11...)
        - les noms des salons sont en minuscules (ge21, math01, phys11...)
        - les noms des catégories sont en majuscules (ME, CS, TM...)
    """

    def __init__(self, bot: EtuUTTBot):
        self._bot = bot

    @staticmethod
    async def delete_channel(channel: TextChannel, *, delete_role: bool = False) -> None:
        """Supprime un salon d'UE.

        Args:
            channel: Le salon à supprimer
            delete_role: si `True`, supprime également le rôle associé à l'UE
        """
        if delete_role:
            ue_role = next(
                (r for r in channel.guild.roles if r.name.lower() == channel.name),
                None,
            )
            if ue_role is not None:
                await ue_role.delete(reason="Suppression du rôle associé à un salon d'UE")
        await channel.delete(reason="Suppression d'un salon d'UE")

    async def delete_all_channels(
        self, category: CategoryChannel, *, delete_roles: bool = False
    ) -> int:
        """Supprime tous les salons d'UE de la catégorie.

        Args:
            category: la catégorie dans laquelle supprimer les salons d'UE.
            delete_roles: si True, les rôles associés aux salons sont aussi supprimés

        Returns:
            Le nombre de salons qui ont été supprimés
        """
        ues_names = next(
            (cat.ues for cat in self._bot.settings.categories if cat.id == category.id),
            None,
        )
        if not ues_names:
            return 0
        channels = [c for c in category.text_channels if c.name.upper() in ues_names]
        for channel in channels:
            await self.delete_channel(channel, delete_role=delete_roles)
        return len(channels)

    async def create_channel(self, name: str) -> (TextChannel, Role):
        """Crée un salon d'UE.

        Si le rôle correspondant à l'UE n'existe pas encore, le crée également.

        Args:
            name: le nom du salon à créer.

        Returns:
            Le salon créé.

        Raises:
            AlreadyExistsError:
                Un salon avec ce nom existe déjà.
            MissingConfigurationError:
                Le nom donné ne correspond à rien dans la configuration.
        """
        guild = self._bot.watched_guild
        settings = self._bot.settings
        name = name.upper()
        if any(c.name == name.lower() for c in guild.text_channels):
            raise AlreadyExistsError

        category_settings = next((c for c in settings.categories if name in c.ues), None)
        if category_settings is None:
            raise MissingConfigurationError
        category = next((c for c in guild.categories if c.id == category_settings.id), None)
        if category is None:
            raise CategoryMissingError

        role = next((r for r in guild.roles if r.name == name), None)
        if role is None:
            role = await guild.create_role(
                name=name, reason=f"Création d'un rôle pour l'UE {name}"
            )

        moderator_role = guild.get_role(self._bot.settings.guild.special_roles.moderator)
        elected = guild.get_role(category_settings.elected_role)
        overwrites = {
            guild.default_role: PermissionOverwrite(read_messages=False),
            role: PermissionOverwrite(read_messages=True),
            moderator_role: PermissionOverwrite(read_messages=True),
        }
        if elected:
            overwrites[elected] = PermissionOverwrite(read_messages=True)

        return await category.create_text_channel(
            name.lower(), overwrites=overwrites, reason=f"Création d'un salon pour l'UE {name}"
        ), role

    def get_missing_channels(self, category: CategoryChannel = None) -> set[LowerStr]:
        """Renvoie le nom de tous les salons d'UEs manquant sur le serveur."""
        if category:
            ues = {
                LowerStr(ue.lower())
                for ue in next(
                    (cat for cat in self._bot.settings.categories if cat.id == category.id), None
                ).ues
            }
            existing = {
                LowerStr(channel.name)  # les noms des salons Discord sont en minuscule par défaut
                for channel in category.text_channels
            }
            return ues - existing
        ues = {LowerStr(ue.lower()) for cat in self._bot.settings.categories for ue in cat.ues}
        existing = {
            LowerStr(channel.name)  # les noms des salons Discord sont en minuscule par défaut
            for channel in self._bot.watched_guild.text_channels
        }
        return ues - existing

create_channel(name) async

Crée un salon d'UE.

Si le rôle correspondant à l'UE n'existe pas encore, le crée également.

Parameters:

Name Type Description Default
name str

le nom du salon à créer.

 required

Returns:

Type Description
(TextChannel, Role)

Le salon créé.

Raises:

Type Description
AlreadyExistsError

Un salon avec ce nom existe déjà.
MissingConfigurationError

Le nom donné ne correspond à rien dans la configuration.
Source code in etuutt_bot/services/ue.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
async def create_channel(self, name: str) -> (TextChannel, Role):
    """Crée un salon d'UE.

    Si le rôle correspondant à l'UE n'existe pas encore, le crée également.

    Args:
        name: le nom du salon à créer.

    Returns:
        Le salon créé.

    Raises:
        AlreadyExistsError:
            Un salon avec ce nom existe déjà.
        MissingConfigurationError:
            Le nom donné ne correspond à rien dans la configuration.
    """
    guild = self._bot.watched_guild
    settings = self._bot.settings
    name = name.upper()
    if any(c.name == name.lower() for c in guild.text_channels):
        raise AlreadyExistsError

    category_settings = next((c for c in settings.categories if name in c.ues), None)
    if category_settings is None:
        raise MissingConfigurationError
    category = next((c for c in guild.categories if c.id == category_settings.id), None)
    if category is None:
        raise CategoryMissingError

    role = next((r for r in guild.roles if r.name == name), None)
    if role is None:
        role = await guild.create_role(
            name=name, reason=f"Création d'un rôle pour l'UE {name}"
        )

    moderator_role = guild.get_role(self._bot.settings.guild.special_roles.moderator)
    elected = guild.get_role(category_settings.elected_role)
    overwrites = {
        guild.default_role: PermissionOverwrite(read_messages=False),
        role: PermissionOverwrite(read_messages=True),
        moderator_role: PermissionOverwrite(read_messages=True),
    }
    if elected:
        overwrites[elected] = PermissionOverwrite(read_messages=True)

    return await category.create_text_channel(
        name.lower(), overwrites=overwrites, reason=f"Création d'un salon pour l'UE {name}"
    ), role

delete_all_channels(category, *, delete_roles=False) async

Supprime tous les salons d'UE de la catégorie.

Parameters:

Name Type Description Default
category CategoryChannel

la catégorie dans laquelle supprimer les salons d'UE.

 required
delete_roles bool

si True, les rôles associés aux salons sont aussi supprimés

 False

Returns:

Type Description
int

Le nombre de salons qui ont été supprimés
Source code in etuutt_bot/services/ue.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
async def delete_all_channels(
    self, category: CategoryChannel, *, delete_roles: bool = False
) -> int:
    """Supprime tous les salons d'UE de la catégorie.

    Args:
        category: la catégorie dans laquelle supprimer les salons d'UE.
        delete_roles: si True, les rôles associés aux salons sont aussi supprimés

    Returns:
        Le nombre de salons qui ont été supprimés
    """
    ues_names = next(
        (cat.ues for cat in self._bot.settings.categories if cat.id == category.id),
        None,
    )
    if not ues_names:
        return 0
    channels = [c for c in category.text_channels if c.name.upper() in ues_names]
    for channel in channels:
        await self.delete_channel(channel, delete_role=delete_roles)
    return len(channels)

delete_channel(channel, *, delete_role=False) async staticmethod

Supprime un salon d'UE.

Parameters:

Name Type Description Default
channel TextChannel

Le salon à supprimer

 required
delete_role bool

si True, supprime également le rôle associé à l'UE

 False
Source code in etuutt_bot/services/ue.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
@staticmethod
async def delete_channel(channel: TextChannel, *, delete_role: bool = False) -> None:
    """Supprime un salon d'UE.

    Args:
        channel: Le salon à supprimer
        delete_role: si `True`, supprime également le rôle associé à l'UE
    """
    if delete_role:
        ue_role = next(
            (r for r in channel.guild.roles if r.name.lower() == channel.name),
            None,
        )
        if ue_role is not None:
            await ue_role.delete(reason="Suppression du rôle associé à un salon d'UE")
    await channel.delete(reason="Suppression d'un salon d'UE")

get_missing_channels(category=None)

Renvoie le nom de tous les salons d'UEs manquant sur le serveur.

Source code in etuutt_bot/services/ue.py 
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
def get_missing_channels(self, category: CategoryChannel = None) -> set[LowerStr]:
    """Renvoie le nom de tous les salons d'UEs manquant sur le serveur."""
    if category:
        ues = {
            LowerStr(ue.lower())
            for ue in next(
                (cat for cat in self._bot.settings.categories if cat.id == category.id), None
            ).ues
        }
        existing = {
            LowerStr(channel.name)  # les noms des salons Discord sont en minuscule par défaut
            for channel in category.text_channels
        }
        return ues - existing
    ues = {LowerStr(ue.lower()) for cat in self._bot.settings.categories for ue in cat.ues}
    existing = {
        LowerStr(channel.name)  # les noms des salons Discord sont en minuscule par défaut
        for channel in self._bot.watched_guild.text_channels
    }
    return ues - existing