PyBugReporter 1.0.9__tar.gz → 1.0.11__tar.gz

{pybugreporter-1.0.9 → pybugreporter-1.0.11}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: PyBugReporter
-Version: 1.0.9
+Version: 1.0.11
 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
@@ -9,11 +9,13 @@ Project-URL: Bug Tracker, https://github.com/byuawsfhtl/PyBugReporter/issues
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: python-graphql-client~=0.4.3
+Requires-Dist: discord.py~=2.0.1
 Dynamic: author
 Dynamic: author-email
 Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
+Dynamic: license-file
 Dynamic: project-url
 Dynamic: requires-dist
 Dynamic: summary

pybugreporter-1.0.11/PyBugReporter/_version.py

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

pybugreporter-1.0.9/PyBugReporter.egg-info/requires.txt → pybugreporter-1.0.11/PyBugReporter/requirements.txt

@@ -1 +1,2 @@
 python-graphql-client~=0.4.3
+discord.py~=2.0.1

{pybugreporter-1.0.9 → pybugreporter-1.0.11}/PyBugReporter/src/BugReporter.py

@@ -2,6 +2,7 @@ import asyncio
 import sys
 import traceback
 from functools import wraps
+from PyBugReporter.src.DiscordBot import DiscordBot
 
 from python_graphql_client import GraphqlClient
 
@@ -25,8 +26,11 @@ class BugHandler:
     repoName: str = ''
     orgName: str = ''
     test: bool = False
+    useDiscord: bool = False
+    botToken: str = ''
+    channelId: str | int = ''
 
-    def __init__(self, githubKey: str, repoName: str, orgName: str, test: bool) -> None:
+    def __init__(self, githubKey: str, repoName: str, orgName: str, test: bool, useDiscord: bool = False, botToken: str = "", channelId: str | int = "") -> None:
         """Saves the given information in the BugHandler object.
 
         Args:
@@ -34,11 +38,19 @@ class BugHandler:
             repoName (str): the name of the repo to report to
             orgName (str): the organization of the repo
             test (bool): whether or not bugs in this code should actually be reported
+            useDiscord (bool): whether to send the bug report to Discord
+            botToken (str): the token for the Discord bot
+            channelId (str | int): the ID of the Discord channel to send messages to
         """
         self.githubKey = githubKey
         self.repoName = repoName
         self.orgName = orgName
         self.test = test
+        self.useDiscord = useDiscord
+
+        if useDiscord:
+            self.botToken = botToken
+            self.channelId = channelId
 
 class BugReporter:
     """Sends errors to their corresponding repos.
@@ -64,7 +76,7 @@ class BugReporter:
         self.kwargs = kwargs
 
     @classmethod
-    def setVars(cls, githubKey: str, repoName: str, orgName: str, test: bool) -> None:
+    def setVars(cls, githubKey: str, repoName: str, orgName: str, test: bool, useDiscord: bool = False, botToken: str = "", channelId: str = "") -> None:
         """Sets the necessary variables to make bug reports.
 
         Args:
@@ -73,7 +85,7 @@ class BugReporter:
             orgName (str): the name of the organization
             test (bool): whether to run in testing mode
         """
-        cls.handlers[repoName] = BugHandler(githubKey, repoName, orgName, test)
+        cls.handlers[repoName] = BugHandler(githubKey, repoName, orgName, test, useDiscord, botToken, channelId)
 
     def __call__(self, func: callable) -> None:
         """Decorator that catches exceptions and sends a bug report to the github repository.
@@ -118,26 +130,51 @@ class BugReporter:
         if self.extraInfo:
             description += f"\nExtra Info: {self.kwargs}"
 
+        # shortened description for discord if too long (shortens the error text)
+        start = f"# {title}\n\nType: {excType}\nError text: "
+        compress = f"{e}\nTraceback: {traceback.format_exc()}"
+        end = f"\n\nFunction Name: {functionName}\nArguments: {args}\nKeyword Arguments: {kwargs}"
+        if self.extraInfo:
+            end += f"\nExtra Info: {self.kwargs}"
+
+        staticLength = len(start) + len(end)
+        if staticLength > 2000:
+            shortDescription = f"# {title}\n\n" + description[:2000 - len(f"# {title}\n\n") - 3] + "..."
+        else:
+            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)
+            self._sendBugReport(repoName, title, description, shortDescription)
 
         print(title)
         print(description)
         raise e
 
