Merge branch 'release/1.2.1' into main

Author: dotchetter

CHANGELOG.md

@@ -1,14 +1,26 @@
 # Pyttman Changelog
 
 
+# V 1.2.1
+This release includes an important update for the discord client.
+Any application using Pyttman will need to upgrade to this version for the 
+app to still work after new year 2023 due to Discord API changes.
+
+
+### **🐛 Splatted bugs and corrected issues** 
+* **Fixes [#71](https://github.com/dotchetter/Pyttman/issues/71)**
+* Reduced dependencies to 1/3 of previous versions, improving security and reducing dependency exposure.
+* Fixes various spelling errors in the code and comments
+    
+
 # V 1.2.0.4
 This is a hotfix release, fixing an issue with BoolEntityField instances 
 not parsing the values correctly if the sought word is also part of the 
 'lead' and/or 'trail' tuples.
 
 
 ### **🐛 Splatted bugs and corrected issues** 
-* **Fixes [#69](https://github.com/dotchetter/Pyttman/issues/68)**
+* **Fixes [#69](https://github.com/dotchetter/Pyttman/issues/69)**
 
 
 

README.md

@@ -17,7 +17,7 @@ trying to decipher a message and its contents to find words of interest? Maybe t
 The Pyttman Framework aims to provide a similar experience as Django and Flask does for web, but for chatbots and digital assistants.
 It's large and full of features yet easy to use.
 
-# Abiliy, Intent, Entity
+# Ability, Intent, Entity
 Pyttman apps are structured with inspiration from the MVC (Model View Controller) 
 pattern, but things are named a bit differently. Here's a short rundown on what they're about.
 
@@ -172,7 +172,7 @@ on a different platform.
 * Built-in thread based task scheduler 
 * Abstraction layer middleware for managing incoming Messages just like requests in API frameworks
 * Django-like settings.py file
-* Powerful built-in rule-based API for parsing entities in messages (identifying words based on pre/suffixes and/or regex patterns, and/or order of appearence
+* Powerful built-in rule-based API for parsing entities in messages (identifying words based on pre/suffixes and/or regex patterns, and/or order of appearance
 
 
 ### Documentation

pyttman/__init__.py

@@ -1,3 +1,5 @@
+from pyttman.core.internals import PyttmanApp
+
 from pyttman import version
 from pyttman.tools.scheduling.schedule import schedule
 from pyttman.tools.logger.logger import PyttmanLogger
@@ -30,7 +32,7 @@ def __getattr__(self, item):
                                   "move lifecycle hooks to a separate module.")
 
 
-app = None
+app: PyttmanApp | None = None
 settings = _SettingsNotConfigured
 is_configured = False
 logger = PyttmanLogger

pyttman/clients/community/discord/client.py

@@ -1,8 +1,12 @@
-
 import asyncio
 from datetime import datetime
 
 import discord
+from discord import Intents
+
+from pyttman import logger
+from pyttman.core.middleware.routing import AbstractMessageRouter
+from pyttman.core.exceptions import ClientImproperlyConfiguredError
 from pyttman.clients.base import BaseClient
 from pyttman.clients.community.discord.misc import DiscordMessage
 from pyttman.core.containers import Reply, ReplyStream
@@ -52,13 +56,47 @@ class DiscordClient(discord.Client, BaseClient):
         be parsed.
     """
     token: str = ""
-    guild: str = ""
+    guild: int = None
     message_startswith: str = ""
     message_endswith: str = ""
 
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        [setattr(self, k, v) for k, v in kwargs.items()]
+    def __init__(self,
+                 message_router: AbstractMessageRouter,
+                 token: str,
+                 guild: int,
+                 *args,
+                 **kwargs):
+        try:
+            discord_intent_flags = kwargs["discord_intent_flags"]
+            discord_intents = discord.Intents(**discord_intent_flags)
+            if not discord_intents:
+                raise ClientImproperlyConfiguredError(
+                    "Pyttman cannot start the Discord client without the "
+                    "discord intent 'message_content' being set to True, "
+                    "since the contents in the message are required to "
+                    "do the routing and deliver the Entities found in the "
+                    "message.")
+        except KeyError:
+            raise ClientImproperlyConfiguredError(
+                "Could not find 'discord_intent_flags' in 'CLIENT' section "
+                "in settings.py for this app, and it's required. The app cannot "
+                "start. Refer to the documentation for settings.py to setup "
+                "the client and the discord intent flags correctly.")
+
+        message_startswith = kwargs.get("message_startswith")
+        message_endswith = kwargs.get("message_endswith")
+        self.message_startswith = message_startswith or self.message_startswith
+        self.message_startswith = message_endswith or self.message_endswith
+        self.message_router = message_router
+        self._token = token
+        self.guild = guild
+        super().__init__(*args,
+                         **kwargs,
+                         guild=guild,
+                         intents=discord_intents)
+
+    async def on_ready(self):
+        logger.log(f"App online on discord.")
 
     async def on_message(self, message: DiscordMessage) -> None:
         """
@@ -71,6 +109,7 @@ async def on_message(self, message: DiscordMessage) -> None:
         :param message: discord.Message
         :return: None
         """
+        print("Message recieved:", message)
         if message.author == self.user:
             return
 
@@ -109,20 +148,23 @@ async def on_message(self, message: DiscordMessage) -> None:
                 _generate_error_entry(discord_message, e).as_str())
 
     def run_client(self):
-        if not self.token or not self.guild:
-            raise ValueError("Cannot connect - missing authentication."
-                             "'token' and 'guild' must be provided when "
-                             "using the Discord client. Specify these "
-                             "values in the dictionary for the client "
-                             "as {\"token\": \"foo_token\", \"guild\": "
-                             "\"foo_guild\"}")
-        _token = self.token
-        del self.token
+        if not self._token:
+            raise ClientImproperlyConfiguredError(
+                "Cannot connect - missing authentication."
+                "'token' must be provided when "
+                "using the Discord client. Specify these "
+                "values in the dictionary for the client "
+                "as {\"token\": \"foo_token\", \"guild\": "
+                "\"foo_guild\"}")
+
+        _token = self._token
+        del self._token
 
         try:
             self.run(_token)
         except Exception as e:
-            raise RuntimeError("DiscordClient ran in to a problem. "
-                               "Please ensure that all data is provided "
-                               "correctly in settings.py."
-                               f"Excact error message: \"{e}\"")
+            raise ClientImproperlyConfiguredError(
+                "DiscordClient ran in to a problem. "
+                "Please ensure that all data is provided "
+                "correctly in settings.py."
+                f"Exact error message: \"{e}\"")

pyttman/clients/community/discord/misc.py

@@ -9,7 +9,7 @@ class DiscordMessage(MessageMixin, discord.Message):
     of the Pyttman framework depend on, while also
     supporting the Discord module and API for interacting
     with its API to support full interaction with the
-    discord plattform from within applications developed
+    discord platform from within applications developed
     in Pyttman, and not just the content of the message.
 
     This class is designed to be used with the DiscordClient

pyttman/core/containers.py

@@ -58,7 +58,7 @@ def content(self, val):
                 self._content = repr(val).split()
             except Exception:
                 raise TypeError(f"content cannot be type {type(val)} "
-                                f"as it is could not be typecasted to "
+                                f"as it is could not be typecast to "
                                 f"str.")
 
     def sanitized_content(self, preserve_case=False) -> List[str]:

pyttman/core/entity_parsing/identifiers.py

@@ -15,9 +15,9 @@ class Identifier:
     whether they are capitalized, have a date-like
     format to them, and alike.
 
-    Subclasses can define very granularly how
+    Subclasses can define in a very granular way, how
     a string can look by strict rules, or less
-    so with less defined criterias.
+    so with less defined criterion.
 
     The Identifier will use regex to assess
     the similarity of given string.

pyttman/core/exceptions.py

@@ -24,3 +24,13 @@ class InvalidPyttmanObjectException(BaseException):
     """
     def __init__(self, message):
         super().__init__(message)
+
+
+class ClientImproperlyConfiguredError(BaseException):
+    """
+    This error is raised when a Client is misconfigured in settings.py
+    for a pyttman project.
+    """
+    def __init__(self, message):
+        super().__init__(message)
+

pyttman/core/intent.py

@@ -4,16 +4,16 @@
 from collections import OrderedDict
 from itertools import zip_longest
 
-from pyttman.core.entity_parsing.fields import EntityFieldBase
-from pyttman.core.entity_parsing.parsers import EntityFieldValueParser
-from pyttman.core.internals import _generate_name, depr_graceful
-from pyttman.core.mixins import PrettyReprMixin
-from pyttman.core.storage.basestorage import Storage
 from pyttman.core.containers import (
     Reply,
     ReplyStream,
     Message
 )
+from pyttman.core.entity_parsing.fields import EntityFieldBase
+from pyttman.core.entity_parsing.parsers import EntityFieldValueParser
+from pyttman.core.internals import _generate_name
+from pyttman.core.mixins import PrettyReprMixin
+from pyttman.core.storage.basestorage import Storage
 
 
 class AbstractIntent(abc.ABC):

pyttman/tools/logger/logger.py

@@ -62,7 +62,7 @@ def loggedmethod(func):
         @functools.wraps(func)
         def inner(*args, **kwargs):
             """
-            Inner method, executing the func paramter function,
+            Inner method, executing the func parameter function,
             as well as executing the logger.
             :returns:
                 Output from executed function in parameter func
@@ -74,7 +74,7 @@ def inner(*args, **kwargs):
                 return results
             except Exception as e:
                 pyttman.logger.LOG_INSTANCE.error(
-                    f'Exception occured in {func.__name__}. Traceback '
+                    f'Exception occurred in {func.__name__}. Traceback '
                     f'{traceback.format_exc()} {e}')
                 raise e
         return inner