o 2g4@sdZddlmZddlmZddlmZmZmZddl m Z ddl m Z dd l mZdd lmZdd lmZdd lmZmZerDdd lZGdddeZGdddeZGdddeZGdddeZd S)zProvide the helper classes.) annotations)dumps) TYPE_CHECKINGAny Generator)API_PATH)_deprecate_args)PRAWBase)Draft) LiveThread) Multireddit SubredditNc @sLeZdZdZ d!d"ddZd#d d Zddd d d dd d dddd d$dd ZdS)% 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. Ndraft_id str | Nonereturn+list[praw.models.Draft] | praw.models.DraftcCs|dur t|j|dS|S)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) Nid)r _reddit _draft_list)selfrrK/home/garg/my-data/venv/lib/python3.10/site-packages/praw/models/helpers.py__call__szDraftHelper.__call__list[praw.models.Draft]cCs|jjtdddidS)zjGet a list of :class:`.Draft` instances. :returns: A list of :class:`.Draft` instances. draftsmd_bodyTparamsrgetrrrrrr:szDraftHelper._draft_listFT flair_id flair_textis_public_linknsfworiginal_contentselftext send_repliesspoiler subreddittitleurlr&r'r(boolr)r*r+r,r-r.>str | praw.models.Subreddit | praw.models.UserSubreddit | Noner/r0 draft_kwargsrpraw.models.Draftc Ksf|r | r d} t| t| tr|j| } tjd||||||||| | | d | }|jjtd|dS)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.r%draftdataNr) TypeError isinstancestrrr.r _prepare_datapostr)rr&r'r(r)r*r+r,r-r.r/r0r3msgr7rrrcreateBs*2   zDraftHelper.create)N)rrrr)rr)r&rr'rr(r1r)r1r*r1r+rr,r1r-r1r.r2r/rr0rr3rrr4)__name__ __module__ __qualname____doc__rrr>rrrrrs"  rc@sPeZdZdZdddZedd d d d d d ddddZdddZdddZd S) LiveHelperzDProvide a set of functions to interact with :class:`.LiveThread`\ s.rr:rpraw.models.LiveThreadcCst|j|dS)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``. r)r r)rrrrrrs zLiveHelper.__call__r/ descriptionr) resourcesNF)rEr)rFrr1cCs|jjtd||||ddS)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)rEr)rFr/r6)rr<r)rr/rEr)rFrrrr>szLiveHelper.createids list[str]-Generator[praw.models.LiveThread, None, None]cs*tts d}t|fdd}|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 listc3s`tdtdD]$}||d}tdjd|d}ddi}jj||dEdHq dS)Nrd live_info,)rHlimitr )rangelenrformatjoinrr#)position ids_chunkr0r!rHrrr generatorsz"LiveHelper.info..generator)r9listr8)rrHr=rVrrUrinfos zLiveHelper.infopraw.models.LiveThread | NonecCs|jtdS)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_nowr"r$rrrnows zLiveHelper.now)rr:rrD) r/r:rErr)r1rFr:rrD)rHrIrrJ)rrY) r?r@rArBrr r>rXr[rrrrrCs   *rCc@sPeZdZdZeddddd Zed d d d ddddddddddddZdS)MultiredditHelperz9Provide a set of functions to interact with multireddits.redditornamer:str | praw.models.Redditorrpraw.models.MultiredditcCs$d|d|}t|j||ddS)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/)r^path)_data)rr)rr^r]rarrrrs zMultiredditHelper.__call__ display_name subredditsdescription_md icon_name key_color visibilityweighting_schemeNprivateclassic)rerfrgrhrirstr | praw.models.Subredditc Cs:||||dd|D||d}|jjtddt|idS)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. cSsg|]}dt|iqS)r^)r:).0subrrr 6sz,MultiredditHelper.create..)rercrfrgrdrhrimultireddit_basemodelr6)rr<rr) rrercrfrgrdrhrirqrrrr>s,  zMultiredditHelper.create)r^r:r]r_rr`)rerrcr:rfrrgrrdrlrhr:rir:rr`)r?r@rArBr rr>rrrrr\s&   r\c@s@eZdZdZdddZedd d d d d dddddddZdS)SubredditHelperz7Provide a set of functions to interact with Subreddits.rcr:rpraw.models.SubredditcCs>|}|dkr |jS|dkr|jjddSt|j|dS)zqReturn a lazy instance of :class:`.Subreddit`. :param display_name: The name of the subreddit. randomrandnsfwT)r))rc)lowerrrandom_subredditr)rrc lower_namerrrrBs  zSubredditHelper.__call__r^r/ link_typesubreddit_typewikimodeanypublicNdisabled)ryrzr/r{rother_settingsc Ks,tjd|j||||p ||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. )rryr^rzr/r{Nr)r_create_or_updater)rr^ryrzr/r{rrrrr>Qs! zSubredditHelper.create)rcr:rrs)r^r:ryr:rzr:r/rr{r:rrrrs)r?r@rArBrr r>rrrrrr?s rr)rB __future__rjsonrtypingrrrconstrutilr baser reddit.draftr reddit.liver reddit.multirr praw.modelsprawrrCr\rrrrrrs        xjJ