mirror of
https://github.com/status-im/PyGithub.git
synced 2026-08-31 10:51:14 +00:00
80 lines
3.8 KiB
Python
80 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> #
|
|
# Copyright 2023 Nikolay Yurin <yurinnick@meta.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 datetime import datetime
|
|
from typing import Any, Dict
|
|
|
|
from github.GithubObject import Attribute, NonCompletableGithubObject, NotSet
|
|
|
|
|
|
class Rate(NonCompletableGithubObject):
|
|
"""
|
|
This class represents Rates. The reference can be found here https://docs.github.com/en/rest/reference/rate-limit
|
|
"""
|
|
|
|
def _initAttributes(self) -> None:
|
|
self._limit: Attribute[int] = NotSet
|
|
self._remaining: Attribute[int] = NotSet
|
|
self._reset: Attribute[datetime] = NotSet
|
|
self._used: Attribute[int] = NotSet
|
|
|
|
def __repr__(self) -> str:
|
|
return self.get__repr__(
|
|
{
|
|
"limit": self._limit.value,
|
|
"remaining": self._remaining.value,
|
|
"reset": self._reset.value,
|
|
}
|
|
)
|
|
|
|
@property
|
|
def limit(self) -> int:
|
|
return self._limit.value
|
|
|
|
@property
|
|
def remaining(self) -> int:
|
|
return self._remaining.value
|
|
|
|
@property
|
|
def reset(self) -> datetime:
|
|
return self._reset.value
|
|
|
|
@property
|
|
def used(self) -> int:
|
|
return self._used.value
|
|
|
|
def _useAttributes(self, attributes: Dict[str, Any]) -> None:
|
|
if "limit" in attributes: # pragma no branch
|
|
self._limit = self._makeIntAttribute(attributes["limit"])
|
|
if "remaining" in attributes: # pragma no branch
|
|
self._remaining = self._makeIntAttribute(attributes["remaining"])
|
|
if "reset" in attributes: # pragma no branch
|
|
self._reset = self._makeTimestampAttribute(attributes["reset"])
|
|
if "used" in attributes: # pragma no branch
|
|
self._used = self._makeIntAttribute(attributes["used"])
|