Fj-dZddlmZddlmZmZmZddlmZddl m Z ddl m Z ddl mZddlmZerdd lmZdd lZdd lmZGd d e ZGddZy )zProvide the WikiPage class.) annotations) TYPE_CHECKINGAnycast)API_PATH)ListingGenerator) RedditBase)Redditor)cachedproperty)IteratorN)modelsceZdZdZe ddZeddZ d dfd ZddZ ddZ dfd Z dd Z dd Z dd dd Zdd Z ddZxZS)WikiPageaAn 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 c#Kt|j|fi|D]X}td|}|d t|j|dd|d<t |j||d|d|d<|Zyw)Ndict[str, Any]authordata_datapageid)r_redditrr r)generator_kwargs subredditurlitemrevisions Y/root/workspace/ytshorts/venv/lib/python3.12/site-packages/praw/models/reddit/wikipage.py_revision_generatorzWikiPage._revision_generator+s%Y%6%6P?OP D,d3H!-%-i.?.?xPXGYZ`Ga%b"' (9(99hvFVX`aeXfgHV N  sA4A6ct|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") )WikiPageModerationselfs rmodz WikiPage.mod9s"$''NcT||_||_||_t|||dy)zInitialize a :class:`.WikiPage` instance. :param revision: A specific revision ID to fetch. By default, fetches the most recent revision. F)r _str_fieldN)name _revisionrsuper__init__)r#redditrr(rr __class__s rr+zWikiPage.__init__Fs. !" u?r%ch|jjd|jd|jdS)z?Return an object initialization representation of the instance.z (subreddit=z, name=))r-__name__rr(r"s r__repr__zWikiPage.__repr__Ys0..))*+dnn5Gwtyym[\]]r%c8|jd|jS)z/Return a string representation of the instance./)rr(r"s r__str__zWikiPage.__str__]s..!499+..r%c|j}|d}|d t|j|dd|d<|jj |t |y)Nr revision_byr) _fetch_datar r__dict__updater*_fetch)r#rr-s rr:zWikiPage._fetchasa!F|   *"*4<  r%c t|jtdj|j|j fi|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_discussionsr=)rrrformatr(r)r#rs r discussionszWikiPage.discussionspsC  LL ' ( / /TYY$.. / Y   r%)reasonc |j||j|d|jjtdj |j |y)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") )contentrrD wiki_editrrN)r9r(rpostrrBr)r#rFrDother_settingss reditz WikiPage.editsM '499PVWX (;/666PWefr%cnt|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") )rrrr()r#rs rrzWikiPage.revisions'.. 8TTr%c tdj|j|j}|j ||j|S)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_revisionsr=)rrr)rrBr(rr)r#rrs r revisionszWikiPage.revisionssH.,-44$))t~~4^''9IUYUcUcil'mmr%)rrrmodels.SubredditrstrreturnzBIterator[dict[str, Redditor | WikiPage | str | int | bool | None]])rSr!)NN) r,z praw.RedditrrQr(rRr str | Nonerzdict[str, Any] | NonerSNone)rSrRrSrU)rSzDtuple[str, dict[str, str | models.Subreddit], dict[str, str] | None])rrrSzIterator[models.Submission])rFrRrDrTrKrrSrU)rrRrSr)rrrSzIIterator[dict[str, models.Redditor | WikiPage | str | int | bool | None]])r0 __module__ __qualname____doc__ staticmethodrr r$r+r1r4r:r?rCrLrrP __classcell__)r-s@rrrs, ( $   L   ( (" $'+ @@$@ @  @ % @ @&^/  ,:>g& Un"%n Rnr%rc@eZdZdZd dZd dZd dZd dZd dZd dZ y)r!zProvides 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") c||_y)zqInitialize a :class:`.WikiPageModeration` instance. :param wikipage: The wikipage to moderate. N)wikipage)r#r^s rr+zWikiPageModeration.__init__s ! r%c|jjt|d}tdj d|jj }|jj j||y)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") rusernamewiki_page_editoraddmethodrrINr^r(rRrrBrrrJr#redditorrrs rrczWikiPageModeration.add^ **H F)*11$--JaJa1b ""3T"2r%c|jjt|d}tdj d|jj }|jj j||y)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") r`rbdelrdrINrfrgs rremovezWikiPageModeration.removerir%c|jjjtdj |jj |jj |jjdy)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_revertrH)rrrIN)r^rrJrrBrr(r)r"s rrevertzWikiPageModeration.revertsaN "" ] # * *T]]5L5L * M ** MM33 # r%ctdj|jj|jj}|jj j |dS)z0Return the settings for this :class:`.WikiPage`.wiki_page_settingsr=r)rrBr^r(rrget)r#rs rsettingszWikiPageModeration.settings"sT+,339K9KW[WdWdWnWn3o}}$$((-f55r%c |j||dtdj|jj|jj }|jj j||dS)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) )listed permlevelrqr=rIr)r9rrBr^r(rrrJ)r#rurvrKrs rr9zWikiPageModeration.update'sn& iHI+,339K9KW[WdWdWnWn3o}}$$))#N)CFKKr%N)r^rrSrU)rhzmodels.RedditorrSrUrV)rSr)ruboolrvintrKrrSr) r0rWrXrYr+rcrlrorsr9r%rr!r!s'!3 3 - ^6 Lr%r!)rY __future__rtypingrrr praw.constrpraw.models.listing.generatorrpraw.models.reddit.baser praw.models.reddit.redditorr praw.util.cacher collections.abcr prawr rr!ryr%rrsK!"++:.0*(inzinX|L|Lr%