Fix default function values (#306)

* Fix default values

* Tooltip

Author: davidhozic

src/daf/guild.py

@@ -306,7 +306,7 @@ async def _on_invite_delete(self, invite: discord.Invite):
         """
         raise NotImplementedError
 
-    async def update(self, init_options={}, **kwargs):
+    async def update(self, init_options = None, **kwargs):
         """
         .. versionadded:: v2.0
 
@@ -443,7 +443,7 @@ class GUILD(_BaseGUILD):
     @typechecked
     def __init__(self,
                  snowflake: Union[int, discord.Guild],
-                 messages: Optional[List[Union[TextMESSAGE, VoiceMESSAGE]]] = [],
+                 messages: Optional[List[Union[TextMESSAGE, VoiceMESSAGE]]] = None,
                  logging: Optional[bool] = False,
                  remove_after: Optional[Union[timedelta, datetime]] = None,
                  invite_track: Optional[List[str]] = None):
@@ -568,7 +568,7 @@ def generate_invite_log_context(self, member: discord.Member, invite_id: str) ->
         }
 
     @misc._async_safe("update_semaphore", 1)
-    async def update(self, init_options = {}, _init = True, **kwargs):
+    async def update(self, init_options = None, _init = True, **kwargs):
         """
         Used for changing the initialization parameters,
         the object was initialized with.
@@ -600,7 +600,7 @@ async def update(self, init_options = {}, _init = True, **kwargs):
         if "invite_track" not in kwargs:
             kwargs["invite_track"] = list(self.join_count.keys())
 
-        if len(init_options) == 0:
+        if init_options is None:
             init_options = {"parent": self.parent}
 
         # Add uninitialized servers
@@ -651,7 +651,7 @@ class USER(_BaseGUILD):
     def __init__(
         self,
         snowflake: Union[int, discord.User],
-        messages: Optional[List[DirectMESSAGE]] = [],
+        messages: Optional[List[DirectMESSAGE]] = None,
         logging: Optional[bool] = False,
         remove_after: Optional[Union[timedelta, datetime]] = None
     ) -> None:
@@ -689,7 +689,7 @@ async def initialize(self, parent: Any):
         )
 
     @misc._async_safe("update_semaphore", 1)
-    async def update(self, init_options = {}, _init = True, **kwargs):
+    async def update(self, init_options = None, _init = True, **kwargs):
         """
         .. versionadded:: v2.0
 
@@ -718,7 +718,7 @@ async def update(self, init_options = {}, _init = True, **kwargs):
         if "snowflake" not in kwargs:
             kwargs["snowflake"] = self.snowflake
 
-        if len(init_options) == 0:
+        if init_options is None:
             init_options = {"parent": self.parent}
 
         messages = kwargs.pop("messages", self.messages)
@@ -790,7 +790,7 @@ class AutoGUILD:
     logging: Optional[bool] = False
         Set to True if you want the guilds generated to log
         sent messages.
-    interval: Optional[timedelta] = timedelta(minutes=10)
+    interval: Optional[timedelta] = timedelta(minutes=1)
         Interval at which to scan for new guilds
     auto_join: Optional[web.GuildDISCOVERY] = None
         .. versionadded:: v2.5
