SubredditWiki¶

class asyncpraw.models.reddit.subreddit.SubredditWiki(subreddit)¶

Provides a set of wiki functions to a Subreddit.

Parameters:: subreddit (asyncpraw.models.Subreddit)

__init__(subreddit)¶

Initialize a SubredditWiki instance.

Parameters:: subreddit (Subreddit) – The subreddit whose wiki to work with.
Return type:: None

await create(*, content, name, reason=None, **other_settings)¶

Create a new WikiPage.

Parameters:

name (str) – The name of the new WikiPage. This name will be normalized.
content (str) – The content of the new WikiPage.
reason (str | None) – The reason for the creation.
other_settings (Any) – Additional keyword arguments to pass.

Return type:

WikiPage

To create the wiki page "praw_test" in r/test try:

subreddit = await reddit.subreddit("test")
await subreddit.wiki.create(
    name="praw_test", content="wiki body text", reason="Async PRAW Test Creation"
)

await get_page(page_name, *, fetch=True)¶

Return the WikiPage for the Subreddit named page_name.

Parameters:

page_name (str) – Name of the wikipage.
fetch (bool) – Determines if Async PRAW will fetch the object (default: True).

Return type:

WikiPage

This method is to be used to fetch a specific wikipage, like so:

subreddit = await reddit.subreddit("test")
wikipage = await subreddit.wiki.get_page("proof")
print(wikipage.content_md)

revisions(**generator_kwargs)¶

Return a ListingGenerator for recent wiki revisions.

Additional keyword arguments are passed in the initialization of ListingGenerator.

To view the wiki revisions for "praw_test" in r/test try:

subreddit = await reddit.subreddit("test")
page = await subreddit.wiki.get_page("praw_test")
async for item in page.revisions():
    print(item)

Return type:: AsyncIterator[dict[str, Redditor | WikiPage | str | int | bool | None]]
Parameters:: generator_kwargs (Any)