mirror of
https://github.com/status-im/PyGithub.git
synced 2026-08-31 19:01:15 +00:00
86 lines
3.8 KiB
Python
86 lines
3.8 KiB
Python
############################ 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/>. #
|
|
# #
|
|
################################################################################
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, Any
|
|
|
|
import github.Rate
|
|
from github.GithubObject import Attribute, NonCompletableGithubObject, NotSet
|
|
|
|
if TYPE_CHECKING:
|
|
from github.Rate import Rate
|
|
|
|
|
|
class RateLimit(NonCompletableGithubObject):
|
|
"""
|
|
This class represents RateLimits. The reference can be found here https://docs.github.com/en/rest/reference/rate-limit
|
|
"""
|
|
|
|
def _initAttributes(self) -> None:
|
|
self._core: Attribute[Rate] = NotSet
|
|
self._search: Attribute[Rate] = NotSet
|
|
self._graphql: Attribute[Rate] = NotSet
|
|
|
|
def __repr__(self) -> str:
|
|
return self.get__repr__({"core": self._core.value})
|
|
|
|
@property
|
|
def core(self) -> Rate:
|
|
"""
|
|
Rate limit for the non-search-related API
|
|
|
|
:type: class:`github.Rate.Rate`
|
|
"""
|
|
return self._core.value
|
|
|
|
@property
|
|
def search(self) -> Rate:
|
|
"""
|
|
Rate limit for the Search API.
|
|
|
|
:type: class:`github.Rate.Rate`
|
|
"""
|
|
return self._search.value
|
|
|
|
@property
|
|
def graphql(self) -> Rate:
|
|
"""
|
|
(Experimental) Rate limit for GraphQL API, use with caution.
|
|
|
|
:type: class:`github.Rate.Rate`
|
|
"""
|
|
return self._graphql.value
|
|
|
|
def _useAttributes(self, attributes: dict[str, Any]) -> None:
|
|
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"])
|