Rule

class asyncpraw.models.Rule(reddit: Reddit, subreddit: Optional[Subreddit] = None, short_name: Optional[str] = None, _data: Optional[Dict[str, str]] = None)

An individual Rule object.

Typical Attributes

This table describes attributes that typically belong to objects of this class. Since attributes are dynamically provided (see Determine Available Attributes of an Object), there is not a guarantee that these attributes will always be present, nor is this list necessarily comprehensive.

Attribute	Description
created_utc	Time the rule was created, represented in Unix Time.
description	The description of the rule, if provided, otherwise a blank string.
kind	The kind of rule. Can be "link", comment", or "all".
priority	Represents where the rule is ranked. For example, the first rule is at priority 0. Serves as an index number on the list of rules.
short_name	The name of the rule.
violation_reason	The reason that is displayed on the report menu for the rule.

__init__(reddit: Reddit, subreddit: Optional[Subreddit] = None, short_name: Optional[str] = None, _data: Optional[Dict[str, str]] = None)

Construct an instance of the Rule object.

await load()

Re-fetches the object.

This is used to explicitly fetch or re-fetch the object from reddit. This method can be used on any RedditBase object.

await reddit_base_object.load()

mod

Contain methods used to moderate rules.

To delete "No spam" from the subreddit "NAME" try:

subreddit = await reddit.subreddit("NAME")
rule = await subreddit.rules.get_rule("No Spam")
await rule.mod.delete()

To update "No spam" from the subreddit "NAME" try:

subreddit = await reddit.subreddit("NAME")
await subreddit.rules.get_rule("No spam")
await rule.mod.update(description="Don't do this!", violation_reason="Spam post")

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.

Note

This list of attributes is not complete. Async PRAW dynamically provides the attributes that Reddit returns via the API. Because those attributes are subject to change on Reddit’s end, Async PRAW makes no effort to document them, other than to instruct you on how to discover what is available. See Determine Available Attributes of an Object for detailed information.