Merge pull request #15 from DirectiveAthena/v0.7.0

V0.7.0

Author: AnnaSasDev

README.md

@@ -41,20 +41,21 @@ class newBot(AthenaTwitchBot.TwitchBot):
   # - Command -
   #   A command is only ran when it is invoked by a user in chat
   #   In the following case this would be by typing "!ping" in chat
-  @AthenaTwitchBot.command_method(name="ping")
+  @AthenaTwitchBot.TwitchBotMethod.command(names="ping")
   def command_ping(self, context: AthenaTwitchBot.TwitchContext):
-    context.reply("pong!")  # a "context.reply" function will reply to the user whi invoked the command
+    context.reply("pong!")  # a "context.reply" function will reply to the user who invoked the command
 
   # - Task -
   #   A task is run automatically every "delay" amount of seconds
   #   In the following case, the method will be run every minute
-  #   The "wait_before" kwarg defines if the asyncio.sleep runs before or after the first call of the callback
-  @AthenaTwitchBot.scheduled_task_method(delay=60, wait_before=True)
+  #   The "call_on_startup" kwarg defines if the task has to be run on bot startup
+  @AthenaTwitchBot.TwitchBotMethod.scheduled_task(interval=AthenaLib.models.Minute(1), call_on_startup=True)
   def task_post_github(self, context: AthenaTwitchBot.TwitchContext):
     context.write(f"This bot is made possible by: https://github.com/DirectiveAthena/AthenaTwitchBot")
 
 # --- Main function ---
 def main():
