Fj)h6dZddlmZddlmZmZmZddlmZddl m Z ddl m Z ddl mZddlmZmZdd lmZdd lmZdd lmZerdd lmZmZdd lZddlmZGddZGddeeZGddZGddZ GddeeeZ!GddZ"y )zProvide the LiveThread class.) annotations) TYPE_CHECKINGAnycast)API_PATH) RedditorList)ListingGenerator) RedditBase) CreatedMixin FullnameMixin)Redditor)stream_generator)cachedproperty)IterableIteratorN)modelsceZdZdZeddZddZddZddZdd ddZ dd Z dd Z dd Z dd dd Z dd dd Zy)LiveContributorRelationshipzzBLiveContributorRelationship._handle_permissions..s5A!A35s)setjoin permissionss r_handle_permissionsz/LiveContributorRelationship._handle_permissionss*!,!4ug#k:J xx5555ctdj|jj}|jjj |}t dt|tr|S|dS)aReturn a :class:`.RedditorList` for live threads' contributors. Usage: .. code-block:: python thread = reddit.live("ukaeu1ik4sw5") for contributor in thread.contributor(): print(contributor) live_contributorsidlist[models.Redditor]r) rformatthreadr(_redditgetr isinstancer)selfurltemps r__call__z$LiveContributorRelationship.__call__se*+22dkknn2E{{""&&s++Zl5STaaY]^_Y`aar$c||_y)a Initialize a :class:`.LiveContributorRelationship` instance. :param thread: An instance of :class:`.LiveThread`. .. note:: This class should not be initialized directly. Instead, obtain an instance via: :meth:`.LiveThread.contributor`. Nr+r/r+s r__init__z$LiveContributorRelationship.__init__/s  r$ctdj|jj}|jjj |y)zAccept an invite to contribute the live thread. Usage: .. code-block:: python thread = reddit.live("ydwwxneu7vsa") thread.contributor.accept_invite() live_accept_inviter'Nrr*r+r(r,postr/r0s r accept_invitez)LiveContributorRelationship.accept_invite<s=+,33t{{~~3F   %r$Nr!ctdj|jj}t ||j |dd}|jj j||y)aInvite a redditor to be a contributor of the live thread. :param redditor: A redditor name or :class:`.Redditor` instance. :param permissions: When provided (not ``None``), permissions should be a list of strings specifying which subset of permissions to grant. An empty list ``[]`` indicates no permissions, and when not provided (``None``), indicates full permissions. :raises: :class:`.RedditAPIException` if the invitation already exists. Usage: .. code-block:: python thread = reddit.live("ukaeu1ik4sw5") redditor = reddit.redditor("spez") # "manage" and "settings" permissions thread.contributor.invite(redditor, permissions=["manage", "settings"]) .. seealso:: :meth:`.LiveContributorRelationship.remove_invite` to remove the invite for redditor. live_inviter'liveupdate_contributor_invitenamer"typedataNrr*r+r(strr#r,r:r/redditorr"r0rDs rinvitez"LiveContributorRelationship.inviteJsc@}%,, ,?M33K@3    4 0r$ctdj|jj}|jjj |y)zAbdicate the live thread contributor position (use with care). Usage: .. code-block:: python thread = reddit.live("ydwwxneu7vsa") thread.contributor.leave() live_leaver'Nr9r;s rleavez!LiveContributorRelationship.leaver<|$++t{{~~+>   %r$ct|tr |jn|}d|i}tdj |j j }|j jj||y)aRemove the redditor from the live thread contributors. :param redditor: A redditor fullname (e.g., ``"t2_1w72"``) or :class:`.Redditor` instance. Usage: .. code-block:: python thread = reddit.live("ukaeu1ik4sw5") redditor = reddit.redditor("spez") thread.contributor.remove(redditor) thread.contributor.remove("t2_1w72") # with fullname r(live_remove_contribr'rCN r.r fullnamerr*r+r(r,r:r/rHrQrDr0s rremovez"LiveContributorRelationship.removesb )38X(F8$$Hh,-44 4G   4 0r$ct|tr |jn|}d|i}tdj |j j }|j jj||y)aBRemove the invite for redditor. :param redditor: A redditor fullname (e.g., ``"t2_1w72"``) or :class:`.Redditor` instance. Usage: .. code-block:: python thread = reddit.live("ukaeu1ik4sw5") redditor = reddit.redditor("spez") thread.contributor.remove_invite(redditor) thread.contributor.remove_invite("t2_1w72") # with fullname .. seealso:: :meth:`.LiveContributorRelationship.invite` to invite a redditor to be a contributor of the live thread. r(live_remove_inviter'rCNrPrRs r remove_invitez)LiveContributorRelationship.remove_invitesb*)38X(F8$$Hh+,33t{{~~3F   4 0r$ctdj|jj}t ||j |dd}|jj j||y)a Update the contributor permissions for ``redditor``. :param redditor: A redditor name or :class:`.Redditor` instance. :param permissions: When provided (not ``None``), permissions should be a list of strings specifying which subset of permissions to grant (other permissions are removed). An empty list ``[]`` indicates no permissions, and when not provided (``None``), indicates full permissions. For example, to grant all permissions to the contributor, try: .. code-block:: python thread = reddit.live("ukaeu1ik4sw5") thread.contributor.update("spez") To grant ``"access"`` and ``"edit"`` permissions (and to remove other permissions), try: .. code-block:: python thread.contributor.update("spez", permissions=["access", "edit"]) To remove all permissions from the contributor, try: .. code-block:: python subreddit.moderator.update("spez", permissions=[]) live_update_permsr'liveupdate_contributorr@rCNrErGs rupdatez"LiveContributorRelationship.updatesdF*+22dkknn2EM33K@,    4 0r$ctdj|jj}t ||j |dd}|jj j||y)a2Update the contributor invite permissions for ``redditor``. :param redditor: A redditor name or :class:`.Redditor` instance. :param permissions: When provided (not ``None``), permissions should be a list of strings specifying which subset of permissions to grant (other permissions are removed). An empty list ``[]`` indicates no permissions, and when not provided (``None``), indicates full permissions. For example, to set all permissions to the invitation, try: .. code-block:: python thread = reddit.live("ukaeu1ik4sw5") thread.contributor.update_invite("spez") To set ``"access"`` and ``"edit"`` permissions (and to remove other permissions) to the invitation, try: .. code-block:: python thread.contributor.update_invite("spez", permissions=["access", "edit"]) To remove all permissions from the invitation, try: .. code-block:: python thread.contributor.update_invite("spez", permissions=[]) rXr'r?r@rCNrErGs r update_invitez)LiveContributorRelationship.update_invitesdF*+22dkknn2EM33K@3    4 0r$)r"zIterable[str] | NonereturnrF)r]r)r+models.LiveThreadr]Noner]r`)rHstr | models.Redditorr"zlist[str] | Noner]r`)rHrbr]r`)__name__ __module__ __qualname____doc__ staticmethodr#r2r6r<rIrLrSrVrZr\rr$rrrsF66b  &$)- &1'&1& &1  &1P &1*1<)- )1')1& )1  )1^)- )1')1& )1  )1r$rceZdZdZdZeddZeddZeddZddZ ddZ ddZ d dfd Z dfd Z dd Zdd Zdd ZddZxZS) LiveThreadaBAn individual :class:`.LiveThread` object. .. include:: ../../typical_attributes.rst ==================== ========================================================= Attribute Description ==================== ========================================================= ``created_utc`` The creation time of the live thread, in `Unix Time`_. ``description`` Description of the live thread, as Markdown. ``description_html`` Description of the live thread, as HTML. ``id`` The ID of the live thread. ``nsfw`` A ``bool`` representing whether or not the live thread is marked as NSFW. ==================== ========================================================= .. _unix time: https://en.wikipedia.org/wiki/Unix_time r(ct|S)zProvide an instance of :class:`.LiveThreadContribution`. Usage: .. code-block:: python thread = reddit.live("ukaeu1ik4sw5") thread.contrib.add("### update") )LiveThreadContributionr/s rcontribzLiveThread.contribs&d++r$ct|S)aOProvide an instance of :class:`.LiveContributorRelationship`. You can call the instance to get a list of contributors which is represented as :class:`.RedditorList` instance consists of :class:`.Redditor` instances. Those :class:`.Redditor` instances have ``permissions`` attributes as contributors: .. code-block:: python thread = reddit.live("ukaeu1ik4sw5") for contributor in thread.contributor(): # prints `Redditor(name="Acidtwist") ["all"]` print(contributor, contributor.permissions) )rrls r contributorzLiveThread.contributor*s +400r$ct|S)aProvide an instance of :class:`.LiveThreadStream`. Streams are used to indefinitely retrieve new updates made to a live thread, like: .. code-block:: python for live_update in reddit.live("ta535s1hq2je").stream.updates(): print(live_update.body) Updates are yielded oldest first as :class:`.LiveUpdate`. Up to 100 historical updates will initially be returned. To only retrieve new updates starting from when the stream is created, pass ``skip_existing=True``: .. code-block:: python live_thread = reddit.live("ta535s1hq2je") for live_update in live_thread.stream.updates(skip_existing=True): print(live_update.author) )LiveThreadStreamrls rstreamzLiveThread.stream<s. %%r$ct|tr|t|k(St||jxrt|t|k(S)zReturn whether the other instance equals the current. .. note:: This comparison is case sensitive. )r.rF __class__)r/others r__eq__zLiveThread.__eq__Us@ eS !CI% %%0LSY#e*5LLr$cDt|j|j|S)aReturn a lazy :class:`.LiveUpdate` instance. :param update_id: A live update ID, e.g., ``"7827987a-c998-11e4-a0b9-22000b6a88d2"``. Usage: .. code-block:: python thread = reddit.live("ukaeu1ik4sw5") update = thread["7827987a-c998-11e4-a0b9-22000b6a88d2"] update.thread # LiveThread(id="ukaeu1ik4sw5") update.id # "7827987a-c998-11e4-a0b9-22000b6a88d2" update.author # "umbrae" ) LiveUpdater,r()r/ update_ids r __getitem__zLiveThread.__getitem__as"$,,;;r$cjt|jjtt|z S)z(Return the hash of the current instance.)hashrtrcrFrls r__hash__zLiveThread.__hash__ts$DNN++,tCI>>r$c||fjddk7r d}t||r||_t|||y)zInitialize a :class:`.LiveThread` instance. :param reddit: An instance of :class:`.Reddit`. :param id: A live thread ID, e.g., ``"ukaeu1ik4sw5"`` Nz(Either 'id' or '_data' must be provided._data)count TypeErrorr(superr6)r/redditr(rmsgrts rr6zLiveThread.__init__xsG ;  T "a ' :r$ctdj|jj}|jjj |y)zClose the live thread permanently (cannot be undone). Usage: .. code-block:: python thread = reddit.live("ukaeu1ik4sw5") thread.contrib.close() live_closer'Nr9r;s rclosezLiveThreadContribution.closerMr$N descriptionnsfw resourcestitlec ^||||d}|j|td|jDryt|jj |jj }|jD cic]\}} || t||n| } }} tdj|jj } |jj j| | j|jj| jycc} }w)aUpdate settings of the live thread. :param description: The live thread's description (default: ``None``). :param nsfw: Indicate whether this thread is not safe for work (default: ``None``). :param resources: Markdown formatted information that is useful for the live thread (default: ``None``). :param title: The title of the live thread (default: ``None``). Does nothing if no arguments are provided. Each setting will maintain its current value if ``None`` is specified. Additional keyword arguments can be provided to handle new settings as Reddit introduces them. Usage: .. code-block:: python thread = reddit.live("xyu8kmjvfrww") # update 'title' and 'nsfw' updated_thread = thread.contrib.update(title=new_title, nsfw=True) If Reddit introduces new settings, you must specify ``None`` for the setting you want to maintain: .. code-block:: python # update 'nsfw' and maintain new setting 'foo' thread.contrib.update(nsfw=True, foo=None) rc3$K|]}|du yw)Nr)rvalues rrz0LiveThreadContribution.update..?s<u}DLTCC. r$c^|dk(rt|j|}t| ||y)zObjectify author.author)rAN)r r,r __setattr__)r/ attributerrts rrzLiveUpdate.__setattr__s*  T\\6E Iu-r$ctdj|jj|j}|jj |d}|j j|j t|%y)N live_focus)rryr) rr*r+r(r,r-rrZrr)r/r0rurts rrzLiveUpdate._fetchse|$++dkknnPTPWPW+X   %a( U^^, r$)r]r)r]rF)r]ri)NNN) rrrrryrrrr]r`)rrFrrr]r`ra)rcrdrerfrr__annotations__rrmpropertyrr+r6rrrrs@rrxrxs&I , ,!% $'+ %!%!%! %! % %!  %!N. r$rxc(eZdZdZddZddZddZy)rzAProvides a set of contribution functions to :class:`.LiveUpdate`.c||_y)aInitialize a :class:`.LiveUpdateContribution` instance. :param update: An instance of :class:`.LiveUpdate`. This instance can be retrieved through ``update.contrib`` where update is a :class:`.LiveUpdate` instance. E.g., .. code-block:: python thread = reddit.live("ukaeu1ik4sw5") update = thread["7827987a-c998-11e4-a0b9-22000b6a88d2"] update.contrib # LiveUpdateContribution instance update.contrib.remove() N)rZ)r/rZs rr6zLiveUpdateContribution.__init__s  r$ctdj|jjj}d|jj i}|jjj j||y)zRemove a live update. Usage: .. code-block:: python thread = reddit.live("ydwwxneu7vsa") update = thread["6854605a-efec-11e6-b0c7-0eafac4ff094"] update.contrib.remove() live_remove_updater'r(rCNrr*rZr+r(rQr,r:r/r0rDs rrSzLiveUpdateContribution.removesd+,33t{{7I7I7L7L3Mdkk**+ ""''$'7r$ctdj|jjj}d|jj i}|jjj j||y)aStrike a content of a live update. .. code-block:: python thread = reddit.live("xyu8kmjvfrww") update = thread["cb5fe532-dbee-11e6-9a91-0e6d74fabcc4"] update.contrib.strike() To check whether the update is stricken or not, use ``update.stricken`` attribute. .. note:: Accessing lazy attributes on updates (includes ``update.stricken``) may raise :py:class:`AttributeError`. See :class:`.LiveUpdate` for details. live_striker'r(rCNrrs rstrikezLiveUpdateContribution.strike sc$}%,, 0B0B0E0E,Fdkk**+ ""''$'7r$N)rZrr]r`ra)rcrdrerfr6rSrrr$rrrsK$8 8r$r)#rf __future__rtypingrrr praw.constrpraw.models.list.redditorrpraw.models.listing.generatorr praw.models.reddit.baser praw.models.reddit.mixinsr r praw.models.reddit.redditorr praw.models.utilrpraw.util.cachercollections.abcrrprawrrrirkrqrxrrr$rrs#"++2:.A0-*2l1l1^SzSlk4k4\4L4Lnc jcL9898r$