,Of\PddlmZddlZddlZddlZddlmZddlmZm Z m Z m Z ddl Z ddl mZddlZddlZddlZddlZddlZddlZddlZddlZddlZddlZddlZddlZddlZddlZddlmZddlmZddl m!Z!m"Z"m#Z#m$Z$dd lm%Z%dd l&m'Z'm(Z(dd l)m*Z*dd l+m,Z,dd l-m.Z.ddl/m0Z0erlddl1m2Z2ddlm3Z3ddlm4Z4ddl5m6Z6ddl7m8Z8ddlm9Z9ddlm:Z:ddlm;Z;ddlmm?Z?ddlm@Z@ddlmAZAddlBmCZCddlDmEZEddlFmGZGddlHmIZIdd lmJZJe d!e!"ZKGd#d$ZLy)%) annotationsN)datetime) TYPE_CHECKINGAnyBinaryIOTypeVar)Retry)Consts)GithubIntegration) GithubObjectNotSetOpt is_defined) GithubRetry) HookDeliveryHookDeliverySummary)HookDescription) PaginatedList) RateLimit) Requester)AppAuthentication)ApplicationOAuth)AuthenticatedUser)Commit) ContentFile)Event)Gist) GithubApp)GitignoreTemplate)GlobalAdvisory)Issue)License) NamedUser) Organization)Project) ProjectColumn) Repository)Topic TGithubObject)boundceZdZUdZded<eZddddejejejejdedejejdf d7dZd8dZd9dZd:d Zed;d Zej(dd Zed?dZed=dZd@dZedAdZefdBdZdCdZdDdZefdEdZdFdZefdGdZ dHdZ!efdIdZ"dJdZ#dKdLdZ$eef dMdZ%dNdZ&dOdZ'dPd Z(efdQd!Z)dRd"Z*eeeeeeeeeeeeeeeeef dSd#Z+eef dTd$Z,eef dUd%Z-eef dVd&Z.eedf dWd'Z/eef dXd(Z0dYd)Z1efdZd*Z2d[d+Z3d\d,Z4d]d-Z5d^d.Z6d_d/Z7d`d0Z8dad1Z9 db dcd2Z:ddded3Z;dfd4Zy)iGithubz This is the main class you instantiate to access the Github API v3. Optional parameters allow different authentication methods. r_Github__requesterNTc |t|tsJ||t|tsJ||t|tsJ|t|tsJ|t|tsJ||t|tsJ|t|tsJ|t| ttfsJ| | ;t| ts+t| tj j sJ| | t| tsJ| | | dk\sJ| | dk\sJ|+t|tjjsJ||I I>'/3Kq3PPP%-1G11LLL|z$ 0@0@AG4GA   MM6+  ;;$$^X>D  ' MMj+ ;;$$^4D _ MM=,   ;;++C0D  ! MMr+ D$         $ "  c8|jjy)zClose connections to the server. Alternatively, use the Github object as a context manager: .. code-block:: python with github.Github(...) as gh: # do something N)r-closer?s rNrRz Github.closes  rPc|SNrSs rN __enter__zGithub.__enter__s rPc$|jyrU)rR)r?exc_typeexc_valexc_tbs rN__exit__zGithub.__exit__s  rPc.|jjSrUr-FIX_REPO_GET_GIT_REFrSs rNr_zGithub.FIX_REPO_GET_GIT_REFs444rPc&||j_yrUr^r?values rNr_zGithub.FIX_REPO_GET_GIT_REFs05-rPc.|jjSrUr-rGrSs rNrGzGithub.per_pages(((rPc&||j_yrUrdras rNrGzGithub.per_page!s$)!rPc|jj\}}|dkr|j|jjS)zS First value is requests remaining, second value is request limit. r)r- rate_limitingget_rate_limit)r? remaininglimits rNrgzGithub.rate_limiting(s?  ++99 5 19    !---rPc|jjdk(r|j|jjS)zJ Unix timestamp indicating when rate limiting will reset. r)r-rate_limiting_resettimerhrSs rNrlzGithub.rate_limiting_resettime2s6    3 3q 8    !777rPcv|jjdd\}}t|j||ddS)z Rate limit status for different resources (core/search/graphql). :calls: `GET /rate_limit `_ GETz /rate_limit resourcesT)r-requestJsonAndCheckrr?headersdatas rNrhzGithub.get_rate_limit;s<((<`_ rnz /licenses/T completed) r1r2urllibparsequoter-rpr7r")r?keyrrrss rN get_licensezGithub.get_licenseMsw #s#(S(#ll  %((<`_ z /licenses)rr7r"r-)r?url_parameterss rN get_licenseszGithub.get_licensesWs+ *,V^^33T5E5E{TbccrPcbttjj|jddS)zp :calls: `GET /events `_ z/eventsN)rr7rr-rSs rN get_eventszGithub.get_events`s% V\\//1A1A9dSSrPcz|tur/tjj|jiddidSt |t sJ|t jj|}|jjdd|\}}tjj|j||dS)z :calls: `GET /users/{user} `_ or `GET /user `_ urlz/userFrwrnz/users/T) r r7rr-r1r2ryrzr{rpr#r?loginrrrss rNget_userzGithub.get_usergs F?++==d>N>NPRUZ\cTdpu=v veS) 05 0)LL&&u-E ,,@@'RWQXHYZMGT##--d.>.>Y]-^ ^rPct|tsJ||jjdd|\}}tj j |j||dS)z :calls: `GET /user/{id} `_ :param user_id: int :rtype: :class:`github.NamedUser.NamedUser` rnz/user/Trw)r1r3r-rpr7r#)r?user_idrrrss rNget_user_by_idzGithub.get_user_by_idssc '3'00'((<`_ sincez/users)r r1r3dictrr7r#r-r?rrs rN get_userszGithub.get_users}s\*UC"8?%?8  &+N7 #V--779I9I8UcddrPc t|tsJ|tjj |}|j j dd|\}}tjj|j ||dS)z] :calls: `GET /orgs/{org} `_ rnz/orgs/Trw) r1r2ryrzr{r-rpr7r$rs rNget_organizationzGithub.get_organizationsw%%,u,% ""5)((<`_ rz/organizations)r r1r3rrr7r$r-rs rNget_organizationszGithub.get_organizationssc*UC"8?%?8  &+N7 #    , ,        rPct|tsJ|tjj|j|S)z :calls: `GET /enterprises/{enterprise} `_ :param enterprise: string :rtype: :class:`Enterprise` )r1r2r7 Enterpriser-)r? enterprises rNget_enterprisezGithub.get_enterprises8 *c*6J6*  ++D,<,`_ or `GET /repositories/{id} `_ z/repositories/z/repos/rFrwrnT)r1r2r3r7r'r-rp)r?full_name_or_idlazyurl_baserrrrss rNget_repozGithub.get_repos/C:6GG6'1/3'G#Y ?+, $$//0@0@"ucl^c/d d((<`_ :param since: integer :param visibility: string ('all','public') r)publicall visibilityz /repositories)r r1r3rr7r'r-)r?rrrs rN get_reposzGithub.get_reposs*UC"8?%?8)+  &+N7 # V #!22 >J >2+5N< (    ( (        rPc|jjdd|ddtji\}}tj j |j||dS)zz :calls: `GET /projects/{project_id} `_ rnz /projects/dAcceptrrTrw)r-rpr mediaTypeProjectsPreviewr7r%r?idrrrss rN get_projectzGithub.get_projectsg((<< A v>>?=  ~~%%d&6&6QU%VVrPc|jjdd|zdtji\}}tj j |j||dS)z :calls: `GET /projects/columns/{column_id} `_ rnz/projects/columns/%drrTrw)r-rpr rr7r&rs rNget_project_columnzGithub.get_project_columnse((<<  "R 'v>>?=  ##11$2B2BGT]a1bbrPct|tsJ||jjdd|\}}tj j |j||dS)z^ :calls: `GET /gists/{id} `_ rnz/gists/Trw)r1r2r-rpr7rrs rNget_gistzGithub.get_gists_"c"&B&"((<`_ z%Y-%m-%dT%H:%M:%SZrz /gists/public) r r1rrrstrftimerr7rr-rs rN get_gistszGithub.get_gistssd*UH"=DuD= e &+nn5I&JN7 #V[[--t/?/?R`aarPc t|tsJ|tjj |}|j j dd|\}}tjj|j ||dS)z :calls: `GET /advisories/{ghsa_id} `_ :param ghsa_id: string :rtype: :class:`github.GlobalAdvisory.GlobalAdvisory` rnz /advisories/Trw) r1r2ryrzr{r-rpr7r )r?ghsa_idrrrss rNget_global_advisoryzGithub.get_global_advisorysy '3'00',,$$W-((<` :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` )reviewed unreviewedmalwaretypercve_id ecosystem)nulllowmediumhighcriticalseverity,cwes is_withdrawnaffects publishedupdatedmodifiedbeforeafter)rrsortascdesc directionz /advisories) r7r r r1r2listr4rjoinrr r-)r?rrrrrrrrrrrkeywordsrrrGrrrcwes rNget_global_advisorieszGithub.get_global_advisoriessNv**111Zc5JPDPJ&--444 7C8PPP,,333zNVPVVNF//666*YPS:T_V__T6..555Hc9R\T\\Rv**111Zd5KzZ^`cOdjfjjdv22999Z VZ=[i]ii[&--444 7D8QU_`gilUmvovvmF//666*YPS:T_V__T&--444 7C8PYRYYP6..555Hc9R\T\\R,,333zNVPVVN++222j6LSeSLv**111Zc5JPDPJF//666*YPS:T_V__T59V v**11 1@@ F$ F@%)N6 " &--44 4(/N9 % ,,33 3'-N8 $ F//66 6*3N; ' 6..55 5LL Vh VL)1N: & v**11 1$%xxT :cS :;%)N6 " v2299 9-9N> * &--44 4'4(((7+(/N9 % F//66 6*3N; ' &--44 4(/N9 % 6..55 5)1N: & ,,33 3'-N8 $ ++22 2&+N7 # v**11 133 9T 93%)N6 " F//66 6/ : :/*3N; '##11  ! ! 0 0        1!;sWc t|tsJ|t}|tur|dvsJ|||d<|tur|dvsJ|||d<g}|r|j ||j D]\}}|j |d|dj ||d<|dsJdttjj|jd |S) a% :calls: `GET /search/repositories `_ :param query: string :param sort: string ('stars', 'forks', 'updated') :param order: string ('asc', 'desc') :param qualifiers: keyword dict query qualifiers )starsforksrrrorder: qneed at least one qualifierz/search/repositories) r1r2rr appenditemsrrr7r'r- r?queryrr qualifiersr query_chunks qualifierrbs rNsearch_repositorieszGithub.search_repositoriesgs %%,u,% v 88 >$ >8%)N6 "  O+ 2U 2+&+N7 #     & * 0 0 2 8 Iu   9+Qug 6 7 8"hh|4sc"A$AA"    ( (    "    rPc t|tsJ|t}|tur|dvsJ|||d<|tur|dvsJ|||d<g}|r|j ||j D]\}}|j |d|dj ||d<|dsJdttjj|jd |S) av :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` ) followers repositoriesjoinedrrrrrrrz /search/users) r1r2rr rrrrr7r#r-rs rN search_userszGithub.search_userss %%,u,% v BB HD HB%)N6 "  O+ 2U 2+&+N7 #     & * 0 0 2 8 Iu   9+Qug 6 7 8"hh|4sc"A$AA"    & &        rPc t|tsJ|t}|tur|dvsJ|||d<|tur|dvsJ|||d<g}|r|j ||j D]\}}|j |d|dj ||d<|dsJdttjj|jd |S) aj :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` )commentscreatedrrrrrrrrz/search/issues) r1r2rr rrrrr7r!r-rs rN search_issueszGithub.search_issuess%%,u,% v == Ct C=%)N6 "  O+ 2U 2+&+N7 #     & * 0 0 2 8 Iu   9+Qug 6 7 8"hh|4sc"A$AA"V\\//1A1ACSUcddrPc t|tsJ|t}|tur|dvsJ|||d<|tur|dvsJ|||d<g}|r|j ||j D]\}} |j |d| dj ||d<|dsJd|rd tjind } ttjj|jd || S) a :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` )indexedrrrrrrrrNz /search/coder) r1r2rr rrrr highLightSearchPreviewrr7rr-) r?rrr highlightrrrrrbrrs rN search_codezGithub.search_codes!"%%,u,% v <' - -'%)N6 "  O+ 2U 2+&+N7 #     & * 0 0 2 8 Iu   9+Qug 6 7 8"hh|4sc"A$AA"?H8V::;d    * *        rPc t|tsJ|t}|tur|dvsJ|||d<|tur|dvsJ|||d<g}|r|j ||j D]\}}|j |d|dj ||d<|dsJdttjj|jd |d tji S) al :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` )z author-datezcommitter-daterrrrrrrz/search/commitsrr) r1r2rr rrrrr7rr-r mediaTypeCommitSearchPreviewrs rNsearch_commitszGithub.search_commits s%%,u,% v << Bd B<%)N6 "  O+ 2U 2+&+N7 #     & * 0 0 2 8 Iu   9+Qug 6 7 8"hh|4sc"A$AA" MM     vBBC   rPc t|tsJ|t}g}|r|j||j D]\}}|j|d|dj ||d<|dsJdt tjj|jd|dtjiS)z :calls: `GET /search/topics `_ :param query: string :param qualifiers: keyword dict query qualifiers :rtype: :class:`PaginatedList` of :class:`github.Topic.Topic` rrrrz/search/topicsrr) r1r2rrrrrr7r(r-r mediaTypeTopicsPreview)r?rrrrrrbs rN search_topicszGithub.search_topics4s%%,u,%     & * 0 0 2 8 Iu   9+Qug 6 7 8"hh|4sc"A$AA" LL       v<<=   rPc$t|tsJ||tus+t|tjjsJ|d|i}t |rd|d<|j |d<|jjdd|\}}}|S)z :calls: `POST /markdown `_ :param text: string :param context: :class:`github.Repository.Repository` :rtype: string textgfmmodecontextPOSTz /markdown)input) r1r2r r7r'r _identityr- requestJson)r?rrpost_parametersstatusrrrss rNrender_markdownzGithub.render_markdownPs$$*d*$& Jw8I8I8T8T$U^W^^U!4. g &+OF #)0):):OI & $ 0 0 < `_ rn/hooks/Trw)r1r2ryrzr{r-rprr?namerr attributess rNget_hookzGithub.get_hook`sk$$*d*$||!!$'"..BB5GTXSYJZ[t//*PTUUrPc |jjdd\}}|Dcgc]}t|j||dc}Scc}w)z :calls: `GET /hooks `_ :rtype: list of :class:`github.HookDescription.HookDescription` rnz/hooksTrw)r-rpr)r?rrrsrs rN get_hookszGithub.get_hooksisG ((<`_ :param hook_id: integer :param delivery_id: integer :rtype: :class:`HookDelivery` rnrz /deliveries/Trw)r1r3r-rpr)r?hook_id delivery_idrrrs rNget_hook_deliveryzGithub.get_hook_deliveryqst'3'00'+s+8[8+"..BB5GT[S\\hithuJvwD,,gzTRRrPc t|tsJ||jjdd|d\}}|Dcgc]}t |j||dc}Scc}w)z :calls: `GET /hooks/{hook_id}/deliveries `_ :param hook_id: integer :rtype: list of :class:`HookDeliverySummary` rnrz /deliveriesTrw)r1r3r-rpr)r?r rrrsrs rNget_hook_deliverieszGithub.get_hook_deliveries}sg '3'00'((<`_ rnz/gitignore/templatesr-rprqs rNget_gitignore_templateszGithub.get_gitignore_templatess&((<`_ rnz/gitignore/templates/Trw) r1r2ryrzr{r-rpr7rrs rNget_gitignore_templatezGithub.get_gitignore_templates|$$*d*$||!!$'"..BB5LabfagJhi''99$:J:JGU_ko9pprPcD|jjdd\}}|S)z :calls: `GET /emojis `_ :rtype: dictionary of type => url for emoji` rnz/emojisr)r?rrrs rN get_emojiszGithub.get_emojiss' #..BB5)TrPc6|i}||j||dS)a` 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`` Trw)r-)r?klassraw_datarrs rNcreate_from_raw_datazGithub.create_from_raw_datas% ?GT%%wDIIrPcttj|j|j|jf||y)a) 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 `_ N)pickledump __class__r raw_headers)r?objfileprotocols rNrz Github.dumps(@  S]]CLL#//BD(SrPcF|jtj|S)z Loads (unpickles) a PyGithub object from a file-like object. :param f: the file-like object to unpickle from :return: the unpickled object )rrload)r?fs rNr&z Github.loads)t((&++a.99rPcbtjj|ji||ddS)N) client_id client_secretF)rrrrx)r7rr-)r?r)r*s rNget_oauth_applicationzGithub.get_oauth_applications7&&77   %.O 8  rPcr|turHtjdtt di|j j jSt|tsJ|tjj|}tjj|j idd|idS)z :calls: `GET /apps/{slug} `_ or `GET /app `_ zArgument slug is mandatory, calling this method without the slug argument is deprecated, please use github.GithubIntegration(auth=github.Auth.AppAuth(...)).get_app() insteadr/rz/apps/FrwrV)r r9r:r;r r-kwargsget_appr1r2ryrzr{r7r)r?slugs rNr.zGithub.get_apps 6> MM\+  %?t'7'7'>'>?GGI IdC( .$ .(<<%%d+D##--d.>.>UfUYTZOD\hm-n nrP)r@ str | NonerAr0rBr0rCzAppAuthentication | NonerDr2rEr3rFr2rGr3rHz bool | strrIzint | Retry | NonerJz int | NonerK float | NonerLr1rMzgithub.Auth.Auth | NonereturnNone)r2r3)r2r,)rYrrZrr[rr2r3)r2r4)rbr4r2r3)r2r3)rbr3r2r3)r2ztuple[int, int])r2r)r2zlist[str] | None)r|Opt[str]r2r")r2zPaginatedList[License])r2zPaginatedList[Event])rr4r2zNamedUser | AuthenticatedUser)rr3r2r#)rOpt[int]r2PaginatedList[NamedUser])rr2r2r$)rr5r2zPaginatedList[Organization])rr2r2zgithub.Enterprise.Enterprise)F)rz int | strrr4r2r')rr5rr4r2PaginatedList[Repository])rr3r2r%)rr3r2r&)rr2r2r)rz Opt[datetime]r2zPaginatedList[Gist])rr2r2r )$rr4rr4rr4rr4rr4rzlist[Opt[str]] | Opt[str]rz Opt[bool]rzlist[str] | Opt[str]rr4rr4rr4rr4rr4rr4rGr4rr4rr4r2zPaginatedList[GlobalAdvisory]) rr2rr4rr4rrr2r7) rr2rr4rr4rrr2r6) rr2rr4rr4rrr2zPaginatedList[Issue]) rr2rr4rr4rr4rrr2zPaginatedList[ContentFile]) rr2rr4rr4rrr2zPaginatedList[Commit])rr2rrr2zPaginatedList[Topic])rr2rzOpt[Repository]r2r2)rr2r2r)r2zlist[HookDescription])r r3rr3r2r)r r3r2zlist[HookDeliverySummary])r2z list[str])rr2r2r)r2zdict[str, str]rU)rztype[TGithubObject]rzdict[str, Any]rrzdict[str, str | int] | Noner2r))r)r"r r#rr$r3r2r3)r'rr2r)r)r2r*r2r2r)r/r4r2r)?__name__ __module__ __qualname____doc____annotations__r default_retryr DEFAULT_BASE_URLDEFAULT_TIMEOUTDEFAULT_USER_AGENTDEFAULT_PER_PAGE DEFAULT_SECONDS_BETWEEN_REQUESTSDEFAULT_SECONDS_BETWEEN_WRITESrOrRrWr\propertyr_setterrGrgrlrhrur r}rrrrrrrrrrrrrrrrrrrrrrrr r rrrrrrrr&r+r.rVrPrNr,r,s%MM&*#-1//-- 33//!$1 $171X1X/5/T/T(,Y "Y Y  Y + Y  Y Y Y Y Y "Y Y #/Y !-Y &Y !Y v !55  6!6))__** ..88 M-- +1WdT*0 _[+1ea39  J ]!%    #  0 W cQ06b e "!$#*0"((.$"##! #$%e e e  e  e  e (e  e &e e e e e e e !e "#e $%e & ''e T  & & &  &  & # & V  ' ' '  '  ' " ' X  "e"e"e "e  "e  "eN   , , ,  ,  ,  ,  $, b  ( ( (  (  (  ( T 8EK Vo SsqlpJ(J4BJMhJ J$ TD: (.orPr,)M __future__rr urllib.parseryr9rtypingrrrrr5 urllib3.utilr github.ApplicationOAuthr7 github.Authgithub.AuthenticatedUsergithub.Enterprise github.Event github.Gistgithub.GithubAppgithub.GithubIntegrationgithub.GithubRetrygithub.GitignoreTemplategithub.GlobalAdvisorygithub.Licensegithub.NamedUser github.Topicr r github.GithubObjectr r rrrgithub.HookDeliveryrrgithub.HookDescriptionrgithub.PaginatedListrgithub.RateLimitrgithub.Requesterrgithub.AppAuthenticationrrr github.Commitrgithub.ContentFilerrrrrr github.Issuer!r"r#github.Organizationr$github.Projectr%github.ProjectColumnr&github.Repositoryr'r(r)r,rVrPrNrfsz# 886EE*A2.&&:8:$." *:4"&*0&2,"|< ` o` orP