SubredditRelationship¶
- class praw.models.reddit.subreddit.SubredditRelationship(subreddit: praw.models.Subreddit, relationship: str)¶
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:
for ban in reddit.subreddit("redditdev").banned(): print(f"{ban}: {ban.note}")
- __call__(redditor: Optional[Union[praw.models.Redditor, str]] = None, **generator_kwargs) → Iterator[praw.models.Redditor]¶
Return a
ListingGenerator
for Redditors in the relationship.- Parameters
redditor – 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).
Additional keyword arguments are passed in the initialization of
ListingGenerator
.
- __init__(subreddit: praw.models.Subreddit, relationship: str)¶
Create a SubredditRelationship instance.
- Parameters
subreddit – The subreddit for the relationship.
relationship – The name of the relationship.
- add(redditor: Union[str, praw.models.Redditor], **other_settings: Any)¶
Add
redditor
to this relationship.- Parameters
redditor – A redditor name (e.g.,
"spez"
) orRedditor
instance.
- remove(redditor: Union[str, praw.models.Redditor])¶
Remove
redditor
from this relationship.- Parameters
redditor – A redditor name (e.g.,
"spez"
) orRedditor
instance.