o 2g@sndZddlmZddlmZmZddlmZddlm Z ddl m Z dd l m Z er.dd lZGd d d Zd S) z.Provide CommentForest for submission comments.) annotations)heappopheappush) TYPE_CHECKING)DuplicateReplaceException)_deprecate_args) MoreCommentsNc@seZdZdZd*ddZd+dd Zd,d d Zd-ddZeddd.ddZ d/d0ddZ d1d d!Z e d"d#d$d%d&d2d(d)Z dS)3 CommentForestzyA forest of comments starts with multiple top-level comments. Each of these comments can be a tree of replies. indexintreturnpraw.models.CommentcCs |j|S)aReturn the comment at position ``index`` in the list. This method is to be used like an array access, such as: .. code-block:: python first_comment = submission.comments[0] Alternatively, the presence of this method enables one to iterate over all top level comments, like so: .. code-block:: python for comment in submission.comments: print(comment.body) ) _comments)selfr rR/home/garg/my-data/venv/lib/python3.10/site-packages/praw/models/comment_forest.py __getitem__s zCommentForest.__getitem__cCs t|jS)z6Return the number of top-level comments in the forest.)lenr)rrrr__len__+s zCommentForest.__len__commentcCsp|j|jjvr t|j|_t|ts|jr|j |dS|j |jjvs(Jd|jj|j }|j j |dS)NzYPRAW Error occurred. Please file a bug report and include the code that caused the error.) name _submission_comments_by_idr submission isinstancer is_rootrappend parent_idreplies)rrparentrrr_insert_comment/szCommentForest._insert_comment4list[praw.models.Comment | praw.models.MoreComments]cCsBg}t|}|r|d}||t|ts||j|s|S)zReturn a flattened list of all comments. This list may contain :class:`.MoreComments` instances if :meth:`.replace_more` was not called first. r)listpoprrr extendr )rcommentsqueuerrrrr$=s     zCommentForest.listN parent_treetreelist[praw.models.MoreComments]r*%list[praw.models.MoreComments] | Nonelist[MoreComments]cCsvg}dd|D}|r9|d\}}t|tr*t|||r$|jj|_n|p'||_n |jD] }|||fq-|s |S)zCReturn a list of :class:`.MoreComments` objects obtained from tree.cSsg|]}d|fqSNr).0xrrr Wsz7CommentForest._gather_more_comments..r)r%rr rr r _remove_fromr)r+r* more_commentsr(r!ritemrrr_gather_more_commentsOs      z#CommentForest._gather_more_commentsrpraw.models.Submissionr' list[praw.models.Comment] | NonecCs||_||_dS)aInitialize a :class:`.CommentForest` instance. :param submission: An instance of :class:`.Submission` that is the parent of the comments. :param comments: Initialize the forest with a list of comments (default: ``None``). N)rr)rrr'rrr__init__es zCommentForest.__init__list[praw.models.Comment]cCs||_|D]}|j|_qdSr/)rrr)rr'rrrr_updateus zCommentForest._updatelimit threshold r)r<r= int | Nonec Cs|}||j}g}|r]t|}|dur|dks|j|kr)|||j|q |jdd}|dur7|d8}|j||jdD] }|j|_ t ||q?|D]} | | qM|j||s ||S)aeUpdate the comment forest by resolving instances of :class:`.MoreComments`. :param limit: The maximum number of :class:`.MoreComments` instances to replace. Each replacement requires 1 API request. Set to ``None`` to have no limit, or to ``0`` to remove all :class:`.MoreComments` instances without additional requests (default: ``32``). :param threshold: The minimum number of children comments a :class:`.MoreComments` instance must have in order to be replaced. :class:`.MoreComments` instances that represent "continue this thread" links unfortunately appear to have 0 children (default: ``0``). :returns: A list of :class:`.MoreComments` instances that were not replaced. :raises: ``prawcore.TooManyRequests`` when used concurrently. For example, to replace up to 32 :class:`.MoreComments` instances of a submission try: .. code-block:: python submission = reddit.submission("3hahrw") submission.comments.replace_more() Alternatively, to replace :class:`.MoreComments` instances within the replies of a single comment try: .. code-block:: python comment = reddit.comment("d8r4im1") comment.refresh() comment.replies.replace_more() .. note:: This method can take a long time as each replacement will discover at most 100 new :class:`.Comment` instances. As a result, consider looping and handling exceptions until the method returns successfully. For example: .. code-block:: python while True: try: submission.comments.replace_more() break except PossibleExceptions: print("Handling replace_more exception") sleep(1) .. warning:: If this method is called, and the comments are refreshed, calling this method again will result in a :class:`.DuplicateReplaceException`. NrF)updater r)) r6rrcountrr3remover'rrrr") rr<r= remainingr4skippedr5 new_commentsmorerrrr replace_morezs,:        zCommentForest.replace_more)r r rr)rr )rr)rr#)r+r,r*r-rr.r/)rr7r'r8)r'r:)r<r?r=r rr,)__name__ __module__ __qualname____doc__rrr"r$ staticmethodr6r9r;rrGrrrrr s     r )rK __future__rheapqrrtypingr exceptionsrutilr reddit.morer praw.modelsprawr rrrrs