o 2g.@sdZddlmZddlmZmZmZmZddlm Z ddl m Z ddl m Z dd lmZd d lmZd d lmZer>dd lZGdddZGdddeZd S)zProvide the WikiPage class.) annotations) TYPE_CHECKINGAny GeneratorIterator)API_PATH)_deprecate_args)cachedproperty)ListingGenerator) RedditBase)RedditorNc@sTeZdZdZdddZddd Zdd d Zd d ZdddZe dddddZ dS)WikiPageModerationzProvides a set of moderation functions for a :class:`.WikiPage`. For example, to add u/spez as an editor on the wikipage ``"praw_test"`` try: .. code-block:: python reddit.subreddit("test").wiki["praw_test"].mod.add("spez") wikipageWikiPagecCs ||_dS)zqInitialize a :class:`.WikiPageModeration` instance. :param wikipage: The wikipage to moderate. N)r)selfrrS/home/garg/my-data/venv/lib/python3.10/site-packages/praw/models/reddit/wikipage.py__init__s zWikiPageModeration.__init__redditorpraw.models.RedditorcC>|jjt|d}tdj|jjdd}|jjj||ddS)a.Add an editor to this :class:`.WikiPage`. :param redditor: A redditor name or :class:`.Redditor` instance. To add u/spez as an editor on the wikipage ``"praw_test"`` try: .. code-block:: python reddit.subreddit("test").wiki["praw_test"].mod.add("spez") pageusernamewiki_page_editoradd subredditmethoddataNrnamestrrformatr _redditpostrrr#urlrrrr%  zWikiPageModeration.addcCr)a9Remove an editor from this :class:`.WikiPage`. :param redditor: A redditor name or :class:`.Redditor` instance. To remove u/spez as an editor on the wikipage ``"praw_test"`` try: .. code-block:: python reddit.subreddit("test").wiki["praw_test"].mod.remove("spez") rrdelrr"Nr$r*rrrremove7r,zWikiPageModeration.removecCs4|jjjtdj|jjd|jj|jjdddS)aRevert a wikipage back to a specific revision. To revert the page ``"praw_test"`` in r/test to revision ``"1234abc"``, try .. code-block:: python reddit.subreddit("test").wiki["praw_test"].revision("1234abc").mod.revert() .. note:: When you attempt to revert the page ``config/stylesheet``, Reddit checks to see if the revision being reverted to passes the CSS filter. If the check fails, then the revision attempt will also fail, and a ``prawcore.Forbidden`` exception will be raised. For example, you can't revert to a revision that contains a link to ``url(%%PRAW%%)`` if there is no image named ``PRAW`` on the current stylesheet. Here is an example of how to look for this type of error: .. code-block:: python from prawcore.exceptions import Forbidden try: reddit.subreddit("test").wiki["config/stylesheet"].revision("1234abc").mod.revert() except Forbidden as exception: try: exception.response.json() except ValueError: exception.response.text If the error occurs, the output will look something like .. code-block:: python {"reason": "INVALID_CSS", "message": "Forbidden", "explanation": "%(css_error)s"} wiki_revertr )rrevisionr"N)rr(r)rr'r r% _revisionrrrrrevertIs ' zWikiPageModeration.revertreturndict[str, Any]cCs,tdj|jj|jjd}|jj|dS)z0Return the settings for this :class:`.WikiPage`.wiki_page_settingsr rr#)rr'rr r%r(get)rr+rrrsettingsxs zWikiPageModeration.settingslisted permlevelboolintother_settingsrcKs@|||dtdj|jj|jjd}|jjj||ddS)aUpdate the settings for this :class:`.WikiPage`. :param listed: Show this page on page list. :param permlevel: Who can edit this page? ``0`` use subreddit wiki permissions, ``1`` only approved wiki contributors for this page may edit (see :meth:`.WikiPageModeration.add`), ``2`` only mods may edit and view. :param other_settings: Additional keyword arguments to pass. :returns: The updated WikiPage settings. To set the wikipage ``"praw_test"`` in r/test to mod only and disable it from showing in the page list, try: .. code-block:: python reddit.subreddit("test").wiki["praw_test"].mod.update(listed=False, permlevel=2) )r;r<r7r8r"r#)updaterr'rr r%r(r))rr;r<r?r+rrrr@s  zWikiPageModeration.updateN)rr)rr)r5r6)r;r=r<r>r?rr5r6) __name__ __module__ __qualname____doc__rrr.r4r:r r@rrrrrs   /rcseZdZdZejZed1d d Zed2d dZ  d3d4fdd Z d5ddZ d5ddZ fddZ dd Zd6d#d$Zed%d&dd'd7d)d*Zd8d+d,Zd9d/d0ZZS):raAn individual :class:`.WikiPage` object. .. include:: ../../typical_attributes.rst ================= ================================================================= 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 :class:`.Redditor` who authored this revision of the wiki page. ``revision_date`` The time of this revision, in `Unix Time`_. ``subreddit`` The :class:`.Subreddit` this wiki page belongs to. ================= ================================================================= .. _unix time: https://en.wikipedia.org/wiki/Unix_time generator_kwargsr6r praw.models.Subredditr+r&r5OGenerator[dict[str, Redditor | WikiPage | str | int | bool | None], None, None]ccsht|j|fi|D]&}|ddur t|j|ddd|d<t|j||d|d|d<|Vq dS)Nauthorr#_datarid)r r(rr)rEr r+r1rrr_revision_generators  zWikiPage._revision_generatorrcCst|S)zProvide an instance of :class:`.WikiPageModeration`. For example, to add u/spez as an editor on the wikipage ``"praw_test"`` try: .. code-block:: python reddit.subreddit("test").wiki["praw_test"].mod.add("spez") )rr3rrrmods z WikiPage.modNreddit praw.Redditr%r1 str | NonerJdict[str, Any] | Nonecs(||_||_||_tj||dddS)zInitialize a :class:`.WikiPage` instance. :param revision: A specific revision ID to fetch. By default, fetches the most recent revision. F)rJ _str_fieldN)r%r2r superr)rrNr r%r1rJ __class__rrrszWikiPage.__init__cCs|jjd|jd|jdS)z?Return an object initialization representation of the instance.z (subreddit=z, name=))rUrAr r%r3rrr__repr__szWikiPage.__repr__cCs|jd|jS)z/Return a string representation of the instance./)r r%r3rrr__str__szWikiPage.__str__csP|}|d}|ddurt|j|ddd|d<|j|tdS)Nr# revision_byrI) _fetch_datarr(__dict__r@rS_fetch)rr#rTrrr]s  zWikiPage._fetchcCs&d|j|jd|jrd|jifSdfS)N wiki_pager8v)r r%r2r3rrr _fetch_infos  zWikiPage._fetch_infor Iterator[praw.models.Submission]cKs&t|jtdj|j|jdfi|S)aReturn a :class:`.ListingGenerator` for discussions of a wiki page. Discussions are site-wide links to a wiki page. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. To view the titles of discussions of the page ``"praw_test"`` in r/test, try: .. code-block:: python for submission in reddit.subreddit("test").wiki["praw_test"].discussions(): print(submission.title) wiki_discussionsr8)r r(rr'r r%)rrErrr discussionsszWikiPage.discussionscontentreason)rer?cKs6|||j|d|jjtdj|jd|ddS)aEdit this wiki page's contents. :param content: The updated Markdown content of the page. :param reason: The reason for the revision. :param other_settings: Additional keyword arguments to pass. For example, to replace the first wiki page of r/test with the phrase ``"test wiki page"``: .. code-block:: python page = next(iter(reddit.subreddit("test").wiki)) page.edit(content="test wiki page") )rdrre wiki_editr0r"N)r@r%r(r)rr'r )rrdrer?rrredits z WikiPage.editcCst|jj|j|j|S)zReturn a specific version of this page by revision ID. To view revision ``"1234abc"`` of ``"praw_test"`` in r/test: .. code-block:: python page = reddit.subreddit("test").wiki["praw_test"].revision("1234abc") )rr r(r%)rr1rrrr12s zWikiPage.revisionstr | int | dict[str, str]Generator[WikiPage, None, None]cKs(tdj|j|jd}|j||j|dS)aVReturn a :class:`.ListingGenerator` for page revisions. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. To view the wiki revisions for ``"praw_test"`` in r/test try: .. code-block:: python for item in reddit.subreddit("test").wiki["praw_test"].revisions(): print(item) To get :class:`.WikiPage` objects for each revision: .. code-block:: python for item in reddit.subreddit("test").wiki["praw_test"].revisions(): print(item["page"]) wiki_page_revisionsr8)rEr r+)rr'r r%rL)rrEr+rrr revisions>s zWikiPage.revisions)rEr6r rFr+r&r5rG)r5r)NN) rNrOr rFr%r&r1rPrJrQ)r5r&)rErr5ra)rdr&rerPr?r)r1r&r5r)rErhr5ri)rArBrCrDr__hash__ staticmethodrLr rMrrWrYr]r`rcr rgr1rk __classcell__rrrTrrs&        r)rD __future__rtypingrrrrconstrutilr util.cacher listing.generatorr baserrr praw.modelsprawrrrrrrs