o 2gEB@sdZddlmZddlmZddlmZmZmZddl m Z ddl m Z ddl mZd d lmZd d l mZd d lmZd dlmZmZerJddlZGdddeeeeZGdddZdS)zProvide the Redditor class.) annotations)dumps) TYPE_CHECKINGAny Generator)API_PATH)_deprecate_args)cachedproperty)RedditorListingMixin)stream_generator) RedditBase) FullnameMixinMessageableMixinNcs*eZdZdZdZedJd d ZedKd d ZedLddZ e dMddZ e dMddZ   dNdOfdd Z dPfdd Zfd!d"Zd#d$ZdQd%d&ZdRd(d)Zd*d+Zd,d-Zed.dd/dSd0d1ZdTd3d4Zed5d6d7dUd9d:ZdVd|}|d}t||j|d}|j|jtdS)Nr)r3) _fetch_datatyper!__dict__updater<_fetch)r"rotherr?rrrJs zRedditor._fetchcCs(t|dr ||j|_dd|jidfS)Nr5 user_aboutr-)hasattr_fetch_usernamer5rr&rrr _fetch_infos zRedditor._fetch_infocCs |jjtdd|id|dS)Nuser_by_fullnameidsparamsr)r!getr)r"r2rrrrNs zRedditor._fetch_usernamemethodcCs*tdj|d}|jjt|||ddS)N friend_v1r.)rrUpath)rr/r!requestr)r"rrUurlrrr_friendszRedditor._friendcC|jjtdd|jiddS)aFBlock the :class:`.Redditor`. For example, to block :class:`.Redditor` u/spez: .. code-block:: python reddit.redditor("spez").block() .. note:: Blocking a trusted user will remove that user from your trusted list. .. seealso:: :meth:`.trust` block_userrrRNr!postrrr&rrrblockszRedditor.blockcCr[)aRemove the :class:`.Redditor` from your whitelist of trusted users. For example, to remove :class:`.Redditor` u/spez from your whitelist: .. code-block:: python reddit.redditor("spez").distrust() .. seealso:: :meth:`.trust` remove_whitelistedrrNr]r&rrrdistrustszRedditor.distrustnote)rccCs|j|rd|inidddS)aFriend the :class:`.Redditor`. :param note: A note to save along with the relationship. Requires Reddit Premium (default: ``None``). Calling this method subsequent times will update the note. For example, to friend u/spez: .. code-block:: python reddit.redditor("spez").friend() To add a note to the friendship (requires Reddit Premium): .. code-block:: python reddit.redditor("spez").friend(note="My favorite admin") rcPUTrrUN)rZ)r"rcrrrfriendszRedditor.friendpraw.models.RedditorcC|jtdj|dS)aReturn a :class:`.Redditor` instance with specific friend-related attributes. :returns: A :class:`.Redditor` instance with fields ``date``, ``id``, and possibly ``note`` if the authenticated user has Reddit Premium. For example, to get the friendship information of :class:`.Redditor` u/spez: .. code-block:: python info = reddit.redditor("spez").friend_info friend_data = info.date rVr.r!rTrr/r&rrr friend_infoszRedditor.friend_infomonthsr)rkintcCs@|dks|dkrd}t||jjtdj|dd|iddS) aGild the :class:`.Redditor`. :param months: Specifies the number of months to gild up to 36 (default: ``1``). For example, to gild :class:`.Redditor` u/spez for 1 month: .. code-block:: python reddit.redditor("spez").gild(months=1) r$zmonths must be between 1 and 36 gild_user)usernamerkraN)r8r!r^rr/)r"rkr>rrrgilds   z Redditor.gildlist[praw.models.Subreddit]cCs|jtdj|dp gS)aReturn a list of the redditor's moderated subreddits. :returns: A list of :class:`.Subreddit` objects. Return ``[]`` if the redditor has no moderated subreddits. :raises: ``prawcore.ServerError`` in certain circumstances. See the note below. .. note:: The redditor's own user profile subreddit will not be returned, but other user profile subreddits they moderate will be returned. Usage: .. code-block:: python for subreddit in reddit.redditor("spez").moderated(): print(subreddit.display_name) print(subreddit.title) .. note:: A ``prawcore.ServerError`` exception may be raised if the redditor moderates a large number of subreddits. If that happens, try switching to :ref:`read-only mode `. For example, .. code-block:: python reddit.read_only = True for subreddit in reddit.redditor("reddit").moderated(): print(str(subreddit)) It is possible that requests made in read-only mode will also raise a ``prawcore.ServerError`` exception. When used in read-only mode, this method does not retrieve information about subreddits that require certain special permissions to access, e.g., private subreddits and premium-only subreddits. .. seealso:: :meth:`.User.moderator_subreddits` moderatedr.rir&rrrrr)s-zRedditor.moderatedlist[praw.models.Multireddit]cCrh)zReturn a list of the redditor's public multireddits. For example, to to get :class:`.Redditor` u/spez's multireddits: .. code-block:: python multireddits = reddit.redditor("spez").multireddits() multireddit_userr.rir&rrr multiredditsXs zRedditor.multiredditslist[praw.models.Trophy]cCst|jtdj|dS)aReturn a list of the redditor's trophies. :returns: A list of :class:`.Trophy` objects. Return ``[]`` if the redditor has no trophies. :raises: :class:`.RedditAPIException` if the redditor doesn't exist. Usage: .. code-block:: python for trophy in reddit.redditor("spez").trophies(): print(trophy.name) print(trophy.description) trophiesr.)listr!rTrr/r&rrrrwdszRedditor.trophiescCr[)aqAdd the :class:`.Redditor` to your whitelist of trusted users. Trusted users will always be able to send you PMs. Example usage: .. code-block:: python reddit.redditor("AaronSw").trust() Use the ``accept_pms`` parameter of :meth:`.Preferences.update` to toggle your ``accept_pms`` setting between ``"everyone"`` and ``"whitelisted"``. For example: .. code-block:: python # Accept private messages from everyone: reddit.user.preferences.update(accept_pms="everyone") # Only accept private messages from trusted users: reddit.user.preferences.update(accept_pms="whitelisted") You may trust a user even if your ``accept_pms`` setting is switched to ``"everyone"``. .. note:: You are allowed to have a user on your blocked list and your friends list at the same time. However, you cannot trust a user who is on your blocked list. .. seealso:: - :meth:`.distrust` - :meth:`.Preferences.update` - :meth:`.trusted` add_whitelistedrraNr]r&rrrtrustws%zRedditor.trustcCs>|jjjt|dd}tdjdd}|jj||ddS)zUnblock the :class:`.Redditor`. For example, to unblock :class:`.Redditor` u/spez: .. code-block:: python reddit.redditor("spez").unblock() enemy) containerrrGunfriendall)rBraN)r!r-mer2r(rr/r^)r"rrYrrrunblocks zRedditor.unblockcCs|jdt|idddS)zUnfriend the :class:`.Redditor`. For example, to unfriend :class:`.Redditor` u/spez: .. code-block:: python reddit.redditor("spez").unfriend() idDELETEreN)rZr(r&rrrr}s zRedditor.unfriend)rrrrrr)rr)rr$)rr()NNN)rrrr1r2r1r3r4)rr(rAr)r2r()rrrUr()rcr()rrg)rkrl)rrq)rrs)rrv) __name__ __module__ __qualname____doc__ STR_FIELD classmethodrr r#r'propertyr,r0r=rErJrOrNrZr_rbr rfrjrprrrurwrzrr} __classcell__rrr?rrsF8           / 'rc@s.eZdZdZdddZdd d Zdd dZdS)r%z(Provides submission and comment streams.r)rgcCs ||_dS)z}Initialize a :class:`.RedditorStream` instance. :param redditor: The redditor associated with the streams. N)r))r"r)rrrr=s zRedditorStream.__init__stream_optionsstr | int | dict[str, str]r*Generator[praw.models.Comment, None, None]cKt|jjjfi|S)aYield new comments as they become available. Comments are yielded oldest first. Up to 100 historical comments will initially be returned. Keyword arguments are passed to :func:`.stream_generator`. For example, to retrieve all new comments made by redditor u/spez, try: .. code-block:: python for comment in reddit.redditor("spez").stream.comments(): print(comment) )r r)commentsnewr"rrrrrzRedditorStream.comments-Generator[praw.models.Submission, None, None]cKr)aYield new submissions as they become available. Submissions are yielded oldest first. Up to 100 historical submissions will initially be returned. Keyword arguments are passed to :func:`.stream_generator`. For example, to retrieve all new submissions made by redditor u/spez, try: .. code-block:: python for submission in reddit.redditor("spez").stream.submissions(): print(submission) )r r) submissionsrrrrrrrzRedditorStream.submissionsN)r)rg)rrrr)rrrr)rrrrr=rrrrrrr%s   r%)r __future__rjsonrtypingrrrconstrutilr util.cacher listing.mixinsr r basermixinsrr praw.modelsprawrr%rrrrs$        ,