reddit.redditors

class praw.models.Redditors(reddit, _data)

Redditors is a Listing class that provides various Redditor lists.

Parameters:
__init__(reddit, _data)

Initialize a PRAWBase instance.

Parameters:
Return type:

None

new(**generator_kwargs)

Return a ListingGenerator for new Redditors.

Return type:

Iterator[Subreddit]

Returns:

Redditor profiles, which are a type of Subreddit.

Parameters:

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

Additional keyword arguments are passed in the initialization of ListingGenerator.

classmethod parse(data, reddit)

Return an instance of cls from data.

Parameters:
Return type:

PRAWBase

partial_redditors(ids)

Get user summary data by redditor IDs.

Parameters:

ids (Iterable[str]) – An iterable of redditor fullname IDs.

Return type:

Iterator[PartialRedditor]

Returns:

A iterator producing PartialRedditor objects.

Each ID must be prefixed with t2_.

Invalid IDs are ignored by the server.

popular(**generator_kwargs)

Return a ListingGenerator for popular Redditors.

Return type:

Iterator[Subreddit]

Returns:

Redditor profiles, which are a type of Subreddit.

Parameters:

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

Additional keyword arguments are passed in the initialization of ListingGenerator.

search(query, **generator_kwargs)

Return a ListingGenerator of Redditors for query.

Parameters:

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

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

Return type:

Iterator[Subreddit]

Returns:

Redditors.

Additional keyword arguments are passed in the initialization of ListingGenerator.

stream(**stream_options)

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

Return type:

Iterator[Subreddit]

Returns:

Redditor profiles, which are a type of Subreddit.

Parameters:

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