_OgtSrSSKrSSKJr SSKJr SSKJr SSK J r SSK J r SS K Jr "S S \R5r"S S \R5r"SS\R5r"SS\R5r"SS\5r"SS\5r"SS\R5r"SS\5r"SS\5r"SS\5r"SS\5r"S S!\5r"S"S#\5r\R:\\\\\\4rg)$z2This module contains everything relating to Users.N)dumps) URITemplate)models) requires_auth)Event) Authorizationc:\rSrSrSrSrSrSr\S5r Sr g) GPGKey aThe object representing a user's GPG key. .. versionadded:: 1.2.0 Please see GitHub's `GPG Key Documentation` for more information. .. _GPG Key Documentation: https://developer.github.com/v3/users/gpg_keys/ .. attribute:: can_certify Whether this GPG key can be used to sign a key. .. attribute:: can_encrypt_comms Whether this GPG key can be used to encrypt communications. .. attribute:: can_encrypt_storage Whether this GPG key can be used to encrypt storage. .. attribute:: can_sign Whether this GPG key can be used to sign some data. .. attribute:: created_at A :class:`~datetime.datetime` representing the date and time when this GPG key was created. .. attribute:: emails A list of :class:`~github3.users.ShortEmail` attached to this GPG key. .. attribute:: expires_at A :class:`~datetime.datetime` representing the date and time when this GPG key will expire. .. attribute:: id The unique identifier of this GPG key. .. attribute:: key_id A hexadecimal string that identifies this GPG key. .. attribute:: primary_key_id The unique identifier of the primary key of this GPG key. .. attribute:: public_key The public key contained in this GPG key. This is not a GPG formatted key, and is not suitable to be used directly in programs like GPG. .. attribute:: subkeys A list of :class:`~github3.users.GPGKey` of the subkeys of this GPG key. cUSUlUSUlUSUlUSUlUR US5UlUSVs/sHn[ X 5PM snUlUR US5UlUSUl US Ul US Ul US Ul US Vs/sHn[X05PM snUlgs snfs snf) N can_certifycan_encrypt_commscan_encrypt_storagecan_sign created_atemails expires_atidkey_idprimary_key_id public_keysubkeys)rrrr _strptimer ShortEmailrrrrrrr r)selfkeyemailsubkeys R/Users/admin/workspace/ai/Jarvis/env/lib/python3.13/site-packages/github3/users.py_update_attributesGPGKey._update_attributesMs}-!$%8!9#&'<#= J ..\):;y>J>v,>J K Ks C .Cc"SURS3$)Nz rrs r _repr GPGKey._repr[sDKK=++cUR$Nr%r&s r __str__GPGKey.__str__^s {{r)cURSSUR5nURURU5SS5$)zYDelete this GPG key. :returns: True if successful, False otherwise :rtype: bool usergpg_keys) _build_urlr_boolean_deleterurls r delete GPGKey.deleteas6oofj$'':}}T\\#.S99r)) rrrrrrrrrrrrN) __name__ __module__ __qualname____firstlineno____doc__r!r'r,rr8__static_attributes__r)r r r s,=~ K, : :r)r cN\rSrSrSrS SjrSrSr\S5r \S5r S r g) KeynaqThe object representing a user's SSH key. Please see GitHub's `Key Documentation`_ for more information. .. _Key Documentation: http://developer.github.com/v3/users/keys/ .. versionchanged:: 1.0.0 Removed ``title`` attribute .. attribute:: key A string containing the actual text of the SSH Key .. attribute:: id GitHub's unique ID for this key NcXURS5UlUSUlUSUlg)Nr7rr)get_apirr)rrsessions r r!Key._update_attributess'GGEN u:d)r)c"SURS3$)Nz U(a7XS.nURURUR[U5S9S5nU(aUR U5 gg)a Update this key. .. warning:: As of 20 June 2014, the API considers keys to be immutable. This will soon begin to return MethodNotAllowed errors. :param str title: (required), title of the key :param str key: (required), text of the key file :returns: bool N)rJrdataTF)_json_patchrFrr!)rrJrjsonrRs r update Key.updatesR S"/D::dkk$))%+kFLD   # #D )r))rFrrr+) r:r;r<r=r>r!r'r,rr8rWr?r@r)r rBrBns@( ,@@r)rBc0\rSrSrSrSrSrSrSrSr g) Plana4The :class:`Plan ` object. Please see GitHub's `Authenticated User`_ documentation for more details. .. _Authenticated User: http://developer.github.com/v3/users/#get-the-authenticated-user .. attribute:: collaborators_count .. versionchanged:: 1.0.0 The number of collaborators allowed on this plan .. attribute:: name The name of the plan on GitHub .. attribute:: private_repos_count .. versionchanged:: 1.0.0 The number of allowed private repositories .. attribute:: space The amount of space allotted by this plan cTUSUlUSUlUSUlUSUlg)N collaboratorsname private_reposspacer]r^private_repos_countr`)rplans r r!Plan._update_attributess2!/2L #'#8 '] r)c"SURS3$)Nzr!r'r,rlr?r@r)r rZrZs8# '#r)rZc.\rSrSrSrSrSrSrSrSr g)_EmailzBase email object.c,USUlUSUlg)Nrverifiedrrr)rrs r r!_Email._update_attributess7^ j) r)c<SURSURS3$)Nrwr!r'r,r?r@r)r rorosJ*5r)roc\rSrSrSrSrSrg)ra The object used to represent an email attached to a GPG key. This object has the following attributes: .. attribute:: email The email address as a string .. attribute:: verified A boolean value representing whether the address has been verified or not r@N)r:r;r<r=r>rwr?r@r)r rrs Jr)rc8^\rSrSrSrU4SjrSrSrSrU=r $)Emaila]The object used to represent an AuthenticatedUser's email. Please see GitHub's `Emails documentation`_ for more information. .. _Emails documentation: https://developer.github.com/v3/users/emails/ This object has all of the attributes of :class:`ShortEmail` as well as the following attributes: .. attribute:: primary A boolean value representing whether the address is the primary address for the user or not .. attribute:: visibility A string value representing whether an authenticated user can view the email address. Use ``public`` to allow it, ``private`` to disallow it. cL>[TU]U5 USUlUSUlg)Nprimary visibility)superr!rr)rr __class__s r r!Email._update_attributess( "5)Y'  -r)c"SURS3$)Nzr!r'r,r? __classcell__rs@r rrs*. )r)rc.\rSrSrSrSrSrSrSrSr Sr SS jr SS jr SS jr SS jrSS jr\SSj5rSSjrSSjrSSjrSSjr\S5r\SSj5r\S5r\S5r\S5r\S5r\S5r\S5rSrg) _Useria&The :class:`User ` object. This handles and structures information in the `User section`_. Two user instances can be checked like so:: u1 == u2 u1 != u2 And is equivalent to:: u1.id == u2.id u1.id != u2.id .. _User section: http://developer.github.com/v3/users/ cUSUl[US5UlUSUl[US5Ul[US5UlUSUlUSUlUSUlUS Ul US Ul US Ul US Ul URS 5Ul[US5UlUSUlUSUlUS=UlUlURUlg)N avatar_url events_url followers_url following_url gists_url gravatar_idhtml_urlrloginorganizations_urlreceived_events_url repos_url site_admin starred_urlsubscriptions_urltyper7)rr events_urltrfollowing_urlt gists_urltrrrrrrrrEr starred_urltrrr7rF_uniq)rr/s r r!_User._update_attributes4s|,&tL'9:!/2)$*?@%d;&78 .Z( t*'] !%&9!:#'(=#> k*((<0'](;<!%&9!:L #E{*49WW r)cUR$r+)rr&s r r, _User.__str__Hr|r)cNSn[USS5nUbSU3nSRXS9$)Nr^:z'<{s.class_name} [{s.login}{full_name}]>)s full_name)getattrformat)rrr^s r r' _User._reprKsB tVT*  D6 I8??@  r)cURSXSUR5nURURU5SS5$)zCheck if this user can be assigned to issues on username/repository. :param str username: owner's username of the repository :param str repository: name of the repository :returns: True if the use can be assigned, False otherwise :rtype: :class:`bool` repos assigneesr1r2)r3rr4_get)rusername repositoryr7s r is_assignee_on_User.is_assignee_onTs<oo X;  }}TYYs^S#66r)cxURRUS9nURURU5SS5$)z_Check if this user is following ``username``. :param str username: (required) :returns: bool ) other_userr1r2)rexpandr4r)rrr7s r is_following_User.is_followingas8!!((H(=}}TYYs^S#66r)NcS/nU(aURS5 UR"USUR06nUR[ U5U[ US9$)aIterate over events performed by this user. :param bool public: (optional), only list public events for the authenticated user :param int number: (optional), number of events to return. Default: -1 returns all available events. :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`Event `\ s eventspublicbase_urletagappendr3rF_iterintrrrnumberrpathr7s r r _User.eventsksLz  KK !oot8dii8zz#f+sEz==r)ctURSURS9nUR[U5U[US9$)aIterate over the followers of this user. :param int number: (optional), number of followers to return. Default: -1 returns all available :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`User `\ s followersrrr3rFrr ShortUserrrrr7s r r_User.followers|5ookDIIo>zz#f+sIDzAAr)ctURSURS9nUR[U5U[US9$)aIterate over the users being followed by this user. :param int number: (optional), number of users to return. Default: -1 returns all available users :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`User `\ s followingrrrrs r r_User.followingrr)ctURSURS9nUR[U5U[US9$)a4Iterate over the GPG keys of this user. .. versionadded:: 1.2.0 :param int number: (optional), number of GPG keys to return. Default: -1 returns all available GPG keys :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`GPGKey `\ s r0rr)r3rFrrr rs r r0_User.gpg_keyss5ooj499o=zz#f+sFz>>r)ctURSURS9nUR[U5U[US9$)a'Iterate over the public keys of this user. .. versionadded:: 0.5 :param int number: (optional), number of keys to return. Default: -1 returns all available keys :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`Key `\ s keysrr)r3rFrrrBrs r r _User.keyss5ooftyyo9zz#f+sCdz;;r)cSnU(aURSSXRS9nUR[U5U[US9$)aIterate over events from the user's organization dashboard. .. note:: You must be authenticated to view this. :param str org: (required), name of the organization :param int number: (optional), number of events to return. Default: -1 returns all available events :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`Event `\ s rrorgsrr)r3rFrrr)rorgrrr7s r organization_events_User.organization_eventss? //(FC))/LCzz#f+sEz==r)cS/nU(aURS5 UR"USUR06nUR[ U5U[ US9$)aIterate over events that the user has received. If the user is the authenticated user, you will see private and public events, otherwise you will only see public events. :param bool public: (optional), determines if the authenticated user sees both private and public or just public :param int number: (optional), number of events to return. Default: -1 returns all events available :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`Event `\ s received_eventsrrrrrs r r_User.received_eventssM""  KK !oot8dii8zz#f+sEz==r)cvSSKJn URSURS9nUR [ U5XCUS9$)aUIterate over organizations the user is member of. :param int number: (optional), number of organizations to return. Default: -1 returns all available organization :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`ShortOrganization `\ s r)ShortOrganizationrrr)rrr3rFrr)rrrrr7s r organizations_User.organizationss6 ,ooftyyo9zz#f+sDzIIr)c SSKJnJn XS.nURU5 URR SSS9nUR [U5UUUUURS9$)a|Iterate over repositories starred by this user. .. versionchanged:: 0.5 Added sort and direction parameters (optional) as per the change in GitHub's API. :param int number: (optional), number of starred repos to return. Default: -1, returns all available repos :param str sort: (optional), either 'created' (when the star was created) or 'updated' (when the repository was last pushed to) :param str direction: (optional), either 'asc' or 'desc'. Default: 'desc' :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`~github3.repos.repo.StarredRepository` r) RepositoryStarredRepository)sort directionN)ownerrepo)headers) rrr _remove_nonerrrr STAR_HEADERS) rrrrrrrparamsr7s r starred_repositories_User.starred_repositoriessj& 97 &!&&T&=zz K    ++   r)cvSSKJn URSURS9nUR [ U5XCUS9$)a9Iterate over repositories subscribed to by this user. :param int number: (optional), number of subscriptions to return. Default: -1, returns all available :param str etag: (optional), ETag from a previous request to the same endpoint :returns: generator of :class:`Repository ` r)ShortRepository subscriptionsrr)rrr3rFrr)rrrrr7s r r_User.subscriptionss6 +ooo oBzz#f+s$zGGr)cURSSUR5nSU0nURURX#S9SS5nU$)zRename the user. .. note:: This is only available for administrators of a GitHub Enterprise instance. :param str login: (required), new name of the user :returns: bool adminusersrrQ)r3rr4rU)rrr7payloadresps r rename _User.renamesFoogw ;E"}}T[[[;S#F r)cURSSURS5n0nU(aXS'URURX#S9S5nUR [ U5$)a<Obtain an impersonation token for the user. The retrieved token will allow impersonation of the user. This is only available for admins of a GitHub Enterprise instance. :param list scopes: (optional), areas you want this token to apply to, i.e., 'gist', 'user' :returns: :class:`Authorization ` rrauthorizationsscopesrQ)r3rrT_post_instance_or_nullr )rrr7rRrVs r impersonate_User.impersonate&sZoogw }}TYYs^S#66r)czURSURS9nURURU5SS5$)zUnsuspend the user. This is only available for admins of a GitHub Enterprise instance. This API is disabled if you use LDAP, check the GitHub API dos for more information. :returns: bool -- True if successful, False otherwise rrr1rrr6s r unsuspend_User.unsuspendps6ookDIIo>}}T\\#.S99r)cURSSUR5nURURU5SS5$)zDelete the user. Per GitHub API documentation, it is often preferable to suspend the user. .. note:: This is only available for admins of a GitHub Enterprise instance. :returns: bool -- True if successful, False otherwise rrr1rr r6s r r8 _User.deletes6oogw ;}}T\\#.S99r))rFrrrrrrrrrrrrrrrrrr7)FN)rN)NNrNr+)r:r;r<r=r>rwr!r,r'rrrrrr0rrrrrrrrrr rrrrr8r?r@r)r rrs$J(  77>" B B ? <>>">(J":> B H ;;( : : 7 7 : : 7 7 : : : :r)rc0^\rSrSrSrSrU4SjrSrU=r$)UseriaKObject for the full representation of a User. GitHub's API returns different amounts of information about users based upon how that information is retrieved. This object exists to represent the full amount of information returned for a specific user. For example, you would receive this class when calling :meth:`~github3.github.GitHub.user`. To provide a clear distinction between the types of users, github3.py uses different classes with different sets of attributes. This object no longer contains information about the currently authenticated user (e.g., :meth:`~github3.github.GitHub.me`). .. versionchanged:: 1.0.0 This object contains all of the attributes available on :class:`~github3.users.ShortUser` as well as the following: .. attribute:: bio The markdown formatted User's biography .. attribute:: blog The URL of the user's blog .. attribute:: company The name or GitHub handle of the user's company .. attribute:: created_at A parsed :class:`~datetime.datetime` object representing the date the user was created .. attribute:: email The email address the user has on their public profile page .. attribute:: followers_count The number of followers of this user .. attribute:: following_count The number of users this user follows .. attribute:: hireable Whether or not the user has opted into GitHub jobs advertising .. attribute:: location The location specified by the user on their public profile .. attribute:: name The name specified by their user on their public profile .. attribute:: public_gists_count The number of public gists owned by this user .. attribute: public_repos_count The number of public repositories owned by this user .. attribute:: updated_at A parsed :class:`~datetime.datetime` object representing the date the user was last updated cd>[TU]U5 USUlUSUlUSUlUR US5UlUSUlUSUlUSUl USUl US Ul US Ul US Ul US UlUR US 5Ulg)Nbioblogcompanyrrrrhireablelocationr^ public_gists public_repos updated_at)rr!r#r$r%rrrfollowers_countfollowing_countr&r'r^public_gists_countpublic_repos_countr*rr/rs r r!User._update_attributess "4(;L I ..l);<'] #K0#K0Z( Z( L "&~"6"&~"6..l);<r)) r#r$r%rrr+r,r&r'r^r-r.r* r:r;r<r=r>rwr!r?rrs@r r!r!sGRJ==r)r!c \rSrSrSrSr\rSrg)riaObject for the shortened representation of a User. GitHub's API returns different amounts of information about users based upon how that information is retrieved. Often times, when iterating over several users, GitHub will return less information. To provide a clear distinction between the types of users, github3.py uses different classes with different sets of attributes. .. versionadded:: 1.0.0 .. attribute:: avatar_url The URL of the avatar (possibly from Gravatar) .. attribute:: events_urlt A URITemplate object from ``uritemplate`` that can be used to generate an events URL .. attribute:: followers_url A string representing the resource to retrieve a User's followers .. attribute:: following_urlt A URITemplate object from ``uritemplate`` that can be used to generate the URL to check if this user is following ``other_user`` .. attribute:: gists_urlt A URITemplate object from ``uritemplate`` that can be used to generate the URL to retrieve a Gist by its id .. attribute:: gravatar_id The identifier for the user's gravatar .. attribute:: html_url The URL of the user's publicly visible profile. For example, ``https://github.com/sigmavirus24`` .. attribute:: id The unique ID of the account .. attribute:: login The username of the user, e.g., ``sigmavirus24`` .. attribute:: organizations_url A string representing the resource to retrieve the organizations to which a user belongs .. attribute:: received_events_url A string representing the resource to retrieve the events a user received .. attribute:: repos_url A string representing the resource to list a user's repositories .. attribute:: site_admin A boolean attribute indicating whether the user is a member of GitHub's staff .. attribute:: starred_urlt A URITemplate object from ``uritemplate`` that can be used to generate a URL to retrieve whether the user has starred a repository. .. attribute:: subscriptions_url A string representing the resource to list a user's subscriptions .. attribute:: type A string representing the type of User account this. In all cases should be "User" .. attribute:: url A string of this exact resource retrievable from GitHub's API r@N) r:r;r<r=r>rwr! _refresh_tor?r@r)r rrsWrJKr)rc4^\rSrSrSrSr\rU4SjrSr U=r $) StargazeriKa:Object representing a user that has starred a repository. .. versionadded:: 3.0.0 This object contains all of the attributes available on :class:`~github3.users.ShortUser` as well as the following: .. attribute:: starred_at The time and date that the user starred the repository this was queried from. c\>[TU]US5 URUS5Ulg)Nr/ starred_at)rr!rr7)r stargazerrs r r!Stargazer._update_attributes\s* "9V#45..<)@Ar))r7 r:r;r<r=r>rwr!r3r!r?rrs@r r5r5Ks  JKBBr)r5c0^\rSrSrSrSrU4SjrSrU=r$)AuthenticatedUseriaavObject to represent the currently authenticated user. This is returned by :meth:`~github3.github.GitHub.me`. It contains the extra informtation that is not returned for other users such as the currently authenticated user's plan and private email information. .. versionadded:: 1.0.0 .. versionchanged:: 1.0.0 The ``total_private_gists`` attribute is no longer returned by GitHub's API and so is removed. This object has all of the same attribute as the :class:`~github3.users.ShortUser` and :class:`~github3.users.User` objects as well as: .. attribute:: disk_usage The amount of repository space that has been used by you, the user .. attribute:: owned_private_repos_count The number of private repositories owned by you, the user .. attribute:: plan .. note:: When used with a Github Enterprise instance <= 2.12.7, this attribute will not be returned. To handle these situations sensitively, the attribute will be set to ``None``. Repositories may still have a license associated with them in these cases. The name of the plan that you, the user, have purchased c&>[TU]U5 URS5UlURS5UlURS5UlURS5UlUR b[UR U5Ulgg)N disk_usageowned_private_repostotal_private_reposrc)rr!rEr>owned_private_repos_counttotal_private_repos_countrcrZr/s r r!$AuthenticatedUser._update_attributessu "4(((<0)-2G)H&)-2G)H&HHV$ 99 TYY-DI !r))r>rArcrBr1rs@r r<r<as$L%J..r)r<c4^\rSrSrSrSr\rU4SjrSr U=r $) Collaboratoria6Object for the representation of a collaborator. .. versionadded:: 1.1.0 When retrieving a repository's contributors, GitHub returns the same information as a :class:`~github3.users.ShortUser` with an additional attribute: .. attribute:: permissions Admin, push, and pull permissions of a collaborator c8>[TU]U5 USUlg)N permissions)rr!rGr/s r r!Collaborator._update_attributess "4( .r))rGr:rs@r rErEs  JK//r)rEc4^\rSrSrSrSr\rU4SjrSr U=r $) ContributoriaObject for the specialized representation of a contributor. .. versionadded:: 1.0.0 .. versionchanged:: 1.1.0 This class now refreshes to a :class:`~github3.users.User`. The attribute ``contributions`` was renamed to ``contributions_count``, the documentation already declared it as ``contributions_count``, it was the implementation now reflects this as well. When retrieving a repository's contributors, GitHub returns the same information as a :class:`~github3.users.ShortUser` with an additional attribute: .. attribute:: contributions_count The number of contributions a contributor has made to the repository c8>[TU]U5 USUlg)N contributions)rr!contributions_count)r contributorrs r r!Contributor._update_attributess ";/#.#? r))rMr:rs@r rJrJs ,JK@@r)rJ) r>typingtrVr uritemplaterrr decoratorsrrr github3.authsr GitHubCorer rBrZrorrrr!rr5r<rErJUnionstrUserLiker@r)r rYs 8#%'^:V  ^:B9&  9x.#6  .#b V    $FDn:F  n:b Z=5Z=z[[|BB,0.0.f/5/.@%@> 77 t& k3F r)