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
|
############################ 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> #
# Copyright 2024 Enrico Minack <github@enrico.minack.dev> #
# Copyright 2024 Jirka Borovec <6035284+Borda@users.noreply.github.com> #
# Copyright 2025 Enrico Minack <github@enrico.minack.dev> #
# #
# 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 typing import TYPE_CHECKING, Any
import github.CodeScanAlertInstanceLocation
from github.GithubObject import Attribute, NonCompletableGithubObject, NotSet
if TYPE_CHECKING:
from github.CodeScanAlertInstanceLocation import CodeScanAlertInstanceLocation
class CodeScanAlertInstance(NonCompletableGithubObject):
"""
This class represents code scanning alert instances.
The reference can be found here
https://docs.github.com/en/rest/reference/code-scanning.
"""
def _initAttributes(self) -> None:
self._analysis_key: Attribute[str] = NotSet
self._classifications: Attribute[list[str]] = NotSet
self._commit_sha: Attribute[str] = NotSet
self._environment: Attribute[str] = NotSet
self._location: Attribute[CodeScanAlertInstanceLocation] = NotSet
self._message: Attribute[dict[str, Any]] = NotSet
self._ref: Attribute[str] = NotSet
self._state: Attribute[str] = NotSet
def __repr__(self) -> str:
return self.get__repr__({"ref": self.ref, "analysis_key": self.analysis_key})
@property
def analysis_key(self) -> str:
return self._analysis_key.value
@property
def classifications(self) -> list[str]:
return self._classifications.value
@property
def commit_sha(self) -> str:
return self._commit_sha.value
@property
def environment(self) -> str:
return self._environment.value
@property
def location(self) -> CodeScanAlertInstanceLocation:
return self._location.value
@property
def message(self) -> dict[str, Any]:
return self._message.value
@property
def ref(self) -> str:
return self._ref.value
@property
def state(self) -> str:
return self._state.value
def _useAttributes(self, attributes: dict[str, Any]) -> None:
if "analysis_key" in attributes: # pragma no branch
self._analysis_key = self._makeStringAttribute(attributes["analysis_key"])
if "classifications" in attributes: # pragma no branch
self._classifications = self._makeListOfStringsAttribute(attributes["classifications"])
if "commit_sha" in attributes: # pragma no branch
self._commit_sha = self._makeStringAttribute(attributes["commit_sha"])
if "environment" in attributes: # pragma no branch
self._environment = self._makeStringAttribute(attributes["environment"])
if "environment" in attributes: # pragma no branch
self._environment = self._makeStringAttribute(attributes["environment"])
if "location" in attributes: # pragma no branch
self._location = self._makeClassAttribute(
github.CodeScanAlertInstanceLocation.CodeScanAlertInstanceLocation,
attributes["location"],
)
if "message" in attributes: # pragma no branch
self._message = self._makeDictAttribute(attributes["message"])
if "ref" in attributes: # pragma no branch
self._ref = self._makeStringAttribute(attributes["ref"])
if "state" in attributes: # pragma no branch
self._state = self._makeStringAttribute(attributes["state"])
|
