{iPcSrSSKJr SSKJrJrJrJrJrJ r J r SSK J r SSK Jr SSKJr SS KJr SS KJr SS KJr \(aSS Kr\ \\4r\ S \4r\ \\4r"SS5r"SS\5r"SS\5r"SS\5r g )z6Provides classes for interacting with moderator notes.)islice) TYPE_CHECKINGAny GeneratorListOptionalTupleUnion)API_PATH)PRAWBase)ListingGenerator)Comment)Redditor) SubmissionNzpraw.models.Subredditc<\rSrSrSrS SjrS\S\S\4Sjr S\ \S \ \S \ S 4S jr S \ S\S \4SjrS\S\ \S \ \S\S \ S 4 SjrSSSSS.S\\ S\ S\\S\\S\\\\\ 4S\S S4SjjrSSSSS.S\S\\ S\\S\\4SjjrSrg)! BaseModNotesz7Provides base methods to interact with moderator notes.cXlg)z`Initialize a :class:`.BaseModNotes` instance. :param reddit: An instance of :class:`.Reddit`. N_reddit)selfreddits O/home/james-whalen/.local/lib/python3.13/site-packages/praw/models/mod_notes.py__init__BaseModNotes.__init__s  redditor subredditgenerator_kwargsc l[R"USUUS9 [UR[S40UD6$)Nparams) argumentskeyr user mod_notes)r_safely_add_argumentsrrr )rrr r!s r_all_generatorBaseModNotes._all_generator#s< &&&    h{.CXGWXXr redditors subredditsreturnpraw.models.ModNoteNNc## [U5n[U5n[[US55n[[US55n[XV/5(dgSR [ [ U55SR [ [ U55S.nURR[SUS9nUSH*n URRRU 5v M, M7f)Ni,)r,usersmod_notes_bulkr#r') iterlistranyjoinmapstrrgetr _objector objectify) rr+r,subreddits_iterredditors_itersubreddits_chunk users_chunkr#response note_dicts r_bulk_generatorBaseModNotes._bulk_generator1sz*i#F?C$@A vnc:;K(677!hhs30@'AB#c;"78F||''1A(B6'RH%k2 ll,,66yAA3sC)C+ error_message attributesc pUR5up4U=(d [XS5nUc [U5eU$N)popitemgetattr TypeError)rrFrG attribute_valuevalues r_ensure_attributeBaseModNotes._ensure_attributeCs9&..0 8'$48 =M* * r all_notesc+# U(a.UH'nUHnUR"Xe40UD6ShvN M M) gURX#5ShvN gN'N7frI)r)rD)rrRr+r,r!r rs r_notesBaseModNotes._notesJsb ' )H#22  /? !*( ++IB B B  Cs!(AA!A A AAN)labelrr thingrVnoterWother_settingsr/c jSnU(a[U[5(aJUn[USU5(a[USU5(d#[URR U/S95nO UR n[USU5=(d URn[USU5=(d URnURSUS9nURSUS9n[U5[U5US .nU(aXS 'U(aXxS 'URU5 URR[S US 9$)aCreate a :class:`.ModNote` for a redditor in the specified subreddit. :param label: The label for the note. As of this writing, this can be one of the following: ``"ABUSE_WARNING"``, ``"BAN"``, ``"BOT_BAN"``, ``"HELPFUL_USER"``, ``"PERMA_BAN"``, ``"SOLID_CONTRIBUTOR"``, ``"SPAM_WARNING"``, ``"SPAM_WATCH"``, or ``None`` (default: ``None``). :param note: The content of the note. As of this writing, this is limited to 250 characters. :param redditor: The redditor to create the note for (default: ``None``). .. note:: This parameter is required if ``thing`` is not provided or this is not called from a :class:`.Redditor` instance (e.g., ``reddit.redditor.notes``). :param subreddit: The subreddit associated with the note (default: ``None``). .. note:: This parameter is required if ``thing`` is not provided or this is not called from a :class:`.Subreddit` instance (e.g., ``reddit.subreddit.mod``). :param thing: Either the fullname of a comment/submission, a :class:`.Comment`, or a :class:`.Submission` to associate with the note. :param other_settings: Additional keyword arguments can be provided to handle new parameters as Reddit introduces them. :returns: The new :class:`.ModNote` object. For example, to create a note for u/spez in r/test: .. code-block:: python reddit.subreddit("test").mod.notes.create( label="HELPFUL_USER", note="Test note", redditor="spez" ) # or reddit.redditor("spez").mod.notes.create( label="HELPFUL_USER", note="Test note", subreddit="test" ) # or reddit.notes.create( label="HELPFUL_USER", note="Test note", redditor="spez", subreddit="test" ) Nrr ) fullnameszEither the 'redditor' or 'thing' parameters must be provided or this method must be called from a Redditor instance (e.g., 'redditor.notes').rzEither the 'subreddit' or 'thing' parameters must be provided or this method must be called from a Subreddit instance (e.g., 'subreddit.mod.notes').r )r&r rXrV reddit_idr')data) isinstancer:rKnextrinfofullnameauthorr rPupdatepostr ) rrVrXrr rWrYr^r_s rcreateBaseModNotes.createZs2t %%%! D*h77k9==!!2!2eW!2!EFE!NN tZ:JellHk9=PI)) X*  ** ' + MY  !M  )  N#||  +!6T BBrF) delete_allnote_idrr rirjcLURSUS9nURSUS9nU(dUc Sn[U5eU(a-URSU/U/5HnUR5 M g[ U5[ U5US.nUR R[ S US 9 g) aDelete note(s) for a redditor. :param delete_all: When ``True``, delete all notes for the specified redditor in the specified subreddit (default: ``False``). .. note:: This will make a request for each note. :param note_id: The ID of the note to delete. This parameter is ignored if ``delete_all`` is ``True``. :param redditor: The redditor to delete the note(s) for (default: ``None``). Can be a :class:`.Redditor` instance or a redditor name. .. note:: This parameter is required if this method is **not** called from a :class:`.Redditor` instance (e.g., ``redditor.notes``). :param subreddit: The subreddit to delete the note(s) from (default: ``None``). Can be a :class:`.Subreddit` instance or a subreddit name. .. note:: This parameter is required if this method is **not** called from a :class:`.Subreddit` instance (e.g., ``reddit.subreddit.mod``). For example, to delete a note with the ID ``"ModNote_d324b280-5ecc-435d-8159-3e259e84e339"``, try: .. code-block:: python reddit.subreddit("test").mod.notes.delete( note_id="ModNote_d324b280-5ecc-435d-8159-3e259e84e339", redditor="spez" ) # or reddit.redditor("spez").notes.delete( note_id="ModNote_d324b280-5ecc-435d-8159-3e259e84e339", subreddit="test" ) # or reddit.notes.delete( note_id="ModNote_d324b280-5ecc-435d-8159-3e259e84e339", subreddit="test", redditor="spez", ) To delete all notes for u/spez, try: .. code-block:: python reddit.subreddit("test").mod.notes.delete(delete_all=True, redditor="spez") # or reddit.redditor("spez").notes.delete(delete_all=True, subreddit="test") # or reddit.notes.delete(delete_all=True, subreddit="test", redditor="spez") zEither the 'redditor' parameter must be provided or this method must be called from a Redditor instance (e.g., 'redditor.notes').r\zEither the 'subreddit' parameter must be provided or this method must be called from a Subreddit instance (e.g., 'subreddit.mod.notes').r]Nz2Either 'note_id' or 'delete_all' must be provided.T)r&r rjr'r4)rPrLrTdeleter:rr )rrirjrr msgrXr#s rrlBaseModNotes.deletesD)) I*  ** O+ goFCC.  D8*ykB CH  ^"F LL   5f  Err)r praw.Reddit)__name__ __module__ __qualname____firstlineno____doc__r RedditorType SubredditTyperr)rrrDr:rPboolrTrr rrrgrl__static_attributes__rrrrsA   Y Y! Y YBl+B9=m9LB 4 5B$s##CC %C' C  C 4 5 C& $+/-1;?^C}^C ^C <( ^C M* ^Cgz3678^C^C ^CF!!%+/-1 XFXF# XF <( XF M* XFXFrrc f^\rSrSrSrSSS\4U4SjjrSS.S \S \\ S \ S \ S 4Sjjr Sr U=r$)RedditorModNotesiaProvides methods to interact with moderator notes at the redditor level. .. note:: The authenticated user must be a moderator of the provided subreddit(s). For example, all the notes for u/spez in r/test can be iterated through like so: .. code-block:: python redditor = reddit.redditor("spez") for note in redditor.notes.subreddits("test"): print(f"{note.label}: {note.note}") rrorc0>[TU]U5 X lg)zInitialize a :class:`.RedditorModNotes` instance. :param reddit: An instance of :class:`.Reddit`. :param redditor: An instance of :class:`.Redditor`. N)superrr)rrr __class__s rrRedditorModNotes.__init__'s   rNrRr,rRr!r-r.c[U5S:Xa Sn[U5eUc[U5S:HnUR"UUR/[U5-[ U540UD6$)aYReturn notes for this :class:`.Redditor` from one or more subreddits. :param subreddits: One or more subreddits to retrieve the notes from. Must be either a :class:`.Subreddit` or a subreddit name. :param all_notes: Whether to return all notes or only the latest note (default: ``True`` if only one subreddit is provided otherwise ``False``). .. note:: Setting this to ``True`` will result in a request for each subreddit. :returns: A generator that yields the most recent :class:`.ModNote` (or ``None`` if this redditor doesn't have any notes) per subreddit in their relative order. If ``all_notes`` is ``True``, this will yield all notes or ``None`` from each subreddit for this redditor. For example, all the notes for u/spez in r/test can be iterated through like so: .. code-block:: python redditor = reddit.redditor("spez") for note in redditor.notes.subreddits("test"): print(f"{note.label}: {note.note}") For example, the latest note for u/spez from r/test and r/redditdev can be iterated through like so: .. code-block:: python redditor = reddit.redditor("spez") subreddit = reddit.subreddit("redditdev") for note in redditor.notes.subreddits("test", subreddit): print(f"{note.label}: {note.note}") For example, **all** the notes for u/spez in r/test and r/redditdev can be iterated through like so: .. code-block:: python redditor = reddit.redditor("spez") subreddit = reddit.subreddit("redditdev") for note in redditor.notes.subreddits("test", subreddit, all_notes=True): print(f"{note.label}: {note.note}") rz&At least 1 subreddit must be provided.r )len ValueErrorrTrr6)rrRr,r!rms rr,RedditorModNotes.subreddits1sln z?a :CS/ !  J1,I{{  ]]Oc*o -      rr\)rprqrrrsrtrurrvrrwrrr,rx __classcell__r~s@rr{r{s`"!}! !%)A "A D>A  A 4 5 A A rr{c f^\rSrSrSrSSS\4U4SjjrSS.S \S \\ S \ S \ S 4Sjjr Sr U=r$)SubredditModNotesiuaProvides methods to interact with moderator notes at the subreddit level. .. note:: The authenticated user must be a moderator of this subreddit. For example, all the notes for u/spez in r/test can be iterated through like so: .. code-block:: python subreddit = reddit.subreddit("test") for note in subreddit.mod.notes.redditors("spez"): print(f"{note.label}: {note.note}") rror c0>[TU]U5 X lg)zInitialize a :class:`.SubredditModNotes` instance. :param reddit: An instance of :class:`.Reddit`. :param subreddit: An instance of :class:`.Subreddit`. N)r}rr )rrr r~s rrSubredditModNotes.__init__s  "rNrr+rRr!r-r.c[U5S:Xa Sn[U5eUc[U5S:HnUR"U[U5UR/[U5-40UD6$)a7Return notes from this :class:`.Subreddit` for one or more redditors. :param redditors: One or more redditors to retrieve notes for. Must be either a :class:`.Redditor` or a redditor name. :param all_notes: Whether to return all notes or only the latest note (default: ``True`` if only one redditor is provided otherwise ``False``). .. note:: Setting this to ``True`` will result in a request for each redditor. :returns: A generator that yields the most recent :class:`.ModNote` (or ``None`` if the user doesn't have any notes in this subreddit) per redditor in their relative order. If ``all_notes`` is ``True``, this will yield all notes for each redditor. For example, all the notes for u/spez in r/test can be iterated through like so: .. code-block:: python subreddit = reddit.subreddit("test") for note in subreddit.mod.notes.redditors("spez"): print(f"{note.label}: {note.note}") For example, the latest note for u/spez and u/bboe from r/test can be iterated through like so: .. code-block:: python subreddit = reddit.subreddit("test") redditor = reddit.redditor("bboe") for note in subreddit.mod.notes.redditors("spez", redditor): print(f"{note.label}: {note.note}") For example, **all** the notes for both u/spez and u/bboe in r/test can be iterated through like so: .. code-block:: python subreddit = reddit.subreddit("test") redditor = reddit.redditor("bboe") for note in subreddit.mod.notes.redditors("spez", redditor, all_notes=True): print(f"{note.label}: {note.note}") rz%At least 1 redditor must be provided.r )rrrTr6r )rrRr+r!rms rr+SubredditModNotes.redditorssln y>Q 9CS/ !  I!+I{{  O ^^ s9~ -    rr])rprqrrrsrtrvrrurrwrrr+rxrrs@rrrus`"#}##%)A  A D>A  A 4 5 A A rrc\rSrSrSrSSSSSS.S\S\\\\ \ 4S\\\ S \\\ S \\\ S \ S \ S 4SjjrSS.S \ S\\S \ S \ S 4SjjrSrg)RedditModNotesia4Provides methods to interact with moderator notes at a global level. .. note:: The authenticated user must be a moderator of the provided subreddit(s). For example, the latest note for u/spez in r/redditdev and r/test, and for u/bboe in r/redditdev can be iterated through like so: .. code-block:: python redditor = reddit.redditor("bboe") subreddit = reddit.subreddit("redditdev") pairs = [(subreddit, "spez"), ("test", "spez"), (subreddit, redditor)] for note in reddit.notes(pairs=pairs): print(f"{note.label}: {note.note}") FN)rRpairsr+r,thingsrRrr+r,rr!r-r.c BUc/nUc/nUc/nUc/nX#-U-U-(d Sn[U5e[U5[U5-S:Xa;[U5[U5-S:a [[U5S:aS5eS5e/n/n U[U5V V s/sHn [U5Hn X4PM M sn n -U-n U Hn [U [[ 45(aLUR U RR5 U R U RR5 Mj[U [5(a(U upUR U 5 U R U 5 MS[U 53n[U5e UR"XU 40UD6$s sn n f)ac Get note(s) for each subreddit/user pair, or ``None`` if they don't have any. :param all_notes: Whether to return all notes or only the latest note for each subreddit/redditor pair (default: ``False``). .. note:: Setting this to ``True`` will result in a request for each unique subreddit/redditor pair. If ``subreddits`` and ``redditors`` are provided, this will make a request equivalent to number of redditors multiplied by the number of subreddits. :param pairs: A list of subreddit/redditor tuples. .. note:: Required if ``subreddits``, ``redditors``, nor ``things`` are provided. :param redditors: A list of redditors to return notes for. This parameter is used in tandem with ``subreddits`` to get notes from multiple subreddits for each of the provided redditors. .. note:: Required if ``items`` or ``things`` is not provided or if ``subreddits`` **is** provided. :param subreddits: A list of subreddits to return notes for. This parameter is used in tandem with ``redditors`` to get notes for multiple redditors from each of the provided subreddits. .. note:: Required if ``items`` or ``things`` is not provided or if ``redditors`` **is** provided. :param things: A list of comments and/or submissions to return notes for. :param generator_kwargs: Additional keyword arguments passed to the generator. This parameter is ignored when ``all_notes`` is ``False``. :returns: A generator that yields the most recent :class:`.ModNote` (or ``None`` if the user doesn't have any notes) per entry in their relative order. If ``all_notes`` is ``True``, this will yield all notes for each entry. .. note:: This method will merge the subreddits and redditors provided from ``pairs``, ``redditors``, ``subreddits``, and ``things``. .. note:: This method accepts :class:`.Redditor` instances or redditor names and :class:`.Subreddit` instances or subreddit names where applicable. For example, the latest note for u/spez in r/redditdev and r/test, and for u/bboe in r/redditdev can be iterated through like so: .. code-block:: python redditor = reddit.redditor("bboe") subreddit = reddit.subreddit("redditdev") pairs = [(subreddit, "spez"), ("test", "spez"), (subreddit, redditor)] for note in reddit.notes(pairs=pairs): print(f"{note.label}: {note.note}") For example, **all** the notes for u/spez and u/bboe in r/announcements, r/redditdev, and r/test can be iterated through like so: .. code-block:: python redditor = reddit.redditor("bboe") subreddit = reddit.subreddit("redditdev") for note in reddit.notes( redditors=["spez", redditor], subreddits=["announcements", subreddit, "test"], all_notes=True, ): print(f"{note.label}: {note.note}") For example, the latest note for the authors of the last 5 comments and submissions from r/test can be iterated through like so: .. code-block:: python submissions = list(reddit.subreddit("test").new(limit=5)) comments = list(reddit.subreddit("test").comments(limit=5)) for note in reddit.notes(things=submissions + comments): print(f"{note.label}: {note.note}") .. note:: Setting ``all_notes`` to ``True`` will make a request for each redditor and subreddit combination. The previous example will make 6 requests. zWEither the 'pairs', 'redditors', 'subreddits', or 'things' parameters must be provided.rz;'redditors' must be non-empty if 'subreddits' is not empty.z;'subreddits' must be non-empty if 'redditors' is not empty.z1Cannot get subreddit and author fields from type )rLrsetr`rrappendrdnamer display_namer typerrT)rrRrr+r,rr!rmmerged_redditorsmerged_subredditsrr itemsitems r__call__RedditModNotes.__call__sZ =E  I  J >F!J.7kCC.  NS_ , 1IZ014z?Q&N S   !$I .H!$ZI%!0& .     D$* 566 '' (8(89!(()D)DED%((&*#  ''1!((3I$t*V o%{{ ): >N  's Frc/n/nUH9nURUR5 URUR5 M; Uc[U5S:HnUR"XU40UD6$)aReturn notes associated with the author of a :class:`.Comment` or :class:`.Submission`. :param things: One or more things to return notes on. Must be a :class:`.Comment` or :class:`.Submission`. :param all_notes: Whether to return all notes, or only the latest (default: ``True`` if only one thing is provided otherwise ``False``). .. note:: Setting this to ``True`` will result in a request for each thing. :returns: A generator that yields the most recent :class:`.ModNote` (or ``None`` if the user doesn't have any notes) per entry in their relative order. If ``all_notes`` is ``True``, this will yield all notes for each entry. For example, to get the latest note for the authors of the top 25 submissions in r/test: .. code-block:: python submissions = reddit.subreddit("test").top(limit=25) for note in reddit.notes.things(*submissions): print(f"{note.label}: {note.note}") For example, to get the latest note for the authors of the last 25 comments in r/test: .. code-block:: python comments = reddit.subreddit("test").comments(limit=25) for note in reddit.notes.things(*comments): print(f"{note.label}: {note.note}") r )rr rdrrT)rrRrr!r,r+rWs rrRedditModNotes.thingssjR  E   eoo .   U\\ *  F q(I{{9P?OPPrry)rprqrrrsrtrwrrr rvru ThingTyperrrrrxryrrrrs0 DH2648,0[ [ U=,#>?@A [ D./ [ T-01 [ i)[  [  4 5[ @%)0Q0QD>0Q 0Q 4 5 0Q0Qrr)!rt itertoolsrtypingrrrrrr r constr baserlisting.generatorrreddit.commentrreddit.redditorrreddit.submissionr praw.modelsprawr:rurvrrr{rrryrrrs<NNN/#%)Xs]# -s23 ':% & }F}F@] |] @] ] @cQ\cQr