PRAW
latest

Getting Started

  • Quick Start
  • Installing PRAW
  • Authenticating via OAuth
  • Configuring PRAW
  • Running Multiple Instances of PRAW
  • Logging in PRAW
  • Ratelimits
  • Frequently Asked Questions

Code Overview

  • The Reddit Instance
  • Working with PRAW’s Models
  • Exceptions in PRAW
  • Other Classes
    • Collection
    • CollectionModeration
    • SubredditCollections
    • SubredditCollectionsModeration
    • SubmissionFlair
    • SubredditFlair
    • SubredditFlairTemplates
    • SubredditLinkFlairTemplates
    • SubredditRedditorFlairTemplates
    • InlineGif
    • InlineImage
    • InlineMedia
    • InlineVideo
    • BaseModNotes
    • ModNote
    • ModNoteMixin
    • RedditModNotes
    • RedditorModNotes
    • SubredditModNotes
    • CommentModeration
    • RuleModeration
    • SubmissionModeration
    • SubredditModeration
    • SubredditRulesModeration
    • SubredditWidgetsModeration
    • ThingModerationMixin
    • UserSubredditModeration
    • WidgetModeration
    • WikiPageModeration
    • LiveContributorRelationship
    • LiveThreadContribution
    • LiveThreadStream
    • LiveUpdateContribution
    • ContributorRelationship
    • ModeratorRelationship
    • SubredditRelationship
    • SubredditEmoji
    • SubredditFilters
    • SubredditModerationStream
    • SubredditQuarantine
    • SubredditRemovalReasons
    • SubredditRules
    • SubredditStream
    • SubredditStylesheet
    • SubredditWidgets
    • SubredditWiki
    • Button
    • ButtonWidget
    • Calendar
    • CalendarConfiguration
    • CommunityList
    • CustomWidget
    • Hover
    • IDCard
    • Image
    • ImageData
    • ImageWidget
    • Menu
    • MenuLink
    • ModeratorsWidget
    • PostFlairWidget
    • RulesWidget
    • Styles
    • Submenu
      • Submenu
        • Submenu.__contains__()
        • Submenu.__getitem__()
        • Submenu.__init__()
        • Submenu.__iter__()
        • Submenu.__len__()
        • Submenu.parse()
    • TextArea
    • Widget
    • Auth
    • BaseList
    • CommentForest
    • CommentHelper
    • Config
    • DomainListing
    • DraftList
    • Emoji
    • FullnameMixin
    • InboxableMixin
    • ListingGenerator
    • ModAction
    • ModNote
    • ModeratedList
    • Modmail
    • ModmailMessage
    • PollData
    • PollOption
    • PartialRedditor
    • PRAWBase
    • Preferences
    • RedditBase
    • RedditorList
    • RedditorStream
    • RemovalReason
    • Rule
    • Stylesheet
    • SubListing
    • SubredditMessage
    • Token Manager
    • Trophy
    • UserSubreddit
    • Util

Tutorials

  • Comment Extraction and Parsing
  • Working with Refresh Tokens
  • Submission Stream Reply Bot

Package Info

  • Change Log
  • Contributing to PRAW
  • Glossary
  • Migrating to PRAW 7.X
  • References
  • Sponsors
  • Index
PRAW
  • Other Classes
  • Submenu
  • Edit on GitHub

Submenu

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

Class to represent a submenu of links inside a Menu.

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

children

A list of the MenuLinks in this submenu. Can be iterated over by iterating over the Submenu (e.g., for menu_link in submenu).

text

The name of the submenu.

__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 BaseList instance.

Parameters:

reddit – An instance of Reddit.

__iter__() → Iterator[Any]

Return an iterator to the list.

__len__() → int

Return the number of items in the list.

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.

Previous Next

© Copyright 2023, Bryce Boe. Revision e69816e5.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
v7.7.0
v7.6.1
v7.6.0
v7.5.0
v7.4.0
v7.3.0
v7.2.0
v7.1.4
v7.1.3
v7.1.2
v7.1.0
v6.5.1
v6.3.0
v5.4.0
v4.6.0
v3.6.2
v2.1.21
Downloads
html
On Read the Docs
Project Home
Builds