Skip to content
Back to top
View this page

# RulesWidget

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

  Class to represent a rules widget.

      widgets = reddit.subreddit("test").widgets
      rules_widget = None
      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:

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

  Typical Attributes

  Note

  This table describes attributes that typically belong to objects of this class. PRAW dynamically provides the attributes that Reddit returns via the API. Since those attributes are subject to change on Reddit’s end, 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.

  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.

  __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: praw.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() → praw.models.WidgetModeration

    Get an instance of `WidgetModeration` for this widget.

    Note

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

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

    Return an instance of `cls` from `data`.

    Parameters:

      - data – The structured data.

      - reddit – An instance of `Reddit`.