ModeratorsWidget

class praw.models.ModeratorsWidget(reddit, _data)

Class to represent a moderators widget.

widgets = reddit.subreddit("test").widgets
print(widgets.moderators_widget)

Update one:

new_styles = {"backgroundColor": "#FFFFFF", "headerColor": "#FF9900"}
widgets.moderators_widget.mod.update(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

id

The widget ID.

kind

The widget kind (always "moderators").

mods

A list of the Redditors that moderate the subreddit. Can be iterated over by iterating over the ModeratorsWidget (e.g., for mod in widgets.moderators_widget).

styles

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

subreddit

The Subreddit the button widget belongs to.

totalMods

The total number of moderators in the subreddit.
Parameters:
__contains__(item)

Test if item exists in the list.

Return type:

bool

Parameters:

item (Any)

__getitem__(index)

Return the item at position index in the list.

Return type:

Any

Parameters:

index (int)

__init__(reddit, _data)

Initialize a ModeratorsWidget instance.

Parameters:
Return type:

None

__iter__()

Return an iterator to the list.

Return type:

Iterator[Any]

__len__()

Return the number of items in the list.

Return type:

int

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().

Return type:

WidgetModeration

classmethod parse(data, reddit)

Return an instance of cls from data.

Parameters:
Return type:

PRAWBase