Fj@ dZddlmZddlmZddlmZmZmZddl m Z ddl m Z ddl mZddlmZdd lmZdd lmZmZer dd lmZdd lmZGd de ZGdde ZGdde ZGdde ZGdde Zy)zProvide the helper classes.) annotations)dumps) TYPE_CHECKINGAnyoverload)API_PATH)PRAWBase)ListingGenerator)Draft) LiveThread) Multireddit Subreddit)Iterator)modelsc0eZdZdZddZddZd dZddZy) AnnouncementHelperzProvide a set of functions to interact with :class:`.Announcement`\ s. .. note:: The methods provided by this class will only work on the currently authenticated user's :class:`.Announcement`\ s. c |jd|jddt|jtdfi|S)adReturn a :class:`.ListingGenerator` for the authenticated user's announcements. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. Example usage: .. code-block:: python for announcement in reddit.announcements(): print(announcement.subject) request_limitlimitd announcements) setdefaultgetr _redditr)selfgenerator_kwargss Q/root/workspace/ytshorts/venv/lib/python3.12/site-packages/praw/models/helpers.py__call__zAnnouncementHelper.__call__s?$ ##O5E5I5I'SV5WX h.G\K[\\c|rJdjd|ddD}|jjtdd|i|dd}|rIyy)aHide :class:`.Announcement`\ s. :param announcements: A list of :class:`.Announcement` instances to hide. Requests are batched at 100 items (Reddit limit). For example, to hide every announcement: .. code-block:: python reddit.announcements.hide(list(reddit.announcements())) .. seealso:: :meth:`.Announcement.hide` to hide a single announcement. ,c34K|]}|jywNfullname.0 announcements r z*AnnouncementHelper.hide..GY\<00YNrhide_announcementsidsdatajoinrpostrrrr-s rhidezAnnouncementHelper.hide4sV$((Y]SWTWEXYYC LL  h';.nr*r+Nrread_announcementsr-r.r0r3s r mark_readzAnnouncementHelper.mark_readWsV,((Y]SWTWEXYYC LL  h';None)r>r?)__name__ __module__ __qualname____doc__rr4r9r=rrrrs]*0. >0rrc eZdZdZed d dZed dZd ddZddZdddddddddddd dd Zy) DraftHelperzProvide a set of functions to interact with :class:`.Draft` instances. .. note:: The methods provided by this class will only work on the currently authenticated user's :class:`.Draft`\ s. Ncyr#rDrdraft_ids rrzDraftHelper.__call__}sEHrcyr#rDrHs rrzDraftHelper.__call__s7:rcT|t|j|S|jS)aReturn a list of :class:`.Draft` instances. :param draft_id: When provided, this returns a :class:`.Draft` instance (default: ``None``). :returns: A :class:`.Draft` instance if ``draft_id`` is provided. Otherwise, a list of :class:`.Draft` objects. .. note:: Drafts fetched using a specific draft ID are lazily loaded, so you might have to access an attribute to get all the expected attributes. This method can be used to fetch a specific draft by ID, like so: .. code-block:: python draft_id = "124862bc-e1e9-11eb-aa4f-e68667a77cbb" draft = reddit.drafts(draft_id) print(draft) id)r r _draft_listrHs rrzDraftHelper.__call__s*.  (3 3!!rcN|jjtdddiS)zjGet a list of :class:`.Draft` instances. :returns: A list of :class:`.Draft` instances. draftsmd_bodyTparamsrrrr8s rrNzDraftHelper._draft_lists( || 2It;LMMrFT flair_id flair_textis_public_linknsfworiginal_contentselftext send_repliesspoiler subreddittitleurlc  |r| r d} t| t| tr|jj | } t j d||||||||| | | d | }|jjtd|S)aaCreate a new :class:`.Draft`. :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``). ``flair_id`` is required when ``flair_text`` is provided. :param is_public_link: Whether to enable public viewing of the draft before it is submitted (default: ``False``). :param nsfw: Whether the draft should be marked NSFW (default: ``False``). :param original_content: Whether the submission should be marked as original content (default: ``False``). :param selftext: The Markdown formatted content for a text submission draft. Use ``None`` to make a title-only submission draft (default: ``None``). ``selftext`` can not be provided if ``url`` is provided. :param send_replies: When ``True``, messages will be sent to the submission author when comments are made to the submission (default: ``True``). :param spoiler: Whether the submission should be marked as a spoiler (default: ``False``). :param subreddit: The subreddit to create the draft for. This accepts a subreddit display name, :class:`.Subreddit` object, or :class:`.UserSubreddit` object. If ``None``, the :class:`.UserSubreddit` of currently authenticated user will be used (default: ``None``). :param title: The title of the draft (default: ``None``). :param url: The URL for a ``link`` submission draft (default: ``None``). ``url`` can not be provided if ``selftext`` is provided. Additional keyword arguments can be provided to handle new parameters as Reddit introduces them. :returns: The new :class:`.Draft` object. z4Exactly one of 'selftext' or 'url' must be provided.rUdraftr.rD) TypeError isinstancestrrr^r _prepare_datar2r)rrVrWrXrYrZr[r\r]r^r_r` draft_kwargsmsgr/s rcreatezDraftHelper.creates` HCC. i % ..y9I""  !)-%    ||  '!2 >>rr#)rIr?r>list[models.Draft])rIrer> models.Draft)rI str | Noner>z!list[models.Draft] | models.Draft)r>rj)rVrlrWrlrXboolrYrmrZrmr[rlr\rmr]rmr^z4str | models.Subreddit | models.UserSubreddit | Noner_rlr`rlrgrr>rk)r@rArBrCrrrNrirDrrrFrFssHH ::"6N $!%$!&#!LP D?D? D?  D?  D?D?D?D?D?ID?D?D?D? D?rrFcLeZdZdZd dZdddd d dZd dZd dZy) LiveHelperzDProvide a set of functions to interact with :class:`.LiveThread`\ s.c0t|j|S)aReturn a new lazy instance of :class:`.LiveThread`. This method is intended to be used as: .. code-block:: python livethread = reddit.live("ukaeu1ik4sw5") :param id: A live thread ID, e.g., ``ukaeu1ik4sw5``. rL)r r)rrMs rrzLiveHelper.__call__s$,,2..rNF) descriptionrY resourcescT|jjtd||||dS)aCreate a new :class:`.LiveThread`. :param title: The title of the new :class:`.LiveThread`. :param description: The new :class:`.LiveThread`'s description. :param nsfw: Indicate whether this thread is not safe for work (default: ``False``). :param resources: Markdown formatted information that is useful for the :class:`.LiveThread`. :returns: The new :class:`.LiveThread` object. livecreate)rqrYrrr_r.r7)rr_rqrYrrs rrizLiveHelper.creates9(||  \ "*& !  rc\tts d}t|dfd }|S)aFetch information about each live thread in ``ids``. :param ids: A list of IDs for a live thread. :returns: A generator that yields :class:`.LiveThread` instances. :raises: ``prawcore.ServerError`` if invalid live threads are requested. Requests will be issued in batches for each 100 IDs. .. note:: This method doesn't support IDs for live updates. .. warning:: Unlike :meth:`.Reddit.info`, the output of this method may not reflect the order of input. Usage: .. code-block:: python ids = ["3rgnbke2rai6hen7ciytwcxadi", "sw7bubeycai6hey4ciytwamw3a", "t8jnufucss07"] for thread in reddit.live.info(ids): print(thread.title) zids must be a listc3KtdtdD][}||dz}tdjdj |}ddi}j j ||Ed{]y7w)Nrr live_infor!)r-rrR)rangelenrformatr1rr)position ids_chunkr`rSr-rs r generatorz"LiveHelper.info..generator=s!!SXs3 @8c>: {+22sxx 7J2K07~<<++C+???  @@sA.A;1A92A;)r>Iterator[models.LiveThread])rdlistrc)rr-rhr}s`` rinfozLiveHelper.infos.:#t$&CC.  @{rcF|jjtdS)a!Get the currently featured live thread. :returns: The :class:`.LiveThread` object, or ``None`` if there is no currently featured live thread. Usage: .. code-block:: python thread = reddit.live.now() # LiveThread object or None live_nowrTr8s rnowzLiveHelper.nowFs|| 455r)rMrer>models.LiveThread) r_rerqrlrYrmrrrlr>r)r-z list[str]r>r~)r>zmodels.LiveThread | None)r@rArBrCrrirrrDrrrorosUO /$#' $           <(T 6rrocLeZdZdZddZdddddd d dZy) MultiredditHelperz9Provide a set of functions to interact with multireddits.cFd|d|}t|j||dS)zReturn a lazy instance of :class:`.Multireddit`. :param name: The name of the multireddit. :param redditor: A redditor name or :class:`.Redditor` instance who owns the multireddit. z/user/z/m/)namepath)_data)r r)rrredditorrs rrzMultiredditHelper.__call__Ys,zTF+4<<d/KLLrNprivateclassic)description_md icon_name key_color visibilityweighting_schemec |||||Dcgc]}dt|ic}||d} |jjtddt | iScc}w)a;Create a new :class:`.Multireddit`. :param display_name: The display name for the new multireddit. :param subreddits: Subreddits to add to the new multireddit. Can be a list of either :class:`.Subreddit` instances or subreddit display names. :param description_md: Description for the new multireddit, formatted in markdown. :param icon_name: Can be one of: ``"art and design"``, ``"ask"``, ``"books"``, ``"business"``, ``"cars"``, ``"comics"``, ``"cute animals"``, ``"diy"``, ``"entertainment"``, ``"food and drink"``, ``"funny"``, ``"games"``, ``"grooming"``, ``"health"``, ``"life advice"``, ``"military"``, ``"models pinup"``, ``"music"``, ``"news"``, ``"philosophy"``, ``"pictures and gifs"``, ``"science"``, ``"shopping"``, ``"sports"``, ``"style"``, ``"tech"``, ``"travel"``, ``"unusual stories"``, ``"video"``, or ``None``. :param key_color: RGB hex color code of the form ``"#FFFFFF"``. :param visibility: Can be one of: ``"hidden"``, ``"private"``, or ``"public"`` (default: ``"private"``). :param weighting_scheme: Can be one of: ``"classic"`` or ``"fresh"`` (default: ``"classic"``). :returns: The new :class:`.Multireddit` object. r)r display_namerr subredditsrrmultireddit_basemodelr.)rerr2rr) rrrrrrrrsubrs rrizMultiredditHelper.createdsgF-(""9CD#FCH-D$ 0 ||  *models.Multireddit)rrlrrerrlrrlrzlist[str | models.Subreddit]rrerrer>rr@rArBrCrrirDrrrrVszC M&* $ $# )+]#+] +]  +]  +]1+]+]+] +]rrcFeZdZdZd dZddddd d dZy) SubredditHelperz7Provide a set of functions to interact with Subreddits.c0t|j|S)zqReturn a lazy instance of :class:`.Subreddit`. :param display_name: The name of the subreddit. )r)rr)rrs rrzSubredditHelper.__call__s LAAranypublicNdisabled) link_typesubreddit_typer_wikimodec ftjd|j||||xs||d|||S)aCreate a new :class:`.Subreddit`. :param name: The name for the new subreddit. :param link_type: The types of submissions users can make. One of ``"any"``, ``"link"``, or ``"self"`` (default: ``"any"``). :param subreddit_type: One of ``"archived"``, ``"employees_only"``, ``"gold_only"``, ``"gold_restricted"``, ``"private"``, ``"public"``, or ``"restricted"`` (default: ``"public"``). :param title: The title of the subreddit. When ``None`` or ``""`` use the value of ``name``. :param wikimode: One of ``"anyone"``, ``"disabled"``, or ``"modonly"`` (default: ``"disabled"``). Any keyword parameters not provided, or set explicitly to ``None``, will take on a default value assigned by the Reddit server. .. seealso:: :meth:`~.SubredditModeration.update` for documentation of other available settings. )rrrrr_rrD)r_create_or_updater)rrrrr_rother_settingss rrizSubredditHelper.createsH@ ## LL)-4   Dzr)rrer>models.Subreddit)rrerrerrer_rlrrerrr>rrrDrrrrsbAB& ")) )  )  ))) )rrN)rC __future__rjsonrtypingrrr praw.constrpraw.models.baser praw.models.listing.generatorr praw.models.reddit.draftr praw.models.reddit.liver praw.models.reddit.multir rcollections.abcrprawrrrFrorrrDrrrsw!"//%:*.;([0[0|w?(w?tf6f6R9]9]x4h4r