PyBugReporter 1.0.12__tar.gz → 1.0.15__tar.gz

{pybugreporter-1.0.12 → pybugreporter-1.0.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyBugReporter
-Version: 1.0.12
+Version: 1.0.15
 Summary: A python library for catching thrown exceptions and automatically creating issues on a GitHub repo.
 Home-page: https://github.com/byuawsfhtl/PyBugReporter.git
 Author: Record Linking Lab

pybugreporter-1.0.15/PyBugReporter/_version.py

@@ -0,0 +1 @@
+__version__ = '1.0.15'

{pybugreporter-1.0.12 → pybugreporter-1.0.15}/PyBugReporter/src/BugReporter.py

@@ -1,4 +1,5 @@
 import asyncio
+import inspect
 import sys
 import traceback
 from functools import wraps
@@ -93,20 +94,38 @@ class BugReporter:
         Args:
             func (callable): the function to be decorated
         """
-        @wraps(func)
-        def wrapper(*args, **kwargs) -> None:
-            """Wrapper function that catches exceptions and sends a bug report to the github repository.
-
-            Args:
-                *args: the arguments for the function
-                **kwargs: the keyword arguments for the function
-            """
-            repoName = self.repoName
-            try:
-                return func(*args, **kwargs)
-            except Exception as e:
-                self._handleError(e, repoName, *args, **kwargs)
-        return wrapper
+        if inspect.iscoroutinefunction(func):
+            @wraps(func)
+            async def wrapper_async(*args, **kwargs) -> None:
+                """Wrapper function that catches exceptions and sends a bug report to the github repository.
+                Works for async functions.
+                
+                Args:
+                    *args: the arguments for the function
+                    **kwargs: the keyword arguments for the function
+                """
+                repoName = self.repoName
+                try:
+                    return func(*args, **kwargs)
+                except Exception as e:
+                    await self._handleError_async(e, repoName, *args, **kwargs)
+            return wrapper_async
+        else:
+            @wraps(func)
+            def wrapper(*args, **kwargs) -> None:
+                """Wrapper function that catches exceptions and sends a bug report to the github repository.
+                Works for synchronous functions.
+                
+                Args:
+                    *args: the arguments for the function
+                    **kwargs: the keyword arguments for the function
+                """
+                repoName = self.repoName
+                try:
+                    return func(*args, **kwargs)
+                except Exception as e:
+                    self._handleError(e, repoName, *args, **kwargs)
+            return wrapper
 
     def _handleError(self, e: Exception, repoName: str, *args, **kwargs) -> None:
         """Handles error by creating a bug report.
@@ -117,6 +136,46 @@ class BugReporter:
         Raises:
             e: the exception that was raised
         """
+        title, description, shortDescription = self._prepare_bug_report(e, repoName, args, kwargs)
+
+        # Check if we need to send a bug report
+        if not self.handlers[repoName].test:
+            self._sendBugReport(repoName, title, description, shortDescription)
+
+        print(title)
+        print(description)
+        raise e
+    
+    async def _handleError_async(self, e: Exception, repoName: str, *args, **kwargs) -> None:
+        """Handles error by creating a bug report asynchronously.
+
+        Args:
+            e (Exception): the exception that was raised
+
+        Raises:
+            e: the exception that was raised
+        """
+        title, description, shortDescription = self._prepare_bug_report(e, repoName, args, kwargs)
+
+        # Check if we need to send a bug report
+        if not self.handlers[repoName].test:
+            await self._sendBugReport_async(repoName, title, description, shortDescription)
+
+        print(title)
+        print(description)
+        raise e
+
+
+    def _prepare_bug_report(self, e: Exception, repoName: str, *args, **kwargs) -> tuple[str,str,str]:
+        """Prepares all information needed to send the bug report.
+
+        Args:
+            e (Exception): the exception that was raised
+
+        Returns:
+            tuple[str,str,str]: The title, description, and short description of the error for the report.
+        
+        """
         excType = type(e).__name__
         tb = traceback.extract_tb(sys.exc_info()[2])
         functionName = tb[-1][2]
@@ -144,15 +203,7 @@ class BugReporter:
             shortDescription = f"{start}{compress[:2000 - staticLength]}{end}"
 
         print(f"SHORT DESCRIPTION with length {len(shortDescription)}:\n{shortDescription}")
-        
-
-        # Check if we need to send a bug report
-        if not self.handlers[repoName].test:
-            self._sendBugReport(repoName, title, description, shortDescription)
-
-        print(title)
-        print(description)
-        raise e
+        return title,description,shortDescription
 
     def _sendBugReport(self, repoName: str, errorTitle: str, errorMessage: str, shortErrorMessage: str) -> None:
         """Sends a bug report to the Github repository.
@@ -213,7 +264,7 @@ class BugReporter:
         # Send to Discord if applicable
         if self.handlers[repoName].useDiscord:
             discordBot = DiscordBot(self.handlers[repoName].botToken, self.handlers[repoName].channelId)
-            await discordBot.send_message(shortErrorMessage, issueExists)
+            await discordBot.send_message(shortErrorMessage, issueExists, errorTitle)
 
         if (not issueExists):
             result = await client.execute_async(query=createIssue, variables=variables, headers=headers)
@@ -430,7 +481,7 @@ class BugReporter:
         # Send to Discord if applicable
         if cls.handlers[repoName].useDiscord:
             discordBot = DiscordBot(cls.handlers[repoName].botToken, cls.handlers[repoName].channelId)
-            await discordBot.send_message(f"## {repoName}: {errorTitle}\n{errorMessage}", issueExists)
+            await discordBot.send_message(f"## {repoName}: {errorTitle}\n{errorMessage}", issueExists, errorTitle)
 
         if (issueExists == False):
             result = await client.execute_async(query=createIssue, variables=variables, headers=headers)

{pybugreporter-1.0.12 → pybugreporter-1.0.15}/PyBugReporter/src/DiscordBot.py

@@ -27,6 +27,7 @@ class DiscordBot(discord.Client):
         self.channelId = int(channelId)
         self._message = None
         self._alreadySent = False
+        self._title = None
         self._doneFuture = None
 
         intents = discord.Intents(emojis = True,
@@ -36,16 +37,18 @@ class DiscordBot(discord.Client):
                                   guilds = True)
         super().__init__(intents=intents)
 
-    async def send_message(self, message, alreadySent = False):
+    async def send_message(self, message, alreadySent = False, title = None):
         """
         Sends a message to the specified channel by setting the variables and starting the bot, then turning it off when finished.
 
         Args:
             message (str): The message to send.
             alreadySent (bool): Whether the message has already been sent.
+            title (str): The stable error title used to find the original message when reacting.
         """
         self._message = message
         self._alreadySent = alreadySent
+        self._title = title
         self._doneFuture = asyncio.get_running_loop().create_future()
         print("Starting bot...")
         # Start the bot as a background task
@@ -64,7 +67,7 @@ class DiscordBot(discord.Client):
                 print(f"Sent message to channel {self.channelId}")
             elif channel and self._alreadySent:
                 async for message in channel.history(limit=HISTORY_LIMIT):
-                    if message.content == self._message:
+                    if self._title and self._title in message.content:
                         await message.add_reaction(EMOJI)
                         break
             else:

{pybugreporter-1.0.12 → pybugreporter-1.0.15}/PyBugReporter.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyBugReporter
-Version: 1.0.12
+Version: 1.0.15
 Summary: A python library for catching thrown exceptions and automatically creating issues on a GitHub repo.
 Home-page: https://github.com/byuawsfhtl/PyBugReporter.git
 Author: Record Linking Lab

pybugreporter-1.0.12/PyBugReporter/_version.py

@@ -1 +0,0 @@
-__version__ = '1.0.12'