reddit.subreddit

class asyncpraw.models.SubredditHelper(reddit: asyncpraw.Reddit, _data: Optional[Dict[str, Any]])

Provide a set of functions to interact with Subreddits.

await __call__(display_name: str, fetch: bool = False) asyncpraw.models.Subreddit

Return an instance of Subreddit.

Parameters
  • display_name – The name of the subreddit.

  • fetch – Determines if Async PRAW will fetch the object (default: False).

If you need the object fetched right away (e.g., to access an attribute) you can do:

subreddit = await reddit.subreddit("test", fetch=True)
print(subreddit.subscribers)
__init__(reddit: asyncpraw.Reddit, _data: Optional[Dict[str, Any]])

Initialize a AsyncPRAWBase instance.

Parameters

reddit – An instance of Reddit.

await create(name: str, title: Optional[str] = None, link_type: str = 'any', subreddit_type: str = 'public', wikimode: str = 'disabled', **other_settings: Optional[str]) asyncpraw.models.Subreddit

Create a new Subreddit.

Parameters
  • name – The name for the new subreddit.

  • title – The title of the subreddit. When None or "" use the value of "name".

  • link_type – The types of submissions users can make. One of "any", "link", or "self" (default: "any").

  • subreddit_type – One of "archived", "employees_only", "gold_only", "gold_restricted", "private", "public", or "restricted" (default: "public").

  • wikimode – One of "anyone", "disabled", or "modonly" (default: "disabled").

Any keyword parameters not provided, or set explicitly to None, will take on a default value assigned by the Reddit server.

See also

update() for documentation of other available settings.

classmethod parse(data: Dict[str, Any], reddit: asyncpraw.Reddit) Any

Return an instance of cls from data.

Parameters
  • data – The structured data.

  • reddit – An instance of Reddit.