SubredditQuarantine¶

class asyncpraw.models.reddit.subreddit.SubredditQuarantine(subreddit)¶

Provides subreddit quarantine related methods.

To opt-in into a quarantined subreddit:

subreddit = await reddit.subreddit("test")
await subreddit.quaran.opt_in()

Parameters:: subreddit (asyncpraw.models.Subreddit)

__init__(subreddit)¶

Initialize a SubredditQuarantine instance.

Parameters:: subreddit (Subreddit) – The Subreddit associated with the quarantine.
Return type:: None

await opt_in()¶

Permit your user access to the quarantined subreddit.

Usage:

subreddit = await reddit.subreddit("QUESTIONABLE")
async for submission in subreddit.hot():  # Raises asyncprawcore.Forbidden
    print(submission)

await subreddit.quaran.opt_in()
async for submission in subreddit.hot():
    print(submission)  # Returns Submission

Return type:: None

await opt_out()¶

Remove access to the quarantined subreddit.

Usage:

subreddit = await reddit.subreddit("QUESTIONABLE")
async for submission in subreddit.hot():
    print(submission)  # Returns Submission

await subreddit.quaran.opt_out()
async for submission in subreddit.hot():  # Raises asyncprawcore.Forbidden
    print(submission)

Return type:: None