-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
CodeScanAlert.py
158 lines (130 loc) · 6.76 KB
/
CodeScanAlert.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
############################ Copyrights and license ############################
# #
# Copyright 2022 Eric Nieuwland <eric.nieuwland@gmail.com> #
# Copyright 2023 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> #
# Copyright 2023 Trim21 <trim21.me@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/>. #
# #
################################################################################
from __future__ import annotations
from datetime import datetime
from typing import Any
import github.CodeScanAlertInstance
import github.CodeScanRule
import github.CodeScanTool
import github.GithubObject
import github.NamedUser
from github.GithubObject import Attribute, NonCompletableGithubObject, NotSet
from github.PaginatedList import PaginatedList
class CodeScanAlert(NonCompletableGithubObject):
"""
This class represents alerts from code scanning.
The reference can be found here
https://docs.github.com/en/rest/reference/code-scanning.
"""
def _initAttributes(self) -> None:
self._number: Attribute[int] = NotSet
self._rule: Attribute[github.CodeScanRule.CodeScanRule] = NotSet
self._tool: Attribute[github.CodeScanTool.CodeScanTool] = NotSet
self._created_at: Attribute[datetime] = NotSet
self._dismissed_at: Attribute[datetime | None] = NotSet
self._dismissed_by: Attribute[github.NamedUser.NamedUser | None] = NotSet
self._dismissed_reason: Attribute[str | None] = NotSet
self._url: Attribute[str] = NotSet
self._html_url: Attribute[str] = NotSet
self._instances_url: Attribute[str] = NotSet
self._most_recent_instance: Attribute[github.CodeScanAlertInstance.CodeScanAlertInstance] = NotSet
self._state: Attribute[str] = NotSet
def __repr__(self) -> str:
return self.get__repr__({"number": self.number})
@property
def number(self) -> int:
return self._number.value
@property
def rule(self) -> github.CodeScanRule.CodeScanRule:
return self._rule.value
@property
def tool(self) -> github.CodeScanTool.CodeScanTool:
return self._tool.value
@property
def created_at(self) -> datetime:
return self._created_at.value
@property
def dismissed_at(self) -> datetime | None:
return self._dismissed_at.value
@property
def dismissed_by(self) -> github.NamedUser.NamedUser | None:
return self._dismissed_by.value
@property
def dismissed_reason(self) -> str | None:
return self._dismissed_reason.value
@property
def url(self) -> str:
return self._url.value
@property
def html_url(self) -> str:
return self._html_url.value
@property
def instances_url(self) -> str:
return self._instances_url.value
@property
def most_recent_instance(self) -> github.CodeScanAlertInstance.CodeScanAlertInstance:
return self._most_recent_instance.value
@property
def state(self) -> str:
return self._state.value
def get_instances(self) -> PaginatedList[github.CodeScanAlertInstance.CodeScanAlertInstance]:
"""
Get instances.
:calls: `GET` on the URL for instances as provided by Github.
"""
return PaginatedList(
github.CodeScanAlertInstance.CodeScanAlertInstance,
self._requester,
self.instances_url,
None,
)
def _useAttributes(self, attributes: dict[str, Any]) -> None:
if "number" in attributes: # pragma no branch
self._number = self._makeIntAttribute(attributes["number"])
if "rule" in attributes: # pragma no branch
self._rule = self._makeClassAttribute(github.CodeScanRule.CodeScanRule, attributes["rule"])
if "tool" in attributes: # pragma no branch
self._tool = self._makeClassAttribute(github.CodeScanTool.CodeScanTool, attributes["tool"])
if "created_at" in attributes: # pragma no branch
self._created_at = self._makeDatetimeAttribute(attributes["created_at"])
if "dismissed_at" in attributes: # pragma no branch
self._dismissed_at = self._makeDatetimeAttribute(attributes["dismissed_at"])
if "dismissed_by" in attributes: # pragma no branch
self._dismissed_by = self._makeClassAttribute(github.NamedUser.NamedUser, attributes["dismissed_by"])
if "dismissed_reason" in attributes: # pragma no branch
self._dismissed_reason = self._makeStringAttribute(attributes["dismissed_reason"])
if "url" in attributes: # pragma no branch
self._url = self._makeStringAttribute(attributes["url"])
if "html_url" in attributes: # pragma no branch
self._html_url = self._makeStringAttribute(attributes["html_url"])
if "instances_url" in attributes: # pragma no branch
self._instances_url = self._makeStringAttribute(attributes["instances_url"])
if "most_recent_instance" in attributes: # pragma no branch
self._most_recent_instance = self._makeClassAttribute(
github.CodeScanAlertInstance.CodeScanAlertInstance,
attributes["most_recent_instance"],
)
if "state" in attributes: # pragma no branch
self._state = self._makeStringAttribute(attributes["state"])