o 2g2@sRdZddlmZddlZddlmZddlmZmZm Z ddl m Z ddl m Z ddlmZd d lmZd d lmZd d lmZmZd dlmZd dlmZd dlmZddlmZddlm Z m!Z!m"Z"m#Z#ddl$m%Z%ddl&m'Z'ddl(m)Z)er~ddl*Z+e,dZ-ddddZ.GdddZ/Gddde"e!Z0Gd d!d!ee#e eZ1e1e)_2dS)"zProvide the Submission class.) annotationsN)dumps) TYPE_CHECKINGAny Generator)urljoin)warn)Conflict)API_PATH) InvalidURL)_deprecate_argscachedproperty) CommentForest)Listing)SubmissionListingMixin) RedditBase) FullnameMixin ModNoteMixinThingModerationMixinUserContentMixin)PollData)Redditor) Subredditzn\n\n!?(\[.*?])?\(?((https://((preview|i)\.redd\.it|reddit.com/link).*?)|(?!https)([a-zA-Z0-9]+( \".*?\")?))\)?imgvideogif)Image RedditVideo AnimatedImagec@s>eZdZdZdddZddd Zed d d d dddZd S)SubmissionFlairzDProvide a set of functions pertaining to :class:`.Submission` flair. submissionpraw.models.SubmissioncC ||_dS)zInitialize a :class:`.SubmissionFlair` instance. :param submission: The :class:`.Submission` associated with the flair functions. N)r#selfr#r(U/home/garg/my-data/venv/lib/python3.10/site-packages/praw/models/reddit/submission.py__init__) zSubmissionFlair.__init__return"list[dict[str, bool | list | str]]cCs2tdj|jjd}|jjj|d|jjiddS)zReturn list of available flair choices. Choices are required in order to use :meth:`.select`. For example: .. code-block:: python choices = submission.flair.choices() flairselector subredditlinkdatachoices)r formatr#r0_redditpostfullname)r'urlr(r(r)r41s   zSubmissionFlair.choicesflair_template_idtextN)r;str str | NonecCs:||jj|d}tdj|jjd}|jjj||ddS)aSelect flair for submission. :param flair_template_id: The flair template to select. The possible values can be discovered through :meth:`.choices`. :param text: If the template's ``flair_text_editable`` value is ``True``, this value will set a custom text (default: ``None``). For example, to select an arbitrary editable flair text (assuming there is one) and set a custom value try: .. code-block:: python choices = submission.flair.choices() template_id = next(x for x in choices if x["flair_text_editable"])["flair_template_id"] submission.flair.select(template_id, text="my custom value") )r:r1r; select_flairr/r2N)r#r8r r5r0r6r7)r'r:r;r3r9r(r(r)selectBs zSubmissionFlair.selectr#r$)r,r-)r:r<r;r=)__name__ __module__ __qualname____doc__r*r4r r?r(r(r(r)r"&s   r"c@seZdZdZdZd1ddZeddd d2d d Zed ddddddd3ddZddZ ddZ ddZ ddZ eddddd d4d"d#Z ed$d%d&d5d'd(Zd)d*Zd+d,Zd6d/d0ZdS)7SubmissionModerationzProvide a set of functions pertaining to :class:`.Submission` moderation. Example usage: .. code-block:: python submission = reddit.submission("8dmv8z") submission.mod.approve() removal_link_messager#r$cCr%)zwInitialize a :class:`.SubmissionModeration` instance. :param submission: The submission to moderate. N)thingr&r(r(r)r*lr+zSubmissionModeration.__init__stateT)rHboolcC$|jjjtd|jj|dddS)aSet contest mode for the comments of this submission. :param state: ``True`` enables contest mode and ``False`` disables (default: ``True``). Contest mode have the following effects: - The comment thread will default to being sorted randomly. - Replies to top-level comments will be hidden behind "[show replies]" buttons. - Scores will be hidden from non-moderators. - Scores accessed through the API (mobile apps, bots) will be obscured to "1" for non-moderators. Example usage: .. code-block:: python submission = reddit.submission("5or86n") submission.mod.contest_mode() contest_modeidrHr2NrGr6r7r r8)r'rHr(r(r)rKts z!SubmissionModeration.contest_moder; css_classr:N)rOr:r;r<r=cCs^||jj|d}tdj|jjd}|dur$||d<tdj|jjd}|jjj||ddS)a|Set flair for the submission. :param css_class: The css class to associate with the flair html (default: ``""``). :param flair_template_id: The flair template ID to use when flairing. :param text: The flair text to associate with the :class:`.Submission` (default: ``""``). This method can only be used by an authenticated user who is a moderator of the submission's :class:`.Subreddit`. Example usage: .. code-block:: python submission = reddit.submission("5or86n") submission.mod.flair(text="PRAW", css_class="bot") )rOr1r;flairr/Nr:r>r2)rGr8r r5r0r6r7)r'rOr:r;r3r9r(r(r)rQszSubmissionModeration.flaircC"|jjjtdd|jjiddS)aMark as not safe for work. This method can be used both by the submission author and moderators of the subreddit that the submission belongs to. Example usage: .. code-block:: python submission = reddit.subreddit("test").submit("nsfw test", selftext="nsfw") submission.mod.nsfw() .. seealso:: :meth:`.sfw` marknsfwrMr2NrNr'r(r(r)nsfw"zSubmissionModeration.nsfwcCs6|jj|jjdd|jjd}|jjjtd|ddS)aMark as original content. This method can be used by moderators of the subreddit that the submission belongs to. If the subreddit has enabled the Original Content beta feature in settings, then the submission's author can use it as well. Example usage: .. code-block:: python submission = reddit.subreddit("test").submit("oc test", selftext="original") submission.mod.set_original_content() .. seealso:: :meth:`.unset_original_content` TFrMr8 should_set_ocexecutedrset_original_contentr2NrGrMr8r0r6r7r r'r3r(r(r)r[z)SubmissionModeration.set_original_contentcCrR)agMark as safe for work. This method can be used both by the submission author and moderators of the subreddit that the submission belongs to. Example usage: .. code-block:: python submission = reddit.submission("5or86n") submission.mod.sfw() .. seealso:: :meth:`.nsfw` unmarknsfwrMr2NrNrTr(r(r)sfws zSubmissionModeration.sfwcCrR)aIndicate that the submission contains spoilers. This method can be used both by the submission author and moderators of the subreddit that the submission belongs to. Example usage: .. code-block:: python submission = reddit.submission("5or86n") submission.mod.spoiler() .. seealso:: :meth:`.unspoiler` spoilerrMr2NrNrTr(r(r)rarVzSubmissionModeration.spoilerbottom)rbrHr,cCsH|jj|d}|s d|d<z |jjjtd|dWSty#YdSw)aSet the submission's sticky state in its subreddit. :param bottom: When ``True``, set the submission as the bottom sticky. If no top sticky exists, this submission will become the top sticky regardless (default: ``True``). :param state: ``True`` sets the sticky for the submission and ``False`` unsets (default: ``True``). :returns: The stickied submission object. .. note:: When a submission is stickied two or more times, the Reddit API responds with a 409 error that is raised as a ``Conflict`` by prawcore. This method suppresses these ``Conflict`` errors. This submission will replace the second stickied submission if one exists. For example: .. code-block:: python submission = reddit.submission("5or86n") submission.mod.sticky() rLrnumsticky_submissionr2N)rGr8r6r7r r )r'rbrHr3r(r(r)stickys zSubmissionModeration.stickysortblank)rfcCrJ)aSet the suggested sort for the comments of the submission. :param sort: Can be one of: ``"confidence"``, ``"top"``, ``"new"``, ``"controversial"``, ``"old"``, ``"random"``, ``"qa"``, or ``"blank"`` (default: ``"blank"``). suggested_sort)rMrfr2NrN)r'rfr(r(r)rh5s  z#SubmissionModeration.suggested_sortcCs6|jj|jjdd|jjd}|jjjtd|ddS)a3Indicate that the submission is not original content. This method can be used by moderators of the subreddit that the submission belongs to. If the subreddit has enabled the Original Content beta feature in settings, then the submission's author can use it as well. Example usage: .. code-block:: python submission = reddit.subreddit("test").submit("oc test", selftext="original") submission.mod.unset_original_content() .. seealso:: :meth:`.set_original_content` FrWr[r2Nr\r]r(r(r)unset_original_contentBr^z+SubmissionModeration.unset_original_contentcCrR)aIndicate that the submission does not contain spoilers. This method can be used both by the submission author and moderators of the subreddit that the submission belongs to. For example: .. code-block:: python submission = reddit.subreddit("test").submit("not spoiler", selftext="spoiler") submission.mod.unspoiler() .. seealso:: :meth:`.spoiler` unspoilerrMr2NrNrTr(r(r)rj^rVzSubmissionModeration.unspoilerlevelintcCrJ)uChange the Crowd Control level of the submission. :param level: An integer between 0 and 3. **Level Descriptions** ===== ======== ================================================================ Level Name Description ===== ======== ================================================================ 0 Off Crowd Control will not action any of the submission's comments. 1 Lenient Comments from users who have negative karma in the subreddit are automatically collapsed. 2 Moderate Comments from new users and users with negative karma in the subreddit are automatically collapsed. 3 Strict Comments from users who haven’t joined the subreddit, new users, and users with negative karma in the subreddit are automatically collapsed. ===== ======== ================================================================ Example usage: .. code-block:: python submission = reddit.submission("745ryj") submission.mod.update_crowd_control_level(2) .. seealso:: :meth:`~.CommentModeration.show` update_crowd_control)rMrkr2NrN)r'rkr(r(r)update_crowd_control_levelrs   z/SubmissionModeration.update_crowd_control_levelr@)rHrI)rOr<r:r=r;r<)rbrIrHrIr,r$)rfr<)rkrl)rArBrCrDREMOVAL_MESSAGE_APIr*r rKrQrUr[r`rarerhrirjrnr(r(r(r)rE^s.  %% rEcsBeZdZdZdZedSddZedTd d ZedUd d Z e dVddZ e dWddZ e dVddZ   dXdYfdd ZdZfd d! Zd[d'd(Zd)dd*d\d1d2Zfd3d4Zd5d6Zd7d8Zd]d;d<Zd^d>d?Zed@dAdBdCdDdEdFddd)dGd)ddHd_dJdKZed$ddLd`dMdNZdOdPZed$ddLd`dQdRZZS)a Submissiona A class for submissions to Reddit. .. include:: ../../typical_attributes.rst ========================== ========================================================= Attribute Description ========================== ========================================================= ``author`` Provides an instance of :class:`.Redditor`. ``author_flair_text`` The text content of the author's flair, or ``None`` if not flaired. ``clicked`` Whether or not the submission has been clicked by the client. ``comments`` Provides an instance of :class:`.CommentForest`. ``created_utc`` Time the submission was created, represented in `Unix Time`_. ``distinguished`` Whether or not the submission is distinguished. ``edited`` Whether or not the submission has been edited. ``id`` ID of the submission. ``is_original_content`` Whether or not the submission has been set as original content. ``is_self`` Whether or not the submission is a selfpost (text-only). ``link_flair_template_id`` The link flair's ID. ``link_flair_text`` The link flair's text content, or ``None`` if not flaired. ``locked`` Whether or not the submission has been locked. ``name`` Fullname of the submission. ``num_comments`` The number of comments on the submission. ``over_18`` Whether or not the submission has been marked as NSFW. ``permalink`` A permalink for the submission. ``poll_data`` A :class:`.PollData` object representing the data of this submission, if it is a poll submission. ``saved`` Whether or not the submission is saved. ``score`` The number of upvotes for the submission. ``selftext`` The submissions' selftext - an empty string if a link post. ``spoiler`` Whether or not the submission has been marked as a spoiler. ``stickied`` Whether or not the submission is stickied. ``subreddit`` Provides an instance of :class:`.Subreddit`. ``title`` The title of the submission. ``upvote_ratio`` The percentage of upvotes from all votes on the submission. ``url`` The URL the submission links to, or the permalink if a selfpost. ========================== ========================================================= .. _unix time: https://en.wikipedia.org/wiki/Unix_time rMr9r<r,cCst|}d|vrd|vr|d}d|vrt|ddn#d|vr*||dd}n|ddkr6t|dd||dd}|sGt||S) aReturn the ID contained within a submission URL. :param url: A url to a submission in one of the following formats (http urls will also work): - ``"https://redd.it/2gmzqe"`` - ``"https://reddit.com/comments/2gmzqe/"`` - ``"https://www.reddit.com/r/redditdev/comments/2gmzqe/praw_https/"`` - ``"https://www.reddit.com/gallery/2gmzqe"`` :raises: :class:`.InvalidURL` if ``url`` is not a valid submission URL. commentsgalleryrZz+Invalid URL (subreddit, not submission): {})messagerz+Invalid URL (submission ID not present): {})r _url_partsr indexisalnum)r9parts submission_idr(r(r) id_from_urls   zSubmission.id_from_urlr"cCt|S)a\Provide an instance of :class:`.SubmissionFlair`. This attribute is used to work with flair as a regular user of the subreddit the submission belongs to. Moderators can directly use :meth:`.flair`. For example, to select an arbitrary editable flair text (assuming there is one) and set a custom value try: .. code-block:: python choices = submission.flair.choices() template_id = next(x for x in choices if x["flair_text_editable"])["flair_template_id"] submission.flair.select(template_id, text="my custom value") )r"rTr(r(r)rQszSubmission.flairrEcCr{)zProvide an instance of :class:`.SubmissionModeration`. Example usage: .. code-block:: python submission = reddit.submission("8dmv8z") submission.mod.approve() )rErTr(r(r)mods zSubmission.modcCs|jjjdS)zReturn the class's kind.r#)r6configkindsrTr(r(r)_kindszSubmission._kindrcCs|jS)aProvide an instance of :class:`.CommentForest`. This attribute can be used, for example, to obtain a flat list of comments, with any :class:`.MoreComments` removed: .. code-block:: python submission.comments.replace_more(limit=0) comments = submission.comments.list() Sort order and comment limit can be set with the ``comment_sort`` and ``comment_limit`` attributes before comments are fetched, including any call to :meth:`.replace_more`: .. code-block:: python submission.comment_sort = "new" comments = submission.comments.list() .. note:: The appropriate values for ``"comment_sort"`` include ``"confidence"``, ``"controversial"``, ``"new"``, ``"old"``, ``"q&a"``, and ``"top"`` See :ref:`extracting_comments` for more on working with a :class:`.CommentForest`. ) _commentsrTr(r(r)rqszSubmission.commentscCst|jjj|jS)zReturn a shortlink to the submission. For example, https://redd.it/eorhm is a shortlink for https://www.reddit.com/r/announcements/comments/eorhm/reddit_30_less_typing/. )rr6r} short_urlrMrTr(r(r) shortlink8szSubmission.shortlinkNreddit praw.Redditr=_datadict[str, Any] | Nonecsh|||fddkrd}t|d|_d|_|r||_n|r$|||_tj||di|_i|_ dS)a2Initialize a :class:`.Submission` instance. :param reddit: An instance of :class:`.Reddit`. :param id: A reddit base36 submission ID, e.g., ``"2gmzqe"``. :param url: A URL supported by :meth:`.id_from_url`. Either ``id`` or ``url`` can be provided, but not both. Nrz8Exactly one of 'id', 'url', or '_data' must be provided.i confidencer) count TypeError comment_limit comment_sortrMrzsuperr*_additional_fetch_params_comments_by_id)r'rrMr9rmsg __class__r(r)r*Bs  zSubmission.__init__ attributevaluercs|dkr t|j|}n2|dkrt|j|}n'|dkr"t|j|}n|dkr>t|dr>|jr>t|dr>|jjjr>t ddd t ||d S) z6Objectify author, subreddit, and poll data attributes.authorr0 poll_datar_fetchedr6zqThe comments for this submission have already been fetched, so the updated comment_sort will not have any effect.r stacklevelN) r from_datar6rrhasattrrr}warn_comment_sortrr __setattr__)r'rrrr(r)rds(zSubmission.__setattr__ chunk_sizerlother_submissions#list[praw.models.Submission] | NoneGenerator[str, None, None]ccsR|jg}|r|dd|D7}tdt||D]}d|||dVqdS)NcSsg|]}|jqSr()r8).0xr(r(r) sz%Submission._chunk..r,2)r8rangelenjoin)r'rrall_submissionspositionr(r(r)_chunkzszSubmission._chunkF)preserve_inline_media inline_mediabodyrrIr)dict[str, praw.models.InlineMedia] | Noner$c sjjjd}d}t|rjrd}|r)|jd ifdd|D}d}|r?j |}|r8 |t ||d<n||d<jj t d|d }|sk|d }d D] }||jvrat||qUj|jSj|S)aReplace the body of the object with ``body``. :param body: The Markdown formatted content for the updated object. :param preserve_inline_media: Attempt to preserve inline media in ``body``. .. danger:: This method is experimental. It is reliant on undocumented API endpoints and may result in existing inline media not displaying correctly and/or creating a malformed body. Use at your own risk. This method may be removed in the future without warning. :param inline_media: A dict of :class:`.InlineMedia` objects where the key is the placeholder name in ``body``. :returns: The current instance after updating its attributes. Example usage: .. code-block:: python from praw.models import InlineGif, InlineImage, InlineVideo submission = reddit.submission("5or86n") gif = InlineGif(path="path/to/image.gif", caption="optional caption") image = InlineImage(path="path/to/image.jpg", caption="optional caption") video = InlineVideo(path="path/to/video.mp4", caption="optional caption") body = "New body with a gif {gif1} an image {image1} and a video {video1} inline" media = {"gif1": gif, "image1": image, "video1": video} submission._edit_experimental(submission.selftext + body, inline_media=media) )thing_idvalidate_on_submitFTcsi|] \}}|j|qSr()r0_upload_inline_media)r placeholdermediarTr(r)  z1Submission._edit_experimental.. richtext_jsonr;editr2r)rr6 _submissionrepliesr0Nr()r8r6rINLINE_MEDIA_PATTERNsearchmedia_metadatar5itemsr0_convert_to_fancypants_replace_richtext_linksrr7r __dict__delattrupdate) r'rrrr3is_richtext_jsonrupdatedrr(rTr)_edit_experimentals<(      zSubmission._edit_experimentalcs|}|\}}t|j|dd}|dddd}t||j|d}t|dt|dt||_|j|j|j |j t dS)Nr3rchildrenrrr) _fetch_datarr6typerrrrrrq_updaterr_fetch)r'r3submission_listingcomment_listingsubmission_datar#rr(r)rs   zSubmission._fetchcCsD|\}}}||jt|jdi|}|jjd||dS)NGET)methodparamspathr() _fetch_inforrcopyr r5r6request)r'namefieldsrrr(r(r)rszSubmission._fetch_datacCsdd|ji|j|jdfS)Nr#rM)limitrf)rMrrrTr(r(r)rs zSubmission._fetch_infordictc Csdd|jD}t|dddD]g\}}|d}t|tr.|ddvs-Jdq|dD]G}|ddkrzt|}|d d d d d }|t d|} | rz| } || | d} |d|d krt|d| d<| |d|<q3qdS)NcSsi|] \}}|t|dqS)e)MEDIA_TYPE_MAPPING)rmedia_idrr(r(r)rrz6Submission._replace_richtext_links..documentcr)rrrzDUnexpected richtext JSON schema. Please file a bug report with PRAW.r1uzhttps://r?rz[./])rrMt) rr enumerateget isinstancer<setsplit intersectionrepop) r'rparsed_media_typesrvelement element_itemsitemidsr9 matched_idcorrect_elementr(r(r)rs4    z"Submission._replace_richtext_linkskeycCsNt|dr |jr t|dr |jjjr td|jjddd||j |<dS)aAdd a parameter to be used for the next fetch. :param key: The key of the fetch parameter. :param value: The value of the fetch parameter. For example, to fetch a submission with the ``rtjson`` attribute populated: .. code-block:: python submission = reddit.submission("mcqjl8") submission.add_fetch_param("rtj", "all") print(submission.rtjson) rr6zThis zZ has already been fetched, so adding additional fetch parameters will not have any effect.rrN) rrr6r}warn_additional_fetch_paramsrrrAlowerr)r'rrr(r(r)add_fetch_paramszSubmission.add_fetch_paramr0title send_repliesflair_id flair_textrUraT)rrrUrrarpraw.models.Subredditc Csr|dur|j}t||t|d|jt|t|d}d|fd|ffD] \} } | dur.| || <q"|jjtd|dS)a)Crosspost the submission to a subreddit. .. note:: Be aware you have to be subscribed to the target subreddit. :param subreddit: Name of the subreddit or :class:`.Subreddit` object to crosspost into. :param flair_id: The flair template to select (default: ``None``). :param flair_text: If the template's ``flair_text_editable`` value is ``True``, this value will set a custom text (default: ``None``). :param nsfw: Whether the submission should be marked NSFW (default: ``False``). :param send_replies: When ``True``, messages will be sent to the created submission's author when comments are made to the submission (default: ``True``). :param spoiler: Whether the submission should be marked as a spoiler (default: ``False``). :param title: Title of the submission. Will use this submission's title if ``None`` (default: ``None``). :returns: A :class:`.Submission` object for the newly created submission. Example usage: .. code-block:: python submission = reddit.submission("5or86n") cross_post = submission.crosspost("learnprogramming", send_replies=False) .. seealso:: :meth:`.hide` N crosspost)srr sendreplieskindcrosspost_fullnamerUrarrsubmitr2)rr<rIr8r6r7r ) r'r0rrrUrrarr3rrr(r(r)r,s6 zSubmission.crosspost)rcC0|jd|dD]}|jjtdd|idqdS)aHide :class:`.Submission`. :param other_submissions: When provided, additionally hide this list of :class:`.Submission` instances as part of a single request (default: ``None``). Example usage: .. code-block:: python submission = reddit.submission("5or86n") submission.hide() .. seealso:: :meth:`.unhide` rrrhiderMr2Nrr6r7r r'r submissionsr(r(r)rt  zSubmission.hidecCs"d|ji}|jjtd|ddS)zMark submission as visited. This method requires a subscription to reddit premium. Example usage: .. code-block:: python submission = reddit.submission("5or86n") submission.mark_visited() links store_visitsr2N)r8r6r7r r]r(r(r) mark_visiteds zSubmission.mark_visitedcCr)aUnhide :class:`.Submission`. :param other_submissions: When provided, additionally unhide this list of :class:`.Submission` instances as part of a single request (default: ``None``). Example usage: .. code-block:: python submission = reddit.submission("5or86n") submission.unhide() .. seealso:: :meth:`.hide` rrunhiderMr2Nrrr(r(r)r rzSubmission.unhide)r9r<r,r<)r,r")r,rE)r,r<)r,r)NNN)rrrMr=r9r=rr)rr<rr)rrlrrr,r)rr<rrIrrr,r$)rr)rr<rr<)r0rrr=rr=rUrIrrIrarIrr=r,r$)rr)rArBrCrD STR_FIELD staticmethodrzrrQr|propertyrrqrr*rrrrrrrrr rrr r  __classcell__r(r(rr)rpsd2 #      "  N   ?rp)3rD __future__rrjsonrtypingrrr urllib.parserwarningsrprawcorer constr exceptionsr utilr rcomment_forestrlisting.listingrlisting.mixinsrbasermixinsrrrrpollrredditorrr0r praw.modelsprawcompilerrr"rErp_submission_classr(r(r(r)sL              8< #