Submission¶

class praw.models.Submission(reddit: Reddit, id: Optional[str] = None, url: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)¶

A class for submissions to reddit.

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 comprehensive in any way.

Attribute	Description
`author`	Provides an instance of `Redditor`.
`clicked`	Whether or not the submission has been clicked by the client.
`comments`	Provides an instance of `CommentForest`.
`created_utc`	Time the submission was created, represented in Unix Time.
`distinguished`	Whether or not the submission is distinguished.
`edited`	Whether or not the submission has been edited.
`id`	ID of the submission.
`is_original_content`	Whether or not the submission has been set as original content.
`is_self`	Whether or not the submission is a selfpost (text-only).
`link_flair_template_id`	The link flair’s ID, or None if not flaired.
`link_flair_text`	The link flair’s text content, or None if not flaired.
`locked`	Whether or not the submission has been locked.
`name`	Fullname of the submission.
`num_comments`	The number of comments on the submission.
`over_18`	Whether or not the submission has been marked as NSFW.
`permalink`	A permalink for the submission.
`score`	The number of upvotes for the submission.
`selftext`	The submissions’ selftext - an empty string if a link post.
`spoiler`	Whether or not the submission has been marked as a spoiler.
`stickied`	Whether or not the submission is stickied.
`subreddit`	Provides an instance of `Subreddit`.
`title`	The title of the submission.
`upvote_ratio`	The percentage of upvotes from all votes on the submission.
`url`	The URL the submission links to, or the permalink if a selfpost.

__init__(reddit: Reddit, id: Optional[str] = None, url: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)¶

Initialize a Submission instance.

Parameters:	reddit – An instance of `Reddit`. id – A reddit base36 submission ID, e.g., `2gmzqe`. url – A URL supported by `id_from_url()`.

Either id or url can be provided, but not both.

clear_vote()¶

Clear the authenticated user’s vote on the object.

Note

Votes must be cast by humans. That is, API clients proxying a human’s action one-for-one are OK, but bots deciding how to vote on content or amplifying a human’s vote are not. See the reddit rules for more details on what constitutes vote cheating. [Ref]

Example usage:

submission = reddit.submission(id='5or86n')
submission.clear_vote()

comment = reddit.comment(id='dxolpyc')
comment.clear_vote()

comments¶

Provide an instance of CommentForest.

This attribute can use used, for example, to obtain a flat list of comments, with any MoreComments removed:

submission.comments.replace_more(limit=0)
comments = submission.comments.list()

Sort order and comment limit can be set with the comment_sort and comment_limit attributes before comments are fetched, including any call to replace_more():

submission.comment_sort = 'new'
comments = submission.comments.list()

See Extracting comments with PRAW for more on working with a CommentForest.

crosspost(subreddit: praw.models.reddit.subreddit.Subreddit, title: Optional[str] = None, send_replies: bool = True, flair_id: Optional[str] = None, flair_text: Optional[str] = None, nsfw: bool = False, spoiler: bool = False) → _Submission¶

Crosspost the submission to a subreddit.

Note

Be aware you have to be subscribed to the target subreddit.

Parameters:

subreddit – Name of the subreddit or Subreddit object to crosspost into.
title – Title of the submission. Will use this submission’s title if None (default: None).
flair_id – The flair template to select (default: None).
flair_text – If the template’s flair_text_editable value is True, this value will set a custom text (default: None).
send_replies – When True, messages will be sent to the submission author when comments are made to the submission (default: True).
nsfw – Whether or not the submission should be marked NSFW (default: False).
spoiler – Whether or not the submission should be marked as a spoiler (default: False).

Returns:

A Submission object for the newly created submission.

Example usage:

submission = reddit.submission(id='5or86n')
cross_post = submission.crosspost(subreddit="learnprogramming",
                                  send_replies=False)