Fj_edZddlmZddlmZddlmZmZmZddl m Z ddl m Z ddl mZddlmZdd lmZerdd lmZdd lZdd lmZdd lmZddlmZGddZGddeZGddeZGddeZy )z6Provides classes for interacting with moderator notes.) annotations)islice) TYPE_CHECKINGAnycast)API_PATH)PRAWBase)ListingGenerator)Comment) Submission)IteratorN)models)Redditor) SubredditceZdZdZ d dZ ddZ ddZddZ ddZddddd dd Z d dddd  dd Z y) BaseModNotesz7Provides base methods to interact with moderator notes.c||_y)zpInitialize a :class:`.BaseModNotes` instance. :param reddit: An instance of :class:`.Reddit`. N)_reddit)selfreddits S/root/workspace/ytshorts/venv/lib/python3.12/site-packages/praw/models/mod_notes.py__init__zBaseModNotes.__init__s  c tj|d||tdt|jt dfi|S)Nparams) argumentskey subreddituserIterator[models.ModNote] mod_notes)r _safely_add_argumentsrr rr)rredditorrgenerator_kwargss r_all_generatorzBaseModNotes._all_generator%sI &&&   & T\\8K+@ UDT U  rc#Kt|}t|} tt|d}tt|d}t||gsydj t t |dj t t |d}|jjtd|}|dD]4} td|jjj| 6حw) Ni,) subredditsusersmod_notes_bulkrr!models.ModNotedata) iterlistranyjoinmapstrrgetrr _objector objectify) r redditorsr(subreddits_iterredditors_itersubreddits_chunk users_chunkrresponse note_dicts r_bulk_generatorzBaseModNotes._bulk_generator6sz*i#F?C$@A vnc:;K(+67!hhs30@'AB#c;"78,F||''1A(B6'RH%k2 _ +T\\-C-C-M-MS\-M-]^^ _sC0C2c h|j\}}|xs t||d}| t||SN)popitemgetattr TypeError)r error_message attributes attributevalue_values r_ensure_attributezBaseModNotes._ensure_attributeHs=&..0 68'$ 48 =M* * rc+K|r+|D]%}|D]}|j||fi|Ed{ 'y|j||Ed{y7$7wrA)r%r?)r all_notesr8r(r$rr#s r_noteszBaseModNotes._notesOsm ' \ )\H2t228Y[JZ[[[\ \++IzB B B\ Bs!$AA AA A AN)labelr#rthingc jd}|r|}t|trC|}t|d|r t|d|s3t|jj |g}n |j }t|ttfsJt|d|xs |j}t|d|xs |j}|jd|}|jd|}|t|t|d } |r|| d <|r|| d <| j||jjtd | S)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" ) Nr#r) fullnameszEither the 'redditor' or 'thing' parameters must be provided or this method must be called from a Redditor instance (e.g., 'redditor.notes').r#zEither the 'subreddit' or 'thing' parameters must be provided or this method must be called from a Subreddit instance (e.g., 'subreddit.mod.notes').r)noterrrN reddit_idr!r-) isinstancer4rCnextrinfofullnamer r authorrrJupdatepostr) rrNrTr#rrOother_settingsrUresolvedr.s rcreatezBaseModNotes.create^sFt ?DH%%! j(;k[d@e#DLL$5$5$5$HIH!NN h*(=> >>tZ:MhooHk9=SASASI)) X*  ** ' + YM  !DM  )D  N#||  +!6T BBrF) delete_allnote_idr#rcF|jd|}|jd|}|s| d}t||r,|jd|g|gD]}|jy|t |t |d } |j jt d | y) aHDelete 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').rRzEither the 'subreddit' parameter must be provided or this method must be called from a Subreddit instance (e.g., 'subreddit.mod.notes').rSNz2Either 'note_id' or 'delete_all' must be provided.TrLr8r()rarrr!r+)rJrDrMdeleter4rr) rr`rar#r redditor_ subreddit_msgrTrs rrdzBaseModNotes.deletesD%)$:$: I%;% '+&<&< O'=' goFCC.  dykWaVb c   # _IF LL   5f  Er)r praw.RedditreturnNone)r#Redditor | strrSubreddit | strr$rrir )r8list[Redditor | str]r(list[Subreddit | str]rir )rEr4rFrrir) rLboolr8rmr(rnr$rrir )rN str | NonerTr4r#Redditor | str | NonerSubreddit | str | NonerOz!Comment | Submission | str | Noner]rrir,) r`rorarpr#rqrrrrirj) __name__ __module__ __qualname____doc__rr%r?rJrMr_rdrrrrseA       #   "  "_-_;P_ !_$ C C( C * C  C " C$!*.,037`C`C `C ( `C * `C1`C`C `CJ!"*.,0 XFXF XF ( XF * XF XFrrc\eZdZdZdddddd ddZdd d dZy) RedditModNotesa`Provides 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)rLpairsr8r(thingsc |g}|g}|g}|g}||z|z|zs d}t|t|t|zdk(r9t|t|zdkDrtt|dkDrddg}g} |t|D cgc]} t|D]} | | fc} } z|z} | D]} t| tt frK|j | jj| j | jjdt| tr(| \} } |j | | j | dt| }t||jd||| d|Scc} } w)acGet 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 rcrw)rDlensetrVr r appendrZnamer display_nametupletyperM)rrLrzr8r(r{r$rgmerged_redditorsmerged_subredditsr#ritemsitems r__call__zRedditModNotes.__call__1sZ =E  I  J >F !J.7kCC. y>C O +q 0S^c*o5UXY5Yz?Q&N S  s9~o8_bcm_noR[)X.o.oorxx %D$* 56 '' (8(89!(()D)DED%(&*# 8 ''1!((3I$t*Vn$ %t{{ &(    psFrLcg}g}|D]8}|j|j|j|j:|t|dk(}|jd|||d|S)a]Return 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}") rcrw)rrrZr}rM)rrLr{r$r(r8rOs rr{zRedditModNotes.thingssR   +E   eoo .   U\\ * +  F q(It{{ !    r)rLrorzz3list[tuple[Subreddit | str, Redditor | str]] | Noner8zlist[Redditor | str] | Noner(zlist[Subreddit | str] | Noner{z!list[Comment | Submission] | Noner$rrir )r{zComment | SubmissionrL bool | Noner$rrir )rsrtrurvrr{rwrrryrys0 EI153748S S C S / S 1 S 2S  S  "S p"&5 %5 5  5 " 5 rryc@eZdZdZdfd Zdd ddZxZS)RedditorModNotesaProvides 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}") c2t||||_y)zInitialize a :class:`.RedditorModNotes` instance. :param reddit: An instance of :class:`.Reddit`. :param redditor: An instance of :class:`.Redditor`. N)superrr#)rrr# __class__s rrzRedditorModNotes.__init__s    rNrct|dk(r d}t||t|dk(}|jd||jgt|zt |d|S)aIReturn 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.rrcrw)r} ValueErrorrMr#r0)rrLr(r$rgs rr(zRedditorModNotes.subredditsssn z?a :CS/ !  J1,It{{ }}oJ7J'    r)rrhr#rkrirj)r(rlrLrr$rrir )rsrtrurvrr( __classcell__rs@rrrsB"!"&A $A A  A " A rrc@eZdZdZdfd Zdd ddZxZS)SubredditModNotesaProvides 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}") c2t||||_y)zInitialize a :class:`.SubredditModNotes` instance. :param reddit: An instance of :class:`.Reddit`. :param subreddit: An instance of :class:`.Subreddit`. N)rrr)rrrrs rrzSubredditModNotes.__init__ps  "rNrc t|dk(r d}t||t|dk(}|jd|t||jgt|zd|S)a'Return 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.rrcrw)r}rrMr0r)rrLr8r$rgs rr8zSubredditModNotes.redditorszssn y>Q 9CS/ !  I!+It{{ 9o'#i.8    r)rrhrrlrirj)r8rkrLrr$rrir )rsrtrurvrr8rrs@rrr^sB"#"&A "A A  A " A rr)rv __future__r itertoolsrtypingrrr praw.constrpraw.models.baser praw.models.listing.generatorr praw.models.reddit.commentr praw.models.reddit.submissionr collections.abcr prawrpraw.models.reddit.redditorrpraw.models.reddit.subredditrrryrrrwrrrsp<"++%:.4(46AFAFH` \` F] |] @] ] r