reddit.drafts

class praw.models.DraftHelper(reddit, _data)

Provide a set of functions to interact with Draft instances.

Note

The methods provided by this class will only work on the currently authenticated user’s Drafts.

Parameters:
__call__(draft_id=None)

Return a list of Draft instances.

Parameters:

draft_id (str | None) – When provided, this returns a Draft instance (default: None).

Return type:

list[Draft] | Draft

Returns:

A Draft instance if draft_id is provided. Otherwise, a list of Draft objects.

Note

Drafts fetched using a specific draft ID are lazily loaded, so you might have to access an attribute to get all the expected attributes.

This method can be used to fetch a specific draft by ID, like so:

draft_id = "124862bc-e1e9-11eb-aa4f-e68667a77cbb"
draft = reddit.drafts(draft_id)
print(draft)
__init__(reddit, _data)

Initialize a PRAWBase instance.

Parameters:
Return type:

None

create(*, flair_id=None, flair_text=None, is_public_link=False, nsfw=False, original_content=False, selftext=None, send_replies=True, spoiler=False, subreddit=None, title=None, url=None, **draft_kwargs)

Create a new 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.

  • is_public_link (bool) – Whether to enable public viewing of the draft before it is submitted (default: False).

  • nsfw (bool) – Whether the draft should be marked NSFW (default: False).

  • original_content (bool) – Whether the submission should be marked as original content (default: False).

  • selftext (str | None) – The Markdown formatted content for a text submission draft. Use None to make a title-only submission draft (default: None). selftext can not be provided if url is provided.

  • send_replies (bool) – When True, messages will be sent to the submission author when comments are made to the submission (default: True).

  • spoiler (bool) – Whether the submission should be marked as a spoiler (default: False).

  • subreddit (str | Subreddit | UserSubreddit | None) – The subreddit to create the draft for. This accepts a subreddit display name, Subreddit object, or UserSubreddit object. If None, the UserSubreddit of currently authenticated user will be used (default: None).

  • title (str | None) – The title of the draft (default: None).

  • url (str | None) – The URL for a link submission draft (default: None). url can not be provided if selftext is provided.

  • draft_kwargs (Any)

Return type:

Draft

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

Return type:

Draft

Returns:

The new Draft object.

Parameters:
classmethod parse(data, reddit)

Return an instance of cls from data.

Parameters:
Return type:

PRAWBase