o 2g$@sdZddlmZddlmZmZmZddlmZddl m Z ddl m Z dd l mZdd lmZdd lmZdd l mZerBdd lZGdddeZd S)zProvide the Subreddits class.) annotations) TYPE_CHECKINGAnyIterator)warn)API_PATH)_deprecate_args) Subreddit)PRAWBase)ListingGenerator)stream_generatorNc@seZdZdZed-ddZd.d d Zd/ddZd.ddZd.ddZ d.ddZ d0d1ddZ d2ddZ e dd d!d"d#d$d3d&d'Zd4d(d)Zd5d+d,ZdS)6 SubredditszDSubreddits is a Listing class that provides various subreddit lists.subreddit_list!list[str | praw.models.Subreddit]returnstrcCsddd|DS)N,cSsg|]}t|qS)r.0xrrN/home/garg/my-data/venv/lib/python3.10/site-packages/praw/models/subreddits.py sz'Subreddits._to_list..)join)rrrr_to_listszSubreddits._to_listgenerator_kwargsstr | int | dict[str, str]Iterator[praw.models.Subreddit]cKt|jtdfi|S)zReturn a :class:`.ListingGenerator` for default subreddits. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. subreddits_defaultr _redditrselfrrrrdefault  zSubreddits.defaultrcKstdtdd|jdi|S)z?Alias for :meth:`.premium` to maintain backwards compatibility.z9'subreddits.gold' has be renamed to 'subreddits.premium'.r)category stacklevelNr)rDeprecationWarningpremiumr$rrrgold's zSubreddits.goldcKr )zReturn a :class:`.ListingGenerator` for new subreddits. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. subreddits_newr"r$rrrnew0r'zSubreddits.newcKr )zReturn a :class:`.ListingGenerator` for popular subreddits. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. subreddits_popularr"r$rrrpopular=r'zSubreddits.popularcKr )zReturn a :class:`.ListingGenerator` for premium subreddits. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. subreddits_goldr"r$rrrr+Jr'zSubreddits.premiumN subredditsomit_subreddits(list[str | praw.models.Subreddit] | Nonelist[praw.models.Subreddit]cszt|ts d}t||durt|tsd}t|d|p gi}tdj|d}fddjj||d DS) aaReturn subreddits recommended for the given list of subreddits. :param subreddits: A list of :class:`.Subreddit` instances and/or subreddit names. :param omit_subreddits: A list of :class:`.Subreddit` instances and/or subreddit names to exclude from the results (Reddit's end may not work as expected). zsubreddits must be a listNz&omit_subreddits must be a list or Noneomitsub_recommended)r2csg|] }tj|dqS)sr_name)r r#)rsubr%rrrmsz*Subreddits.recommended..params) isinstancelist TypeErrorrrformatr#get)r%r2r3msgr<urlrr:r recommendedWs  zSubreddits.recommendedquerycKs(|j|d|dt|jtdfi|S)aReturn a :class:`.ListingGenerator` of subreddits matching ``query``. Subreddits are searched by both their title and description. :param query: The query string to filter subreddits by. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. .. seealso:: :meth:`.search_by_name` to search by subreddit names r<) argumentskeyqsubreddits_search)_safely_add_argumentsr r#r)r%rErrrrsearchrs  zSubreddits.search include_nsfwexactTF)rLrMboolcs2jjtd|||dd}fdd|dDS)a?Return list of :class:`.Subreddit`\ s whose names begin with ``query``. :param query: Search for subreddits beginning with this string. :param exact: Return only exact matches to ``query`` (default: ``False``). :param include_nsfw: Include subreddits labeled NSFW (default: ``True``). subreddits_name_search)include_over_18rMrE)datacsg|]}j|qSr)r# subredditrr:rrrsz-Subreddits.search_by_name..names)r#postr)r%rErLrMresultrr:rsearch_by_names  zSubreddits.search_by_namecs*jjtdd|id}fdd|DS)zReturn list of Subreddits whose topics match ``query``. :param query: Search for subreddits relevant to the search topic. .. note:: As of 09/01/2020, this endpoint always returns 404. subreddits_by_topicrEr;cs&g|]}|drj|dqS)name)rAr#rRrr:rrrs&z.Subreddits.search_by_topic..)r#rAr)r%rErUrr:rsearch_by_topics zSubreddits.search_by_topicstream_optionscKst|jfi|S)zYield new subreddits as they are created. Subreddits are yielded oldest first. Up to 100 historical subreddits will initially be returned. Keyword arguments are passed to :func:`.stream_generator`. )rr.)r%rZrrrstreams zSubreddits.stream)rrrr)rrrr)rrrr)N)r2rr3r4rr5)rErrrrr)rErrLrNrMrNrr5)rErrr5)rZrrr)__name__ __module__ __qualname____doc__ staticmethodrr&r,r.r0r+rDrKr rVrYr[rrrrrs$      r)r_ __future__rtypingrrrwarningsrconstrutilr r baser listing.generatorr r praw.modelsprawrrrrrs