ImageWidget¶

class praw.models.ImageWidget(reddit, _data)¶

Class to represent an image widget.

Find an existing one:

image_widget = None
widgets = reddit.subreddit("redditdev").widgets
for widget in widgets.sidebar:
    if isinstance(widget, praw.models.ImageWidget):
        image_widget = widget
        break

for image in image_widget:
    print(image.url)

Create one (requires proper moderator permissions):

widgets = reddit.subreddit("redditdev").widgets
image_paths = ["/path/to/image1.jpg", "/path/to/image2.png"]
image_dicts = [
    {
        "width": 600,
        "height": 450,
        "linkUrl": '',
        "url": widgets.mod.upload_image(img_path),
    }
    for img_path in image_paths
]
styles = {"backgroundColor": "#FFFF66", "headerColor": "#3333EE"}
image_widget = widgets.mod.add_image_widget("My cool pictures", image_dicts, styles)

For more information on creation, see add_image_widget().

Update one (requires proper moderator permissions):

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

Delete one (requires proper moderator permissions):

image_widget.mod.delete()

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 `Image`s in this widget. Can be iterated over by iterating over the `ImageWidget` (e.g. `for img in image_widget`).
`id`	The widget ID.
`kind`	The widget kind (always `"image"`).
`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, _data)¶: Initialize an instance of the class.

__iter__() → Iterator[Any]¶: Return an iterator to the list.

__len__() → int ¶: Return the number of items in the list.

mod()¶: 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: Reddit) → Any¶

Return an instance of cls from data.

Parameters

data – The structured data.
reddit – An instance of Reddit.