Fj7dZddlmZddlmZmZmZddlmZddl m Z ddl m Z ddl mZddlmZdd lmZerdd lmZdd lZdd lmZGd deeZGddZGddZGddZy )zProvide the Rule class.) annotations) TYPE_CHECKINGAny SupportsIndex)quote)API_PATH)ClientException) RedditBase) CreatedMixin)cachedproperty)IteratorN)modelscleZdZdZdZeddZdfd Z d d fd Zd fd Z xZ S) RuleaRAn individual :class:`.Rule` object. .. include:: ../../typical_attributes.rst ==================== ============================================================= Attribute Description ==================== ============================================================= ``created_utc`` Time the rule was created, represented in `Unix Time`_. ``description`` The description of the rule, if provided, otherwise a blank string. ``kind`` The kind of rule. Can be ``"link"``, ``comment"``, or ``"all"``. ``priority`` Represents where the rule is ranked. For example, the first rule is at priority ``0``. Serves as an index number on the list of rules. ``short_name`` The name of the rule. ``violation_reason`` The reason that is displayed on the report menu for the rule. ==================== ============================================================= .. _unix time: https://en.wikipedia.org/wiki/Unix_time short_namect|S)aContain methods used to moderate rules. To delete ``"No spam"`` from r/test try: .. code-block:: python reddit.subreddit("test").rules["No spam"].mod.delete() To update ``"No spam"`` from r/test try: .. code-block:: python reddit.subreddit("test").removal_reasons["No spam"].mod.update( description="Don't do this!", violation_reason="Spam post" ) )RuleModerationselfs V/root/workspace/ytshorts/venv/lib/python3.12/site-packages/praw/models/reddit/rules.pymodzRule.mod/s&d##cNt||}|dk(r| d}t||S)zGet the value of an attribute. subredditz;The Rule is missing a subreddit. File a bug report at PRAW.)super__getattribute__ ValueError)r attributevaluemsg __class__s rrzRule.__getattribute__Ds2(3  # OCS/ ! rc||fjddk7r d}t||r||_||_t|||y)z%Initialize a :class:`.Rule` instance.Nz-Either short_name or _data needs to be given.)_data)countrrrr__init__)rredditrrr$r r!s rr&z Rule.__init__LsQ   $ $T *a /ACS/ ! (DO# u-rc@|jJ|jjD]P}|j|jk(s|jj |jt |yd|jd|j}t|)Nz Subreddit z does not have the rule )rrulesr__dict__updater_fetchr )rruler r!s rr,z Rule._fetch_s~~)))NN(( D$//1 $$T]]3    4>>**B4??BSTc""r)returnr)rstrr.r)NNN) r'z praw.Redditrzmodels.Subreddit | Noner str | Noner$zdict[str, str] | Noner.Noner.r1) __name__ __module__ __qualname____doc__ STR_FIELDr rrr&r, __classcell__)r!s@rrrsp.I$$(.2!%'+ ..+. . % .  .&##rrcFeZdZdZddZddZddddd d dZy) raContain methods used to moderate rules. To delete ``"No spam"`` from r/test try: .. code-block:: python reddit.subreddit("test").rules["No spam"].mod.delete() To update ``"No spam"`` from r/test try: .. code-block:: python reddit.subreddit("test").removal_reasons["No spam"].mod.update( description="Don't do this!", violation_reason="Spam post" ) c||_y)z/Initialize a :class:`.RuleModeration` instance.N)r-)rr-s rr&zRuleModeration.__init__}s  rct|jj|jjd}|jjj t d|y)zDelete a rule from this subreddit. To delete ``"No spam"`` from r/test try: .. code-block:: python reddit.subreddit("test").rules["No spam"].mod.delete() )rrremove_subreddit_ruledataN)r/r-rr_redditpostr)rr?s rdeletezRuleModeration.deletesOTYY(()))..  x(?@tLrN descriptionkindrviolation_reasonc~|jjt|jjd}||||dj D]"\}}|t |j|n|||<$|jj jtd|d}|jj|_|S)a Update the rule from this subreddit. .. note:: Existing values will be used for any unspecified arguments. :param description: The new description for the rule. Can be empty. :param kind: The kind of item that the rule applies to. One of ``"link"``, ``"comment"``, or ``"all"``. :param short_name: The name of the rule. :param violation_reason: The reason that is shown on the report menu. :returns: A Rule object containing the updated values. To update ``"No spam"`` from r/test try: .. code-block:: python reddit.subreddit("test").removal_reasons["No spam"].mod.update( description="Don't do this!", violation_reason="Spam post" ) )old_short_namer<rCupdate_subreddit_ruler>r) r-rr/ritemsgetattrr@rAr) rrDrErrFr?namer updated_rules rr+zRuleModeration.updates@#ii22TYY(()  '$ 0  %'  NKD% 6;]D1DJ  Nyy((--h7N.OVZ-[\]^ !%!4!4 r)r- models.Ruler.r1r2) rDr0rEr0rr0rFr0r.rN)r3r4r5r6r&rBr+rrrrjsW$M&#'!%'+ , , ,  , % , ,rrcLeZdZdZeddZed dZd dZd dZd dZ y) SubredditRulesa Provide a set of functions to access a :class:`.Subreddit`'s rules. For example, to list all the rules for a subreddit: .. code-block:: python for rule in reddit.subreddit("test").rules: print(rule) Moderators can also add rules to the subreddit. For example, to make a rule called ``"No spam"`` in r/test: .. code-block:: python reddit.subreddit("test").rules.mod.add( short_name="No spam", kind="all", description="Do not spam. Spam bad" ) c|jjtdj|j}|D]}|j|_|S)ziGet a list of :class:`.Rule` objects. :returns: A list of instances of :class:`.Rule`. r))r)r@getrformatr)r rule_listr-s r _rule_listzSubredditRules._rule_listsOLL$$Xg%6%=%=%=%WX  ,D!^^DN ,rct|S)aContain methods to moderate subreddit rules as a whole. To add rule ``"No spam"`` to r/test try: .. code-block:: python reddit.subreddit("test").rules.mod.add( short_name="No spam", kind="all", description="Do not spam. Spam bad" ) To move the fourth rule to the first position, and then to move the prior first rule to where the third rule originally was in r/test: .. code-block:: python subreddit = reddit.subreddit("test") rules = list(subreddit.rules) new_rules = rules[3:4] + rules[1:3] + rules[0:1] + rules[4:] # Alternate: [rules[3]] + rules[1:3] + [rules[0]] + rules[4:] new_rule_list = subreddit.rules.mod.reorder(new_rules) )SubredditRulesModerationrs rrzSubredditRules.mods0(--rct|ts|j|St|j||j S)aReturn the :class:`.Rule` for the subreddit with short_name ``short_name``. :param short_name: The short_name of the rule, or the rule number. .. note:: Rules 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 rule, like so: .. code-block:: python rule_name = "No spam" rule = reddit.subreddit("test").rules[rule_name] print(rule) You can also fetch a numbered rule of a subreddit. Rule numbers start at ``0``, so the first rule is at index ``0``, and the second rule is at index ``1``, and so on. :raises: :py:class:`IndexError` if a rule of a specific number does not exist. .. note:: You can use negative indexes, such as ``-1``, to get the last rule. You can also use slices, to get a subset of rules, such as the last three rules with ``rules[-3:]``. For example, to fetch the second rule of r/test: .. code-block:: python rule = reddit.subreddit("test").rules[1] To get the last three rules in a subreddit: .. code-block:: python reasons = reddit.subreddit("test").rules[-3:] for rule in rules: print(rule) )rr) isinstancer/rVrr@r)rrs r __getitem__zSubredditRules.__getitem__s5\*c*??:. .DLLZ4>>RRrc4||_|j|_y)z|Initialize a :class:`.SubredditRules` instance. :param subreddit: The subreddit whose rules to work with. N)rr@)rrs rr&zSubredditRules.__init__-s # (( rc,t|jS)aiIterate through the rules of the subreddit. :returns: An iterator containing all the rules of a subreddit. This method is used to discover all rules for a subreddit. For example, to get the rules for r/test: .. code-block:: python for rule in reddit.subreddit("test").rules: print(rule) )iterrVrs r__iter__zSubredditRules.__iter__6sDOO$$rN)r.z list[Rule])r.rX)rrr.rN)rzmodels.Subredditr.r1)r.zIterator[models.Rule]) r3r4r5r6r rVrr[r&r_rOrrrQrQs@(  ..20Sd)%rrQcBeZdZdZddZddd d dZd dZy) rXaContain methods to moderate subreddit rules as a whole. To add rule ``"No spam"`` to r/test try: .. code-block:: python reddit.subreddit("test").rules.mod.add( short_name="No spam", kind="all", description="Do not spam. Spam bad" ) To move the fourth rule to the first position, and then to move the prior first rule to where the third rule originally was in r/test: .. code-block:: python subreddit = reddit.subreddit("test") rules = list(subreddit.rules) new_rules = rules[3:4] + rules[1:3] + rules[0:1] + rules[4:] # Alternate: [rules[3]] + rules[1:3] + [rules[0]] + rules[4:] new_rule_list = subreddit.rules.mod.reorder(new_rules) c||_y)z9Initialize a :class:`.SubredditRulesModeration` instance.N)subreddit_rules)rrbs rr&z!SubredditRulesModeration.__init__`s .rN)rDrFc||t|jj|||n|d}|jjj t d|d}|jj|_|S)aAdd a removal reason to this subreddit. :param description: The description for the rule. :param kind: The kind of item that the rule applies to. One of ``"link"``, ``"comment"``, or ``"all"``. :param short_name: The name of the rule. :param violation_reason: The reason that is shown on the report menu. If a violation reason is not specified, the short name will be used as the violation reason. :returns: The added :class:`.Rule`. To add rule ``"No spam"`` to r/test try: .. code-block:: python reddit.subreddit("test").rules.mod.add( short_name="No spam", kind="all", description="Do not spam. Spam bad" ) )rDrEr<rrFadd_subreddit_ruler>r)r/rbrr@rAr)rrDrErrFr?new_rules raddzSubredditRulesModeration.addds|<'T))334$/?/GM]  ''//44X>R5SZ^4_`ab!11;;rc\tdj|Dcgc]}|jc}d}|t|jj d}|jj jtd|}|D]}|jj |_|Scc}w)aReorder the rules of a subreddit. :param rule_list: The list of rules, in the wanted order. Each index of the list indicates the position of the rule. :returns: A list containing the rules in the specified order. For example, to move the fourth rule to the first position, and then to move the prior first rule to where the third rule originally was in r/test: .. code-block:: python subreddit = reddit.subreddit("test") rules = list(subreddit.rules) new_rules = rules[3:4] + rules[1:3] + rules[0:1] + rules[4:] # Alternate: [rules[3]] + rules[1:3] + [rules[0]] + rules[4:] new_rule_list = subreddit.rules.mod.reorder(new_rules) ,)safe)new_rule_orderr<reorder_subreddit_rulesr>) rjoinrr/rbrr@rAr)rrUr- order_stringr?responses rreorderz SubredditRulesModeration.reorders(SXX9&M4t&MNUXY *T))334 ''//44X>W5X_c4d r|sf"44+.2$(R#<R#jSSlE%E%P``r