SubListing

class asyncpraw.models.listing.mixins.redditor.SubListing(reddit, base_path, subpath)

Helper class for generating ListingGenerator objects.

Parameters:
__init__(reddit, base_path, subpath)

Initialize a SubListing instance.

Parameters:

  • reddit (Reddit) – An instance of Reddit.

  • base_path (str) – The path to the object up to this point.

  • subpath (str) – The additional path to this sublisting.

Return type:

None

controversial(*, time_filter='all', **generator_kwargs)

Return a ListingGenerator for controversial items.

Parameters:

  • time_filter (str) – Can be one of: "all", "day", "hour", "month", "week", or "year" (default: "all").

  • generator_kwargs (Unpack[ListingGeneratorKwargs])

Raises:

ValueError if time_filter is invalid.

Return type:

AsyncIterator[Any]

Additional keyword arguments are passed in the initialization of ListingGenerator.

This method can be used like:

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

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

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

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

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

subreddit = await reddit.subreddit("all")
subreddit.controversial(time_filter="hour")
hot(**generator_kwargs)

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(redditor="samuraisam", name="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()
Return type:

AsyncIterator[Any]

Parameters:

generator_kwargs (Unpack[ListingGeneratorKwargs])

new(**generator_kwargs)

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(redditor="samuraisam", name="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()
Return type:

AsyncIterator[Any]

Parameters:

generator_kwargs (Unpack[ListingGeneratorKwargs])

classmethod parse(data, reddit)

Return an instance of cls from data.

Parameters:
Return type:

AsyncPRAWBase

top(*, time_filter='all', **generator_kwargs)

Return a ListingGenerator for top items.

Parameters:

  • time_filter (str) – Can be one of: "all", "day", "hour", "month", "week", or "year "``(default: ``"all").

  • generator_kwargs (Unpack[ListingGeneratorKwargs])

Raises:

ValueError if time_filter is invalid.

Return type:

AsyncIterator[Any]

Additional keyword arguments are passed in the initialization of ListingGenerator.

This method can be used like:

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

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

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

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

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

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