class asyncpraw.models.RulesWidget(reddit: asyncpraw.Reddit, _data: Dict[str, Any])

Class to represent a rules widget.

subreddit = await reddit.subreddit("test")
widgets = subreddit.widgets
rules_widget = None
async for widget in widgets.sidebar():
    if isinstance(widget, asyncpraw.models.RulesWidget):
        rules_widget = widget
from pprint import pprint


Update one:

new_styles = {"backgroundColor": "#FFFFFF", "headerColor": "#FF9900"}
await rules_widget.mod.update(
    display="compact", shortName="The LAWS", styles=new_styles

Typical Attributes


This table describes attributes that typically belong to objects of this class. Async PRAW dynamically provides the attributes that Reddit returns via the API. Since those attributes are subject to change on Reddit’s end, Async PRAW makes no effort to document any new/removed/changed attributes, other than to instruct you on how to discover what is available. As a result, this table of attributes may not be complete. See Determine Available Attributes of an Object for detailed information.

If you would like to add an attribute to this table, feel free to open a pull request.




A list of the subreddit rules. Can be iterated over by iterating over the RulesWidget (e.g., for rule in rules_widget).


The display style of the widget, either "full" or "compact".


The widget ID.


The widget kind (always "subreddit-rules").


The short name of the widget.


A dict with the keys "backgroundColor" and "headerColor".


The Subreddit the button widget belongs to.

__contains__(item: Any) bool

Test if item exists in the list.

__getitem__(index: int) Any

Return the item at position index in the list.

__init__(reddit: asyncpraw.Reddit, _data: Dict[str, Any])

Initialize a RulesWidget instance.

__iter__() Iterator[Any]

Return an iterator to the list.

__len__() int

Return the number of items in the list.

mod() asyncpraw.models.WidgetModeration

Get an instance of WidgetModeration for this widget.


Using any of the methods of WidgetModeration will likely make outdated the data in the SubredditWidgets that this widget belongs to. To remedy this, call refresh().

classmethod parse(data: Dict[str, Any], reddit: asyncpraw.Reddit) Any

Return an instance of cls from data.

  • data – The structured data.

  • reddit – An instance of Reddit.