forked from PyGithub/PyGithub
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathInstallation.py
More file actions
125 lines (107 loc) · 5.4 KB
/
Copy pathInstallation.py
File metadata and controls
125 lines (107 loc) · 5.4 KB
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
############################ Copyrights and license ############################
# #
# Copyright 2017 Jannis Gebauer <[email protected]> #
# Copyright 2017 Simon <[email protected]> #
# Copyright 2018 Wan Liuyang <[email protected]> #
# Copyright 2018 sfdye <[email protected]> #
# Copyright 2019 Rigas Papathanasopoulos <[email protected]> #
# #
# 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.Authorization
import github.Event
import github.Gist
import github.GithubObject
import github.Issue
import github.Notification
import github.Organization
import github.PaginatedList
import github.Plan
import github.Repository
import github.UserKey
from github import Consts
from github.Auth import AppAuth
from github.GithubObject import Attribute, NonCompletableGithubObject, NotSet
from github.PaginatedList import PaginatedList
from github.Requester import Requester
if TYPE_CHECKING:
from github.MainClass import Github
INTEGRATION_PREVIEW_HEADERS = {"Accept": Consts.mediaTypeIntegrationPreview}
class Installation(NonCompletableGithubObject):
"""
This class represents Installations. The reference can be found here https://docs.github.com/en/rest/reference/apps#installations
"""
def __init__(
self,
requester: Requester,
headers: dict[str, str | int],
attributes: Any,
completed: bool,
) -> None:
super().__init__(requester, headers, attributes, completed)
auth = self._requester.auth if self._requester is not None else None
# Usually, an Installation is created from a Requester with App authentication
if isinstance(auth, AppAuth):
# But the installation has to authenticate as an installation (e.g. for get_repos())
auth = auth.get_installation_auth(self.id, requester=self._requester)
self._requester = self._requester.withAuth(auth)
def _initAttributes(self) -> None:
self._id: Attribute[int] = NotSet
self._app_id: Attribute[int] = NotSet
self._target_id: Attribute[int] = NotSet
self._target_type: Attribute[str] = NotSet
def __repr__(self) -> str:
return self.get__repr__({"id": self._id.value})
def get_github_for_installation(self) -> Github:
return github.Github(**self._requester.kwargs)
@property
def id(self) -> int:
return self._id.value
@property
def app_id(self) -> int:
return self._app_id.value
@property
def target_id(self) -> int:
return self._target_id.value
@property
def target_type(self) -> str:
return self._target_type.value
def get_repos(self) -> PaginatedList[github.Repository.Repository]:
"""
:calls: `GET /installation/repositories <https://docs.github.com/en/rest/reference/integrations/installations#list-repositories>`_
"""
url_parameters: dict[str, Any] = {}
return PaginatedList(
contentClass=github.Repository.Repository,
requester=self._requester,
firstUrl="/installation/repositories",
firstParams=url_parameters,
headers=INTEGRATION_PREVIEW_HEADERS,
list_item="repositories",
)
def _useAttributes(self, attributes: dict[str, Any]) -> None:
if "id" in attributes: # pragma no branch
self._id = self._makeIntAttribute(attributes["id"])
if "app_id" in attributes: # pragma no branch
self._app_id = self._makeIntAttribute(attributes["app_id"])
if "target_id" in attributes: # pragma no branch
self._target_id = self._makeIntAttribute(attributes["target_id"])
if "target_type" in attributes: # pragma no branch
self._target_type = self._makeStringAttribute(attributes["target_type"])