RulesWidget¶
-
class
asyncpraw.models.
RulesWidget
(reddit, _data)¶ Class to represent a rules widget.
subreddit = await reddit.subreddit("redditdev") widgets = subreddit.widgets rules_widget = None async for widget in widgets.sidebar(): if isinstance(widget, praw.models.RulesWidget): rules_widget = widget break from pprint import pprint pprint(rules_widget.data)
Update one (requires proper moderator permissions):
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. 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 complete.
Attribute
Description
data
A list of the subreddit rules. Can be iterated over by iterating over the
RulesWidget
(e.g.for rule in rules_widget
).display
The display style of the widget, either
"full"
or"compact"
.id
The widget ID.
kind
The widget kind (always
"subreddit-rules"
).shortName
The short name of the widget.
styles
A
dict
with the keys"backgroundColor"
and"headerColor"
.subreddit
The
Subreddit
the button widget belongs to.-
__init__
(reddit, _data)¶ Initialize the rules widget.
-
__iter__
() → Iterator[Any]¶ Return an iterator to the list.
-
mod
()¶ Get an instance of
WidgetModeration
for this widget.Note
Using any of the methods of
WidgetModeration
will likely make outdated the data in theSubredditWidgets
that this widget belongs to. To remedy this, callrefresh()
.
-
classmethod
parse
(data: Dict[str, Any], reddit: asyncpraw.Reddit) → Any¶ Return an instance of
cls
fromdata
.- 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.