SubredditRelationship

class asyncpraw.models.reddit.subreddit.SubredditRelationship(subreddit, relationship)

Represents a relationship between a Redditor and Subreddit.

Instances of this class can be iterated through in order to discover the Redditors that make up the relationship.

For example, banned users of a subreddit can be iterated through like so:

subreddit = await reddit.subreddit("test")
async for ban in subreddit.banned():
    print("{ban}: {ban.note}")
Parameters:
__call__(redditor=None, **generator_kwargs)

Return a ListingGenerator for Redditors in the relationship.

Parameters:

  • redditor (str | Redditor | None) – When provided, yield at most a single Redditor instance. This is useful to confirm if a relationship exists, or to fetch the metadata associated with a particular relationship (default: None).

  • generator_kwargs (Any)

Return type:

AsyncIterator[Redditor]

Additional keyword arguments are passed in the initialization of ListingGenerator.

__init__(subreddit, relationship)

Initialize a SubredditRelationship instance.

Parameters:

  • subreddit (Subreddit) – The Subreddit for the relationship.

  • relationship (str) – The name of the relationship.

Return type:

None

await add(redditor, **other_settings)

Add redditor to this relationship.

Parameters:
Return type:

None

await remove(redditor)

Remove redditor from this relationship.

Parameters:

redditor (str | Redditor) – A redditor name or Redditor instance.

Return type:

None