reddit.redditors¶
-
class
praw.models.
Redditors
(reddit: Reddit, _data: Optional[Dict[str, Any]])¶ Redditors is a Listing class that provides various Redditor lists.
-
__init__
(reddit: Reddit, _data: Optional[Dict[str, Any]])¶ Initialize a PRAWModel instance.
Parameters: reddit – An instance of Reddit
.
-
new
(**generator_kwargs) → Generator[[Subreddit, None], None]¶ Return a
ListingGenerator
for new Redditors.:returns Redditor profiles, which are a type of
Subreddit
.Additional keyword arguments are passed in the initialization of
ListingGenerator
.
-
classmethod
parse
(data: Dict[str, Any], reddit: Reddit) → Any¶ Return an instance of
cls
fromdata
.Parameters: - data – The structured data.
- reddit – An instance of
Reddit
.
-
popular
(**generator_kwargs) → Generator[[Subreddit, None], None]¶ Return a
ListingGenerator
for popular Redditors.:returns Redditor profiles, which are a type of
Subreddit
.Additional keyword arguments are passed in the initialization of
ListingGenerator
.
-
search
(query: str, **generator_kwargs) → Generator[[Subreddit, None], None]¶ Return a
ListingGenerator
of Redditors forquery
.Parameters: query – The query string to filter Redditors by. :returns
Redditor
s.Additional keyword arguments are passed in the initialization of
ListingGenerator
.
-
stream
(**stream_options) → Generator[[Subreddit, None], None]¶ 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()
.:returns Redditor profiles, which are a type of
Subreddit
.
-