Menu¶
-
class
asyncpraw.models.
Menu
(reddit, _data)¶ Class to represent the top menu widget of a subreddit.
Menus can generally be found as the first item in a subreddit’s top bar.
subreddit = await reddit.subreddit("redditdev") topbar = [widget async for widget in subreddit.widgets.topbar()] if len(topbar) > 0: probably_menu = topbar[0] assert isinstance(probably_menu, praw.models.Menu) for item in probably_menu: if isinstance(item, praw.models.Submenu): print(item.text) for child in item: print("\t", child.text, child.url) else: # MenuLink print(item.text, item.url)
Create one (requires proper moderator permissions):
subreddit = await reddit.subreddit("redditdev") widgets = subreddit.widgets menu_contents = [ {"text": "My homepage", "url": "https://example.com"}, { "text": "Python packages", "children": [ {"text": "PRAW", "url": "https://praw.readthedocs.io/"}, {"text": "requests", "url": "http://python-requests.org"}, ], }, {"text": "Reddit homepage", "url": "https://reddit.com"}, ] menu = await widgets.mod.add_menu(menu_contents)
For more information on creation, see
add_menu()
.Update one (requires proper moderator permissions):
menu_items = list(menu) menu_items.reverse() menu = await menu.mod.update(data=menu_items)
Delete one (requires proper moderator permissions):
await menu.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
MenuLink
s andSubmenu
s in this widget. Can be iterated over by iterating over theMenu
(e.g.for item in menu
).id
The widget ID.
kind
The widget kind (always
"menu"
).subreddit
The
Subreddit
the button widget belongs to.-
__init__
(reddit, _data)¶ Initialize an instance of the class.
-
__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.