Skip to content
Back to top
View this page

# PostFlairWidget

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

  Class to represent a post flair widget.

  Find an existing one:

      post_flair_widget = None
      widgets = reddit.subreddit("test").widgets
      for widget in widgets.sidebar:
          if isinstance(widget, praw.models.PostFlairWidget):
              post_flair_widget = widget
              break

      for flair in post_flair_widget:
          print(flair)
          print(post_flair_widget.templates[flair])

  Create one:

      subreddit = reddit.subreddit("test")
      widgets = subreddit.widgets
      flairs = [f["id"] for f in subreddit.flair.link_templates]
      styles = {"backgroundColor": "#FFFF66", "headerColor": "#3333EE"}
      post_flair = widgets.mod.add_post_flair_widget(
          short_name="Some flairs", display="list", order=flairs, styles=styles
      )

  For more information on creation, see `add_post_flair_widget()`.

  Update one:

      new_styles = {"backgroundColor": "#FFFFFF", "headerColor": "#FF9900"}
      post_flair = post_flair.mod.update(shortName="My fav flairs", styles=new_styles)

  Delete one:

      post_flair.mod.delete()

  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
  --- | ---
  `display` | The display style of the widget, either `"cloud"` or `"list"`.
  `id` | The widget ID.
  `kind` | The widget kind (always `"post-flair"`).
  `order` | A list of the flair IDs in this widget. Can be iterated over by iterating over the `PostFlairWidget` (e.g., `for flair_id in post_flair`).
  `shortName` | The short name of the widget.
  `styles` | A `dict` with the keys `"backgroundColor"` and `"headerColor"`.
  `subreddit` | The `Subreddit` the button widget belongs to.
  `templates` | A `dict` that maps flair IDs to dictionaries that describe flairs.

  __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 `Widget` 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`.