_Og?1SrSSKJr SSKJr SSKJr SSKJr SSKJr SS KJ r SS K J r "S S \R5r "S S\R5r"SS\ 5r"SS\ 5rg)z?This module contains the Gist, ShortGist, and GistFork objects.)dumps)comment)file)history)models)users) requires_authc\rSrSrSrSr\RrSr Sr Sr \ S5r \ S5r\ S04S j5r\ S 5r\ S 5rSS jrSSjrSSjr\ S5r\ S5rSrg )_Gist aThis object holds all the information returned by Github about a gist. With it you can comment on or fork the gist (assuming you are authenticated), edit or delete the gist (assuming you own it). You can also "star" or "unstar" the gist (again assuming you have authenticated). Two gist instances can be checked like so:: g1 == g2 g1 != g2 And is equivalent to:: g1.id == g2.id g1.id != g2.id See also: http://developer.github.com/v3/gists/ c @USUlUSUlURUS5UlUSUlUSR 5VVs0sHup#X R X05_M snnUlUSUlUSUl USUl US Ul URS 5Ul URb&[R"URU5Ul US UlURUS 5UlUS =UlUlgs snnf)Ncomments comments_url created_at descriptionfiles git_pull_url git_push_urlhtml_urlidownerpublic updated_aturl)comments_countr _strptimerritems _file_classrrrrrgetrr ShortUserrrr_api)selfgistfilenamegfiles W/Users/admin/workspace/ai/Jarvis/env/lib/python3.13/site-packages/github3/gists/gist.py_update_attributes_Gist._update_attributes$s":. 0..l);< .$(=#6#6#8 #8 &&u3 3#8  !0 0Z( t*XXg& :: !T:DJ8n ..l);<#E{*49 sDcUR$)Nrr$s r(__str__ _Gist.__str__8s wwc SRUS9$)Nz<{s.class_name} [{s.id}]>)s)formatr-s r(_repr _Gist._repr;s*11D199r0cSnU(a<URSURS9nURURUSU0S9S5nUR [ R U5$)zCreate a comment on this gist. :param str body: (required), body of the comment :returns: Created comment or None :rtype: :class:`~github3.gists.comment.GistComment` Nrbase_urlbodydata) _build_urlr#_json_post_instance_or_nullr GistComment)r$r9jsonrs r(create_comment_Gist.create_comment>s\ //*tyy/AC::djjFD>jBCHD%%g&9&94@@r0cZURURUR5SS5$)z]Delete this gist. :returns: Whether the deletion was successful or not :rtype: bool )_boolean_deleter#r-s r(delete _Gist.deleteOs$}}T\\$))4c3??r0c0nSnU(aXS'U(aX#S'U(a3URURUR[U5S9S5nU(aUR U5 gg)aEdit this gist. :param str description: (optional), description of the gist :param dict files: (optional), files that make up this gist; the key(s) should be the file name(s) and the values should be another (optional) dictionary with (optional) keys: 'content' and 'filename' where the former is the content of the file and the latter is the new name of the file. :returns: Whether the edit was successful or not :rtype: bool Nrrr:TF)r>_patchr#rr))r$rrr;rBs r(edit _Gist.editZsb  "-  !M ::dkk$))%+kFLD   # #D )r0cURSURS9nURURU5S5nUR [ U5$)zFork this gist. :returns: New gist if successfully forked, ``None`` otherwise :rtype: :class:`~github3.gists.gist.ShortGist` forksr7r<)r=r#r>r?r@ ShortGist)r$rrBs r(fork _Gist.forkwsEoog o:zz$**S/3/%%i66r0czURSURS9nURURU5SS5$)zCheck to see if this gist is starred by the authenticated user. :returns: True if it is starred, False otherwise :rtype: bool starr7rFrG)r=r#rH_getr$rs r( is_starred_Gist.is_starred5ooftyyo9}}TYYs^S#66r0NcURSURS9nUR[U5U[R US9$)aVIterate over comments on this gist. :param int number: (optional), number of comments to iterate over. Default: -1 will iterate over all comments on the gist :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of comments :rtype: :class:`~github3.gists.comment.GistComment` rr7etag)r=r#_iterintrrAr$numberr`rs r(r_Gist.commentss;ooj499o=zz#f+sG,?,?dzKKr0cURSURS9nUR[U5U[R 5$)a!Iterate over the commits on this gist. These commits will be requested from the API and should be the same as what is in ``Gist.history``. .. versionadded:: 0.6 .. versionchanged:: 0.9 Added param ``etag``. :param int number: (optional), number of commits to iterate over. Default: -1 will iterate over all commits associated with this gist. :param str etag: (optional), ETag from a previous request to this endpoint. :returns: generator of the gist's history :rtype: :class:`~github3.gists.history.GistHistory` commitsr7)r=r#rarbr GistHistoryrcs r(rg _Gist.commitss7.ooi$))o<zz#f+sG,?,?@@r0ctURSURS9nUR[U5U[US9$)aIterator of forks of this gist. .. versionchanged:: 0.9 Added params ``number`` and ``etag``. :param int number: (optional), number of forks to iterate over. Default: -1 will iterate over all forks of this gist. :param str etag: (optional), ETag from a previous request to this endpoint. :returns: generator of gists :rtype: :class:`~github3.gists.gist.ShortGist` rSr7r_)r=r#rarbrTrcs r(rS _Gist.forkss5"oog o:zz#f+sIDzAAr0czURSURS9nURURU5SS5$)zTStar this gist. :returns: True if successful, False otherwise :rtype: bool rXr7rFrG)r=r#rH_putrZs r(rX _Gist.starr]r0czURSURS9nURURU5SS5$)zWUn-star this gist. :returns: True if successful, False otherwise :rtype: bool rXr7rFrG)r=r#rHrIrZs r(unstar _Gist.unstars6ooftyyo9}}T\\#.S99r0)r#rrrrrrrrrrrrr)N)__name__ __module__ __qualname____firstlineno____doc__ class_namegistfile ShortGistFiler r)r.r4r rCrJrPrUr[rrgrSrXrp__static_attributes__r0r(r r s(J((K+(:AA @@!8 7 7 7 7L A4B( 7 7 : :r0r c.\rSrSrSrSrSrSr\rSr g)GistForkaThis object represents a forked Gist. This has a subset of attributes of a :class:`~github3.gists.gist.ShortGist`: .. attribute:: created_at The date and time when the gist was created. .. attribute:: id The unique identifier of the gist. .. attribute:: owner The user who forked the gist. .. attribute:: updated_at The date and time of the most recent modification of the fork. .. attribute:: url The API URL for the fork. cURUS5UlUSUl[R"USU5UlURUS5UlUS=UlUlg)Nrruserrr) rrrr r"rrrr#)r$rUs r(r)GistFork._update_attributess_..l);<t*__T&\48 ..l);<#E{*49r0c"SURS3$)Nz r,r-s r(r4GistFork._repr sTWWIR((r0cURURUR5S5nUR[U5$)zRetrieve the full Gist representation of this fork. :returns: The Gist if retrieving it was successful or ``None`` :rtype: :class:`~github3.gists.gist.Gist` rN)r>rYrr@Gist)r$rBs r(to_gistGistFork.to_gist s4zz$))DHH-s3%%dD11r0)r#rrrrrN) rsrtrurvrwr)r4rrefreshr{r|r0r(r~r~s4+) 2Gr0r~cH^\rSrSrSrSr\RrU4Sjr Sr U=r $)riaThis object constitutes the full representation of a Gist. GitHub's API returns different amounts of information about gists based upon how that information is retrieved. This object exists to represent the full amount of information returned for a specific gist. For example, you would receive this class when calling :meth:`~github3.github.GitHub.gist`. To provide a clear distinction between the types of gists, github3.py uses different classes with different sets of attributes. This object has all the same attributes as :class:`~github3.gists.gist.ShortGist` as well as: .. attribute:: commits_url The URL to retrieve gist commits from the GitHub API. .. attribute:: original_forks A list of :class:`~github3.gists.gist.GistFork` objects representing each fork of this gist. To retrieve the most recent list of forks, use the :meth:`forks` method. .. attribute:: forks_url The URL to retrieve the current listing of forks of this gist. .. attribute:: history A list of :class:`~github3.gists.history.GistHistory` objects representing each change made to this gist. .. attribute:: truncated This is a boolean attribute that indicates whether the content of this Gist has been truncated or not. c>[TU]U5 USUlUSVs/sHn[X 5PM snUlUSUlUSVs/sHn[ R"X05PM snUlUSUlgs snfs snf)N commits_urlrS forks_urlr truncated) superr)rr~original_forksrrrhr)r$r%rUh __class__s r(r)Gist._update_attributesDs "4( .@DW N x3 Nk*>B9oNo++A4oN k*ONs B B)rrrrr) rsrtrurvrwrxryGistFiler r)r{ __classcell__)rs@r(rrs%$LJ##K++r0rc \rSrSrSrSr\rSrg)rTiMaZShort representation of a gist. GitHub's API returns different amounts of information about gists based upon how that information is retrieved. This object exists to represent the full amount of information returned for a specific gist. For example, you would receive this class when calling :meth:`~github3.github.GitHub.all_gists`. To provide a clear distinction between the types of gists, github3.py uses different classes with different sets of attributes. This object only has the following attributes: .. attribute:: url The GitHub API URL for this repository, e.g., ``https://api.github.com/gists/6faaaeb956dec3f51a9bd630a3490291``. .. attribute:: comments_count Number of comments on this gist .. attribute:: description Description of the gist as written by the creator .. attribute:: html_url The URL of this gist on GitHub, e.g., ``https://gist.github.com/sigmavirus24/6faaaeb956dec3f51a9bd630a3490291`` .. attribute:: id The unique identifier for this gist. .. attribute:: public This is a boolean attribute describing if the gist is public or private .. attribute:: git_pull_url The git URL to pull this gist, e.g., ``git://gist.github.com/sigmavirus24/6faaaeb956dec3f51a9bd630a3490291.git`` .. attribute:: git_push_url The git URL to push to gist, e.g., ``git@gist.github.com/sigmavirus24/6faaaeb956dec3f51a9bd630a3490291.git`` .. attribute:: created_at This is a datetime object representing when the gist was created. .. attribute:: updated_at This is a datetime object representing the last time this gist was most recently updated. .. attribute:: owner This attribute is a :class:`~github3.users.ShortUser` object representing the creator of the gist. .. attribute:: files A dictionary mapping the filename to a :class:`~github3.gists.gist.GistFile` object. .. versionchanged:: 1.0.0 Previously this was a list but it has been converted to a dictionary to preserve the structure of the API. .. attribute:: comments_url The URL to retrieve the list of comments on the Gist via the API. r|N) rsrtrurvrwrxr _refresh_tor{r|r0r(rTrTMsKZJKr0rTN)rwrBrrLrrryrr r decoratorsr GitHubCorer r~rrTr|r0r(rs`E&X:F  X:v0v  0f0+50+fOOr0