Skip to content

2000 char limit #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
epbay01 merged 4 commits into from
May 22, 2025
Merged

2000 char limit #60

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
72310ed
added compressable middle part of the error message so that we can ha…
epbay01 May 21, 2025
88c46bb
Merge branch 'dev' into 2000-char-limit
epbay01 May 21, 2025
4c17110
traceback test
epbay01 May 21, 2025
4273871
Merge branch '2000-char-limit' of https://github.com/byuawsfhtl/PyBug…
epbay01 May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 21 additions & 5 deletions PyBugReporter/src/BugReporter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,24 +130,40 @@ def _handleError(self, e: Exception, repoName: str, *args, **kwargs) -> None:
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))
asyncio.run(self._sendBugReport_async(repoName, errorTitle, errorMessage, shortErrorMessage))

async def _sendBugReport_async(self, repoName: str, errorTitle: str, errorMessage: str) -> None:
async def _sendBugReport_async(self, repoName: str, errorTitle: str, errorMessage: str, shortErrorMessage: str) -> None:
"""Sends a bug report to the Github repository asynchronously.

Args:
Expand Down Expand Up @@ -197,7 +213,7 @@ async def _sendBugReport_async(self, repoName: str, errorTitle: str, errorMessag
# Send to Discord if applicable
if self.handlers[repoName].useDiscord:
discordBot = DiscordBot(self.handlers[repoName].botToken, self.handlers[repoName].channelId)
await discordBot.send_message(f"## {repoName}: {errorTitle}\n{errorMessage}", issueExists)
await discordBot.send_message(shortErrorMessage, issueExists)

if (not issueExists):
result = await client.execute_async(query=createIssue, variables=variables, headers=headers)
Expand Down
35 changes: 34 additions & 1 deletion test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,39 @@

@BugReporter('PyBugReporter', extraInfo=True, env='test')
def test(item, item2=None):
raise Exception("This is a test exception")
raise Exception("""
This is a really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really
really really really really really really really really long test exception
""")

test(None, item2='item2')