Fj2 dZddlmZddlmZmZddlmZddlm Z m Z ddl m Z ddl mZddlmZmZmZmZmZdd lmZdd lmZer dd lZdd lmZGd deeeeeZGddeZy )zProvide the Comment class.) annotations) TYPE_CHECKINGAny)API_PATH)ClientException InvalidURL) CommentForest) RedditBase) CreatedMixin FullnameMixinInboxableMixinThingModerationMixinUserContentMixin)Redditor)cachedpropertyN)modelsc eZdZdZdZdZeddZeddZ e ddZ e ddZ e ddZ e dd Zejdd Z d dfd Z dfd Zdd Zdfd ZddZ ddZddZxZS) CommentaA class that represents a Reddit comment. .. include:: ../../typical_attributes.rst ================= ================================================================= Attribute Description ================= ================================================================= ``author`` Provides an instance of :class:`.Redditor`. ``body`` The body of the comment, as Markdown. ``body_html`` The body of the comment, as HTML. ``created_utc`` Time the comment was created, represented in `Unix Time`_. ``distinguished`` Whether or not the comment is distinguished. ``edited`` Whether or not the comment has been edited. ``id`` The ID of the comment. ``is_submitter`` Whether or not the comment author is also the author of the submission. ``likes`` The user's current vote status on the comment: ``True`` if upvoted, ``False`` if downvoted, and ``None`` if not voted or not logged in. ``link_id`` The submission ID that the comment belongs to. ``parent_id`` The ID of the parent comment (prefixed with ``t1_``). If it is a top-level comment, this returns the submission ID instead (prefixed with ``t3_``). ``permalink`` A permalink for the comment. :class:`.Comment` objects from the inbox have a ``context`` attribute instead. ``replies`` Provides an instance of :class:`.CommentForest`. ``saved`` Whether or not the comment is saved. ``score`` The number of upvotes for the comment. ``stickied`` Whether or not the comment is stickied. ``submission`` Provides an instance of :class:`.Submission`. The submission that the comment belongs to. ``subreddit`` Provides an instance of :class:`.Subreddit`. The subreddit that the comment belongs to. ``subreddit_id`` The subreddit ID that the comment belongs to. ================= ================================================================= .. _unix time: https://en.wikipedia.org/wiki/Unix_time z6This comment does not appear to be in the comment treeidctj|} |jd}t |dz |k7r t ||dS#t$r t |dwxYw)z*Get the ID of a comment from the full URL.commentsN)r _url_partsindex ValueErrorrlen)urlparts comment_indexs X/root/workspace/ytshorts/venv/lib/python3.12/site-packages/praw/models/reddit/comment.py id_from_urlzComment.id_from_urlFsj%%c* ,!KK 3M u:>] *S/ !Ry  ,S/t + ,s A Act|S)zProvide an instance of :class:`.CommentModeration`. Example usage: .. code-block:: python comment = reddit.comment("dkk4qjd") comment.mod.approve() )CommentModerationselfs r!modz Comment.modSs!&&cH|jjjdS)zThe class's kind.comment)_redditconfigkindsr%s r!_kindz Comment._kindas||""((33r(c|jjddd}||jjjdk(S)z1``True`` when the comment is a top-level comment._r submission) parent_idsplitr+r,r-)r& parent_types r!is_rootzComment.is_rootfs?nn**3215 dll1177 EEEr(ct|jtr%t|j|j|_|jS)aProvide an instance of :class:`.CommentForest`. This property may return an empty list if the comment has not been refreshed with :meth:`.refresh` Sort order and reply limit can be set with the ``reply_sort`` and ``reply_limit`` attributes before replies are fetched, including any call to :meth:`.refresh`: .. code-block:: python comment.reply_sort = "new" comment.refresh() replies = comment.replies .. note:: The appropriate values for ``reply_sort`` include ``"confidence"``, ``"controversial"``, ``"new"``, ``"old"``, ``"q&a"``, and ``"top"``. ) isinstance_replieslistr r2r%s r!replieszComment.repliesls2. dmmT *)$//4==IDM}}r(c|js.|jj|j|_|jS)z8The :class:`.Submission` object this comment belongs to.) _submissionr+r2_extract_submission_idr%s r!r2zComment.submissions9#||66t7R7R7TUD r(cv||j|j<||_t|dgD] }||_ y)zFUpdate the :class:`.Submission` associated with the :class:`.Comment`.r;N)_comments_by_idfullnamer=getattrr2)r&r2replys r!r2zComment.submissions@59 ""4==1%T9b1 *E)E  *r(ctd|||fDdk7r d}t|d}g|_d|_|r||_n|r|j ||_nd}t ||||y)z(Initialize a :class:`.Comment` instance.c3&K|] }|d yw)Nr1).0values r! z#Comment.__init__..sDU%2CqDsr1z8Exactly one of 'id', 'url', or '_data' must be provided.FNT)_data_fetched)sum TypeErrorr9r=rr"super__init__)r&redditrrrJmsgfetched __class__s r!rOzComment.__init__sz Dr3.D D ILCC.   DG &&s+DGG uw?r(c<|dk(r!tj|j|}ne|dk(r@|dk(rdn%|jjj |}|gn |j }d}n |dk(r|jj |}t|!||y)z)Objectify author, replies, and subreddit.authorr;Ndatar9 subreddit) r from_datar+ _objector objectifychildrenrYrN __setattr__)r& attributerHlistingrSs r!r^zComment.__setattr__s  &&t||U;E ) ##(B;4DLL4J4J4T4TZ_4T4`G!/Bw/?/?E"I + %LL**51E Iu-r(cd|jvr|jjdddS|jj dddS)Ncontext/rr1r0)__dict__rbrsplitlink_idr4r%s r!r>zComment._extract_submission_idsF  %<<&&sA.q1 1||!!#q)!,,r(c$|j}|d}|dsd|j}t||ddd}t||j|}|j j |j t|!y)NrXr]zNo data returned for comment r)rJ) _fetch_datarArtyper+rdupdaterN_fetch)r&rXrQ comment_dataotherrSs r!rkzComment._fetchs!F|J1$--AC!#& &J'*62 T 4<<|< U^^, r(c$did|jifS)Ninfor)rAr%s r! _fetch_infozComment._fetch_infosrD$--000r(cv|j|jjk(r |jS|j|jjvr#|jj|jSt |j |jj ddd}|j|_|S)aReturn the parent of the comment. The returned parent will be an instance of either :class:`.Comment`, or :class:`.Submission`. If this comment was obtained through a :class:`.Submission`, then its entire ancestry should be immediately available, requiring no extra network requests. However, if this comment was obtained through other means, e.g., ``reddit.comment("COMMENT_ID")``, or ``reddit.inbox.comment_replies``, then the returned parent may be a lazy instance of either :class:`.Comment`, or :class:`.Submission`. Lazy comment example: .. code-block:: python comment = reddit.comment("cklhv0f") parent = comment.parent() # 'replies' is empty until the comment is refreshed print(parent.replies) # Output: [] parent.refresh() print(parent.replies) # Output is at least: [Comment(id="cklhv0f")] .. warning:: Successive calls to :meth:`.parent` may result in a network request per call when the comment is not obtained through a :class:`.Submission`. See below for an example of how to minimize requests. If you have a deeply nested comment and wish to most efficiently discover its top-most :class:`.Comment` ancestor you can chain successive calls to :meth:`.parent` with calls to :meth:`.refresh` at every 9 levels. For example: .. code-block:: python ancestor = reddit.comment("dkk4qjd") refresh_counter = 0 while not ancestor.is_root: ancestor = ancestor.parent() if refresh_counter % 9 == 0: ancestor.refresh() refresh_counter += 1 print(f"Top-most Ancestor: {ancestor}") The above code should result in 5 network requests to Reddit. Without the calls to :meth:`.refresh` it would make at least 31 network requests. r0r1)r3r2rAr@rr+r4r=)r&parents r!rrzComment.parentsf >>T__55 5?? " >>T__<< <??224>>B Bt~~';';C'CA'FG!__ r(cd|jvr |jjddd}n>tdj |j j }|d|j }ddi}d |jvr|j|d <d |jvr|j|d <|jj|| dj}|st|jd}|dd}|ru||j |j k7rZ|j}t|t r|j#|j$|r|@|j |j k7rZ||j |j k7rt|j|j& |jd=|jj)|j|D]}|j |_|S)a)Refresh the comment's attributes. If using :meth:`.Reddit.comment` this method must be called in order to obtain the comment's replies. Example usage: .. code-block:: python comment = reddit.comment("dkk4qjd") comment.refresh() rb?r1rr2)rz_/d reply_limitlimit reply_sortsort)paramsNr=)rdrbr4rformatr2rrvrxr+getr]rMISSING_COMMENT_MESSAGEpopr8rextendr9r=rj)r& comment_pathpathrz comment_listr*queuerCs r!refreshzComment.refreshs  %<<--c15a8LL)00DOO4F4F0GD"V2dggY/L)23'7 DMM )"..F7O 4== (!__F6N||'' V'DQGPP !$">">? ?QGJJ$'',AiikG'7+ W--.GJJ$'',A ?gjjDGG3!$">">? ?    '  / W--.! /E#E  / r()rstrreturnr)rr$)rr)rbool)rr )rmodels.Submission)r2rrNone)NNN) rPz praw.Redditr str | NonerrrJzdict[str, Any] | Nonerr)r_rrHrrrrr)rz tuple[str, dict, dict[str, str]])rzComment | models.Submission)rr)__name__ __module__ __qualname____doc__r} STR_FIELD staticmethodr"rr'propertyr.r6r;r2setterrOr^r>rkrprrr __classcell__)rSs@r!rrs2&PWI   ' '44FF 4  **'+ @@ @ @ % @  @,...  . - 1< $<|/r(rc$eZdZdZdZddZddZy)r$zProvide a set of functions pertaining to :class:`.Comment` moderation. Example usage: .. code-block:: python comment = reddit.comment("dkk4qjd") comment.mod.approve() removal_comment_messagec||_y)znInitialize a :class:`.CommentModeration` instance. :param comment: The comment to moderate. N)thing)r&r*s r!rOzCommentModeration.__init__Os  r(ctd}|jjj|d|jjiy)zUncollapse a :class:`.Comment` that has been collapsed by Crowd Control. Example usage: .. code-block:: python # Uncollapse a comment: comment = reddit.comment("dkk4qjd") comment.mod.show() show_commentrrWN)rrr+postrA)r&rs r!showzCommentModeration.showWs:~& 41D1D*EFr(N)r*zmodels.Commentrrr)rrrrREMOVAL_MESSAGE_APIrOrrFr(r!r$r$As 4Gr(r$)r __future__rtypingrr praw.constrpraw.exceptionsrrpraw.models.comment_forestr praw.models.reddit.baser praw.models.reddit.mixinsr r r rrpraw.models.reddit.redditorrpraw.util.cacherprawrrr$rFr(r!rs\ "%74.1*dn. |ZdN $G,$Gr(