+  # the launch function handles everything about the protocol setup and command handling
   AthenaTwitchBot.launch(
     bot=newBot(),
     ssl=True  # set to true to enable ssl connection to Twitch

src/AthenaTwitchBot/models/decorator_helpers/command.py renamed to Tests/__init__.py

@@ -3,8 +3,6 @@
 # ----------------------------------------------------------------------------------------------------------------------
 # General Packages
 from __future__ import annotations
-from dataclasses import dataclass
-from typing import Callable
 
 # Custom Library
 
@@ -13,9 +11,3 @@
 # ----------------------------------------------------------------------------------------------------------------------
 # - Code -
 # ----------------------------------------------------------------------------------------------------------------------
-@dataclass(kw_only=True, match_args=True, slots=True)
-class Command:
-    name:str
-    case_sensitive:bool
-    callback:Callable
-    args_enabled:bool

Tests/models/__init__.py

@@ -0,0 +1,13 @@
+# ----------------------------------------------------------------------------------------------------------------------
+# - Package Imports -
+# ----------------------------------------------------------------------------------------------------------------------
+# General Packages
+from __future__ import annotations
+
+# Custom Library
+
+# Custom Packages
+
+# ----------------------------------------------------------------------------------------------------------------------
+# - Code -
+# ----------------------------------------------------------------------------------------------------------------------

Tests/models/test_TwitchBotMethod.py

@@ -0,0 +1,75 @@
+# ----------------------------------------------------------------------------------------------------------------------
+# - Package Imports -
+# ----------------------------------------------------------------------------------------------------------------------
+# General Packages
+from __future__ import annotations
+import unittest
+
+# Custom Library
+from AthenaTwitchBot.models.twitch_bot_method import TwitchBotMethod
+from AthenaTwitchBot.models.twitch_channel import TwitchChannel
+
+# Custom Packages
+from Tests.support import EmptyBot
+
+# ----------------------------------------------------------------------------------------------------------------------
+# - Support Code -
+# ----------------------------------------------------------------------------------------------------------------------
+class TestBot_0(EmptyBot):
+    @TwitchBotMethod().command(names="help")
+    def command_help(self):
+        return "not helping"
+
+class TestBot_1(EmptyBot):
+    def __init__(self):
+        self.name = "TestBot_1"
+        super(TestBot_1, self).__init__()
+
+    @TwitchBotMethod(channels=["some_channel"]).command(names="help")
+    def command_help(self):
+        return f"{self.name}"
+
+class TestBot_2(EmptyBot):
+    @TwitchBotMethod.command(names="help")
+    def command_help(self):
+        return "not helping"
+
+# ----------------------------------------------------------------------------------------------------------------------
+# - Code -
+# ----------------------------------------------------------------------------------------------------------------------
+class Test_TwitchBotMethod(unittest.TestCase):
+    def test_Bot0(self):
+        test_bot0 = TestBot_0()
+
+        self.assertEqual(
+            [],
+            test_bot0.command_help.channels
+        )
+
+        self.assertEqual(
+            "not helping",
+            test_bot0.command_help.callback()
+        )
+
+    def test_Bot1(self):
+        test_bot1 = TestBot_1()
+        self.assertEqual(
+            [TwitchChannel("some_channel")],
+            test_bot1.command_help.channels
+        )
+        self.assertIs(
+            test_bot1,
+            test_bot1.command_help.owner
+        )
+        self.assertEqual(
+            test_bot1.name,
+            test_bot1.command_help.callback()
+        )
+
+    def test_Bot2(self):
+        test_bot2 = TestBot_2()
+        self.assertEqual(
+            [],
+            test_bot2.command_help.channels
+        )
+

Tests/support.py

@@ -0,0 +1,22 @@
+# ----------------------------------------------------------------------------------------------------------------------
+# - Package Imports -
+# ----------------------------------------------------------------------------------------------------------------------
+# General Packages
+from __future__ import annotations
+
+# Custom Library
+from AthenaTwitchBot.models.twitch_bot import TwitchBot
+
+# Custom Packages
+
+# ----------------------------------------------------------------------------------------------------------------------
+# - Support Code -
+# ----------------------------------------------------------------------------------------------------------------------
+class EmptyBot(TwitchBot):
+    def __init__(self):
+        super(EmptyBot, self).__init__(
+            nickname="empty_bot",
+            oauth_token="...",
+            channels=["directiveathena"],
+            prefix="!",
+        )

setup.py

@@ -18,7 +18,7 @@ def readme_handler() -> str:
 
 def version_handler() -> str:
     # ------------------------------------------------------------------------------------------------------------------
-    version = 0,6,1 # <-- DEFINE THE VERSION IN A TUPLE FORMAT HERE
+    version = 0,7,0 # <-- DEFINE THE VERSION IN A TUPLE FORMAT HERE
     # ------------------------------------------------------------------------------------------------------------------
     version_str = ".".join(str(i) for i in version)
 

src/AthenaTwitchBot/__init__.py

@@ -1,12 +1,10 @@
 # ----------------------------------------------------------------------------------------------------------------------
 # - Package Imports -
 # ----------------------------------------------------------------------------------------------------------------------
-from AthenaTwitchBot.decorators.command import command_method
-from AthenaTwitchBot.decorators.scheduled_task import scheduled_task_method
-
 from AthenaTwitchBot.models.twitch_bot import TwitchBot
 from AthenaTwitchBot.models.twitch_bot_protocol import TwitchBotProtocol
 from AthenaTwitchBot.models.twitch_context import TwitchContext
+from AthenaTwitchBot.models.twitch_bot_method import TwitchBotMethod
 
 from AthenaTwitchBot.functions.launch import launch
 

src/AthenaTwitchBot/data/dict_mapping_logic.py

@@ -14,28 +14,29 @@
 # - Code -
 # ----------------------------------------------------------------------------------------------------------------------
 MESSAGE_TAG_MAPPING:dict[str:Callable] = {
-    "@badge-info":               "badge_info",
-    "badges":                    "badges",
-    "client-nonce":              "client_nonce",
-    "color":                     "color",
-    "display-name":              "display_name",
-    "emotes":                    "emotes",
-    "first-msg":                 "first_msg",
-    "flags":                     "flags",
-    "id":                        "message_id",
-    "mod":                       "mod",
-    "room-id":                   "room_id",
-    "subscriber":                "subscriber",
-    "tmi-sent-ts":               "tmi_sent_ts",
-    "turbo":                     "turbo",
-    "user-id":                   "user_id",
-    "user-type":                 "user_type",
-    "reply-parent-display-name": "reply_parent_display_name",
-    "reply-parent-msg-body":     "reply_parent_msg_body",
-    "reply-parent-msg-id":       "reply_parent_msg_id",
-    "reply-parent-user-id":      "reply_parent_user_id",
-    "reply-parent-user-login":   "reply_parent_user_login",
-    "emote-only":                "emote_only",
+    "@badge-info":                  "badge_info",
+    "badges":                       "badges",
+    "client-nonce":                 "client_nonce",
+    "color":                        "color",
+    "display-name":                 "display_name",
+    "emotes":                       "emotes",
+    "first-msg":                    "first_msg",
+    "flags":                        "flags",
+    "id":                           "message_id",
+    "mod":                          "mod",
+    "room-id":                      "room_id",
+    "subscriber":                   "subscriber",
+    "tmi-sent-ts":                  "tmi_sent_ts",
+    "turbo":                        "turbo",
+    "user-id":                      "user_id",
+    "user-type":                    "user_type",
+    "reply-parent-display-name":    "reply_parent_display_name",
+    "reply-parent-msg-body":        "reply_parent_msg_body",
+    "reply-parent-msg-id":          "reply_parent_msg_id",
+    "reply-parent-user-id":         "reply_parent_user_id",
+    "reply-parent-user-login":      "reply_parent_user_login",
+    "emote-only":                   "emote_only",
+    "returning-chatter":            "returning_chatter"
 }
 
 MESSAGE_TAG_CONVERSION_MAPPING:dict[str:Callable] = {
@@ -57,8 +58,9 @@
     "user-type":                lambda value: value,
     "reply-parent-display-name":lambda value: value,
     "reply-parent-msg-body":    lambda value: value,
-    "reply-parent-msg-id":      lambda value: int(value),
+    "reply-parent-msg-id":      lambda value: value,
     "reply-parent-user-id":     lambda value: int(value),
     "reply-parent-user-login":  lambda value: value,
     "emote-only":               lambda value: bool(int(value)),
+    "returning-chatter":        lambda value: bool(int(value)),
 }