Skip to content
Back to top
View this page

# SubredditStream

class praw.models.reddit.subreddit.SubredditStream(subreddit: praw.models.Subreddit)

  Provides submission and comment streams.

  __init__(subreddit: praw.models.Subreddit)

    Initialize a `SubredditStream` instance.

    Parameters:

      subreddit – The subreddit associated with the streams.

  comments(**stream_options: Any) → Generator[praw.models.Comment, None, None]

    Yield new comments as they become available.

    Comments are yielded oldest first. Up to 100 historical comments will initially be returned.

    Keyword arguments are passed to `stream_generator()`.

    Note

    While PRAW tries to catch all new comments, some high-volume streams, especially the r/all stream, may drop some comments.

    For example, to retrieve all new comments made to r/test, try:

        for comment in reddit.subreddit("test").stream.comments():
            print(comment)

    To only retrieve new submissions starting when the stream is created, pass `skip_existing=True`:

        subreddit = reddit.subreddit("test")
        for comment in subreddit.stream.comments(skip_existing=True):
            print(comment)

  submissions(**stream_options: Any) → Generator[praw.models.Submission, None, None]

    Yield new `Submission`s as they become available.

    Submissions are yielded oldest first. Up to 100 historical submissions will initially be returned.

    Keyword arguments are passed to `stream_generator()`.

    Note

    While PRAW tries to catch all new submissions, some high-volume streams, especially the r/all stream, may drop some submissions.

    For example, to retrieve all new submissions made to all of Reddit, try:

        for submission in reddit.subreddit("all").stream.submissions():
            print(submission)