Fj!VdZddlmZddlmZmZddlmZddlm Z ddl m Z ddl m Z ddlmZdd lmZerdd lmZdd lmZdd lmZGd dZGddZy)z,Provide the SubredditModerationStream class.) annotations) TYPE_CHECKINGAny)API_PATH)ListingGenerator) RedditBase)SubredditRemovalReasons)stream_generator)cachedproperty)Iterator)models)ModmailConversationceZdZdZeddZeddZeddZeddZ ddZ ddZ dd  dd Z ddd  dd Z dd  dd Zdd  ddZddZdd ddZddZddZy)SubredditModerationzProvides a set of moderation functions to a :class:`.Subreddit`. For example, to accept a moderation invite from r/test: .. code-block:: python reddit.subreddit("test").mod.accept_invite() cH| |dk(rd}tj|d|yy)N submissionslinksparams) argumentskeyonly)r_safely_add_argumentsgenerator_kwargsrs e/root/workspace/ytshorts/venv/lib/python3.12/site-packages/praw/models/reddit/subreddit/moderation.py _handle_onlyz SubredditModeration._handle_only s.  }$  , ,7GX\` a c^ddlm}||jj|jS)aProvide an instance of :class:`.SubredditModNotes`. This provides an interface for managing moderator notes for 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}") r)SubredditModNotes subreddit)praw.models.mod_notesrr!_reddit)selfrs rnoteszSubredditModeration.notes's" < !7!74>>RRrc,t|jS)aProvide an instance of :class:`.SubredditRemovalReasons`. Use this attribute for interacting with a :class:`.Subreddit`'s removal reasons. For example to list all the removal reasons for a subreddit which you have the ``posts`` moderator permission on, try: .. code-block:: python for removal_reason in reddit.subreddit("test").mod.removal_reasons: print(removal_reason) A single removal reason can be lazily retrieved via: .. code-block:: python reddit.subreddit("test").mod.removal_reasons["reason_id"] .. note:: Attempting to access attributes of a nonexistent removal reason will result in a :class:`.ClientException`. )r r!r$s rremoval_reasonsz#SubredditModeration.removal_reasons;s2't~~66rc,t|jS)aProvide an instance of :class:`.SubredditModerationStream`. Streams can be used to indefinitely retrieve Moderator only items from :class:`.SubredditModeration` made to moderated subreddits, like: .. code-block:: python for log in reddit.subreddit("mod").mod.stream.log(): print(f"Mod: {log.mod}, Subreddit: {log.subreddit}") )SubredditModerationStreamr!r's rstreamzSubredditModeration.streamVs)88rc ||_d|_y)ztInitialize a :class:`.SubredditModeration` instance. :param subreddit: The subreddit to moderate. N)r!_streamr$r!s r__init__zSubredditModeration.__init__es # rctdj|j}|jjj |y)z5Accept an invitation as a moderator of the community.accept_mod_inviter N)rformatr!r#postr$urls r accept_invitez!SubredditModeration.accept_invitens7*+22T^^2L ##C(rNrc |j||t|jjtdj |jfi|S)aReturn a :class:`.ListingGenerator` for edited comments and submissions. :param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield only results of that type. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. To print all items in the edited queue try: .. code-block:: python for item in reddit.subreddit("mod").mod.edited(limit=None): print(item) r about_editedr rrr!r#rr2r$rrs reditedzSubredditModeration.editedssV& +;$G NN " " ^ $ + +dnn + E   ractionmodc |r t|n||d}tjd|dd|t|jj t dj|jfi|S)aoReturn a :class:`.ListingGenerator` for moderator log entries. :param action: If given, only return log entries for the specified action. :param mod: If given, only return log entries for actions made by the passed in redditor. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. To print the moderator and subreddit of the last 5 modlog entries try: .. code-block:: python for log in reddit.subreddit("mod").mod.log(limit=5): print(f"Mod: {log.mod}, Subreddit: {log.subreddit}") )r?typer)rr about_logr )strrrrr!r#rr2)r$r>r?rrs rlogzSubredditModeration.logsn0&)Sc6B((\3C\U[\ NN " " [ ! ( (4>> ( B   rc |j||t|jjtdj |jfi|S)aReturn a :class:`.ListingGenerator` for modqueue items. :param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield only results of that type. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. To print all modqueue items try: .. code-block:: python for item in reddit.subreddit("mod").mod.modqueue(limit=None): print(item) rabout_modqueuer r:r;s rmodqueuezSubredditModeration.modqueuesW& +;$G NN " " % & - - - G   rc |j||t|jjtdj |jfi|S)a}Return a :class:`.ListingGenerator` for reported comments and submissions. :param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield only results of that type. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. To print the user and mod report reasons in the report queue try: .. code-block:: python for reported_item in reddit.subreddit("mod").mod.reports(): print(f"User Reports: {reported_item.user_reports}") print(f"Mod Reports: {reported_item.mod_reports}") r about_reportsr r:r;s rreportszSubredditModeration.reportssV( +;$G NN " " _ % , ,t~~ , F   rctdj|j}|jjj |dS)zBReturn a dictionary of the :class:`.Subreddit`'s current settings.subreddit_settingsr data)rr2r!r#getr4s rsettingszSubredditModeration.settingss?+,33dnn3M~~%%))#.v66rc |j||t|jjtdj |jfi|S)aReturn a :class:`.ListingGenerator` for spam comments and submissions. :param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield only results of that type. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. To print the items in the spam queue try: .. code-block:: python for item in reddit.subreddit("mod").mod.spam(): print(item) r about_spamr r:r;s rspamzSubredditModeration.spamsV" +;$G NN " " \ " ) )DNN ) C   rc t|jjtdj |jfi|S)arReturn a :class:`.ListingGenerator` for unmoderated submissions. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. To print the items in the unmoderated queue try: .. code-block:: python for item in reddit.subreddit("mod").mod.unmoderated(): print(item) about_unmoderatedr )rr!r#rr2)r$rs r unmoderatedzSubredditModeration.unmoderatedsC NN " " ( ) 0 04>> 0 J   rc dddddd}|jDcic]\}}|j|||}}}|jj|d<|jjj t d| Scc}}w) a>Update the :class:`.Subreddit`'s settings. See https://www.reddit.com/dev/api#POST_api_site_admin for the full list. :param all_original_content: Mandate all submissions to be original content only. :param allow_chat_post_creation: Allow users to create chat submissions. :param allow_images: Allow users to upload images using the native image hosting. :param allow_polls: Allow users to post polls to the subreddit. :param allow_post_crossposts: Allow users to crosspost submissions from other subreddits. :param allow_videos: Allow users to upload videos using the native image hosting. :param collapse_deleted_comments: Collapse deleted and removed comments on comments pages by default. :param comment_score_hide_mins: The number of minutes to hide comment scores. :param content_options: The types of submissions users can make. One of ``"any"``, ``"link"``, or ``"self"``. :param crowd_control_chat_level: Controls the crowd control level for chat rooms. Goes from 0-3. :param crowd_control_level: Controls the crowd control level for submissions. Goes from 0-3. :param crowd_control_mode: Enables/disables crowd control. :param default_set: Allow the subreddit to appear on r/all as well as the default and trending lists. :param disable_contributor_requests: Specifies whether redditors may send automated modmail messages requesting approval as a submitter. :param exclude_banned_modqueue: Exclude posts by site-wide banned users from modqueue/unmoderated. :param free_form_reports: Allow users to specify custom reasons in the report menu. :param header_hover_text: The text seen when hovering over the snoo. :param hide_ads: Don't show ads within this subreddit. Only applies to Premium-user only subreddits. :param key_color: A 6-digit rgb hex color (e.g., ``"#AABBCC"``), used as a thematic color for your subreddit on mobile. :param language: A valid IETF language tag (underscore separated). :param original_content_tag_enabled: Enables the use of the ``original content`` label for submissions. :param over_18: Viewers must be over 18 years old (i.e., NSFW). :param public_description: Public description blurb. Appears in search results and on the landing page for private subreddits. :param restrict_commenting: Specifies whether approved users have the ability to comment. :param restrict_posting: Specifies whether approved users have the ability to submit posts. :param show_media: Show thumbnails on submissions. :param show_media_preview: Expand media previews on comments pages. :param spam_comments: Spam filter strength for comments. One of ``"all"``, ``"low"``, or ``"high"``. :param spam_links: Spam filter strength for links. One of ``"all"``, ``"low"``, or ``"high"``. :param spam_selfposts: Spam filter strength for selfposts. One of ``"all"``, ``"low"``, or ``"high"``. :param spoilers_enabled: Enable marking posts as containing spoilers. :param submit_link_label: Custom label for submit link button (``None`` for default). :param submit_text: Text to show on submission page. :param submit_text_label: Custom label for submit text post button (``None`` for default). :param subreddit_type: One of ``"archived"``, ``"employees_only"``, ``"gold_only"``, ``gold_restricted``, ``"private"``, ``"public"``, or ``"restricted"``. :param suggested_comment_sort: All comment threads will use this sorting method by default. Leave ``None``, or choose one of ``"confidence"``, ``"controversial"``, ``"live"``, ``"new"``, ``"old"``, ``"qa"``, ``"random"``, or ``"top"``. :param title: The title of the subreddit. :param welcome_message_enabled: Enables the subreddit welcome message. :param welcome_message_text: The text to be used as a welcome message. A welcome message is sent to all new subscribers by a Reddit bot. :param wiki_edit_age: Account age, in days, required to edit and create wiki pages. :param wiki_edit_karma: Subreddit karma required to edit and create wiki pages. :param wikimode: One of ``"anyone"``, ``"disabled"``, or ``"modonly"``. .. note:: Updating the subreddit sidebar on old reddit (``description``) is no longer supported using this method. You can update the sidebar by editing the ``"config/sidebar"`` wiki page. For example: .. code-block:: python sidebar = reddit.subreddit("test").wiki["config/sidebar"] sidebar.edit(content="new sidebar content") Additional keyword arguments can be provided to handle new settings as Reddit introduces them. Settings that are documented here and aren't explicitly set by you in a call to :meth:`.SubredditModeration.update` should retain their current value. If they do not, please file a bug. link_type allow_top header_titlelangrA)content_options default_setheader_hover_textlanguagesubreddit_typesrupdate_settings)json)itemsrOr!fullnamer#patchr)r$rPremaprvalues rupdatezSubredditModeration.updatesF +&!/$  BJAQR:3EIIc3'.RR00~~%%++H5F,Gh+WWSsB)rzdict[str, Any]r str | NonereturnNone)rkzmodels.SubredditModNotes)rkr )rkr*r!zmodels.Subredditrkrl)rkrl)rrjrrrk,Iterator[models.Comment | models.Submission])r>rjr?zmodels.Redditor | str | NonerrrkIterator[models.ModAction])rrjrrrkz,Iterator[models.Submission | models.Comment])rkdict[str, str | int | bool])rrrkIterator[models.Submission])rPzstr | int | boolrkrp)__name__ __module__ __qualname____doc__ staticmethodrr r%r(r+r/r6r<rErHrKrPrSrVrirCrrrrsbb SS&774 9 9) %) ! >A 5 :",0   *    $  B%) ! >A 5 6%) ! >A 5 67 *. 0 (kXrrceZdZdZddZddddZddd ddZdddd dd Zdd dd Zdd dd Z dddd Z dd Z y)r*zProvides moderator streams.c||_y)zInitialize a :class:`.SubredditModerationStream` instance. :param subreddit: The moderated subreddit associated with the streams. Nr r.s rr/z"SubredditModerationStream.__init__s #rNr7c Zt|jjjfd|i|S)aYield edited comments and submissions as they become available. :param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield only results of that type. Keyword arguments are passed to :func:`.stream_generator`. For example, to retrieve all new edited submissions/comments made to all moderated subreddits, try: .. code-block:: python for item in reddit.subreddit("mod").mod.stream.edited(): print(item) r)r r!r?r<r$rstream_optionss rr<z SubredditModerationStream.editeds)"  2 2 9 9WWWWrr=c ^t|jjjf|d|d|S)a Yield moderator log entries as they become available. :param action: If given, only return log entries for the specified action. :param mod: If given, only return log entries for actions made by the passed in redditor. For example, to retrieve all new mod actions made to all moderated subreddits, try: .. code-block:: python for log in reddit.subreddit("mod").mod.stream.log(): print(f"Mod: {log.mod}, Subreddit: {log.subreddit}") id)r>attribute_namer?)r r!r?rE)r$r>r?r{s rrEzSubredditModerationStream.logs<, NN   " "      r)other_subredditssortstatec |jdk(r*|jjjd|_t|jjjfdd|||d|S)a8Yield new-modmail conversations as they become available. :param other_subreddits: A list of :class:`.Subreddit` instances for which to fetch conversations (default: ``None``). :param sort: Can be one of: ``"mod"``, ``"recent"``, ``"unread"``, or ``"user"`` (default: ``"recent"``). :param state: Can be one of: ``"all"``, ``"appeals"``, ``"archived"``, ``"default"``, ``"highlighted"``, ``"inbox"``, ``"inprogress"``, ``"join_requests"``, ``"mod"``, ``"new"``, or ``"notifications"`` (default: ``"all"``). ``"all"`` does not include mod or archived conversations. ``"inbox"`` does not include appeals conversations. Keyword arguments are passed to :func:`.stream_generator`. To print new mail in the unread modmail queue try: .. code-block:: python subreddit = reddit.subreddit("all") for message in subreddit.mod.stream.modmail_conversations(): print(f"From: {message.owner}, To: {message.participant}") r?allr}T)r~exclude_beforerrr)r!r#r modmail conversations)r$rrrr{s rmodmail_conversationsz/SubredditModerationStream.modmail_conversationssj> >>U "!^^33==eDDN NN " " 0 0 -    rc Zt|jjjfd|i|S)aYield :class:`.Comment`\ s and :class:`.Submission`\ s in the modqueue as they become available. :param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield only results of that type. Keyword arguments are passed to :func:`.stream_generator`. To print all new modqueue items try: .. code-block:: python for item in reddit.subreddit("mod").mod.stream.modqueue(): print(item) r)r r!r?rHrzs rrHz"SubredditModerationStream.modqueues)$  2 2 ; ;Y$Y.YYrc Zt|jjjfd|i|S)aYield reported :class:`.Comment`\ s and :class:`.Submission`\ s as they become available. :param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield only results of that type. Keyword arguments are passed to :func:`.stream_generator`. To print new user and mod report reasons in the report queue try: .. code-block:: python for item in reddit.subreddit("mod").mod.stream.reports(): print(item) r)r r!r?rKrzs rrKz!SubredditModerationStream.reportss)$  2 2 : :XXXXrc Zt|jjjfd|i|S)aYield spam :class:`.Comment`\ s and :class:`.Submission`\ s as they become available. :param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield only results of that type. Keyword arguments are passed to :func:`.stream_generator`. To print new items in the spam queue try: .. code-block:: python for item in reddit.subreddit("mod").mod.stream.spam(): print(item) r)r r!r?rSrzs rrSzSubredditModerationStream.spams)   2 2 7 7UdUnUUrc Vt|jjjfi|S)aRYield unmoderated :class:`.Submission`\ s as they become available. Keyword arguments are passed to :func:`.stream_generator`. To print new items in the unmoderated queue try: .. code-block:: python for item in reddit.subreddit("mod").mod.stream.unmoderated(): print(item) )r r!r?rV)r$r{s rrVz%SubredditModerationStream.unmoderated"s$  2 2 > >Q.QQrrm)rrjr{rrkrn)r>rjr?zstr | models.Redditor | Noner{rrkro) rzlist[models.Subreddit] | Nonerrjrrjr{rrkzIterator[ModmailConversation])r{rrkrq) rrrsrtrur/r<rErrHrKrSrVrCrrr*r*s%#,0X,",0   *    $  B;? ) 8)  )  )  )  ') X%)Z!ZrsI2"%:.F-$(>iXiXX nRnRr