reddit.subreddits

class praw.models.Subreddits(reddit, _data)

Subreddits is a Listing class that provides various subreddit lists.

Parameters:

• reddit (praw.Reddit)

• _data (dict[str, Any] | None)

__init__(reddit, _data)

Initialize a PRAWBase instance.

Parameters:

• reddit (Reddit) – An instance of Reddit.

• _data (dict[str, Any] | None)

Return type:

None

default(**generator_kwargs)

Return a ListingGenerator for default subreddits.

Additional keyword arguments are passed in the initialization of ListingGenerator.

Return type:

Iterator[Subreddit]

Parameters:

generator_kwargs (str | int | dict[str, str])

new(**generator_kwargs)

Return a ListingGenerator for new subreddits.

Additional keyword arguments are passed in the initialization of ListingGenerator.

Return type:

Iterator[Subreddit]

Parameters:

generator_kwargs (str | int | dict[str, str])

classmethod parse(data, reddit)

Return an instance of cls from data.

Parameters:

• data (dict[str, Any]) – The structured data.

• reddit (Reddit) – An instance of Reddit.

Return type:

PRAWBase

popular(**generator_kwargs)

Return a ListingGenerator for popular subreddits.

Additional keyword arguments are passed in the initialization of ListingGenerator.

Return type:

Iterator[Subreddit]

Parameters:

generator_kwargs (str | int | dict[str, str])

premium(**generator_kwargs)

Return a ListingGenerator for premium subreddits.

Additional keyword arguments are passed in the initialization of ListingGenerator.

Return type:

Iterator[Subreddit]

Parameters:

generator_kwargs (str | int | dict[str, str])

recommended(subreddits, omit_subreddits=None)

Return subreddits recommended for the given list of subreddits.

Parameters:

• subreddits (list[str | Subreddit]) – A list of Subreddit instances and/or subreddit names.

• omit_subreddits (list[str | Subreddit] | None) – A list of Subreddit instances and/or subreddit names to exclude from the results (Reddit’s end may not work as expected).

Return type:

list[Subreddit]

search(query, **generator_kwargs)

Return a ListingGenerator of subreddits matching query.

Subreddits are searched by both their title and description.

Parameters:

• query (str) – The query string to filter subreddits by.

• generator_kwargs (str | int | dict[str, str])

Return type:

Iterator[Subreddit]

Additional keyword arguments are passed in the initialization of ListingGenerator.

See also

search_by_name() to search by subreddit names

search_by_name(query, *, include_nsfw=True, exact=False)

Return list of Subreddits whose names begin with query.

Parameters:

• query (str) – Search for subreddits beginning with this string.

• exact (bool) – Return only exact matches to query (default: False).

• include_nsfw (bool) – Include subreddits labeled NSFW (default: True).

Return type:

list[Subreddit]

stream(**stream_options)

Yield 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 stream_generator().

Return type:

Iterator[Subreddit]

Parameters:

stream_options (str | int | dict[str, str])