############################ Copyrights and license ############################ # # # Copyright 2012 Vincent Jacques # # Copyright 2012 Zearin # # Copyright 2013 Vincent Jacques # # Copyright 2014 Vincent Jacques # # Copyright 2016 Jannis Gebauer # # Copyright 2016 Peter Buckley # # Copyright 2018 Wan Liuyang # # Copyright 2018 sfdye # # Copyright 2019 Steve Kowalik # # Copyright 2019 Wan Liuyang # # Copyright 2020 Steve Kowalik # # Copyright 2021 Mark Walker # # Copyright 2021 Steve Kowalik # # Copyright 2023 Enrico Minack # # Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> # # Copyright 2023 Trim21 # # Copyright 2024 Bill Napier # # Copyright 2024 Enrico Minack # # Copyright 2024 Jirka Borovec <6035284+Borda@users.noreply.github.com> # # Copyright 2025 Enrico Minack # # # # 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 . # # # ################################################################################ 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 The OpenAPI schema can be found at - /components/schemas/rate-limit-overview/properties/resources """ def _initAttributes(self) -> None: self._actions_runner_registration: Attribute[Rate] = NotSet self._code_scanning_upload: Attribute[Rate] = NotSet self._code_search: Attribute[Rate] = NotSet self._core: Attribute[Rate] = NotSet self._dependency_snapshots: Attribute[Rate] = NotSet self._graphql: Attribute[Rate] = NotSet self._integration_manifest: Attribute[Rate] = NotSet self._scim: Attribute[Rate] = NotSet self._search: Attribute[Rate] = NotSet self._source_import: Attribute[Rate] = NotSet def __repr__(self) -> str: return self.get__repr__({"core": self._core.value}) @property def actions_runner_registration(self) -> Rate: """ Rate limit for registering self-hosted runners in GitHub Actions. """ return self._actions_runner_registration.value @property def code_scanning_upload(self) -> Rate: """ Rate limit for uploading SARIF results to code scanning. """ return self._code_scanning_upload.value @property def code_search(self) -> Rate: """ Rate limit for the REST API for searching code. """ return self._code_search.value @property def core(self) -> Rate: """ Rate limit for the non-search-related API. """ return self._core.value @property def dependency_snapshots(self) -> Rate: """ Rate limit for submitting snapshots to the dependency graph. """ return self._dependency_snapshots.value @property def graphql(self) -> Rate: """ (Experimental) Rate limit for GraphQL API, use with caution. """ return self._graphql.value @property def integration_manifest(self) -> Rate: """ Rate limit for POST /app-manifests/{code}/conversions operation. """ return self._integration_manifest.value @property def scim(self) -> github.Rate.Rate: return self._scim.value @property def search(self) -> Rate: """ Rate limit for the Search API. """ return self._search.value @property def source_import(self) -> github.Rate.Rate: return self._source_import.value def _useAttributes(self, attributes: dict[str, Any]) -> None: if "actions_runner_registration" in attributes: # pragma no branch self._actions_runner_registration = self._makeClassAttribute( github.Rate.Rate, attributes["actions_runner_registration"] ) if "code_scanning_upload" in attributes: # pragma no branch self._code_scanning_upload = self._makeClassAttribute(github.Rate.Rate, attributes["code_scanning_upload"]) if "code_search" in attributes: # pragma no branch self._code_search = self._makeClassAttribute(github.Rate.Rate, attributes["code_search"]) if "core" in attributes: # pragma no branch self._core = self._makeClassAttribute(github.Rate.Rate, attributes["core"]) if "dependency_snapshots" in attributes: # pragma no branch self._dependency_snapshots = self._makeClassAttribute(github.Rate.Rate, attributes["dependency_snapshots"]) if "graphql" in attributes: # pragma no branch self._graphql = self._makeClassAttribute(github.Rate.Rate, attributes["graphql"]) if "integration_manifest" in attributes: # pragma no branch self._integration_manifest = self._makeClassAttribute(github.Rate.Rate, attributes["integration_manifest"]) if "scim" in attributes: # pragma no branch self._scim = self._makeClassAttribute(github.Rate.Rate, attributes["scim"]) if "search" in attributes: # pragma no branch self._search = self._makeClassAttribute(github.Rate.Rate, attributes["search"]) if "source_import" in attributes: # pragma no branch self._source_import = self._makeClassAttribute(github.Rate.Rate, attributes["source_import"])