{i;SrSSKJr SSKJrJrJr SSKJr SSK J r SSK J r SSK Jr SS KJrJr S S KJr \(aSS Kr"S S\5r"SS5r"SS5r"SS5rg )zProvide the Rule class.) annotations) TYPE_CHECKINGAnyIterator)quote)warn)API_PATH)ClientException)_deprecate_argscachedproperty) RedditBaseNc|^\rSrSrSrSr\S Sj5rS U4SjjrS S U4Sjjjr U4Sjr Sr U=r $) RuleaAn 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_namec[U5$)wContain 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 R/home/james-whalen/.local/lib/python3.13/site-packages/praw/models/reddit/rules.pymodRule.mod,s&d##cR>[TU]U5nUS:XaUc Sn[U5eU$)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 rr Rule.__getattribute__As2(3  # OCS/ ! rc>X44RS5S:wa Sn[U5eU(aX0lX l[TU]XS9 g)z%Initialize a :class:`.Rule` instance.Nrz-Either short_name or _data needs to be given.)_data)countr!rrr__init__)rredditrrr(r$r%s rr* Rule.__init__IsI   $ $T *a /ACS/ ! (O# -rc*>URRHRnURUR:XdMURR UR5 [ TU]5 g SURSUR3n[U5e)Nz Subreddit z does not have the rule )rrulesr__dict__updater_fetchr )rruler$r%s rr1 Rule._fetch\stNN((D$//1 $$T]]3  ) 4>>**B4??BSTc""r)rr)returnz'praw.models.reddit.rules.RuleModeration)r"strr4r)NNN)r+z praw.Redditrzpraw.models.Subreddit | Noner str | Noner(zdict[str, str] | None) __name__ __module__ __qualname____firstlineno____doc__ STR_FIELDr rr r*r1__static_attributes__ __classcell__)r%s@rrrsk.I$$(37!%'+ ..0. . % ..&##rrcn\rSrSrSrS SjrSr\"SSSS5S S S S S .SS jj5rS r g )rfrcXlg)z/Initialize a :class:`.RuleModeration` instance.Nr2)rr2s rr*RuleModeration.__init__ys rc[URR5URRS.nURRR [ SUS9 g)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)r5r2rr_redditpostr )rrHs rdeleteRuleModeration.delete}sOTYY(()))..  x(?@tLr descriptionkindrviolation_reasonNrMrNrrOcz[URR5URRS.nUUUUS.R 5H"upgUc[ URU5OUXV'M$ URR R[SUS9SnURRUlU$)aUpdate 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" ) )rEold_short_namerPupdate_subreddit_rulerGr) r5r2rritemsgetattrrIrJr ) rrMrNrrOrHnamer# updated_rules rr0RuleModeration.updatesBTYY(()"ii22  '$ 0  %' KD 6;]D1DJ yy((-- , -D.  "&!4!4 rrB)r2praw.models.Rule) rMr6rNr6rr6rOr6r4rY) r7r8r9r:r;r*rKr r0r=rrrrfss$M ]FL:LM#'!%'+ . . .  . % . .N.rrch\rSrSrSr\S Sj5r\S Sj5rS SjrSSjr SSjr SSjr S r g )SubredditRulesaProvide 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" ) cURR[SRURS95nUHnURUlM U$)zYGet a list of :class:`.Rule` objects. :returns: A list of instances of :class:`.Rule`. r.r)rIgetr formatr)r rule_listr2s r _rule_listSubredditRules._rule_listsJLL$$Xg%6%=%=%=%WX D!^^DNrc[U5$)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 rrSubredditRules.mods0(--rc[S[SS9 URRS[SR UR S9S9$)aYReturn a list of :class:`.Rule`\ s (Deprecated). :returns: A list of instances of :class:`.Rule`. .. deprecated:: 7.1 Use the iterator by removing the call to :class:`.SubredditRules`. For example, in order to use the iterator: .. code-block:: python for rule in reddit.subreddit("test").rules: print(rule) a=Calling SubredditRules to get a list of rules is deprecated. Remove the parentheses to use the iterator. View the PRAW documentation on how to change the code in order to use the iterator (https://praw.readthedocs.io/en/latest/code_overview/other/subredditrules.html#praw.models.reddit.rules.SubredditRules.__call__).)category stacklevelGETr.r_)methodpath)rDeprecationWarningrIrequestr rarrs r__call__SubredditRules.__call__sT  Q(  ||##x077$..7Q$  rc[U[5(dURU$[URUR US9$)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] )rr) isinstancer5rcrrIr)rrs r __getitem__SubredditRules.__getitem__s8L*c**??:. .DLLDNNzRRrc2XlURUlg)zlInitialize a :class:`.SubredditRules` instance. :param subreddit: The subreddit whose rules to work with. N)rrI)rrs rr*SubredditRules.__init__@s # (( rc,[UR5$)a1Iterate 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) )iterrcrs r__iter__SubredditRules.__iter__IsDOO$$r)rIrN)r4z list[Rule])r4rf)r4list[praw.models.Rule])rzstr | int | slicer4rY)rzpraw.models.Subreddit)r4zIterator[praw.models.Rule]) r7r8r9r:r;r rcrrqrur*r{r=rZrrr\r\sE(  ..2 8(ST)%rr\cn\rSrSrSrSSjr\"SSSS5SS S .SS jj5rSS jrS r g )rfi[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) cXlg)z9Initialize a :class:`.SubredditRulesModeration` instance.Nsubreddit_rules)rrs rr*!SubredditRulesModeration.__init__ss.rrrNrMrON)rMrOc[URR5UUUUcUOUS.nURRR [ SUS9SnURRUlU$)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" ) )rErMrNrrOadd_subreddit_rulerGr)r5rrrIrJr )rrMrNrrOrHnew_rules raddSubredditRulesModeration.addws>T))334&$.6 rs^"//)3Q#:Q#hVVrY%Y%xiir