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
|
# -*- coding: utf-8 -*-
############################ Copyrights and license ############################
# #
# Copyright 2013 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2014 Vincent Jacques <vincent@vincent-jacques.net> #
# Copyright 2016 Jannis Gebauer <ja.geb@me.com> #
# Copyright 2016 Peter Buckley <dx-pbuckley@users.noreply.github.com> #
# Copyright 2018 Wan Liuyang <tsfdye@gmail.com> #
# Copyright 2018 sfdye <tsfdye@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
import github.Rate
from deprecated import deprecated
class RateLimit(github.GithubObject.NonCompletableGithubObject):
"""
This class represents RateLimits. The reference can be found here http://developer.github.com/v3/rate_limit
"""
def __repr__(self):
return self.get__repr__({"core": self._core.value})
@property
@deprecated(reason="""
The rate object is deprecated. If you're writing new API client code
or updating existing code, you should use the core object instead of
the rate object. The core object contains the same information that
is present in the rate object.
""")
def rate(self):
"""
(Deprecated) Rate limit for non-search-related API, use `core` instead
:type: class:`github.Rate.Rate`
"""
return self._core.value
@property
def core(self):
"""
Rate limit for the non-search-related API
:type: class:`github.Rate.Rate`
"""
return self._core.value
@property
def search(self):
"""
Rate limit for the Search API.
:type: class:`github.Rate.Rate`
"""
return self._search.value
@property
def graphql(self):
"""
(Experimental) Rate limit for GraphQL API, use with caution.
:type: class:`github.Rate.Rate`
"""
return self._graphql.value
def _initAttributes(self):
self._core = github.GithubObject.NotSet
self._search = github.GithubObject.NotSet
self._graphql = github.GithubObject.NotSet
def _useAttributes(self, attributes):
if "core" in attributes: # pragma no branch
self._core = self._makeClassAttribute(github.Rate.Rate, attributes["core"])
if "search" in attributes: # pragma no branch
self._search = self._makeClassAttribute(github.Rate.Rate, attributes["search"])
if "graphql" in attributes: # pragma no branch
self._graphql = self._makeClassAttribute(github.Rate.Rate, attributes["graphql"])
|
