Fj dZddlmZddlZddlmZddlmZmZddl m Z ddl m Z ddl mZdd lmZmZdd lmZdd lmZdd lmZdd lmZddlmZmZmZmZmZddl m!Z!ddl"m#Z#ddl$m%Z%ddl&m'Z'erddl(m)Z)ddl*Z*ddl*m+Z+ejXdZ-ddddZ.GddeeeeeZ/GddZ0GddeeZ1e/e%_2y) zProvide the Submission class.) annotationsN)dumps) TYPE_CHECKINGAny)urljoin)Conflict)API_PATH)ClientException InvalidURL) CommentForest)Listing)SubmissionListingMixin) RedditBase) CreatedMixin FullnameMixin ModNoteMixinThingModerationMixinUserContentMixin)PollData)Redditor) Subreddit)cachedproperty)Iterator)modelszn\n\n!?(\[.*?])?\(?((https://((preview|i)\.redd\.it|reddit.com/link).*?)|(?!https)([a-zA-Z0-9]+( \".*?\")?))\)?gifimgvideo) AnimatedImageImage RedditVideocreZdZdZdZeddZeddZeddZ e ddZ e d dZ e ddZ d! d"fd Zd#fd Z d$d Zd d d d%dZd&fd Zd'dZd(dZd)dZd*dZd d d dd d d d+dZd dd,dZd&dZd dd,dZxZS)- Submissionar 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). ``likes`` The user's current vote status on the submission: ``True`` if upvoted, ``False`` if downvoted, and ``None`` if not voted or not logged in. ``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 idc2tj|}d|vrd|vr|d}d|vrUt|dd|vr||jddz}n,|ddk(r t|d||jddz}|j s t||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. commentsgalleryrz+Invalid URL (subreddit, not submission): {})messagez+Invalid URL (submission ID not present): {})r _url_partsr indexisalnum)urlparts submission_ids [/root/workspace/ytshorts/venv/lib/python3.12/site-packages/praw/models/reddit/submission.py id_from_urlzSubmission.id_from_urlfs%%c* U "y'=!"IMe| .[\\ % !%++i"81"<=M 2Y* $S*WX X"%++j"9A"=>M$$&S/ !ct|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") )SubmissionFlairselfs r1flairzSubmission.flairs"t$$r3ct|S)zProvide an instance of :class:`.SubmissionModeration`. Example usage: .. code-block:: python submission = reddit.submission("8dmv8z") submission.mod.approve() )SubmissionModerationr6s r1modzSubmission.mods$D))r3cH|jjjdS)zThe class's kind. submission)_redditconfigkindsr6s r1_kindzSubmission._kinds||""((66r3c|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`. Setting either attribute after the comments have been fetched raises a :class:`.ClientException`: .. 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`. ) _commentsr6s r1r%zSubmission.commentss@~~r3cjt|jjj|jS)zA 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/. )rr>r? short_urlr#r6s r1 shortlinkzSubmission.shortlinks%t||**44dgg>>r3Nctd|||fDdk7r d}t|d|_d|_|r||_n|r|j ||_t |||i|_i|_ y)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. c3&K|] }|d yw)Nr*).0values r1 z&Submission.__init__..sDU%2CqDsr*z8Exactly one of 'id', 'url', or '_data' must be provided.i confidence_dataN) sum TypeError comment_limit comment_sortr#r2super__init___additional_fetch_params_comments_by_id)r7redditr#r.rOmsg __class__s r1rUzSubmission.__init__s Dr3.D D ILCC. !) DG &&s+DG u-(*%!r3c&|dk(r!tj|j|}nZ|dk(rt|j|}n>|dk(rt |j|}n"|dvrt |ddrd|d}t |t|!||y ) z6Objectify author, subreddit, and poll data attributes.author subreddit poll_data>rSrR_fetchedFzCannot update zD because the comments for this submission have already been fetched.N) r from_datar>rrgetattrr rT __setattr__)r7 attributerKrYrZs r1rbzSubmission.__setattr__s  &&t||U;E + %dllE2E + %T\\51E ; ;jZ_@`"9-/stC!#& & Iu-r3c#K|jg}|r||Dcgc]}|jc}z }tdt||D]}dj|||dzycc}ww)Nr,2)fullnamerangelenjoin)r7 chunk_sizeother_submissionsall_submissionsxpositions r1_chunkzSubmission._chunk so  ==/  4EFq F FOa_!5zB FH((?8hmDE E F GsA)A$?A)F) inline_mediapreserve_inline_mediac |jdd}d}tj|r|jrd}|rO|jd i|j Dcic]!\}}||j j|#c}}}d}|r=|j j|}|r|j|t||d<n||d<|jjtd|} |sN| d} d D]} | | jvst| | |jj!| j|S|jj!| |Scc}}w) 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) T)thing_idvalidate_on_submitF richtext_jsontexteditdatar)r_r> _submissionrepliesr]rI)rgINLINE_MEDIA_PATTERNsearchmedia_metadataformatitemsr]_upload_inline_media_convert_to_fancypants_replace_richtext_linksrr>postr __dict__delattrupdate) r7bodyrqrrrzis_richtext_json placeholdermediarvupdatedrcs r1_edit_experimentalzSubmission._edit_experimentalscP "& !  & &t ,1D1D#  4;;bnbtbtbv"L^KY^ T^^@@GG"D $   NNAA$GM$,,];$)-$8D !DL,,##HV$44#@ajG 0  0 00GY/ 0 MM !1!1 2  MM  ) 5"s&Ec|j}|\}}t|j|d}|dddd}t||j|}|`|`t ||_|jj|j|jj|jt|9y)NrzrNchildrenr) _fetch_datar r>typerRrSr rCrrr%_updaterrT_fetch)r7rzsubmission_listingcomment_listingsubmission_datar=rZs r1rzSubmission._fetchas!.2+O!$,,of6MN,V4Z@CFKT$Z OD  $  #,T2  Z001 o667 r3c|j\}}}|j|jjt |j di|}|j jd||S)NGET)methodparamspathrI) _fetch_inforrVcopyr rr>request)r7namefieldsrrs r1rzSubmission._fetch_datapse#//1ff d3388:;~$$.v.||##5d#KKr3cRdd|ji|j|jdfS)Nr=r#)limitsort)r#rRrSr6s r1rzSubmission._fetch_infovs.  477O(($2C2C D  r3c|jjDcic]\}}|t|d}}}t|dddD]\}}|j d}t |t r|j ddvsJdC|j dD]}|j ddk(st|} |djdd jd d } | jtjd | } | st| j} || | d } |j d|j dk7r|d| d<| |d|<ycc}}w)Nedocumentc>rrrzDUnexpected richtext JSON schema. Please file a bug report with PRAW.linkuzhttps://r*?rz[./])rr#t) rrMEDIA_TYPE_MAPPING enumerateget isinstancestrsetsplit intersectionrepop) r7rvmedia_idrKparsed_media_typesr,element element_itemsitemidsr. matched_idcorrect_elements r1rz"Submission._replace_richtext_links}sxLPL_L_LeLeLg 9H5H(s4 4  ( j(A!(DE KNE7#KK,M--{{3'+BBZB C( K88C=F*01Cs)//*5a8>>sCAFC!$!1!1"((7C2H!IJ!%/^^%5 !3J!?",+ 88C=DHHSM9379OC0;J j1%8 K K  sE"ct|ddr3d|jjjd}t |||j |<y)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. :raises ClientException: If the submission has already been fetched, since fetch parameters only affect the initial fetch and would otherwise have no effect. Fetch parameters must be added before the submission is fetched, i.e., before any of its attributes are accessed. 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) r_Fz$Cannot add fetch parameters to this z% because it has already been fetched.N)rarZ__name__lowerr rV)r7keyrKrYs r1add_fetch_paramzSubmission.add_fetch_paramsU( 4U +6t~~7N7N7T7T7V6W78 "#& &-2%%c*r3T)flair_id flair_textnsfw send_repliesspoilertitlec>| |j}|jdt|t|t|t||d}|j d|fd|ffD cic] \} } |  | |  c} } |j j td|Scc} } w)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` crosspost)crosspost_fullnamekindr sendrepliesrsrrrrsubmitry)rrgboolrrr>rr ) r7r]rrrrrrrzrrKs r1rzSubmission.crosspostsZ =JJE#'--J -G}i.  +5x*@rr r7rl submissionss r1rzSubmission.hidesD& ;;"HY;Z JK LL  hv.dK5H  I Jr3chd|ji}|jjtd|y)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_visitsryN)rgr>rr r7rzs r1 mark_visitedzSubmission.mark_visited s.' (>2>r3c|jd|D](}|jjtdd|i*y)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` rfrunhider#ryNrrs r1rzSubmission.unhidesD& ;;"HY;Z LK LL  hx0k7J  K Lr3)r.rreturnr)rr5)rr:)rr)rr )NNN) rXz praw.Redditr# str | Noner.rrOzdict[str, Any] | NonerNone)rcrrKrrr)rkintrllist[models.Submission] | Nonerz Iterator[str])rrrqz$dict[str, models.InlineMedia] | Nonerrrrmodels.Submissionrr)rdict)rz0tuple[str, dict[str, str], dict[str, int | str]])rvrrr)rrrKrrr)r]zmodels.Subredditrrrrrrrrrrrrrr)rlrrr)r __module__ __qualname____doc__ STR_FIELD staticmethodr2rr8r;propertyrAr%rFrUrbrprrrrrrrrrr __classcell__)rZs@r1r"r".s3jIB%%$ * *77B??'+ " "  " " % "  "D . F F: F  F">B&+ II; I $ I  IV L  K:3@ $!%! =@#=@ =@  =@  =@=@=@=@ =@~KOJ,? MQLLr3r"c.eZdZdZddZddZddd dZy) r5zDProvide a set of functions pertaining to :class:`.Submission` flair.c||_y)zInitialize a :class:`.SubmissionFlair` instance. :param submission: The :class:`.Submission` associated with the flair functions. N)r=r7r=s r1rUzSubmissionFlair.__init__5s %r3ctdj|jj}|jjj |d|jj idS)zReturn list of available flair choices. Choices are required in order to use :meth:`.select`. For example: .. code-block:: python choices = submission.flair.choices() flairselectorr]rrychoices)r rr=r]r>rrg)r7r.s r1rzSubmissionFlair.choices=s['..9R9R.S&&++Cvt?W?W6X+YZcddr3N)rwc||jj|d}tdj|jj}|jj j ||y)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") )flair_template_idrrw select_flairrryN)r=rgr rr]r>r)r7rrwrzr.s r1selectzSubmissionFlair.selectLs_&"3OO,,  ~&--8Q8Q-R $$St$4r3r=rrr)rz"list[dict[str, bool | list | str]])rrrwrrr)rrrrrUrrrIr3r1r5r52sN% eDH5r3r5ceZdZUdZdZerded<ddZddddZd d d d  dd Z dd Z ddZ ddZ ddZ dddddZddddZddZddZddZy ) r:zProvide a set of functions pertaining to :class:`.Submission` moderation. Example usage: .. code-block:: python submission = reddit.submission("8dmv8z") submission.mod.approve() removal_link_messagez"models.Comment | models.Submissionthingc||_y)zwInitialize a :class:`.SubmissionModeration` instance. :param submission: The submission to moderate. N)rrs r1rUzSubmissionModeration.__init__xs   r3T)statec|jjjtd|jj|dy)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_moder#rryNrr>rr rg)r7rs r1rz!SubmissionModeration.contest_modes6,  8djjFYFYdi?jkr3N) css_classrrwcH||jj|d}tdj|jj}|2||d<tdj|jj}|jj j ||y)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") )rrrwr8rNrrry)rrgr rr]r>r)r7rrrwrzr.s r1r8zSubmissionModeration.flairs6#JJ''  w&&1E1E&F  ((9D$ %>*11DJJrr rs r1r z)SubmissionModeration.set_original_contents[( ++**--%%!   )? @tLr3c|jjjtdd|jjiy)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` unmarknsfwr#ryNrr6s r1sfwzSubmissionModeration.sfws5$  6dDJJDWDW=XYr3c|jjjtdd|jjiy)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` rr#ryNrr6s r1rzSubmissionModeration.spoilers5$  34ATAT:UVr3)bottomrc|jj|d}|sd|d< |jjjtd|S#t $rYywxYw)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() rr*numsticky_submissionryN)rrgr>rr r)r7rrrzs r1stickyzSubmissionModeration.stickysa6jj))E:DK ::%%**84G+Ht*T T   s-A AAblank)rc|jjjtd|jj|dy)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)r#rryNr)r7rs r1rz#SubmissionModeration.suggested_sort8s7 )9 : H[H[eiAjkr3cd|jj|jj|jjdd}|jjj t d|y)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` Fr r ryNr rs r1unset_original_contentz+SubmissionModeration.unset_original_contentBs[( ++**--%%"   )? @tLr3c|jjjtdd|jjiy)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` unspoilerr#ryNrr6s r1rzSubmissionModeration.unspoiler^s5$  5T4::CVCVr8s#" % 74/=.-02$(!rzzu AL')9=,XbALH2525jn /n b ) r3