o 2g\1@sdZddlmZddlmZmZddlmZddlm Z m Z ddl m Z dd l mZd d lmZd d lmZmZmZmZd d lmZerHddlZGdddeeeeZGdddeZdS)zProvide the Comment class.) annotations) TYPE_CHECKINGAny)API_PATH)ClientException InvalidURL)cachedproperty) CommentForest) RedditBase) FullnameMixinInboxableMixinThingModerationMixinUserContentMixin)RedditorNcseZdZdZdZdZed1ddZed2d d Z e d d Z e d3ddZ e d4ddZ e d5ddZejd6ddZ   d7d8fdd Zd9fd$d% Zd&d'Zfd(d)Zd*d+Zd:d-d.Zd;d/d0ZZS)<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. ``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 treeidurlstrreturncCsRt|}z|d}Wn tyt|dwt|d|kr%t||dS)z*Get the ID of a comment from the full URL.commentsN)r _url_partsindex ValueErrorrlen)rparts comment_indexr!R/home/garg/my-data/venv/lib/python3.10/site-packages/praw/models/reddit/comment.py id_from_urlAs   zComment.id_from_url,praw.models.reddit.comment.CommentModerationcCst|S)zProvide an instance of :class:`.CommentModeration`. Example usage: .. code-block:: python comment = reddit.comment("dkk4qjd") comment.mod.approve() )CommentModerationselfr!r!r"modNs z Comment.modcCs|jjjdS)zReturn the class's kind.comment)_redditconfigkindsr&r!r!r"_kind\sz Comment._kindboolcCs$|jddd}||jjjdkS)z8Return ``True`` when the comment is a top-level comment._r r submission) parent_idsplitr*r+r,)r' parent_typer!r!r"is_rootaszComment.is_rootr cCs"t|jtrt|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 r0r&r!r!r"repliesgs zComment.repliespraw.models.SubmissioncCs|js |j||_|jS)z?Return the :class:`.Submission` object this comment belongs to.) _submissionr*r0_extract_submission_idr&r!r!r"r0szComment.submissionr0cCs.||j|j<||_t|dgD]}||_qdS)zFUpdate the :class:`.Submission` associated with the :class:`.Comment`.r8N)_comments_by_idfullnamer:getattrr0)r'r0replyr!r!r"r0s Nreddit praw.Reddit str | None_datadict[str, Any] | Nonecsh|||fddkrd}t|d}g|_d|_|r||_n |r'|||_nd}tj|||ddS)z(Initialize a :class:`.Comment` instance.Nr z8Exactly one of 'id', 'url', or '_data' must be provided.FT)rC_fetched)count TypeErrorr6r:rr#super__init__)r'r@rrrCmsgfetched __class__r!r"rIszComment.__init__ attributevalue6str | Redditor | CommentForest | praw.models.Subredditcsj|dkr t|j|}n |dkr"|dkrg}n|jj|j}d}n |dkr,|j|}t||dS)z)Objectify author, replies, and subreddit.authorr8r6 subredditN) r from_datar* _objector objectifychildrenrSrH __setattr__)r'rNrOrLr!r"rXs zComment.__setattr__cCs.d|jvr|jdddS|jdddS)Ncontext/rr r/)__dict__rYrsplitlink_idr2r&r!r!r"r;s zComment._extract_submission_idcsj|}|d}|dsd|j}t||ddd}t||j|d}|j|jtdS)NdatarWzNo data returned for comment r)rC) _fetch_datar=rtyper*r[updaterH_fetch)r'r^rJ comment_dataotherrLr!r"rbs zComment._fetchcCsdid|jifS)Ninfor)r=r&r!r!r" _fetch_infoszComment._fetch_info Comment | praw.models.SubmissioncCsV|j|jjkr |jS|j|jjvr|jj|jSt|j|jddd}|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 comment = reddit.comment("dkk4qjd") ancestor = comment 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. r/r )r1r0r=r<rr*r2r:)r'parentr!r!r"rhs4zComment.parentcCs@d|jvr|jddd}ntdj|jjd}|d|j}ddi}d |jvr/|j|d <d |jvr9|j|d <|j j ||d dj }|sKt |j d}|dd}|rz|dus_|j|jkrz|}t|trn||j|rz|dus_|j|jks_|j|jkrt |j |jdur|jd=|j|j|D]}|j|_q|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() rY?r rr0)rz_/d reply_limitlimit reply_sortsort)paramsNr:)r[rYr2rformatr0rrkrmr*getrWrMISSING_COMMENT_MESSAGEpopr5rextendr6r:ra)r' comment_pathpathro comment_listr)queuer?r!r!r"refresh s6             zComment.refresh)rrrr)rr$)rr.)rr )rr9)r0r9)NNN)r@rArrBrrBrCrD)rNrrOrP)rrg)rr)__name__ __module__ __qualname____doc__rr STR_FIELD staticmethodr#r r(propertyr-r4r8r0setterrIrXr;rbrfrhry __classcell__r!r!rLr"rs8%          ?rc@s&eZdZdZdZd ddZddZd S) 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_messager)praw.models.CommentcCs ||_dS)znInitialize a :class:`.CommentModeration` instance. :param comment: The comment to moderate. N)thing)r'r)r!r!r"rIMs zCommentModeration.__init__cCs&td}|jjj|d|jjiddS)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_commentr)r^N)rrr*postr=)r'rr!r!r"showUs zCommentModeration.showN)r)r)rzr{r|r}REMOVAL_MESSAGE_APIrIrr!r!r!r"r%?s   r%)r} __future__rtypingrrconstr exceptionsrr util.cacher comment_forestr baser mixinsrrrrredditorr praw.modelsprawrr%r!r!r!r"s       )