reddit.redditors#
- class praw.models.Redditors(reddit: praw.Reddit, _data: dict[str, Any] | None)#
Redditors is a Listing class that provides various
Redditorlists.- __init__(reddit: praw.Reddit, _data: dict[str, Any] | None)#
Initialize a
PRAWBaseinstance.- Parameters:
reddit – An instance of
Reddit.
- new(**generator_kwargs: str | int | dict[str, str]) Iterator[praw.models.Subreddit]#
Return a
ListingGeneratorfor newRedditors.Additional keyword arguments are passed in the initialization of
ListingGenerator.
- classmethod parse(data: dict[str, Any], reddit: praw.Reddit) Any#
Return an instance of
clsfromdata.- Parameters:
data – The structured data.
reddit – An instance of
Reddit.
- partial_redditors(ids: Iterable[str]) Iterator[PartialRedditor]#
Get user summary data by redditor IDs.
- Parameters:
ids – An iterable of redditor fullname IDs.
- Returns:
A iterator producing
PartialRedditorobjects.
Each ID must be prefixed with
t2_.Invalid IDs are ignored by the server.
- popular(**generator_kwargs: str | int | dict[str, str]) Iterator[praw.models.Subreddit]#
Return a
ListingGeneratorfor popularRedditors.Additional keyword arguments are passed in the initialization of
ListingGenerator.
- search(query: str, **generator_kwargs: str | int | dict[str, str]) Iterator[praw.models.Subreddit]#
Return a
ListingGeneratorof Redditors forquery.- Parameters:
query – The query string to filter Redditors by.
- Returns:
Redditors.
Additional keyword arguments are passed in the initialization of
ListingGenerator.
- stream(**stream_options: str | int | dict[str, str]) Iterator[praw.models.Subreddit]#
Yield new Redditors as they are created.
Redditors are yielded oldest first. Up to 100 historical Redditors will initially be returned.
Keyword arguments are passed to
stream_generator().