Add code scanning alerts (#2227)

2026-09-01 11:21:16 +00:00 · 2022-11-09 14:59:34 +08:00
parent 948edc5bb3
commit 7902351d4f
14 changed files with 982 additions and 0 deletions
@@ -0,0 +1,98 @@
+############################ Copyrights and license ############################
+#                                                                              #
+# Copyright 2022 Eric Nieuwland <eric.nieuwland@gmail.com>                     #
+#                                                                              #
+# This file is part of PyGithub.                                               #
+# http://pygithub.readthedocs.io/                                              #
+#                                                                              #
+# PyGithub is free software: you can redistribute it and/or modify it under    #
+# the terms of the GNU Lesser General Public License as published by the Free  #
+# Software Foundation, either version 3 of the License, or (at your option)    #
+# any later version.                                                           #
+#                                                                              #
+# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY  #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS    #
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
+# details.                                                                     #
+#                                                                              #
+# You should have received a copy of the GNU Lesser General Public License     #
+# along with PyGithub. If not, see <http://www.gnu.org/licenses/>.             #
+#                                                                              #
+################################################################################
+
+import github.GithubObject
+
+
+class CodeScanAlertInstanceLocation(github.GithubObject.NonCompletableGithubObject):
+    """
+    This class represents code scanning alert instance locations.
+    The reference can be found here https://docs.github.com/en/rest/reference/code-scanning.
+    """
+
+    def __str__(self):
+        return f"{self.path} @ l{self.start_line}:c{self.start_column}-l{self.end_line}:c{self.end_column}"
+
+    def __repr__(self):
+        return self.get__repr__(
+            {
+                "path": self.path,
+                "start_line": self.start_line,
+                "start_column": self.start_column,
+                "end_line": self.end_line,
+                "end_column": self.end_column,
+            }
+        )
+
+    @property
+    def path(self):
+        """
+        :type: str
+        """
+        return self._path.value
+
+    @property
+    def start_line(self):
+        """
+        :type: int
+        """
+        return self._start_line.value
+
+    @property
+    def start_column(self):
+        """
+        :type: int
+        """
+        return self._start_column.value
+
+    @property
+    def end_line(self):
+        """
+        :type: int
+        """
+        return self._end_line.value
+
+    @property
+    def end_column(self):
+        """
+        :type: int
+        """
+        return self._end_column.value
+
+    def _initAttributes(self):
+        self._path = github.GithubObject.NotSet
+        self._start_line = github.GithubObject.NotSet
+        self._start_column = github.GithubObject.NotSet
+        self._end_line = github.GithubObject.NotSet
+        self._end_column = github.GithubObject.NotSet
+
+    def _useAttributes(self, attributes):
+        if "path" in attributes:  # pragma no branch
+            self._path = self._makeStringAttribute(attributes["path"])
+        if "start_line" in attributes:  # pragma no branch
+            self._start_line = self._makeIntAttribute(attributes["start_line"])
+        if "start_column" in attributes:  # pragma no branch
+            self._start_column = self._makeIntAttribute(attributes["start_column"])
+        if "end_line" in attributes:  # pragma no branch
+            self._end_line = self._makeIntAttribute(attributes["end_line"])
+        if "end_column" in attributes:  # pragma no branch
+            self._end_column = self._makeIntAttribute(attributes["end_column"])