reddit.subreddits¶
- class asyncpraw.models.Subreddits(reddit: asyncpraw.Reddit, _data: dict[str, Any] | None)¶
Subreddits is a Listing class that provides various subreddit lists.
- __init__(reddit: asyncpraw.Reddit, _data: dict[str, Any] | None)¶
Initialize a
AsyncPRAWBase
instance.- Parameters:
reddit – An instance of
Reddit
.
- default(**generator_kwargs: str | int | dict[str, str]) AsyncIterator[asyncpraw.models.Subreddit] ¶
Return a
ListingGenerator
for default subreddits.Additional keyword arguments are passed in the initialization of
ListingGenerator
.
- gold(**generator_kwargs: Any) AsyncIterator[asyncpraw.models.Subreddit] ¶
Alias for
premium()
to maintain backwards compatibility.
- new(**generator_kwargs: str | int | dict[str, str]) AsyncIterator[asyncpraw.models.Subreddit] ¶
Return a
ListingGenerator
for new subreddits.Additional keyword arguments are passed in the initialization of
ListingGenerator
.
- classmethod parse(data: dict[str, Any], reddit: asyncpraw.Reddit) AsyncPRAWBase ¶
Return an instance of
cls
fromdata
.- Parameters:
data – The structured data.
reddit – An instance of
Reddit
.
- popular(**generator_kwargs: str | int | dict[str, str]) AsyncIterator[asyncpraw.models.Subreddit] ¶
Return a
ListingGenerator
for popular subreddits.Additional keyword arguments are passed in the initialization of
ListingGenerator
.
Return a
ListingGenerator
for premium subreddits.Additional keyword arguments are passed in the initialization of
ListingGenerator
.
- await recommended(subreddits: list[str | asyncpraw.models.Subreddit], omit_subreddits: list[str | asyncpraw.models.Subreddit] | None = None) list[asyncpraw.models.Subreddit] ¶
Return subreddits recommended for the given list of subreddits.
- search(query: str, **generator_kwargs: str | int | dict[str, str]) AsyncIterator[asyncpraw.models.Subreddit] ¶
Return a
ListingGenerator
of subreddits matchingquery
.Subreddits are searched by both their title and description.
- Parameters:
query – The query string to filter subreddits by.
Additional keyword arguments are passed in the initialization of
ListingGenerator
.See also
search_by_name()
to search by subreddit names
- async for ... in search_by_name(query: str, *, include_nsfw: bool = True, exact: bool = False) list[asyncpraw.models.Subreddit] ¶
Return list of
Subreddit
s whose names begin withquery
.- Parameters:
query – Search for subreddits beginning with this string.
exact – Return only exact matches to
query
(default:False
).include_nsfw – Include subreddits labeled NSFW (default:
True
).
- async for ... in search_by_topic(query: str) AsyncIterator[asyncpraw.models.Subreddit] ¶
Return list of Subreddits whose topics match
query
.- Parameters:
query – Search for subreddits relevant to the search topic.
Note
As of 09/01/2020, this endpoint always returns 404.
- stream(**stream_options: str | int | dict[str, str]) AsyncIterator[asyncpraw.models.Subreddit] ¶
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()
.