-    def _sendBugReport(self, repoName: str, errorTitle: str, errorMessage: str) -> None:
+    def _sendBugReport(self, repoName: str, errorTitle: str, errorMessage: str, shortErrorMessage: str) -> None:
         """Sends a bug report to the Github repository.
 
         Args:
             errorTitle (str): the title of the error
             errorMessage (str): the error message
-        """    
+        """ 
+        asyncio.run(self._sendBugReport_async(repoName, errorTitle, errorMessage, shortErrorMessage))
+   
+    async def _sendBugReport_async(self, repoName: str, errorTitle: str, errorMessage: str, shortErrorMessage: str) -> None:
+        """Sends a bug report to the Github repository asynchronously.
+        
+        Args:
+            errorTitle (str): the title of the error
+            errorMessage (str): the error message
+        """
         client = GraphqlClient(endpoint="https://api.github.com/graphql")
         headers = {"Authorization": f"Bearer {self.handlers[repoName].githubKey}"}
 
         # query variables
-        repoId = self._getRepoId(self.handlers[repoName])
+        repoId = await self._getRepoId_async(self.handlers[repoName])
         bugLabel = "LA_kwDOJ3JPj88AAAABU1q15w"
         autoLabel = "LA_kwDOJ3JPj88AAAABU1q2DA"
         
@@ -171,10 +208,15 @@ class BugReporter:
             }
         }
 
-        issueExists = self._checkIfIssueExists(self.handlers[repoName], errorTitle)
+        issueExists = await self._checkIfIssueExists_async(self.handlers[repoName], errorTitle)
 
-        if (issueExists == False):
-            result = asyncio.run(client.execute_async(query=createIssue, variables=variables, headers=headers))
+        # 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)
+
+        if (not issueExists):
+            result = await client.execute_async(query=createIssue, variables=variables, headers=headers)
             print('\nThis error has been reported to the Tree Growth team.\n')
 
             issueId = result['data']['createIssue']['issue']['id']  # Extract the issue ID
@@ -191,7 +233,7 @@ class BugReporter:
             """
             
             # Replace with your actual project ID
-            projectId = self.getProjectId(repoName, "Tree Growth Projects")
+            projectId = await self.getProjectId_async(repoName, "Tree Growth Projects")
 
             variables = {
                 "projectId": projectId,
@@ -199,12 +241,11 @@ class BugReporter:
             }
             
             # Execute the mutation to add the issue to the project
-            asyncio.run(client.execute_async(query=addToProject, variables=variables, headers=headers))
+            await client.execute_async(query=addToProject, variables=variables, headers=headers)
         else:
             print('\nOur team is already aware of this issue.\n')
 
-    def getProjectId(self, repoName: str, projectName: str) -> str:
-        """Retrieves the GitHub project ID for a specified repository and project name."""
+    async def getProjectId_async(self, repoName: str, projectName: str) -> str:
         client = GraphqlClient(endpoint="https://api.github.com/graphql")
         headers = {"Authorization": f"Bearer {self.handlers[repoName].githubKey}"}
 
@@ -228,7 +269,7 @@ class BugReporter:
         }
 
         # Execute the query
-        response = asyncio.run(client.execute_async(query=query, variables=variables, headers=headers))
+        response = await client.execute_async(query=query, variables=variables, headers=headers)
         projects = response["data"]["repository"]["projectsV2"]["nodes"]
 
         # Find the project with the matching name and return its ID
@@ -238,7 +279,7 @@ class BugReporter:
 
         raise ValueError(f"Project '{projectName}' not found in repository '{repoName}'.")
 
-    def _checkIfIssueExists(self, handler: BugHandler, errorTitle: str) -> bool:
+    async def _checkIfIssueExists_async(self, handler: BugHandler, errorTitle: str) -> bool:
         """Checks if an issue already exists in the repository.
 
         Args:
@@ -276,7 +317,7 @@ class BugReporter:
             "labels": autoLabel,
         }
 
-        result = asyncio.run(client.execute_async(query=findIssue, variables=variables, headers=headers))
+        result = await client.execute_async(query=findIssue, variables=variables, headers=headers)
         nodes = result['data']['organization']['repository']['issues']['nodes']
 
         index = 0
@@ -292,7 +333,7 @@ class BugReporter:
 
         return issueExists
 
-    def _getRepoId(self, handler: BugHandler) -> str:
+    async def _getRepoId_async(self, handler: BugHandler) -> str:
         """Gets the repository ID.
 
         Args:
@@ -318,13 +359,24 @@ class BugReporter:
             "name": handler.repoName
         }
 
