|
1 | 1 | import logging |
2 | 2 | import trio |
3 | 3 | from functools import partial |
4 | | -from typing import Union, List |
| 4 | +from typing import Union, List, Set |
5 | 5 |
|
6 | 6 | import aioircd |
7 | 7 |
|
|
10 | 10 |
|
11 | 11 |
|
12 | 12 | class Channel: |
13 | | - def __init__(self, name): |
| 13 | + """ |
| 14 | + The Channel class represents a chat room. |
| 15 | +
|
| 16 | + Attributes: |
| 17 | + name: str |
| 18 | + the channel name. |
| 19 | + users: Set[User] |
| 20 | + a set of user who is subscribe to the channel. |
| 21 | + """ |
| 22 | + |
| 23 | + def __init__(self, name: str) -> None: |
| 24 | + """ |
| 25 | + Parameters: |
| 26 | + name: str |
| 27 | + the channel name. |
| 28 | + """ |
14 | 29 | self._name = name |
15 | 30 | self.users = set() |
16 | 31 |
|
17 | | - def __str__(self): |
| 32 | + def __str__(self) -> str: |
| 33 | + """ |
| 34 | + We represents the channel object by his name. |
| 35 | +
|
| 36 | + Return: str |
| 37 | + the name of the channel. |
| 38 | + """ |
18 | 39 | return self._name |
19 | 40 |
|
20 | 41 | @property |
21 | 42 | def name(self): |
| 43 | + """ |
| 44 | + Getter for private attributes channel name. |
| 45 | +
|
| 46 | + Returns: str |
| 47 | + the name of the channel. |
| 48 | + """ |
22 | 49 | return self._name |
23 | 50 |
|
24 | | - async def send(self, messages: Union[str, List[str]], skipusers=[]): |
25 | | - """ Send many messages to each user subcribed in this channel. """ |
| 51 | + def _log_messages(self, messages: List[str]) -> None: |
| 52 | + """ |
| 53 | + Log all messages sent to a client. |
| 54 | + |
| 55 | + Parameters: List[str] |
| 56 | + A list of messages send to the client. |
| 57 | + """ |
| 58 | + for message in messages: |
| 59 | + logger.log(aioircd.IO, "send to %s: %s", self, message) |
| 60 | + |
| 61 | + async def send(self, messages: Union[str, List[str]], skipusers: Set["aioircd.user.User"] = set()) -> None: |
| 62 | + """" |
| 63 | + Send many messages to each user subscribed to this channel. |
| 64 | + |
| 65 | + Parameters: |
| 66 | + messages: Union[str, List[str]] |
| 67 | + Messages to send to the users. |
| 68 | + skipusers: Set[User] |
| 69 | + A set of users to skip sending messages to. |
| 70 | + """ |
26 | 71 | if isinstance(messages, str): |
27 | 72 | messages = [messages] |
28 | 73 |
|
29 | 74 | async with trio.open_nursery() as self._nursery: |
30 | | - for message in messages: |
31 | | - logger.log(aioircd.IO, "send to %s: %s", self, message) |
32 | | - for user in self.users: |
33 | | - if user in skipusers: |
34 | | - continue |
| 75 | + self._log_messages(messages) |
| 76 | + for user in self.users.difference(skipusers): |
35 | 77 | self._nursery.start_soon(partial( |
36 | 78 | user.send, |
37 | 79 | messages, |
|
0 commit comments