Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
PyGithub/github/GithubException.py at main · PyGithub/PyGithub · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
Uh oh!
There was an error while loading.
Please reload this page
.
PyGithub
/
PyGithub
Public
Uh oh!
There was an error while loading.
Please reload this page
.
Notifications
You must be signed in to change notification settings
Fork
1.9k
Star
7.8k
Code
Issues
281
Pull requests
121
Discussions
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Discussions
Actions
Projects
Security and quality
Insights
Files
Expand file tree
main
Breadcrumbs
PyGithub
/
github
/
GithubException.py
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
225 lines (188 loc) · 8.14 KB
main
Breadcrumbs
PyGithub
/
github
/
GithubException.py
Copy path
Top
File metadata and controls
Code
Blame
225 lines (188 loc) · 8.14 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
############################ Copyrights and license ############################
# #
# Copyright 2012 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2012 Zearin <zearin@gonk.net> #
# Copyright 2013 AKFish <akfish@gmail.com> #
# Copyright 2013 Cameron White <cawhite@pdx.edu> #
# Copyright 2013 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2014 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2016 Peter Buckley <dx-pbuckley@users.noreply.github.com> #
# Copyright 2016 humbug <bah> #
# Copyright 2018 sfdye <tsfdye@gmail.com> #
# Copyright 2019 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2019 Wan Liuyang <tsfdye@gmail.com> #
# Copyright 2020 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2021 Steve Kowalik <steven@wedontsleep.org> #
# Copyright 2022 Liuyang Wan <tsfdye@gmail.com> #
# Copyright 2023 Enrico Minack <github@enrico.minack.dev> #
# 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> #
# Copyright 2026 Sai Asish Y <say.apm35@gmail.com> #
# Copyright 2026 Tanishk <tanishk7531@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
import
json
from
typing
import
Any
class
GithubException
(
Exception
):
"""
Error handling in PyGithub is done with exceptions. This class is the base of all exceptions raised by PyGithub
(but :class:`github.GithubException.BadAttributeException`).
Some other types of exceptions might be raised by underlying libraries, for example for network-related issues.
"""
def
__init__
(
self
,
status
:
int
,
data
:
Any
=
None
,
headers
:
dict
[
str
,
str
]
|
None
=
None
,
message
:
str
|
None
=
None
,
):
super
().
__init__
()
self
.
__status
=
status
self
.
__data
=
data
self
.
__headers
=
headers
self
.
__message
=
message
self
.
args
=
(
status
,
data
,
headers
,
message
)
@
property
def
message
(
self
)
->
str
|
None
:
return
self
.
__message
@
property
def
status
(
self
)
->
int
:
"""
The status returned by the Github API.
"""
return
self
.
__status
@
property
def
data
(
self
)
->
Any
:
"""
The (decoded) data returned by the Github API.
"""
return
self
.
__data
@
property
def
headers
(
self
)
->
dict
[
str
,
str
]
|
None
:
"""
The headers returned by the Github API.
"""
return
self
.
__headers
def
__repr__
(
self
)
->
str
:
return
f"
{
self
.
__class__
.
__name__
}
(
{
self
.
__str__
()
}
)"
def
__str__
(
self
)
->
str
:
if
self
.
__message
:
msg
=
f"
{
self
.
__message
}
:
{
self
.
status
}
"
else
:
msg
=
f"
{
self
.
status
}
"
if
self
.
data
is
not
None
:
data
=
self
.
data
if
isinstance
(
data
,
bytes
):
data
=
data
.
decode
(
"utf-8"
,
errors
=
"replace"
)
msg
+=
" "
+
json
.
dumps
(
data
)
return
msg
class
BadCredentialsException
(
GithubException
):
"""
Exception raised in case of bad credentials (when Github API replies with a 401 or 403 HTML status)
"""
class
UnknownObjectException
(
GithubException
):
"""
Exception raised when a non-existing object is requested (when Github API replies with a 404 HTML status)
"""
class
BadUserAgentException
(
GithubException
):
"""
Exception raised when request is sent with a bad user agent header (when Github API replies with a 403 bad user
agent HTML status)
"""
class
RateLimitExceededException
(
GithubException
):
"""
Exception raised when the rate limit is exceeded (when Github API replies with a 403 rate limit exceeded HTML
status)
"""
class
RateLimitExceededExceedsMaxWait
(
RateLimitExceededException
):
"""
Exception raised when the wait required to respect a rate limit reset exceeds the configured
``max_rate_limit_wait`` on ``GithubRetry``, instead of blocking until the rate limit resets.
"""
def
__init__
(
self
,
status
:
int
,
data
:
Any
=
None
,
headers
:
dict
[
str
,
str
]
|
None
=
None
,
message
:
str
|
None
=
None
,
wait
:
float
|
None
=
None
,
):
super
().
__init__
(
status
,
data
,
headers
,
message
)
self
.
__wait
=
wait
@
property
def
wait
(
self
)
->
float
|
None
:
"""
The backoff in seconds that would have been required to respect the rate limit reset, before it was capped by
``max_rate_limit_wait``.
"""
return
self
.
__wait
class
BadAttributeException
(
Exception
):
"""
Exception raised when Github returns an attribute with the wrong type.
"""
def
__init__
(
self
,
actualValue
:
Any
,
expectedType
: (
dict
[
tuple
[
type
[
str
],
type
[
str
]],
type
[
dict
]]
|
tuple
[
type
[
str
],
type
[
str
]]
|
list
[
type
[
dict
]]
|
list
[
tuple
[
type
[
str
],
type
[
str
]]]
),
transformationException
:
Exception
|
None
,
):
self
.
__actualValue
=
actualValue
self
.
__expectedType
=
expectedType
self
.
__transformationException
=
transformationException
@
property
def
actual_value
(
self
)
->
Any
:
"""
The value returned by Github.
"""
return
self
.
__actualValue
@
property
def
expected_type
(
self
,
)
->
(
list
[
type
[
dict
]]
|
tuple
[
type
[
str
],
type
[
str
]]
|
dict
[
tuple
[
type
[
str
],
type
[
str
]],
type
[
dict
]]
|
list
[
tuple
[
type
[
str
],
type
[
str
]]]
):
"""
The type PyGithub expected.
"""
return
self
.
__expectedType
@
property
def
transformation_exception
(
self
)
->
Exception
|
None
:
"""
The exception raised when PyGithub tried to parse the value.
"""
return
self
.
__transformationException
class
TwoFactorException
(
GithubException
):
"""
Exception raised when Github requires a onetime password for two-factor authentication.
"""
class
IncompletableObject
(
GithubException
):
"""
Exception raised when we can not request an object from Github because the data returned did not include a URL.
"""
You can’t perform that action at this time.