-        repoID = asyncio.run(client.execute_async(query=getID, variables=variables, headers=headers))
+        repoID = await client.execute_async(query=getID, variables=variables, headers=headers)
         return repoID['data']['repository']['id']
 
     @classmethod
     def manualBugReport(cls, repoName: str, errorTitle: str, errorMessage: str) -> None:
         """Manually sends a bug report to the Github repository.
 
+        Args:
+            repoName (str): the name of the repo to report to
+            errorTitle (str): the title of the error
+            errorMessage (str): the error message
+        """
+        asyncio.run(cls.manualBugReportAsync(repoName,errorTitle,errorMessage))
+
+    @classmethod
+    async def manualBugReportAsync(cls, repoName: str, errorTitle: str, errorMessage: str) -> None:
+        """Manually sends a bug report to the Github repository.
+
         Args:
             repoName (str): the name of the repo to report to
             errorTitle (str): the title of the error
@@ -340,7 +392,7 @@ class BugReporter:
         headers = {"Authorization": f"Bearer {handler.githubKey}"}
 
         # query variables
-        repoId = cls._getRepoId(cls, handler)
+        repoId = await cls._getRepoId_async(cls, handler)
         bugLabel = "LA_kwDOJ3JPj88AAAABU1q15w"
         autoLabel = "LA_kwDOJ3JPj88AAAABU1q2DA"
         
@@ -373,10 +425,15 @@ class BugReporter:
             }
         }
 
-        issueExists = cls._checkIfIssueExists(cls, handler, errorTitle)
+        issueExists = await cls._checkIfIssueExists_async(cls, handler, errorTitle)
+
+        # 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)
 
         if (issueExists == False):
-            result = asyncio.run(client.execute_async(query=createIssue, variables=variables, headers=headers))
+            result = await client.execute_async(query=createIssue, variables=variables, headers=headers)
             print('\nThis error has been reported to the Tree Growth team.\n')
         else:
             print('\nOur team is already aware of this issue.\n')

pybugreporter-1.0.11/PyBugReporter/src/DiscordBot.py

@@ -0,0 +1,79 @@
+import asyncio
+import discord
+
+HISTORY_LIMIT = 20
+EMOJI = "‼"
+
+class DiscordBot(discord.Client):
+    """
+    A simple Discord bot that forwards the bug reports to a given Discord channel.
+
+    Attributes:
+        token (str): bot token
+        channel_id (int): the ID of the channel to send messages to
+        _message (str): message to send
+        _alreadySent (bool): whether the message has already been sent
+        _done_future (asyncio.Future): a future that is set when the bot is done
+    """
+    def __init__(self, token: str, channelId: str | int) -> None:
+        """
+        Initializes the Discord bot with the given token and channel ID.
+
+        Args:
+            token (str): bot token
+            channel_id (int): the ID of the channel to send messages to
+        """
+        self.token = token
+        self.channelId = int(channelId)
+        self._message = None
+        self._alreadySent = False
+        self._doneFuture = None
+
+        intents = discord.Intents(emojis = True,
+                                  guild_reactions = True,
+                                  message_content = True,
+                                  guild_messages = True,
+                                  guilds = True)
+        super().__init__(intents=intents)
+
+    async def send_message(self, message, alreadySent = False):
+        """
+        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.
+        """
+        self._message = message
+        self._alreadySent = alreadySent
+        self._doneFuture = asyncio.get_running_loop().create_future()
+        print("Starting bot...")
+        # Start the bot as a background task
+        asyncio.create_task(self.start(self.token))
+        # Wait until the message is sent and the bot is closed
+        await self._doneFuture
+
+    async def on_ready(self):
+        """
+        Called when the bot is ready. Also sends the message to the specified channel, or reacts if it's been sent.
+        """
+        try:
+            channel = await self.fetch_channel(self.channelId)
+            if channel and not self._alreadySent:
+                await channel.send(self._message)
+                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:
+                        await message.add_reaction(EMOJI)
+                        break
+            else:
+                print(f"Channel with ID {self.channelId} not found.")
+        except Exception as e:
+            print(f"Error sending message: {e}")
+        finally:
+            print("Shutting down bot...")
+            await self.close()
+            # Mark the future as done so send_message can return
+            if self._doneFuture and not self._doneFuture.done():
+                self._doneFuture.set_result(True)

{pybugreporter-1.0.9 → pybugreporter-1.0.11}/PyBugReporter.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: PyBugReporter
-Version: 1.0.9
+Version: 1.0.11
 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
@@ -9,11 +9,13 @@ Project-URL: Bug Tracker, https://github.com/byuawsfhtl/PyBugReporter/issues
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: python-graphql-client~=0.4.3
+Requires-Dist: discord.py~=2.0.1
 Dynamic: author
 Dynamic: author-email
 Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
+Dynamic: license-file
 Dynamic: project-url
 Dynamic: requires-dist
 Dynamic: summary

{pybugreporter-1.0.9 → pybugreporter-1.0.11}/PyBugReporter.egg-info/SOURCES.txt

@@ -10,4 +10,5 @@ PyBugReporter.egg-info/dependency_links.txt
 PyBugReporter.egg-info/requires.txt
 PyBugReporter.egg-info/top_level.txt
 PyBugReporter/src/BugReporter.py
+PyBugReporter/src/DiscordBot.py
 PyBugReporter/src/__init__.py

pybugreporter-1.0.11/PyBugReporter.egg-info/requires.txt

@@ -0,0 +1,2 @@
+python-graphql-client~=0.4.3
+discord.py~=2.0.1

pybugreporter-1.0.9/PyBugReporter/_version.py

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

pybugreporter-1.0.9/PyBugReporter/requirements.txt

@@ -1 +0,0 @@
-python-graphql-client~=0.4.3