o 2g#@sdZddlmZddlZddlmZddlmZmZddl m Z ddl m Z m Z d d lmZd d lmZd d lmZd dlmZmZerHddlZGdddeeZdS)zProvide the Multireddit class.) annotationsN)dumps) TYPE_CHECKINGAny)API_PATH)_deprecate_argscachedproperty)SubredditListingMixin) RedditBase)Redditor) SubredditSubredditStreamcseZdZdZdZedejZe d)ddZ e d*d d Z d+fdd Z fddZddZd,ddZedddd-dd Zd!d"Zd,d#d$Zd.d'd(ZZS)/ MultiredditaA class for users' multireddits. This is referred to as a "Custom Feed" on the Reddit UI. .. include:: ../../typical_attributes.rst ==================== ============================================================== Attribute Description ==================== ============================================================== ``can_edit`` A ``bool`` representing whether or not the authenticated user may edit the multireddit. ``copied_from`` The multireddit that the multireddit was copied from, if it exists, otherwise ``None``. ``created_utc`` When the multireddit was created, in `Unix Time`_. ``description_html`` The description of the multireddit, as HTML. ``description_md`` The description of the multireddit, as Markdown. ``display_name`` The display name of the multireddit. ``name`` The name of the multireddit. ``over_18`` A ``bool`` representing whether or not the multireddit is restricted for users over 18. ``subreddits`` A list of :class:`.Subreddit`\ s that make up the multireddit. ``visibility`` The visibility of the multireddit, either ``"private"``, ``"public"``, or ``"hidden"``. ==================== ============================================================== .. _unix time: https://en.wikipedia.org/wiki/Unix_time pathz[\W_]+titlestrreturncCsVtjd|d}t|dkr'|dd}|d}|dkr'|d|}|p*dS)zReturn a slug version of the title. :param title: The title to make a slug of. Adapted from Reddit's utils.py. _Nr)r RE_INVALIDsubstriplowerlenrfind)r last_wordrP/home/garg/my-data/venv/lib/python3.10/site-packages/praw/models/reddit/multi.pysluggify5s    zMultireddit.sluggifyrcCst|S)aProvide an instance of :class:`.SubredditStream`. Streams can be used to indefinitely retrieve new comments made to a multireddit, like: .. code-block:: python for comment in reddit.multireddit(redditor="spez", name="fun").stream.comments(): print(comment) Additionally, new submissions can be retrieved via the stream. In the following example all new submissions to the multireddit are fetched: .. code-block:: python for submission in reddit.multireddit( redditor="bboe", name="games" ).stream.submissions(): print(submission) )rselfrrr streamFszMultireddit.streamreddit praw.Reddit_datadict[str, Any]csd|_tj|dt|jddd|_tdj|j|jd|_ d|j dd|_d |j vrAfd d |j D|_ dSdS) z,Initialize a :class:`.Multireddit` instance.Nr'/rr multiredditmultiuser subredditscsg|] }t|dqSname)r).0xr%rr gsz(Multireddit.__init__..) rsuper__init__rsplit_authorrformatr2_path__dict__r0)r#r%r' __class__r5r r8_s zMultireddit.__init__cs>|}|d}t||j|d}|j|jtdS)Ndatar)) _fetch_datatype_redditr=updater7_fetch)r#r@otherr>rr rEis zMultireddit._fetchcCsd|j|jjddfS)Nmultireddit_apir,)r2r:r"rrr _fetch_infopszMultireddit._fetch_info subredditpraw.models.SubredditcCFtdj|j|j|d}|jj|dtdt|iid|ddS)aMAdd a subreddit to this multireddit. :param subreddit: The subreddit to add to this multi. For example, to add r/test to multireddit ``bboe/test``: .. code-block:: python subreddit = reddit.subreddit("test") reddit.multireddit(redditor="bboe", name="test").add(subreddit) multireddit_updater-r.rImodelr2r@r0N) rr;r2r:rCputrr_reset_attributesr#rIurlrrr addw   zMultireddit.add display_nameN)rV str | Nonepraw.models.MultiredditcCsT|r||}n|j}|j}||jtdj||jjdd}|jj td|dS)aCopy this multireddit and return the new multireddit. :param display_name: The display name for the copied multireddit. Reddit will generate the ``name`` field from this display name. When not provided the copy will use the same display name and name as this multireddit. To copy the multireddit ``bboe/test`` with a name of ``"testing"``: .. code-block:: python reddit.multireddit(redditor="bboe", name="test").copy(display_name="testing") r+r,)rVfromtomultireddit_copyrO) r!rVr2rrr;rCr.mepost)r#rVr2r@rrr copys  zMultireddit.copycCs(tdj|j|jjd}|j|dS)zDelete this multireddit. For example, to delete multireddit ``bboe/test``: .. code-block:: python reddit.multireddit(redditor="bboe", name="test").delete() rGr,N)rr;r2r:rCdelete)r#rrrr r_s zMultireddit.deletecCrK)a_Remove a subreddit from this multireddit. :param subreddit: The subreddit to remove from this multi. For example, to remove r/test from multireddit ``bboe/test``: .. code-block:: python subreddit = reddit.subreddit("test") reddit.multireddit(redditor="bboe", name="test").remove(subreddit) rLrMrNr2rOr0N) rr;r2r:rCr_rrrQrRrrr removerUzMultireddit.removeupdated_settings8str | list[str | praw.models.Subreddit | dict[str, str]]cKs`d|vrdd|dD|d<tdj|j|jjd}|jj|dt|id}|j|jdS) aUpdate this multireddit. Keyword arguments are passed for settings that should be updated. They can any of: :param display_name: The display name for this multireddit. Must be no longer than 50 characters. :param subreddits: Subreddits for this multireddit. :param description_md: Description for this multireddit, formatted in Markdown. :param icon_name: Can be one of: ``"art and design"``, ``"ask"``, ``"books"``, ``"business"``, ``"cars"``, ``"comics"``, ``"cute animals"``, ``"diy"``, ``"entertainment"``, ``"food and drink"``, ``"funny"``, ``"games"``, ``"grooming"``, ``"health"``, ``"life advice"``, ``"military"``, ``"models pinup"``, ``"music"``, ``"news"``, ``"philosophy"``, ``"pictures and gifs"``, ``"science"``, ``"shopping"``, ``"sports"``, ``"style"``, ``"tech"``, ``"travel"``, ``"unusual stories"``, ``"video"``, or ``None``. :param key_color: RGB hex color code of the form ``"#FFFFFF"``. :param visibility: Can be one of: ``"hidden"``, ``"private"``, or ``"public"``. :param weighting_scheme: Can be one of: ``"classic"`` or ``"fresh"``. For example, to rename multireddit ``"bboe/test"`` to ``"bboe/testing"``: .. code-block:: python reddit.multireddit(redditor="bboe", name="test").update(display_name="testing") r0cSsg|]}dt|iqSr1)r)r3rrrr r6s z&Multireddit.update..rGr,rNrON) rr;r2r:rCrPrr=rD)r#rarnewrrr rDs  zMultireddit.update)rrrr)rr)r%r&r'r()rIrJ)rVrWrrX)rarb)__name__ __module__ __qualname____doc__ STR_FIELDrecompileUNICODEr staticmethodr!r r$r8rErHrTrr^r_r`rD __classcell__rrr>r rs"     r)rg __future__rrijsonrtypingrrconstrutilrr listing.mixinsr baser redditorrrIrr praw.modelsprawrrrrr s