SubListing¶

class asyncpraw.models.listing.mixins.redditor.SubListing(reddit: Reddit, base_path: str, subpath: str)¶

Helper class for generating ListingGenerator objects.

__init__(reddit: Reddit, base_path: str, subpath: str)¶

Initialize a SubListing instance.

Parameters

reddit – An instance of Reddit.
base_path – The path to the object up to this point.
subpath – The additional path to this sublisting.

controversial(time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → AsyncIterator[Any]¶

Return a ListingGenerator for controversial submissions.

Parameters: time_filter – Can be one of: all, day, hour, month, week, year (default: all).
Raises: ValueError if time_filter is invalid.

Additional keyword arguments are passed in the initialization of ListingGenerator.

This method can be used like:

reddit.domain("imgur.com").controversial("week")

multireddit = await reddit.multireddit("samuraisam", "programming")
multireddit.controversial("day")

redditor = await reddit.redditor("spez")
redditor.controversial("month")

redditor = await reddit.redditor("spez")
redditor.comments.controversial("year")

redditor = await reddit.redditor("spez")
redditor.submissions.controversial("all")

subreddit = await reddit.subreddit("all")
subreddit.controversial("hour")

hot(**generator_kwargs: Union[str, int, Dict[str, str]]) → AsyncIterator[Any]¶

Return a ListingGenerator for hot items.

Additional keyword arguments are passed in the initialization of ListingGenerator.

This method can be used like:

reddit.domain("imgur.com").hot()

multireddit = await reddit.multireddit("samuraisam", "programming")
multireddit.hot()

redditor = await reddit.redditor("spez")
redditor.hot()

redditor = await reddit.redditor("spez")
redditor.comments.hot()

redditor = await reddit.redditor("spez")
redditor.submissions.hot()

subreddit = await reddit.subreddit("all")
subreddit.hot()

new(**generator_kwargs: Union[str, int, Dict[str, str]]) → AsyncIterator[Any]¶

Return a ListingGenerator for new items.

Additional keyword arguments are passed in the initialization of ListingGenerator.

This method can be used like:

reddit.domain("imgur.com").new()

multireddit = await reddit.multireddit("samuraisam", "programming")
multireddit.new()

redditor = await reddit.redditor("spez")
redditor.new()

redditor = await reddit.redditor("spez")
redditor.comments.new()

redditor = await reddit.redditor("spez")
redditor.submissions.new()

subreddit = await reddit.subreddit("all")
subreddit.new()

classmethod parse(data: Dict[str, Any], reddit: Reddit) → Any¶

Return an instance of cls from data.

Parameters

data – The structured data.
reddit – An instance of Reddit.

top(time_filter: str = 'all', **generator_kwargs: Union[str, int, Dict[str, str]]) → AsyncIterator[Any]¶

Return a ListingGenerator for top submissions.

Parameters: time_filter – Can be one of: all, day, hour, month, week, year (default: all).
Raises: ValueError if time_filter is invalid.

Additional keyword arguments are passed in the initialization of ListingGenerator.

This method can be used like:

reddit.domain("imgur.com").top("week")

multireddit = await reddit.multireddit("samuraisam", "programming")
multireddit.top("day")

redditor = await reddit.redditor("spez")
redditor.top("month")

redditor = await reddit.redditor("spez")
redditor.comments.top("year")

redditor = await reddit.redditor("spez")
redditor.submissions.top("all")

subreddit = await reddit.subreddit("all")
subreddit.top("hour")