WikiPage¶
-
class
praw.models.reddit.wikipage.
WikiPage
(reddit: praw.Reddit, subreddit: praw.models.Subreddit, name: str, revision: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)¶ An individual WikiPage object.
Typical Attributes
This table describes attributes that typically belong to objects of this class. Since attributes are dynamically provided (see Determine Available Attributes of an Object), there is not a guarantee that these attributes will always be present, nor is this list necessarily complete.
Attribute
Description
content_html
The contents of the wiki page, as HTML.
content_md
The contents of the wiki page, as Markdown.
may_revise
A
bool
representing whether or not the authenticated user may edit the wiki page.name
The name of the wiki page.
revision_by
The
Redditor
who authored this revision of the wiki page.revision_date
The time of this revision, in Unix Time.
subreddit
The
Subreddit
this wiki page belongs to.-
__init__
(reddit: praw.Reddit, subreddit: praw.models.Subreddit, name: str, revision: Optional[str] = None, _data: Optional[Dict[str, Any]] = None)¶ Construct an instance of the WikiPage object.
- Parameters
revision – A specific revision ID to fetch. By default, fetches the most recent revision.
-
edit
(content: str, reason: Optional[str] = None, **other_settings: Any)¶ Edit this WikiPage’s contents.
- Parameters
content – The updated Markdown content of the page.
reason – (Optional) The reason for the revision.
other_settings – Additional keyword arguments to pass.
For example, to replace the first wiki page of
r/test
with the phrasetest wiki page
:page = next(iter(reddit.subreddit("test").wiki)) page.edit(content="test wiki page")
-
mod
() → praw.models.reddit.wikipage.WikiPageModeration¶ Provide an instance of
WikiPageModeration
.For example, to add
spez
as an editor on the wikipagepraw_test
try:reddit.subreddit("test").wiki["praw_test"].mod.add("spez")
-
classmethod
parse
(data: Dict[str, Any], reddit: praw.Reddit) → Any¶ Return an instance of
cls
fromdata
.- Parameters
data – The structured data.
reddit – An instance of
Reddit
.
-
revision
(revision: str)¶ Return a specific version of this page by revision ID.
To view revision
[ID]
of"praw_test"
inr/test
:page = reddit.subreddit("test").wiki["praw_test"].revision("[ID]")
-
revisions
(**generator_kwargs: Union[str, int, Dict[str, str]]) → Generator[praw.models.reddit.wikipage.WikiPage, None, None]¶ Return a
ListingGenerator
for page revisions.Additional keyword arguments are passed in the initialization of
ListingGenerator
.To view the wiki revisions for
"praw_test"
inr/test
try:for item in reddit.subreddit("test").wiki["praw_test"].revisions(): print(item)
To get
WikiPage
objects for each revision:for item in reddit.subreddit("test").wiki["praw_test"].revisions(): print(item["page"])
-
Note
This list of attributes is not complete. PRAW dynamically provides the attributes that Reddit returns via the API. Because those attributes are subject to change on Reddit’s end, PRAW makes no effort to document them, other than to instruct you on how to discover what is available. See Determine Available Attributes of an Object for detailed information.