o 2gPc@sdZddlmZddlmZmZmZmZmZm Z m Z ddl m Z ddl mZddlmZdd lmZdd lmZdd lmZerDdd lZe eefZe d efZe eefZGdddZGdddeZGdddeZGdddeZ d S)z6Provides classes for interacting with moderator notes.)islice) TYPE_CHECKINGAny GeneratorListOptionalTupleUnion)API_PATH)PRAWBase)ListingGenerator)Comment)Redditor) SubmissionNzpraw.models.Subredditc@seZdZdZ  d'ddZdededefd d Zd e ed e ed e dfddZ de ded efddZ ded e ed e eded e df ddZddddddee de deedeedeeeee fded dfdd Zd!dddd"d#ed$ee deedeefd%d&ZdS)( BaseModNotesz7Provides base methods to interact with moderator notes.reddit praw.RedditcCs ||_dS)zpInitialize a :class:`.BaseModNotes` instance. :param reddit: An instance of :class:`.Reddit`. N)_reddit)selfrrM/home/garg/my-data/venv/lib/python3.10/site-packages/praw/models/mod_notes.py__init__s zBaseModNotes.__init__redditor subredditgenerator_kwargscKs*tj|d||dt|jtdfi|S)Nparams) argumentskeyruser mod_notes)r _safely_add_argumentsrrr )rrrrrrr_all_generator#szBaseModNotes._all_generator redditors subredditsreturnpraw.models.ModNoteNNc cst|}t|} tt|d}tt|d}t||gs dSdtt|dtt|d}|jjt d|d}|dD] } |jj | Vq?q )NTi,)r%usersmod_notes_bulkrr!) iterlistranyjoinmapstrrgetr _objector objectify) rr$r%subreddits_iterredditors_itersubreddits_chunk users_chunkrresponse note_dictrrr_bulk_generator1s  zBaseModNotes._bulk_generator error_message attributescKs0|\}}|p t||d}|durt||SN)popitemgetattr TypeError)rr=r> attribute_valuevaluerrr_ensure_attributeCs zBaseModNotes._ensure_attribute all_notescksN|r|D]}|D]}|j||fi|EdHq qdS|||EdHdSr?)r#r<)rrGr$r%rrrrrr_notesJszBaseModNotes._notesN)labelrrthingrInoterJother_settingsr(c Ksd}|r7t|tr"|}t|d|rt|d|s!t|jj|gd}n|j}t|d|p-|j}t|d|p6|j}|j d|d}|j d|d}t|t||d }|rU||d <|r[||d <| ||jj t d |d 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" ) 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 rrKrI reddit_idr!)data) isinstancer2rAnextrinfofullnameauthorrrFupdatepostr ) rrIrKrrrJrLrPrQrrrcreateZs>:    zBaseModNotes.createF) delete_allnote_idrrrZr[cCs|jd|d}|jd|d}|s|durd}t||r.|d|g|gD]}|q%dSt|t||d}|jjtd |d dS) 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').rNzEither the 'subreddit' parameter must be provided or this method must be called from a Subreddit instance (e.g., 'subreddit.mod.notes').rONz2Either 'note_id' or 'delete_all' must be provided.T)r rr[r!r,)rFrBrHdeleter2rr )rrZr[rrmsgrKrrrrr\s(B  zBaseModNotes.delete)rr)__name__ __module__ __qualname____doc__r RedditorType SubredditTyperr#rrr<r2rFboolrHrr rrrYr\rrrrrs~      crc ReZdZdZdddeffdd Zddd ed eed e d e d fddZ Z S)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}") rrrct|||_dS)zInitialize a :class:`.RedditorModNotes` instance. :param reddit: An instance of :class:`.Reddit`. :param redditor: An instance of :class:`.Redditor`. N)superrr)rrr __class__rrr'  zRedditorModNotes.__init__NrGr%rGrr&r'cOsRt|dkr d}t||durt|dk}|j||jgt|t|fi|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.Nr )len ValueErrorrHrr.)rrGr%rr]rrrr%1s 7 zRedditorModNotes.subreddits) r^r_r`rarbrrcrrdrrr% __classcell__rrrirrf rfc re)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}") rrrcrg)zInitialize a :class:`.SubredditModNotes` instance. :param reddit: An instance of :class:`.Reddit`. :param subreddit: An instance of :class:`.Subreddit`. N)rhrr)rrrrirrrrkzSubredditModNotes.__init__Nrlr$rGrr&r'cOsRt|dkr d}t||durt|dk}|j|t||jgt|fi|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.Nr )rmrnrHr.r)rrGr$rr]rrrr$s 7 zSubredditModNotes.redditors) r^r_r`rarcrrbrrdrrr$rorrrirrqurprqc@seZdZdZdddddddedeeeee fdeee deeed eee d e d e d fd dZ ddd e deed e d e d fddZdS)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)rGpairsr$r%thingsrGrsr$r%rtrr&r'c s<|durg}|dur g}durg|durg}|||s&d}t|t|tdkrGt|tdkrGttdkrDddg}g} |fddt|D|} | D]6} t| ttfrt|| jj| | j j q\t| t r| \} } || | | q\dt | }t ||j||| fi|S) 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. NzWEither 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.cs"g|] }tD]}||fqqSr)set).0rrr%rr qsz+RedditModNotes.__call__..z1Cannot get subreddit and author fields from type )rBrmrurRrrappendrVnamer display_namertypernrH)rrGrsr$r%rtrr]merged_redditorsmerged_subredditsitemsitemrrrrwr__call__sXm      zRedditModNotes.__call__rlcOsTg}g}|D]}||j||jq|durt|dk}|j|||fi|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}") Nr )ryrrVrmrH)rrGrtrr%r$rJrrrrts)  zRedditModNotes.things)r^r_r`rardrrrrcrb ThingTyperrrrtrrrrrrsB    !rr)!ra itertoolsrtypingrrrrrrr constr baser listing.generatorrreddit.commentrreddit.redditorrreddit.submissionr praw.modelsprawr2rbrcrrrfrqrrrrrrs( $         ``