@@ -824,7 +824,7 @@ def __init__(self,
                  include_pattern: str,
                  exclude_pattern: Optional[str] = None,
                  remove_after: Optional[Union[timedelta, datetime]] = None,
-                 messages: Optional[List[BaseMESSAGE]] = [],
+                 messages: Optional[List[BaseMESSAGE]] = None,
                  logging: Optional[bool] = False,
                  interval: Optional[timedelta] = timedelta(minutes=1),
                  auto_join: Optional[web.GuildDISCOVERY] = None,
@@ -834,7 +834,7 @@ def __init__(self,
         self.remove_after = remove_after
         self.invite_track = invite_track
         # Uninitialized template messages that get copied for each found guild.
-        self.messages = messages
+        self.messages = messages if messages is not None else []
         self.logging = logging
         self.interval = interval
         self.auto_join = auto_join
@@ -1090,15 +1090,15 @@ async def _advertise(self):
         return GUILD_ADVERT_STATUS_SUCCESS
 
     @misc._async_safe("_safe_sem", 1)
-    async def update(self, init_options = {}, _init = True, **kwargs):
+    async def update(self, init_options = None, _init = True, **kwargs):
         """
         Updates the object with new initialization parameters.
 
         .. WARNING::
             After calling this method the entire object is reset
             (this includes it's GUILD objects in cache).
         """
-        if len(init_options) == 0:
+        if init_options is None:
             init_options = {"parent": self.parent}
 
         await self._close()

src/daf/message/text_based.py

@@ -42,6 +42,12 @@ class TextMESSAGE(BaseMESSAGE):
 
         *start_in* now accepts datetime object
 
+    .. note::
+
+        Slow mode period handling:
+            If the advertisement period is set less than the biggest slow-mode delay of the given channels,
+            the period will be automatically set slightly above the slow-mode delay.
+
     Parameters
     ------------
     start_period: Union[int, timedelta, None]
@@ -121,7 +127,7 @@ def __init__(self,
                  data: Union[Iterable[Union[str, discord.Embed, FILE]], str, discord.Embed, FILE, _FunctionBaseCLASS],
                  channels: Union[Iterable[Union[int, discord.TextChannel, discord.Thread]], AutoCHANNEL],
                  mode: Optional[Literal["send", "edit", "clear-send"]] = "send",
-                 start_in: Optional[Union[timedelta, datetime]] = datetime.now(),
+                 start_in: Optional[Union[timedelta, datetime]] = timedelta(seconds=0),
                  remove_after: Optional[Union[int, timedelta, datetime]] = None):
         super().__init__(start_period, end_period, data, start_in, remove_after)
         self.mode = mode
@@ -365,11 +371,6 @@ async def _handle_error(self, channel: Union[discord.TextChannel, discord.Thread
         This method handles the error that occurred during the execution of the function.
         Returns `True` if error was handled.
 
-        Slow mode period handling:
-        When the period is lower than the remaining time, the framework will start
-        incrementing the original period by original period until it is larger then
-        the slow mode remaining time.
-
         Parameters
         -----------
         channel: Union[discord.TextChannel, discord.Thread]
@@ -524,7 +525,7 @@ async def _send(self) -> MessageSendResult:
 
     @typechecked
     @misc._async_safe("update_semaphore")
-    async def update(self, _init_options: Optional[dict] = {}, _init = True, **kwargs: Any):
+    async def update(self, _init_options: Optional[dict] = None, _init = True, **kwargs: Any):
         """
         .. versionadded:: v2.0
 
@@ -561,7 +562,7 @@ async def update(self, _init_options: Optional[dict] = {}, _init = True, **kwarg
         else:
             kwargs["channels"] = [x.id for x in self.channels]
 
-        if not len(_init_options):
+        if _init_options is None:
             _init_options = {"parent": self.parent}
 
         await misc._update(self, init_options=_init_options, _init=_init, **kwargs)
@@ -657,7 +658,7 @@ def __init__(self,
                  end_period: Union[int, timedelta],
                  data: Union[str, discord.Embed, FILE, Iterable[Union[str, discord.Embed, FILE]], _FunctionBaseCLASS],
                  mode: Optional[Literal["send", "edit", "clear-send"]] = "send",
-                 start_in: Optional[Union[timedelta, datetime]] = datetime.now(),
+                 start_in: Optional[Union[timedelta, datetime]] = timedelta(seconds=0),
                  remove_after: Optional[Union[int, timedelta, datetime]] = None):
         super().__init__(start_period, end_period, data, start_in, remove_after)
         self.mode = mode
@@ -877,7 +878,7 @@ async def _send(self) -> MessageSendResult:
 
     @typechecked
     @misc._async_safe("update_semaphore")
-    async def update(self, _init_options: Optional[dict] = {}, _init = True, **kwargs):
+    async def update(self, _init_options: Optional[dict] = None, _init = True, **kwargs):
         """
         .. versionadded:: v2.0
 
@@ -907,7 +908,7 @@ async def update(self, _init_options: Optional[dict] = {}, _init = True, **kwarg
         if "data" not in kwargs:
             kwargs["data"] = self._data
 
-        if not len(_init_options):
+        if _init_options is None:
             _init_options = {"parent": self.parent}
 
         await misc._update(self, init_options=_init_options, _init=_init, **kwargs)

src/daf/message/voice_based.py

@@ -114,7 +114,7 @@ def __init__(self,
                  data: Union[AUDIO, Iterable[AUDIO], _FunctionBaseCLASS],
                  channels: Union[Iterable[Union[int, discord.VoiceChannel]], AutoCHANNEL],
                  volume: Optional[int] = 50,
-                 start_in: Optional[Union[timedelta, datetime]] = datetime.now(),
+                 start_in: Optional[Union[timedelta, datetime]] = timedelta(seconds=0),
                  remove_after: Optional[Union[int, timedelta, datetime]] = None):
 
         if not dtypes.GLOBALS.voice_installed:
@@ -387,7 +387,7 @@ async def _send(self) -> MessageSendResult:
 
     @typechecked
     @misc._async_safe("update_semaphore")
-    async def update(self, _init_options: Optional[dict] = {}, _init = True, **kwargs):
+    async def update(self, _init_options: Optional[dict] = None, _init = True, **kwargs):
         """
         .. versionadded:: v2.0
 
@@ -424,7 +424,7 @@ async def update(self, _init_options: Optional[dict] = {}, _init = True, **kwarg
         else:
             kwargs["channels"] = [x.id for x in self.channels]
 
-        if not len(_init_options):
+        if _init_options is None:
             _init_options = {"parent": self.parent}
 
         await misc._update(self, init_options=_init_options, _init=_init, **kwargs)

src/daf/misc.py

@@ -37,7 +37,7 @@ def _write_attr_once(obj: Any, name: str, value: Any):
         setattr(obj, name, value)
 
 
-async def _update(obj: Any, *, init_options: dict = {}, _init = True, **kwargs):
+async def _update(obj: Any, *, init_options: dict = None, _init = True, **kwargs):
     """
     .. versionadded:: v2.0
 
@@ -73,6 +73,9 @@ async def _update(obj: Any, *, init_options: dict = {}, _init = True, **kwargs):
     Other
         Raised from .initialize() method.
     """
+    if init_options is None:
+        init_options = {}
+
     # Retrieves list of call args
     init_keys = getfullargspec(obj.__init__.__wrapped__ if hasattr(obj.__init__, "__wrapped__") else obj.__init__).args
     init_keys.remove("self")

src/daf_gui/__init__.py

@@ -3,4 +3,4 @@
 from . import main
 
 if __name__ == "__main__":
-    main.run()
+    main.run()

src/daf_gui/widgets/convert.py

@@ -146,6 +146,12 @@ def __init__(self, class_, data: dict, real_object: object = None) -> None:
         self.data = data
         self.real_object = real_object
 
+    def __eq__(self, __value: object) -> bool:
+        if isinstance(__value, ObjectInfo):
+            return self.class_ is __value.class_ and __value.data == self.data and self.real_object is __value.real_object
+
+        return False
+
     def __repr__(self) -> str:
         _ret: str = self.class_.__name__ + "("
         for k, v in self.data.items():

src/daf_gui/widgets/extra.py

@@ -12,6 +12,7 @@
 import tkinter as tk
 import ttkbootstrap.dialogs.dialogs as tkdiag
 import tkinter.filedialog as tkfile
+from ttkbootstrap.tooltip import ToolTip
 
 import datetime as dt
 
@@ -107,6 +108,7 @@ def _callback(*args):
         async_execute(old.real_object.update(**values), parent_window=frame.origin_window)
 
     w.configure(command=_callback)
+    ToolTip(w, "Update the actual object with new parameters (taken from this window)", topmost=True)
     w.pack(side="right")
 
 
@@ -122,6 +124,7 @@ def _callback(*args):
         frame.save_gui_values()
 
     w.configure(command=_callback)
+    ToolTip(w, "Load updated values from the object into the window", topmost=True)
     w.pack(side="right", padx=dpi_scaled(2))