############################ Copyrights and license ############################ # # # Copyright 2012 Dima Kukushkin # # Copyright 2012 Luke Cawood # # Copyright 2012 Michael Woodworth # # Copyright 2012 Steve English # # Copyright 2012 Vincent Jacques # # Copyright 2012 Zearin # # Copyright 2013 AKFish # # Copyright 2013 Ed Jackson # # Copyright 2013 Jonathan J Hunt # # Copyright 2013 Steve Brown # # Copyright 2013 Vincent Jacques # # Copyright 2014 C. R. Oldham # # Copyright 2014 Thialfihar # # Copyright 2014 Tyler Treat # # Copyright 2014 Vincent Jacques # # Copyright 2015 Daniel Pocock # # Copyright 2015 Joseph Rawson # # Copyright 2015 Uriel Corfa # # Copyright 2016 Jannis Gebauer # # Copyright 2016 Peter Buckley # # Copyright 2017 Colin Hoglund # # Copyright 2017 Jannis Gebauer # # Copyright 2018 Agor Maxime # # Copyright 2018 Arda Kuyumcu # # Copyright 2018 Benoit Latinier # # Copyright 2018 Bruce Richardson # # Copyright 2018 Joshua Hoblitt # # Copyright 2018 Maarten Fonville # # Copyright 2018 Mike Miller # # Copyright 2018 Shubham Singh <41840111+singh811@users.noreply.github.com> # # Copyright 2018 Steve Kowalik # # Copyright 2018 Svend Sorensen # # Copyright 2018 Wan Liuyang # # Copyright 2018 Yossarian King # # Copyright 2018 h.shi <10385628+AnYeMoWang@users.noreply.github.com> # # Copyright 2018 sfdye # # Copyright 2019 Adam Baratz # # Copyright 2019 Caleb Sweeney # # Copyright 2019 Hamel Husain # # Copyright 2019 Isac Souza # # Copyright 2019 Jake Klingensmith # # Copyright 2019 Jake Wilkins # # Copyright 2019 Rigas Papathanasopoulos # # Copyright 2019 Steve Kowalik # # Copyright 2019 Tomas Tomecek # # Copyright 2019 Wan Liuyang # # Copyright 2019 chillipeper # # Copyright 2019 秋葉 # # Copyright 2020 Alice GIRARD # # Copyright 2020 Denis Blanchette # # Copyright 2020 Florent Clarret # # Copyright 2020 Mahesh Raju # # Copyright 2020 Nikolay Edigaryev # # Copyright 2020 Omar Brikaa # # Copyright 2020 Steve Kowalik # # Copyright 2021 Amador Pahim # # Copyright 2021 Mark Walker # # Copyright 2021 Sachi King # # Copyright 2021 Steve Kowalik # # Copyright 2023 Denis Blanchette # # Copyright 2023 Enrico Minack # # Copyright 2023 Hemslo Wang # # Copyright 2023 Jirka Borovec <6035284+Borda@users.noreply.github.com> # # Copyright 2023 Jonathan Greg <31892308+jmgreg31@users.noreply.github.com> # # Copyright 2023 Joseph Henrich # # Copyright 2023 Mark Amery # # Copyright 2023 Trim21 # # Copyright 2023 YugoHino # # Copyright 2023 chantra # # Copyright 2024 Enrico Minack # # Copyright 2024 Jirka Borovec <6035284+Borda@users.noreply.github.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 . # # # ################################################################################ from __future__ import annotations import pickle import urllib.parse import warnings from datetime import datetime from typing import TYPE_CHECKING, Any, BinaryIO, TypeVar import urllib3 from urllib3.util import Retry import github.ApplicationOAuth import github.Auth import github.AuthenticatedUser import github.Enterprise import github.Event import github.Gist import github.GithubApp import github.GithubIntegration import github.GithubRetry import github.GitignoreTemplate import github.GlobalAdvisory import github.License import github.NamedUser import github.Topic from github import Consts from github.GithubIntegration import GithubIntegration from github.GithubObject import GithubObject, NotSet, Opt, is_defined from github.GithubRetry import GithubRetry from github.HookDelivery import HookDelivery, HookDeliverySummary from github.HookDescription import HookDescription from github.PaginatedList import PaginatedList from github.RateLimit import RateLimit from github.Requester import Requester if TYPE_CHECKING: from github.AppAuthentication import AppAuthentication from github.ApplicationOAuth import ApplicationOAuth from github.AuthenticatedUser import AuthenticatedUser from github.Commit import Commit from github.ContentFile import ContentFile from github.Event import Event from github.Gist import Gist from github.GithubApp import GithubApp from github.GitignoreTemplate import GitignoreTemplate from github.GlobalAdvisory import GlobalAdvisory from github.Issue import Issue from github.License import License from github.NamedUser import NamedUser from github.Organization import Organization from github.Project import Project from github.ProjectColumn import ProjectColumn from github.Repository import Repository from github.Topic import Topic TGithubObject = TypeVar("TGithubObject", bound=GithubObject) class Github: """ This is the main class you instantiate to access the Github API v3. Optional parameters allow different authentication methods. """ __requester: Requester default_retry = GithubRetry() # keep non-deprecated arguments in-sync with Requester # v3: remove login_or_token, password, jwt and app_auth # v3: move auth to the front of arguments # v3: add * before first argument so all arguments must be named, # allows to reorder / add new arguments / remove deprecated arguments without breaking user code def __init__( self, login_or_token: str | None = None, password: str | None = None, jwt: str | None = None, app_auth: AppAuthentication | None = None, base_url: str = Consts.DEFAULT_BASE_URL, timeout: int = Consts.DEFAULT_TIMEOUT, user_agent: str = Consts.DEFAULT_USER_AGENT, per_page: int = Consts.DEFAULT_PER_PAGE, verify: bool | str = True, retry: int | Retry | None = default_retry, pool_size: int | None = None, seconds_between_requests: float | None = Consts.DEFAULT_SECONDS_BETWEEN_REQUESTS, seconds_between_writes: float | None = Consts.DEFAULT_SECONDS_BETWEEN_WRITES, auth: github.Auth.Auth | None = None, ) -> None: """ :param login_or_token: string deprecated, use auth=github.Auth.Login(...) or auth=github.Auth.Token(...) instead :param password: string deprecated, use auth=github.Auth.Login(...) instead :param jwt: string deprecated, use auth=github.Auth.AppAuth(...) or auth=github.Auth.AppAuthToken(...) instead :param app_auth: github.AppAuthentication deprecated, use auth=github.Auth.AppInstallationAuth(...) instead :param base_url: string :param timeout: integer :param user_agent: string :param per_page: int :param verify: boolean or string :param retry: int or urllib3.util.retry.Retry object, defaults to github.Github.default_retry, set to None to disable retries :param pool_size: int :param seconds_between_requests: float :param seconds_between_writes: float :param auth: authentication method """ assert login_or_token is None or isinstance(login_or_token, str), login_or_token assert password is None or isinstance(password, str), password assert jwt is None or isinstance(jwt, str), jwt assert isinstance(base_url, str), base_url assert isinstance(timeout, int), timeout assert user_agent is None or isinstance(user_agent, str), user_agent assert isinstance(per_page, int), per_page assert isinstance(verify, (bool, str)), verify assert retry is None or isinstance(retry, int) or isinstance(retry, urllib3.util.Retry), retry assert pool_size is None or isinstance(pool_size, int), pool_size assert seconds_between_requests is None or seconds_between_requests >= 0 assert seconds_between_writes is None or seconds_between_writes >= 0 assert auth is None or isinstance(auth, github.Auth.Auth), auth if password is not None: warnings.warn( "Arguments login_or_token and password are deprecated, please use " "auth=github.Auth.Login(...) instead", category=DeprecationWarning, ) auth = github.Auth.Login(login_or_token, password) # type: ignore elif login_or_token is not None: warnings.warn( "Argument login_or_token is deprecated, please use " "auth=github.Auth.Token(...) instead", category=DeprecationWarning, ) auth = github.Auth.Token(login_or_token) elif jwt is not None: warnings.warn( "Argument jwt is deprecated, please use " "auth=github.Auth.AppAuth(...) or " "auth=github.Auth.AppAuthToken(...) instead", category=DeprecationWarning, ) auth = github.Auth.AppAuthToken(jwt) elif app_auth is not None: warnings.warn( "Argument app_auth is deprecated, please use " "auth=github.Auth.AppInstallationAuth(...) instead", category=DeprecationWarning, ) auth = app_auth self.__requester = Requester( auth, base_url, timeout, user_agent, per_page, verify, retry, pool_size, seconds_between_requests, seconds_between_writes, ) def close(self) -> None: """Close connections to the server. Alternatively, use the Github object as a context manager: .. code-block:: python with github.Github(...) as gh: # do something """ self.__requester.close() def __enter__(self) -> Github: return self def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None: self.close() @property def FIX_REPO_GET_GIT_REF(self) -> bool: return self.__requester.FIX_REPO_GET_GIT_REF @FIX_REPO_GET_GIT_REF.setter def FIX_REPO_GET_GIT_REF(self, value: bool) -> None: self.__requester.FIX_REPO_GET_GIT_REF = value # v3: Remove this property? Why should it be necessary to read/modify it after construction @property def per_page(self) -> int: return self.__requester.per_page @per_page.setter def per_page(self, value: int) -> None: self.__requester.per_page = value # v3: Provide a unified way to access values of headers of last response # v3: (and add/keep ad hoc properties for specific useful headers like rate limiting, oauth scopes, etc.) # v3: Return an instance of a class: using a tuple did not allow to add a field "resettime" @property def rate_limiting(self) -> tuple[int, int]: """ First value is requests remaining, second value is request limit. """ remaining, limit = self.__requester.rate_limiting if limit < 0: self.get_rate_limit() return self.__requester.rate_limiting @property def rate_limiting_resettime(self) -> int: """ Unix timestamp indicating when rate limiting will reset. """ if self.__requester.rate_limiting_resettime == 0: self.get_rate_limit() return self.__requester.rate_limiting_resettime def get_rate_limit(self) -> RateLimit: """ Rate limit status for different resources (core/search/graphql). :calls: `GET /rate_limit `_ """ headers, data = self.__requester.requestJsonAndCheck("GET", "/rate_limit") return RateLimit(self.__requester, headers, data["resources"], True) @property def oauth_scopes(self) -> list[str] | None: """ :type: list of string """ return self.__requester.oauth_scopes def get_license(self, key: Opt[str] = NotSet) -> License: """ :calls: `GET /license/{license} `_ """ assert isinstance(key, str), key key = urllib.parse.quote(key) headers, data = self.__requester.requestJsonAndCheck("GET", f"/licenses/{key}") return github.License.License(self.__requester, headers, data, completed=True) def get_licenses(self) -> PaginatedList[License]: """ :calls: `GET /licenses `_ """ url_parameters: dict[str, Any] = {} return PaginatedList(github.License.License, self.__requester, "/licenses", url_parameters) def get_events(self) -> PaginatedList[Event]: """ :calls: `GET /events `_ """ return PaginatedList(github.Event.Event, self.__requester, "/events", None) def get_user(self, login: Opt[str] = NotSet) -> NamedUser | AuthenticatedUser: """ :calls: `GET /users/{user} `_ or `GET /user `_ """ if login is NotSet: return github.AuthenticatedUser.AuthenticatedUser(self.__requester, {}, {"url": "/user"}, completed=False) else: assert isinstance(login, str), login login = urllib.parse.quote(login) headers, data = self.__requester.requestJsonAndCheck("GET", f"/users/{login}") return github.NamedUser.NamedUser(self.__requester, headers, data, completed=True) def get_user_by_id(self, user_id: int) -> NamedUser: """ :calls: `GET /user/{id} `_ :param user_id: int :rtype: :class:`github.NamedUser.NamedUser` """ assert isinstance(user_id, int), user_id headers, data = self.__requester.requestJsonAndCheck("GET", f"/user/{user_id}") return github.NamedUser.NamedUser(self.__requester, headers, data, completed=True) def get_users(self, since: Opt[int] = NotSet) -> PaginatedList[NamedUser]: """ :calls: `GET /users `_ """ assert since is NotSet or isinstance(since, int), since url_parameters = dict() if since is not NotSet: url_parameters["since"] = since return PaginatedList(github.NamedUser.NamedUser, self.__requester, "/users", url_parameters) def get_organization(self, login: str) -> Organization: """ :calls: `GET /orgs/{org} `_ """ assert isinstance(login, str), login login = urllib.parse.quote(login) headers, data = self.__requester.requestJsonAndCheck("GET", f"/orgs/{login}") return github.Organization.Organization(self.__requester, headers, data, completed=True) def get_organizations(self, since: Opt[int] = NotSet) -> PaginatedList[Organization]: """ :calls: `GET /organizations `_ """ assert since is NotSet or isinstance(since, int), since url_parameters = dict() if since is not NotSet: url_parameters["since"] = since return PaginatedList( github.Organization.Organization, self.__requester, "/organizations", url_parameters, ) def get_enterprise(self, enterprise: str) -> github.Enterprise.Enterprise: """ :calls: `GET /enterprises/{enterprise} `_ :param enterprise: string :rtype: :class:`Enterprise` """ assert isinstance(enterprise, str), enterprise # There is no native "/enterprises/{enterprise}" api, so this function is a hub for apis that start with "/enterprise/{enterprise}". return github.Enterprise.Enterprise(self.__requester, enterprise) def get_repo(self, full_name_or_id: int | str, lazy: bool = False) -> Repository: """ :calls: `GET /repos/{owner}/{repo} `_ or `GET /repositories/{id} `_ """ assert isinstance(full_name_or_id, (str, int)), full_name_or_id url_base = "/repositories/" if isinstance(full_name_or_id, int) else "/repos/" url = f"{url_base}{full_name_or_id}" if lazy: return github.Repository.Repository(self.__requester, {}, {"url": url}, completed=False) headers, data = self.__requester.requestJsonAndCheck("GET", url) return github.Repository.Repository(self.__requester, headers, data, completed=True) def get_repos( self, since: Opt[int] = NotSet, visibility: Opt[str] = NotSet, ) -> PaginatedList[Repository]: """ :calls: `GET /repositories `_ :param since: integer :param visibility: string ('all','public') """ assert since is NotSet or isinstance(since, int), since url_parameters: dict[str, Any] = {} if since is not NotSet: url_parameters["since"] = since if visibility is not NotSet: assert visibility in ("public", "all"), visibility url_parameters["visibility"] = visibility return PaginatedList( github.Repository.Repository, self.__requester, "/repositories", url_parameters, ) def get_project(self, id: int) -> Project: """ :calls: `GET /projects/{project_id} `_ """ headers, data = self.__requester.requestJsonAndCheck( "GET", f"/projects/{id:d}", headers={"Accept": Consts.mediaTypeProjectsPreview}, ) return github.Project.Project(self.__requester, headers, data, completed=True) def get_project_column(self, id: int) -> ProjectColumn: """ :calls: `GET /projects/columns/{column_id} `_ """ headers, data = self.__requester.requestJsonAndCheck( "GET", "/projects/columns/%d" % id, headers={"Accept": Consts.mediaTypeProjectsPreview}, ) return github.ProjectColumn.ProjectColumn(self.__requester, headers, data, completed=True) def get_gist(self, id: str) -> Gist: """ :calls: `GET /gists/{id} `_ """ assert isinstance(id, str), id headers, data = self.__requester.requestJsonAndCheck("GET", f"/gists/{id}") return github.Gist.Gist(self.__requester, headers, data, completed=True) def get_gists(self, since: Opt[datetime] = NotSet) -> PaginatedList[Gist]: """ :calls: `GET /gists/public `_ """ assert since is NotSet or isinstance(since, datetime), since url_parameters = dict() if is_defined(since): url_parameters["since"] = since.strftime("%Y-%m-%dT%H:%M:%SZ") return PaginatedList(github.Gist.Gist, self.__requester, "/gists/public", url_parameters) def get_global_advisory(self, ghsa_id: str) -> GlobalAdvisory: """ :calls: `GET /advisories/{ghsa_id} `_ :param ghsa_id: string :rtype: :class:`github.GlobalAdvisory.GlobalAdvisory` """ assert isinstance(ghsa_id, str), ghsa_id ghsa_id = urllib.parse.quote(ghsa_id) headers, data = self.__requester.requestJsonAndCheck("GET", f"/advisories/{ghsa_id}") return github.GlobalAdvisory.GlobalAdvisory(self.__requester, headers, data, completed=True) def get_global_advisories( self, type: Opt[str] = NotSet, ghsa_id: Opt[str] = NotSet, cve_id: Opt[str] = NotSet, ecosystem: Opt[str] = NotSet, severity: Opt[str] = NotSet, cwes: list[Opt[str]] | Opt[str] = NotSet, is_withdrawn: Opt[bool] = NotSet, affects: list[str] | Opt[str] = NotSet, published: Opt[str] = NotSet, updated: Opt[str] = NotSet, modified: Opt[str] = NotSet, keywords: Opt[str] = NotSet, before: Opt[str] = NotSet, after: Opt[str] = NotSet, per_page: Opt[str] = NotSet, sort: Opt[str] = NotSet, direction: Opt[str] = NotSet, ) -> PaginatedList[GlobalAdvisory]: """ :calls: `GET /advisories ` :param type: Optional string :param ghsa_id: Optional string :param cve_id: Optional string :param ecosystem: Optional string :param severity: Optional string :param cwes: Optional comma separated string or list of integer or string :param is_withdrawn: Optional bool :param affects: Optional comma separated string or list of string :param published: Optional string :param updated: Optional string :param modified: Optional string :param before: Optional string :param after: Optional string :param sort: Optional string :param direction: Optional string :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.GlobalAdvisory.GlobalAdvisory` """ assert type is github.GithubObject.NotSet or isinstance(type, str), type assert ghsa_id is github.GithubObject.NotSet or isinstance(ghsa_id, str) assert cve_id is github.GithubObject.NotSet or isinstance(cve_id, str), cve_id assert ecosystem is github.GithubObject.NotSet or isinstance(ecosystem, str), ecosystem assert severity is github.GithubObject.NotSet or isinstance(severity, str), severity assert cwes is github.GithubObject.NotSet or isinstance(cwes, list) or isinstance(cwes, str), cwes assert is_withdrawn is github.GithubObject.NotSet or isinstance(is_withdrawn, bool), is_withdrawn assert affects is github.GithubObject.NotSet or isinstance(affects, list) or isinstance(affects, str), affects assert published is github.GithubObject.NotSet or isinstance(published, str), published assert updated is github.GithubObject.NotSet or isinstance(updated, str), updated assert modified is github.GithubObject.NotSet or isinstance(modified, str), modified assert before is github.GithubObject.NotSet or isinstance(before, str), before assert after is github.GithubObject.NotSet or isinstance(after, str), after assert sort is github.GithubObject.NotSet or isinstance(sort, str), sort assert direction is github.GithubObject.NotSet or isinstance(direction, str), direction url_parameters: dict[str, Opt[str | bool]] = dict() if type is not github.GithubObject.NotSet: # pragma no branch (Should be covered) assert type in ("reviewed", "unreviewed", "malware"), type url_parameters["type"] = type if ghsa_id is not github.GithubObject.NotSet: url_parameters["ghsa_id"] = ghsa_id if cve_id is not github.GithubObject.NotSet: url_parameters["cve_id"] = cve_id # Can be one of: actions, composer, erlang, go, maven, npm, nuget, other, pip, pub, rubygems, rust # Not asserting in that list so that the package doesn't need to be updated when a new ecosystem is added if ecosystem is not github.GithubObject.NotSet: url_parameters["ecosystem"] = ecosystem if severity is not github.GithubObject.NotSet: assert severity in ("null", "low", "medium", "high", "critical"), severity url_parameters["severity"] = severity if cwes is not github.GithubObject.NotSet: if isinstance(cwes, list): cwes = ",".join([str(cwe) for cwe in cwes]) url_parameters["cwes"] = cwes if is_withdrawn is not github.GithubObject.NotSet: url_parameters["is_withdrawn"] = is_withdrawn if affects is not github.GithubObject.NotSet: if isinstance(affects, list): affects = ",".join(affects) url_parameters["affects"] = affects if published is not github.GithubObject.NotSet: url_parameters["published"] = published if updated is not github.GithubObject.NotSet: url_parameters["updated"] = updated if modified is not github.GithubObject.NotSet: url_parameters["modified"] = modified if before is not github.GithubObject.NotSet: url_parameters["before"] = before if after is not github.GithubObject.NotSet: url_parameters["after"] = after if sort is not github.GithubObject.NotSet: assert sort in ("published", "updated"), sort url_parameters["sort"] = sort if direction is not github.GithubObject.NotSet: assert direction in ("asc", "desc"), direction url_parameters["direction"] = direction return github.PaginatedList.PaginatedList( github.GlobalAdvisory.GlobalAdvisory, self.__requester, "/advisories", url_parameters, ) def search_repositories( self, query: str, sort: Opt[str] = NotSet, order: Opt[str] = NotSet, **qualifiers: Any, ) -> PaginatedList[Repository]: """ :calls: `GET /search/repositories `_ :param query: string :param sort: string ('stars', 'forks', 'updated') :param order: string ('asc', 'desc') :param qualifiers: keyword dict query qualifiers """ assert isinstance(query, str), query url_parameters = dict() if sort is not NotSet: # pragma no branch (Should be covered) assert sort in ("stars", "forks", "updated"), sort url_parameters["sort"] = sort if order is not NotSet: # pragma no branch (Should be covered) assert order in ("asc", "desc"), order url_parameters["order"] = order query_chunks = [] if query: # pragma no branch (Should be covered) query_chunks.append(query) for qualifier, value in qualifiers.items(): query_chunks.append(f"{qualifier}:{value}") url_parameters["q"] = " ".join(query_chunks) assert url_parameters["q"], "need at least one qualifier" return PaginatedList( github.Repository.Repository, self.__requester, "/search/repositories", url_parameters, ) def search_users( self, query: str, sort: Opt[str] = NotSet, order: Opt[str] = NotSet, **qualifiers: Any, ) -> PaginatedList[NamedUser]: """ :calls: `GET /search/users `_ :param query: string :param sort: string ('followers', 'repositories', 'joined') :param order: string ('asc', 'desc') :param qualifiers: keyword dict query qualifiers :rtype: :class:`PaginatedList` of :class:`github.NamedUser.NamedUser` """ assert isinstance(query, str), query url_parameters = dict() if sort is not NotSet: assert sort in ("followers", "repositories", "joined"), sort url_parameters["sort"] = sort if order is not NotSet: assert order in ("asc", "desc"), order url_parameters["order"] = order query_chunks = [] if query: query_chunks.append(query) for qualifier, value in qualifiers.items(): query_chunks.append(f"{qualifier}:{value}") url_parameters["q"] = " ".join(query_chunks) assert url_parameters["q"], "need at least one qualifier" return PaginatedList( github.NamedUser.NamedUser, self.__requester, "/search/users", url_parameters, ) def search_issues( self, query: str, sort: Opt[str] = NotSet, order: Opt[str] = NotSet, **qualifiers: Any, ) -> PaginatedList[Issue]: """ :calls: `GET /search/issues `_ :param query: string :param sort: string ('comments', 'created', 'updated') :param order: string ('asc', 'desc') :param qualifiers: keyword dict query qualifiers :rtype: :class:`PaginatedList` of :class:`github.Issue.Issue` """ assert isinstance(query, str), query url_parameters = dict() if sort is not NotSet: assert sort in ("comments", "created", "updated"), sort url_parameters["sort"] = sort if order is not NotSet: assert order in ("asc", "desc"), order url_parameters["order"] = order query_chunks = [] if query: # pragma no branch (Should be covered) query_chunks.append(query) for qualifier, value in qualifiers.items(): query_chunks.append(f"{qualifier}:{value}") url_parameters["q"] = " ".join(query_chunks) assert url_parameters["q"], "need at least one qualifier" return PaginatedList(github.Issue.Issue, self.__requester, "/search/issues", url_parameters) def search_code( self, query: str, sort: Opt[str] = NotSet, order: Opt[str] = NotSet, highlight: bool = False, **qualifiers: Any, ) -> PaginatedList[ContentFile]: """ :calls: `GET /search/code `_ :param query: string :param sort: string ('indexed') :param order: string ('asc', 'desc') :param highlight: boolean (True, False) :param qualifiers: keyword dict query qualifiers :rtype: :class:`PaginatedList` of :class:`github.ContentFile.ContentFile` """ assert isinstance(query, str), query url_parameters = dict() if sort is not NotSet: # pragma no branch (Should be covered) assert sort in ("indexed",), sort url_parameters["sort"] = sort if order is not NotSet: # pragma no branch (Should be covered) assert order in ("asc", "desc"), order url_parameters["order"] = order query_chunks = [] if query: # pragma no branch (Should be covered) query_chunks.append(query) for qualifier, value in qualifiers.items(): query_chunks.append(f"{qualifier}:{value}") url_parameters["q"] = " ".join(query_chunks) assert url_parameters["q"], "need at least one qualifier" headers = {"Accept": Consts.highLightSearchPreview} if highlight else None return PaginatedList( github.ContentFile.ContentFile, self.__requester, "/search/code", url_parameters, headers=headers, ) def search_commits( self, query: str, sort: Opt[str] = NotSet, order: Opt[str] = NotSet, **qualifiers: Any, ) -> PaginatedList[Commit]: """ :calls: `GET /search/commits `_ :param query: string :param sort: string ('author-date', 'committer-date') :param order: string ('asc', 'desc') :param qualifiers: keyword dict query qualifiers :rtype: :class:`PaginatedList` of :class:`github.Commit.Commit` """ assert isinstance(query, str), query url_parameters = dict() if sort is not NotSet: assert sort in ("author-date", "committer-date"), sort url_parameters["sort"] = sort if order is not NotSet: assert order in ("asc", "desc"), order url_parameters["order"] = order query_chunks = [] if query: query_chunks.append(query) for qualifier, value in qualifiers.items(): query_chunks.append(f"{qualifier}:{value}") url_parameters["q"] = " ".join(query_chunks) assert url_parameters["q"], "need at least one qualifier" return PaginatedList( github.Commit.Commit, self.__requester, "/search/commits", url_parameters, headers={"Accept": Consts.mediaTypeCommitSearchPreview}, ) def search_topics(self, query: str, **qualifiers: Any) -> PaginatedList[Topic]: """ :calls: `GET /search/topics `_ :param query: string :param qualifiers: keyword dict query qualifiers :rtype: :class:`PaginatedList` of :class:`github.Topic.Topic` """ assert isinstance(query, str), query url_parameters = dict() query_chunks = [] if query: # pragma no branch (Should be covered) query_chunks.append(query) for qualifier, value in qualifiers.items(): query_chunks.append(f"{qualifier}:{value}") url_parameters["q"] = " ".join(query_chunks) assert url_parameters["q"], "need at least one qualifier" return PaginatedList( github.Topic.Topic, self.__requester, "/search/topics", url_parameters, headers={"Accept": Consts.mediaTypeTopicsPreview}, ) def render_markdown(self, text: str, context: Opt[Repository] = NotSet) -> str: """ :calls: `POST /markdown `_ :param text: string :param context: :class:`github.Repository.Repository` :rtype: string """ assert isinstance(text, str), text assert context is NotSet or isinstance(context, github.Repository.Repository), context post_parameters = {"text": text} if is_defined(context): post_parameters["mode"] = "gfm" post_parameters["context"] = context._identity status, headers, data = self.__requester.requestJson("POST", "/markdown", input=post_parameters) return data def get_hook(self, name: str) -> HookDescription: """ :calls: `GET /hooks/{name} `_ """ assert isinstance(name, str), name name = urllib.parse.quote(name) headers, attributes = self.__requester.requestJsonAndCheck("GET", f"/hooks/{name}") return HookDescription(self.__requester, headers, attributes, completed=True) def get_hooks(self) -> list[HookDescription]: """ :calls: `GET /hooks `_ :rtype: list of :class:`github.HookDescription.HookDescription` """ headers, data = self.__requester.requestJsonAndCheck("GET", "/hooks") return [HookDescription(self.__requester, headers, attributes, completed=True) for attributes in data] def get_hook_delivery(self, hook_id: int, delivery_id: int) -> HookDelivery: """ :calls: `GET /hooks/{hook_id}/deliveries/{delivery_id} `_ :param hook_id: integer :param delivery_id: integer :rtype: :class:`HookDelivery` """ assert isinstance(hook_id, int), hook_id assert isinstance(delivery_id, int), delivery_id headers, attributes = self.__requester.requestJsonAndCheck("GET", f"/hooks/{hook_id}/deliveries/{delivery_id}") return HookDelivery(self.__requester, headers, attributes, completed=True) def get_hook_deliveries(self, hook_id: int) -> list[HookDeliverySummary]: """ :calls: `GET /hooks/{hook_id}/deliveries `_ :param hook_id: integer :rtype: list of :class:`HookDeliverySummary` """ assert isinstance(hook_id, int), hook_id headers, data = self.__requester.requestJsonAndCheck("GET", f"/hooks/{hook_id}/deliveries") return [HookDeliverySummary(self.__requester, headers, attributes, completed=True) for attributes in data] def get_gitignore_templates(self) -> list[str]: """ :calls: `GET /gitignore/templates `_ """ headers, data = self.__requester.requestJsonAndCheck("GET", "/gitignore/templates") return data def get_gitignore_template(self, name: str) -> GitignoreTemplate: """ :calls: `GET /gitignore/templates/{name} `_ """ assert isinstance(name, str), name name = urllib.parse.quote(name) headers, attributes = self.__requester.requestJsonAndCheck("GET", f"/gitignore/templates/{name}") return github.GitignoreTemplate.GitignoreTemplate(self.__requester, headers, attributes, completed=True) def get_emojis(self) -> dict[str, str]: """ :calls: `GET /emojis `_ :rtype: dictionary of type => url for emoji` """ headers, attributes = self.__requester.requestJsonAndCheck("GET", "/emojis") return attributes def create_from_raw_data( self, klass: type[TGithubObject], raw_data: dict[str, Any], headers: dict[str, str | int] | None = None ) -> TGithubObject: """ Creates an object from raw_data previously obtained by :attr:`GithubObject.raw_data`, and optionally headers previously obtained by :attr:`GithubObject.raw_headers`. :param klass: the class of the object to create :param raw_data: dict :param headers: dict :rtype: instance of class ``klass`` """ if headers is None: headers = {} return klass(self.__requester, headers, raw_data, completed=True) def dump(self, obj: GithubObject, file: BinaryIO, protocol: int = 0) -> None: """ Dumps (pickles) a PyGithub object to a file-like object. Some effort is made to not pickle sensitive information like the Github credentials used in the :class:`Github` instance. But NO EFFORT is made to remove sensitive information from the object's attributes. :param obj: the object to pickle :param file: the file-like object to pickle to :param protocol: the `pickling protocol `_ :param obj: the object to pickle :param file: the file-like object to pickle to :param protocol: the `pickling protocol `_ :param obj: the object to pickle :param file: the file-like object to pickle to :param protocol: the `pickling protocol `_ :param obj: the object to pickle :param file: the file-like object to pickle to :param protocol: the `pickling protocol `_ :param obj: the object to pickle :param file: the file-like object to pickle to :param protocol: the `pickling protocol `_ """ pickle.dump((obj.__class__, obj.raw_data, obj.raw_headers), file, protocol) def load(self, f: BinaryIO) -> Any: """ Loads (unpickles) a PyGithub object from a file-like object. :param f: the file-like object to unpickle from :return: the unpickled object """ return self.create_from_raw_data(*pickle.load(f)) def get_oauth_application(self, client_id: str, client_secret: str) -> ApplicationOAuth: return github.ApplicationOAuth.ApplicationOAuth( self.__requester, headers={}, attributes={"client_id": client_id, "client_secret": client_secret}, completed=False, ) def get_app(self, slug: Opt[str] = NotSet) -> GithubApp: """ :calls: `GET /apps/{slug} `_ or `GET /app `_ """ if slug is NotSet: # with no slug given, calling /app returns the authenticated app, # including the actual /apps/{slug} warnings.warn( "Argument slug is mandatory, calling this method without the slug argument is deprecated, please use " "github.GithubIntegration(auth=github.Auth.AppAuth(...)).get_app() instead", category=DeprecationWarning, ) return GithubIntegration(**self.__requester.kwargs).get_app() else: assert isinstance(slug, str), slug # with a slug given, we can lazily load the GithubApp slug = urllib.parse.quote(slug) return github.GithubApp.GithubApp(self.__requester, {}, {"url": f"/apps/{slug}"}, completed=False)