PyBugReporter 1.0.7__py3-none-any.whl

PyBugReporter/_version.py

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

PyBugReporter/requirements.txt

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

PyBugReporter/src/BugReporter.py

@@ -0,0 +1,382 @@
+import asyncio
+import sys
+import traceback
+from functools import wraps
+
+from python_graphql_client import GraphqlClient
+
+class NotCreatedError(Exception):
+    """Raised when someone tries to report a bug to a repo that has not been set up as a reporting destination through setVars.
+    """
+    pass
+
+class BugHandler:
+    """A class for catching exceptions and automatically creating issues on a GitHub repo.
+
+    Attributes:
+        githubKey (str): the key used to make bug reports to our github
+        repoName (str): the name of the repository
+        orgName (str): the name of the organization
+        test (bool): whether to run in testing mode
+        extraInfo (bool): whether to include extra information in the bug report
+        kwargs: extra info for the bug report
+    """
+    githubKey: str = ''
+    repoName: str = ''
+    orgName: str = ''
+    test: bool = False
+
+    def __init__(self, githubKey: str, repoName: str, orgName: str, test: bool) -> None:
+        """Saves the given information in the BugHandler object.
+
+        Args:
+            githubKey (str): the key to use to make the issue
+            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
+        """
+        self.githubKey = githubKey
+        self.repoName = repoName
+        self.orgName = orgName
+        self.test = test
+
+class BugReporter:
+    """Sends errors to their corresponding repos.
+
+    Attributes:
+        handlers (dict): the created BugHandlers to use to send reports
+        extraInfo (bool): whether or not extra information is being passed in
+        repoName (str): the most recent set up repo to send to
+    """
+    handlers: dict = {}
+    extraInfo: bool = False
+    repoName: str
+
+    def __init__(self, repoName: str, extraInfo: bool, **kwargs) -> None:
+        """Initializes the BugReporter class as a decorator.
+        
+        Args:
+            extraInfo (bool): whether to include extra information in the bug report
+            **kwargs: extra info for the bug report
+        """
+        self.repoName = repoName
+        self.extraInfo = extraInfo
+        self.kwargs = kwargs
+
+    @classmethod
+    def setVars(cls, githubKey: str, repoName: str, orgName: str, test: bool) -> None:
+        """Sets the necessary variables to make bug reports.
+
+        Args:
+            githubKey (str): the key used to make bug reports to our github
+            repoName (str): the name of the repository
+            orgName (str): the name of the organization
+            test (bool): whether to run in testing mode
+        """
+        cls.handlers[repoName] = BugHandler(githubKey, repoName, orgName, test)
+
+    def __call__(self, func: callable) -> None:
+        """Decorator that catches exceptions and sends a bug report to the github repository.
+
+        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
+
+    def _handleError(self, e: Exception, repoName: str, *args, **kwargs) -> None:
+        """Handles error by creating a bug report.
+
+        Args:
+            e (Exception): the exception that was raised
+
+        Raises:
+            e: the exception that was raised
+        """
+        excType = type(e).__name__
+        tb = traceback.extract_tb(sys.exc_info()[2])
+        functionName = tb[-1][2]
+
+        # title for bug report
+        title = f"{repoName} had a {excType} error with the {functionName} function"
+
+        # description for bug report
+        description = f'Type: {excType}\nError text: {e}\nFunction Name: {functionName}\n\n{traceback.format_exc()}'
+        description += f"\nArguments: {args}\nKeyword Arguments: {kwargs}"
+        if self.extraInfo:
+            description += f"\nExtra Info: {self.kwargs}"
+
+        # Check if we need to send a bug report
+        if not self.handlers[repoName].test:
+            self._sendBugReport(repoName, title, description)
+
+        print(title)
+        print(description)
+        raise e
+
+    def _sendBugReport(self, repoName: str, errorTitle: str, errorMessage: str) -> None:
+        """Sends a bug report to the Github repository.
+
+        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])
+        bugLabel = "LA_kwDOJ3JPj88AAAABU1q15w"
+        autoLabel = "LA_kwDOJ3JPj88AAAABU1q2DA"
+        
+        # Create new issue
+        createIssue = """
+            mutation createIssue($input: CreateIssueInput!) {
+                createIssue(input: $input) {
+                    issue {
+                        id
+                        title                
+                        body
+                        repository {
+                            name
+                        }
+                        labels(first: 10) {
+                            nodes {
+                            name
+                            }
+                        }
+                    }
+                }
+            }
+        """
+
+        variables = {
+            "input": {
+                "repositoryId": repoId,
+                "title": errorTitle,
+                "body": errorMessage,
+                "labelIds": [bugLabel, autoLabel]
+            }
+        }
+
+        issueExists = self._checkIfIssueExists(self.handlers[repoName], errorTitle)
+
+        if (issueExists == False):
+            result = asyncio.run(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
+
+            # Mutation to add issue to a project
+            addToProject = """
+                mutation addToProject($projectId: ID!, $contentId: ID!) {
+                    addProjectV2ItemById(input: {projectId: $projectId, contentId: $contentId}) {
+                        item {
+                            id
+                        }
+                    }
+                }
+            """
+            
+            # Replace with your actual project ID
+            projectId = self.getProjectId(repoName, "Tree Growth Projects")
+
+            variables = {
+                "projectId": projectId,
+                "contentId": issueId
+            }
+            
+            # Execute the mutation to add the issue to the project
+            asyncio.run(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."""
+        client = GraphqlClient(endpoint="https://api.github.com/graphql")
+        headers = {"Authorization": f"Bearer {self.handlers[repoName].githubKey}"}
+
+        # Define the GraphQL query to list projects for the repository
+        query = """
+            query getProjectId($owner: String!, $repo: String!) {
+                repository(owner: $owner, name: $repo) {
+                    projectsV2(first: 10) {
+                        nodes {
+                            id
+                            title
+                        }
+                    }
+                }
+            }
+        """
+        
+        variables = {
+            "owner": self.handlers[repoName].orgName,
+            "repo": repoName
+        }
+
+        # Execute the query
+        response = asyncio.run(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
+        for project in projects:
+            if project["title"] == projectName:
+                return project["id"]
+
+        raise ValueError(f"Project '{projectName}' not found in repository '{repoName}'.")
+
+    def _checkIfIssueExists(self, handler: BugHandler, errorTitle: str) -> bool:
+        """Checks if an issue already exists in the repository.
+
+        Args:
+            handler (BugHandler): the object of reporting details
+            errorTitle (str): the title of the error
+
+        Returns:
+            bool: True if the issue exists, False if it does not
+        """
+        client = GraphqlClient(endpoint="https://api.github.com/graphql")
+        headers = {"Authorization": f"Bearer {handler.githubKey}"}
+
+        # query variables
+        autoLabel = "auto generated"
+
+        # Query to return all issues with auto gen label
+        findIssue = """
+            query findIssue ($login: String = "", $name: String = "", $labels: [String!] = "") {
+                organization(login: $login) {
+                    repository(name: $name) {
+                        issues(labels: $labels, first: 10, states: [OPEN]) {
+                            nodes {
+                                title,
+                                state
+                            }
+                        }
+                    }
+                }
+            }
+        """
+
+        variables = {
+            "login": handler.orgName,
+            "name": handler.repoName,
+            "labels": autoLabel,
+        }
+
+        result = asyncio.run(client.execute_async(query=findIssue, variables=variables, headers=headers))
+        nodes = result['data']['organization']['repository']['issues']['nodes']
+
+        index = 0
+        issueExists = False
+
+        while (len(nodes) > index) :
+            title = nodes[index]['title']
+            if (errorTitle == title) :
+                issueExists = True
+                break
+            else:
+                index += 1
+
+        return issueExists
+
+    def _getRepoId(self, handler: BugHandler) -> str:
+        """Gets the repository ID.
+
+        Args:
+            handler (BugHandler): the object of reporting details
+
+        Returns:
+            str: the repository ID
+        """
+        client = GraphqlClient(endpoint="https://api.github.com/graphql")
+        headers = {"Authorization": f"Bearer {handler.githubKey}"}
+
+        # query variables
+        getID = """
+            query getID($owner: String!, $name: String!) {
+                repository(owner: $owner, name: $name) {
+                    id
+                }
+            }
+        """
+
+        variables = {
+            "owner": handler.orgName,
+            "name": handler.repoName
+        }
+
+        repoID = asyncio.run(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
+        """
+        if repoName not in cls.handlers:
+            raise NotCreatedError(f"{repoName} has not been associated with a reporter")
+        handler = cls.handlers[repoName]
+        if handler.test == True:
+            print('This is a test run and no bug report will be sent.')
+            return
+        client = GraphqlClient(endpoint="https://api.github.com/graphql")
+        headers = {"Authorization": f"Bearer {handler.githubKey}"}
+
+        # query variables
+        repoId = cls._getRepoId(cls, handler)
+        bugLabel = "LA_kwDOJ3JPj88AAAABU1q15w"
+        autoLabel = "LA_kwDOJ3JPj88AAAABU1q2DA"
+        
+        # Create new issue
+        createIssue = """
+            mutation createIssue($input: CreateIssueInput!) {
+                createIssue(input: $input) {
+                    issue {
+                        title                
+                        body
+                        repository {
+                            name
+                        }
+                        labels(first: 10) {
+                            nodes {
+                            name
+                            }
+                        }
+                    }
+                }
+            }
+        """
+
+        variables = {
+            "input": {
+                "repositoryId": repoId,
+                "title": errorTitle,
+                "body": errorMessage,
+                "labelIds": [bugLabel, autoLabel]
+            }
+        }
+
+        issueExists = cls._checkIfIssueExists(cls, handler, errorTitle)
+
+        if (issueExists == False):
+            result = asyncio.run(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.7.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 byuawsfhtl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pybugreporter-1.0.7.dist-info/METADATA

@@ -0,0 +1,24 @@
+Metadata-Version: 2.2
+Name: PyBugReporter
+Version: 1.0.7
+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
+Author-email: recordlinkinglab@gmail.com
+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
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: summary
+
+# PyBugReporter
+A python library for catching thrown exceptions and automatically creating issues on a GitHub repo.
+
+Not recommended for public repos, as a malicious user could spam your issues with fake exceptions.

pybugreporter-1.0.7.dist-info/RECORD

@@ -0,0 +1,10 @@
+PyBugReporter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+PyBugReporter/_version.py,sha256=GIukrVnl8Ykjex2rUbxdz2Ov1PRc_MomFmxwSzRJH9w,21
+PyBugReporter/requirements.txt,sha256=EAW4yz3vd10zafBk_nrBB4X2l569expN2zb7Mj6m920,29
+PyBugReporter/src/BugReporter.py,sha256=w904iTS42i5dNCN9iCh9AHHEEpYjjEVFMi9KawwLxVw,13601
+PyBugReporter/src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pybugreporter-1.0.7.dist-info/LICENSE,sha256=y1VMyG67xmRdcGWNYFUPkcniixqP7BGqIC5NwYO-Gtk,1067
+pybugreporter-1.0.7.dist-info/METADATA,sha256=F5G0YywjcgYs2M2ecfBcqRtMvdoZOo_CXLjGC8c7g1w,866
+pybugreporter-1.0.7.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
+pybugreporter-1.0.7.dist-info/top_level.txt,sha256=oMev-fwhS97VtD0Y8a-1sl0MfdCLd4cQoySjJPQaIkE,32
+pybugreporter-1.0.7.dist-info/RECORD,,

pybugreporter-1.0.7.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (76.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pybugreporter-1.0.7.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+PyBugReporter
+PyBugReporter/src