Draft¶

class praw.models.Draft(reddit, id=None, _data=None)¶

A class that represents a Reddit submission draft.

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
`link_flair_template_id`	The link flair’s ID.
`link_flair_text`	The link flair’s text content, or `None` if not flaired.
`modified`	Time the submission draft was modified, represented in Unix Time.
`original_content`	Whether the submission draft will be set as original content.
`selftext`	The submission draft’s selftext. `None` if a link submission draft.
`spoiler`	Whether the submission will be marked as a spoiler.
`subreddit`	Provides an instance of `Subreddit` or `UserSubreddit` (if set).
`title`	The title of the submission draft.
`url`	The URL the submission draft links to.

Parameters:

reddit (praw.Reddit)
id (str | None)
_data (dict[str, Any] | None)

__init__(reddit, id=None, _data=None)¶

Initialize a Draft instance.

Parameters:

reddit (Reddit)
id (str | None)
_data (dict[str, Any] | None)

Return type:

None

delete()¶

Delete the Draft.

Example usage:

draft = reddit.drafts("124862bc-e1e9-11eb-aa4f-e68667a77cbb")
draft.delete()

Return type:: None

classmethod parse(data, reddit)¶

Return an instance of cls from data.

Parameters:

data (dict[str, Any]) – The structured data.
reddit (Reddit) – An instance of Reddit.

Return type:

PRAWBase

submit(*, flair_id=None, flair_text=None, nsfw=None, selftext=None, spoiler=None, subreddit=None, title=None, url=None, **submit_kwargs)¶

Submit a draft.

Parameters:

flair_id (str | None) – The flair template to select (default: None).
flair_text (str | None) – If the template’s flair_text_editable value is True, this value will set a custom text (default: None). flair_id is required when flair_text is provided.
nsfw (bool | None) – Whether or not the submission should be marked NSFW (default: None).
selftext (str | None) – The Markdown formatted content for a text submission. Use an empty string, "", to make a title-only submission (default: None).
spoiler (bool | None) – Whether or not the submission should be marked as a spoiler (default: None).
subreddit (str | Subreddit | UserSubreddit | None) – The subreddit to submit the draft to. This accepts a subreddit display name, Subreddit object, or UserSubreddit object.
title (str | None) – The title of the submission (default: None).
url (str | None) – The URL for a link submission (default: None).
submit_kwargs (Any)

Return type:

Submission

Returns:

A Submission object for the newly created submission.

Note

Parameters set here will override their respective Draft attributes.

Additional keyword arguments are passed to the Subreddit.submit() method.

For example, to submit a draft as is:

draft = reddit.drafts("5f87d55c-e4fb-11eb-8965-6aeb41b0880e")
submission = draft.submit()

For example, to submit a draft but use a different title than what is set:

draft = reddit.drafts("5f87d55c-e4fb-11eb-8965-6aeb41b0880e")
submission = draft.submit(title="New Title")

See also

submit() to make a submission directly.

update(*, flair_id=None, flair_text=None, is_public_link=None, nsfw=None, original_content=None, selftext=None, send_replies=None, spoiler=None, subreddit=None, title=None, url=None, **draft_kwargs)¶

Update the Draft.

Note

Only provided values will be updated.

Parameters:

flair_id (str | None) – The flair template to select.
flair_text (str | None) – If the template’s flair_text_editable value is True, this value will set a custom text. flair_id is required when flair_text is provided.
is_public_link (bool | None) – Whether to enable public viewing of the draft before it is submitted.
nsfw (bool | None) – Whether the draft should be marked NSFW.
original_content (bool | None) – Whether the submission should be marked as original content.
selftext (str | None) – The Markdown formatted content for a text submission draft. Use None to make a title-only submission draft. selftext can not be provided if url is provided.
send_replies (bool | None) – When True, messages will be sent to the submission author when comments are made to the submission.
spoiler (bool | None) – Whether the submission should be marked as a spoiler.
subreddit (str | Subreddit | UserSubreddit | None) – The subreddit to create the draft for. This accepts a subreddit display name, Subreddit object, or UserSubreddit object.
title (str | None) – The title of the draft.
url (str | None) – The URL for a link submission draft. url can not be provided if selftext is provided.
draft_kwargs (Any)

Return type:

None

Additional keyword arguments can be provided to handle new parameters as Reddit introduces them.

For example, to update the title of a draft do:

draft = reddit.drafts("5f87d55c-e4fb-11eb-8965-6aeb41b0880e")
draft.update(title="New title")