o 2g!@sdZddlmZddlmZmZmZddlmZddl m Z ddl m Z ddl mZmZd d lmZer8dd lZGd d d eZGdddZd S)z!Provide the Removal Reason class.) annotations) TYPE_CHECKINGAnyIterator)warn)API_PATH)ClientException)_deprecate_argscachedproperty) RedditBaseNcseZdZdZdZed$ddZd%d d Zd&ddZ   d'd(fdd Z fddZ ddZ e dd ddd!d)d"d#Z ZS)* RemovalReasonaAn individual Removal Reason object. .. include:: ../../typical_attributes.rst =========== ================================== Attribute Description =========== ================================== ``id`` The ID of the removal reason. ``message`` The message of the removal reason. ``title`` The title of the removal reason. =========== ================================== idid_value str | Nonereason_id_valuereturncCs|dur tdtdd|S|S)aReason ID param is deprecated. Warns if it's used. :param id_value: Returns the actual value of parameter ``id`` is parameter ``reason_id`` is not used. :param reason_id_value: The value passed as parameter ``reason_id``. NzParameter 'reason_id' is deprecated. Either use positional arguments (e.g., reason_id="x" -> "x") or change the parameter name to 'id' (e.g., reason_id="x" -> id="x"). This parameter will be removed in PRAW 8.r)category stacklevel)rDeprecationWarningrrrZ/home/garg/my-data/venv/lib/python3.10/site-packages/praw/models/reddit/removal_reasons.py_warn_reason_id"s zRemovalReason._warn_reason_idotherstr | RemovalReasonboolcCs2t|tr |t|kSt||jot|t|kS)z5Return whether the other instance equals the current.) isinstancestr __class__)selfrrrr__eq__9s  zRemovalReason.__eq__intcCst|jjtt|AS)z(Return the hash of the current instance.)hashr __name__rr!rrr__hash__?szRemovalReason.__hash__Nreddit praw.Reddit subredditpraw.models.Subreddit reason_id_datadict[str, Any] | NonecsP|j||d}||fddkrd}t||r||_||_tj||ddS)avInitialize a :class:`.RemovalReason` instance. :param reddit: An instance of :class:`.Reddit`. :param subreddit: An instance of :class:`.Subreddit`. :param id: The ID of the removal reason. :param reason_id: The original name of the ``id`` parameter. Used for backwards compatibility. This parameter should not be used. rNr z%Either id or _data needs to be given.r-)rcount ValueErrorrr*super__init__)r!r(r*rr,r-msgr rrr3CszRemovalReason.__init__csV|jjjD]}|j|jkr|j|jtdSqd|jd|j}t|)Nz Subreddit z" does not have the removal reason ) r*modremoval_reasonsr__dict__updater2_fetchr )r!removal_reasonr4r5rrr:^s  zRemovalReason._fetchcCs&tdj|j|jd}|j|dS)zDelete a removal reason from this subreddit. To delete ``"141vv5c16py7d"`` from r/test try: .. code-block:: python reddit.subreddit("test").mod.removal_reasons["141vv5c16py7d"].delete() r;r*rN)rformatr*r_redditdelete)r!urlrrrr?gs zRemovalReason.deletemessagetitlerArBcsFtdjjjd}fdd||dD}jj||ddS)aUpdate the removal reason from this subreddit. .. note:: Existing values will be used for any unspecified arguments. :param message: The removal reason's new message. :param title: The removal reason's new title. To update ``"141vv5c16py7d"`` from r/test try: .. code-block:: python reddit.subreddit("test").mod.removal_reasons["141vv5c16py7d"].update( title="New title", message="New message" ) r;r<cs(i|]\}}||durt|n|qS)N)getattr).0namevaluer&rr sz(RemovalReason.update..rCdataN)rr=r*ritemsr>put)r!rArBr@rJrr&rr9ts   zRemovalReason.update)rrrrrr)rrrr)rr#)NNN) r(r)r*r+rrr,rr-r.)rArrBr)r% __module__ __qualname____doc__ STR_FIELD staticmethodrr"r'r3r:r?r r9 __classcell__rrr5rrs      rc@sPeZdZdZedddZdd d Zdd dZdddZe dddddZ dS)SubredditRemovalReasonszFProvide a set of functions to a :class:`.Subreddit`'s removal reasons.rlist[RemovalReason]cs2jtdjjdfdddDS)zrGet a list of Removal Reason objects. :returns: A list of instances of :class:`.RemovalReason`. removal_reasons_listr*cs&g|]}tjjd|dqS)rJr/)rr>r*)rEr,responser!rr s z@SubredditRemovalReasons._removal_reason_list..order)r>getrr=r*r&rrWr_removal_reason_lists  z,SubredditRemovalReasons._removal_reason_listr,str | int | slicercCs$t|ts |j|St|j|j|S)acReturn the Removal Reason with the ID/number/slice ``reason_id``. :param reason_id: The ID or index of the removal reason .. note:: Removal reasons fetched using a specific rule name are lazily loaded, so you might have to access an attribute to get all the expected attributes. This method is to be used to fetch a specific removal reason, like so: .. code-block:: python reason_id = "141vv5c16py7d" reason = reddit.subreddit("test").mod.removal_reasons[reason_id] print(reason) You can also use indices to get a numbered removal reason. Since Python uses 0-indexing, the first removal reason is index 0, and so on. .. note:: Both negative indices and slices can be used to interact with the removal reasons. :raises: :py:class:`IndexError` if a removal reason of a specific number does not exist. For example, to get the second removal reason of r/test: .. code-block:: python reason = reddit.subreddit("test").mod.removal_reasons[1] To get the last three removal reasons in a subreddit: .. code-block:: python reasons = reddit.subreddit("test").mod.removal_reasons[-3:] for reason in reasons: print(reason) )rrr\rr>r*)r!r,rrr __getitem__s , z#SubredditRemovalReasons.__getitem__r*r+cCs||_|j|_dS)zInitialize a :class:`.SubredditRemovalReasons` instance. :param subreddit: The subreddit whose removal reasons to work with. N)r*r>)r!r*rrrr3s z SubredditRemovalReasons.__init__Iterator[RemovalReason]cCs t|jS)a"Return a list of Removal Reasons for the subreddit. This method is used to discover all removal reasons for a subreddit: .. code-block:: python for removal_reason in reddit.subreddit("test").mod.removal_reasons: print(removal_reason) )iterr\r&rrr__iter__s z SubredditRemovalReasons.__iter__rArBrcCs<||d}tdj|jd}|jj||d}t|j|j|S)aAdd a removal reason to this subreddit. :param message: The message associated with the removal reason. :param title: The title of the removal reason. :returns: The :class:`.RemovalReason` added. The message will be prepended with ``Hi u/username,`` automatically. To add ``"Test"`` to r/test try: .. code-block:: python reddit.subreddit("test").mod.removal_reasons.add(title="Test", message="Foobar") rCrUrVrI)rr=r*r>postr)r!rArBrJr@r,rrradds zSubredditRemovalReasons.addN)rrT)r,r]rr)r*r+)rr_)rArrBrrr) r%rMrNrOr r\r^r3rar rcrrrrrSs   0  rS)rO __future__rtypingrrrwarningsrconstr exceptionsr utilr r baser prawrrSrrrrs