SubredditRedditorFlairTemplates

class praw.models.reddit.subreddit.SubredditRedditorFlairTemplates(subreddit)

Provide functions to interact with Redditor flair templates.

__init__(subreddit)

Create a SubredditFlairTemplate instance.

Parameters

subreddit – The subreddit whose flair templates to work with.

Note

This class should not be initialized directly. Instead obtain an instance via: reddit.subreddit("subreddit_name").flair.templates or reddit.subreddit("subreddit_name").flair.link_templates.

__iter__()

Iterate through the user flair templates.

For example:

for template in reddit.subreddit("NAME").flair.templates:
    print(template)
add(text, css_class='', text_editable=False, background_color=None, text_color=None, mod_only=None, allowable_content=None, max_emojis=None)

Add a Redditor flair template to the associated subreddit.

Parameters
  • text – The flair template’s text (required).

  • css_class – The flair template’s css_class ((default: “”)).

  • text_editable – (boolean) Indicate if the flair text can be modified for each Redditor that sets it (default: False).

  • background_color – The flair template’s new background color, as a hex color.

  • text_color – The flair template’s new text color, either "light" or "dark".

  • mod_only – (boolean) Indicate if the flair can only be used by moderators.

  • allowable_content – If specified, most be one of "all", "emoji", or "text" to restrict content to that type. If set to "emoji" then the "text" param must be a valid emoji string, for example ":snoo:".

  • max_emojis – (int) Maximum emojis in the flair (Reddit defaults this value to 10).

For example, to add an editable Redditor flair try:

reddit.subreddit("NAME").flair.templates.add(css_class="praw", text_editable=True)
clear()

Remove all Redditor flair templates from the subreddit.

For example:

reddit.subreddit("NAME").flair.templates.clear()
delete(template_id)

Remove a flair template provided by template_id.

For example, to delete the first Redditor flair template listed, try:

template_info = list(subreddit.flair.templates)[0]
subreddit.flair.templates.delete(template_info["id"])
static flair_type(is_link)

Return LINK_FLAIR or USER_FLAIR depending on is_link value.

update(template_id, text=None, css_class=None, text_editable=None, background_color=None, text_color=None, mod_only=None, allowable_content=None, max_emojis=None, fetch=True)

Update the flair template provided by template_id.

Parameters
  • template_id – The flair template to update. If not valid then an exception will be thrown.

  • text – The flair template’s new text (required).

  • css_class – The flair template’s new css_class ((default: “”)).

  • text_editable – (boolean) Indicate if the flair text can be modified for each Redditor that sets it (default: False).

  • background_color – The flair template’s new background color, as a hex color.

  • text_color – The flair template’s new text color, either "light" or "dark".

  • mod_only – (boolean) Indicate if the flair can only be used by moderators.

  • allowable_content – If specified, most be one of "all", "emoji", or "text" to restrict content to that type. If set to "emoji" then the "text" param must be a valid emoji string, for example ":snoo:".

  • max_emojis – (int) Maximum emojis in the flair (Reddit defaults this value to 10).

  • fetch – Whether or not PRAW will fetch existing information on the existing flair before updating (Default: True).

Warning

If parameter fetch is set to False, all parameters not provided will be reset to default (None or False) values.

For example to make a user flair template text_editable, try:

template_info = list(subreddit.flair.templates)[0]
subreddit.flair.templates.update(
    template_info["id"], template_info["flair_text"], text_editable=True
)