{iYSrSSKJr SSKrSSKJr SSKJr SSKJ r SSK J r J r SSK Jr SS KJrJrJrJr SS KJr SS KJr SS KJr SSKrSS KJr SSKJr SSKJ r SSK!J"r"J#r# SSK$J%r%J&r&J'r'J(r(J)r)J*r* SSK+J,r,J-r- SSK.J/r/ SSK0J1r1 SSK+J2r2J3r3 SSK4J5r5 SSK6J7r7 SSK8J9r9J:r: SSK;Jr> SSK?J@r@ SSKAJBrBJCrC SS KDJErE \(a SS!KFJGrG SSKHrI"S"S#5rJ"S$S%5rK"S&S'5rL"S(S)5rM"S*S+5rN"S,S-5rO"S.S/5rP"S0S15rQ"S2S35rR"S4S55rS"S6S75rT"S8S9\Q5rU"S:S;\Q5rV"S<S=\:\1\9\55rW\W\ClX"S>S?\M5rY"S@SA\M5rZg)BzProvide the Subreddit class.) annotationsN)deepcopy)writer)StringIO)dumpsloads)Path) TYPE_CHECKINGAny GeneratorIterator)urljoin)warn)XML)Redirect) ServerError) HTTPError)API_PATH JPEG_HEADER)ClientExceptionInvalidFlairTemplateIDMediaPostFailedRedditAPIExceptionTooLargeMediaExceptionWebSocketException)_deprecate_argscachedproperty)ListingGenerator)SubredditListingMixin)permissions_stringstream_generator) RedditBaseSubredditEmoji) FullnameMixinMessageableMixin)ModmailConversation)SubredditRemovalReasonsSubredditRules)SubredditWidgets WidgetEncoder)WikiPage)Responsec\rSrSrSrSSSjjrSSjrSSjr\"SS 5SSS .SS jj5r \"S SS S 5SSSSS.SSjj5r \"SSSS5SS.SSjj5r S Sjr S!Sjr Srg)"Modmail1a,Provides modmail functions for a :class:`.Subreddit`. For example, to send a new modmail from r/test to u/spez with the subject ``"test"`` along with a message body of ``"hello"``: .. code-block:: python reddit.subreddit("test").modmail.create(subject="test", body="hello", recipient="spez") NFc>[URRXS9$)aReturn an individual conversation. :param id: A reddit base36 conversation ID, e.g., ``"2gmz"``. :param mark_read: If ``True``, conversation is marked as read (default: ``False``). For example: .. code-block:: python reddit.subreddit("test").modmail("2gmz", mark_read=True) To print all messages from a conversation as Markdown source: .. code-block:: python conversation = reddit.subreddit("test").modmail("2gmz", mark_read=True) for message in conversation.messages: print(message.body_markdown) ``ModmailConversation.user`` is a special instance of :class:`.Redditor` with extra attributes describing the non-moderator user's recent posts, comments, and modmail messages within the subreddit, as well as information on active bans and mutes. This attribute does not exist on internal moderator discussions. For example, to print the user's ban status: .. code-block:: python conversation = reddit.subreddit("test").modmail("2gmz", mark_read=True) print(conversation.user.ban_status) To print a list of recent submissions by the user: .. code-block:: python conversation = reddit.subreddit("test").modmail("2gmz", mark_read=True) print(conversation.user.recent_posts) )id mark_read)r* subreddit_reddit)selfr6r7s V/home/james-whalen/.local/lib/python3.13/site-packages/praw/models/reddit/subreddit.py__call__Modmail.__call__=sV#4>>#9#9bVVcXlg)z(Initialize a :class:`.Modmail` instance.Nr8r:r8s r;__init__Modmail.__init__js"r>other_subredditscdUR/U=(d /-nSRSU55$)z9Return a comma-separated list of subreddit display names.,c38# UHn[U5v M g7fN)str).0r8s r; 0Modmail._build_subreddit_list..ssC 9I )r8join)r:rD subredditss r;_build_subreddit_listModmail._build_subreddit_listns0nn%)9)?R@ xxC CCCr>state)rDrRcSURU50nU(aX#S'URRR[SUS9nUSVs/sH oP"U5PM sn$s snf)aMark conversations for subreddit(s) as read. .. note:: Due to server-side restrictions, r/all is not a valid subreddit for this method. Instead, use :meth:`~.Modmail.subreddits` to get a list of subreddits using the new modmail. :param other_subreddits: A list of :class:`.Subreddit` instances for which to mark conversations (default: ``None``). :param state: Can be one of: ``"all"``, ``"archived"``, or ``"highlighted"``, ``"inprogress"``, ``"join_requests"``, ``"mod"``, ``"new"``, ``"notifications"``, or ``"appeals"`` (default: ``"all"``). ``"all"`` does not include internal, archived, or appeals conversations. :returns: A list of :class:`.ModmailConversation` instances that were marked read. For example, to mark all notifications for a subreddit as read: .. code-block:: python subreddit = reddit.subreddit("test") subreddit.modmail.bulk_read(state="notifications") entityrRmodmail_bulk_readparamsconversation_ids)rPr8r9postr)r:rDrRrWresponseconversation_ids r; bulk_readModmail.bulk_readusBD667GHI #7O>>)).. ( )&/ :BBT9U 9UoD !9U   sA%aftersort)r^rDr_rRc 0nU(a[S[SS9 XS'URS:waURU5US'[R "S USX4S.UD6 [ URR[S 40UD6$) a(Generate :class:`.ModmailConversation` objects for subreddit(s). :param after: A base36 modmail conversation id. When provided, the listing begins after this conversation (default: ``None``). .. deprecated:: 7.4.0 This parameter is deprecated and will be removed in PRAW 8.0. This method will automatically fetch the next batch. Please pass it in the ``params`` argument like so: .. code-block:: python for convo in subreddit.modmail.conversations(params={"after": "qovbn"}): # process conversation ... :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"``, ``"archived"``, ``"highlighted"``, ``"inprogress"``, ``"join_requests"``, ``"mod"``, ``"new"``, ``"notifications"``, or ``"appeals"`` (default: ``"all"``). ``"all"`` does not include internal, archived, or appeals conversations. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. For example: .. code-block:: python conversations = reddit.subreddit("all").modmail.conversations(state="mod") z[The 'after' argument is deprecated and should be moved to the 'params' dictionary argument.rcategory stacklevelr^allrTrW) argumentskeyr_rRmodmail_conversations) rDeprecationWarningr8rP Subreddit_safely_add_argumentsr r9r)r:r^rDr_rRgenerator_kwargsrWs r; conversationsModmail.conversationss\  (+   $7O >>U "#99:JKF8 '' &H4 PV  NN " " , -   r>subjectbody recipient author_hidden)rrc|UUURUUS.nURRR[SUS9$)abCreate a new :class:`.ModmailConversation`. :param author_hidden: When ``True``, author is hidden from non-moderators (default: ``False``). :param body: The message body. Cannot be empty. :param recipient: The recipient; a username or an instance of :class:`.Redditor`. :param subject: The message subject. Cannot be empty. :returns: A :class:`.ModmailConversation` object for the newly created conversation. .. code-block:: python subreddit = reddit.subreddit("test") redditor = reddit.redditor("bboe") subreddit.modmail.create(subject="Subject", body="Body", recipient=redditor) )rpisAuthorHiddensrNamerotorgdata)r8r9rYr)r:rrrprqrorxs r;createModmail.createsG:+nn  ~~%%**84K+LSW*XXr>c## URRR[S5nUSR 5H9nURRRUS5nUSUlUv M; g7f)zYield subreddits using the new modmail that the user moderates. For example: .. code-block:: python subreddits = reddit.subreddit("all").modmail.subreddits() modmail_subredditsrO display_name lastUpdatedN)r8r9getrvalues last_updated)r:rZvaluer8s r;rOModmail.subredditssp>>))--h7K.LMl+224E..88~9NOI%*=%9I "O5sA>BcZURRR[S5$)aReturn unread conversation count by conversation state. At time of writing, possible states are: ``"archived"``, ``"highlighted"``, ``"inprogress"``, ``"join_requests"``, ``"mod"``, ``"new"``, ``"notifications"``, or ``"appeals"``. :returns: A dict mapping conversation states to unread counts. For example, to print the count of unread moderator discussions: .. code-block:: python subreddit = reddit.subreddit("test") unread_counts = subreddit.modmail.unread_count() print(unread_counts["mod"]) modmail_unread_count)r8r9rrr:s r; unread_countModmail.unread_counts%$~~%%))(3I*JKKr>r@)NF)r6 str | Noner7boolreturnr*r8praw.models.SubredditrD"list[praw.models.Subreddit] | None)rDz(list[praw.models.Subreddit | str] | NonerRrrzlist[ModmailConversation]) r^rrDrr_rrRrrlr rzIterator[ModmailConversation]) rrrrprIrqstr | praw.models.RedditorrorIrr*rz,Generator[praw.models.Subreddit, None, None])rzdict[str, int])__name__ __module__ __qualname____firstlineno____doc__r<rBrPrr\rmryrOr__static_attributes__rhr>r;r3r31s^ 8=+W+W04+W +WZ#D BD'1FJ ( C(  ( # ( 2( TW0&'B!?C ? ? = ?  ?  ?  ?  '? C? BY _E$"Y"Y "Y . "Y  "Y "YF"YH Lr>r3c@\rSrSrSrS SjrS SjrS SjrS SjrSr g) SubredditFiltersi,aProvide functions to interact with the special :class:`.Subreddit`'s filters. Members of this class should be utilized via :meth:`.Subreddit.filters`. For example, to add a filter, run: .. code-block:: python reddit.subreddit("all").filters.add("test") cXlg)zInitialize a :class:`.SubredditFilters` instance. :param subreddit: The special subreddit whose filters to work with. As of this writing filters can only be used with the special subreddits ``all`` and ``mod``. Nr@rAs r;rBSubredditFilters.__init__8s #r>c#\# [SRURURRRR 5S9nSURRR 0nURRRXS9nURShvN gN7f)zIterate through the special :class:`.Subreddit`'s filters. This method should be invoked as: .. code-block:: python for subreddit in reddit.subreddit("test").filters: ... subreddit_filter_list)specialuseruniquerVN) rformatr8r9rme _next_uniquerrO)r:urlrW response_datas r;__iter__SubredditFilters.__iter__Cs./66NN)?)?)D)D)G)G)I7 DNN22??@..2232F  ++++sB"B,$B*%B,c [SRURURRRR 5US9nURRR US[S[U5050S9 g)aAdd ``subreddit`` to the list of filtered subreddits. :param subreddit: The subreddit to add to the filter list. Items from subreddits added to the filtered list will no longer be included when obtaining listings for r/all. Alternatively, you can filter a subreddit temporarily from a special listing in a manner like so: .. code-block:: python reddit.subreddit("all-redditdev-learnpython") :raises: ``prawcore.NotFound`` when calling on a non-special subreddit. subreddit_filterrrr8modelnamerwN) rrr8r9rrputrrIr:r8rs r;addSubredditFilters.addUsw$)*11NN'',,//12  ""3gufc)n=U7V-W"Xr>c[SRURURRRR 5[ U5S9nURRRU5 g)zRemove ``subreddit`` from the list of filtered subreddits. :param subreddit: The subreddit to remove from the filter list. :raises: ``prawcore.NotFound`` when calling on a non-special subreddit. rrN)rrr8r9rrrIdeleters r;removeSubredditFilters.removensc)*11NN'',,//1)n2  %%c*r>r@Nrr)r8zpraw.models.Subreddit | str) rrrrrrBrrrrrhr>r;rr,s  #,$Y2 +r>rcB\rSrSrSr\SSj5r\SSj5rS S!SjjrS"Sjr \ "S S S S 5S SSSS.S#Sjj5r S$Sjr S%Sjr \ "SSSS5SSSS.S&Sjj5r\ "SSS5SSS.S'Sjj5rSrg)(SubredditFlairi~zJProvide a set of functions to interact with a :class:`.Subreddit`'s flair.c,[UR5$)aProvide an instance of :class:`.SubredditLinkFlairTemplates`. Use this attribute for interacting with a :class:`.Subreddit`'s link flair templates. For example to list all the link flair templates for a subreddit which you have the ``flair`` moderator permission on try: .. code-block:: python for template in reddit.subreddit("test").flair.link_templates: print(template) )SubredditLinkFlairTemplatesr8rs r;link_templatesSubredditFlair.link_templatess +4>>::r>c,[UR5$)azProvide an instance of :class:`.SubredditRedditorFlairTemplates`. Use this attribute for interacting with a :class:`.Subreddit`'s flair templates. For example to list all the flair templates for a subreddit which you have the ``flair`` moderator permission on try: .. code-block:: python for template in reddit.subreddit("test").flair.templates: print(template) )SubredditRedditorFlairTemplatesr8rs r; templatesSubredditFlair.templatess /t~~>>r>Nredditorc [RUSUS9 URSS5 [SR UR S9n[ UR RU40UD6$)aReturn a :class:`.ListingGenerator` for Redditors and their flairs. :param redditor: When provided, yield at most a single :class:`.Redditor` instance (default: ``None``). Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. Usage: .. code-block:: python for flair in reddit.subreddit("test").flair(limit=None): print(flair) rW)rerfrlimitN flairlistr@)rjrk setdefaultrrr8r r9r:rrlrs r;r<SubredditFlair.__call__si* ''&H8 (  ##GT2{#**T^^*D 6 6P?OPPr>cXlg)zlInitialize a :class:`.SubredditFlair` instance. :param subreddit: The subreddit whose flair to work with. Nr@rAs r;rBSubredditFlair.__init__ #r>position self_assign link_positionlink_self_assignleftFright)rrrrc [U5U=(d SUU=(d SUS.nURU5 [SRURS9nURR R XvS9 g)aUpdate the :class:`.Subreddit`'s flair configuration. :param link_position: One of ``"left"``, ``"right"``, or ``False`` to disable (default: ``"left"``). :param link_self_assign: Permit self assignment of link flair (default: ``False``). :param position: One of ``"left"``, ``"right"``, or ``False`` to disable (default: ``"right"``). :param self_assign: Permit self assignment of user flair (default: ``False``). .. code-block:: python subreddit = reddit.subreddit("test") subreddit.flair.configure(link_position="right", self_assign=True) Additional keyword arguments can be provided to handle new settings as Reddit introduces them. r) flair_enabledflair_positionflair_self_assign_enabledlink_flair_positionlink_flair_self_assign_enabled flairconfigr@rwN)rupdaterrr8r9rY)r:rrrrsettingsrxrs r; configureSubredditFlair.configuresm<"(^&1')4#0#6B.>   H}%,,t~~,F ##C#3r>c[SRURS9nURRR US[ U50S9 g)zDelete flair for a :class:`.Redditor`. :param redditor: A redditor name or :class:`.Redditor` instance. .. seealso:: :meth:`~.SubredditFlair.update` to delete the flair of many redditors at once. deleteflairr@rrwN)rrr8r9rYrI)r:rrs r;rSubredditFlair.deletesF}%,,t~~,F ##Cvs8}.E#Fr>c<URSU"555$)zDelete all :class:`.Redditor` flair in the :class:`.Subreddit`. :returns: List of dictionaries indicating the success or failure of each delete. c3*# UH oSv M g7f)rNrh)rJxs r;rK,SubredditFlair.delete_all..s5fV9fs)rrs r; delete_allSubredditFlair.delete_alls {{5df555r>text css_classflair_template_idr)rrrc,U(aUb Sn[U5e[U5US.nUb%X6S'[SRURS9nO$X&S'[SRURS9nURR R XvS 9 g) aiSet flair for a :class:`.Redditor`. :param redditor: A redditor name or :class:`.Redditor` instance. :param text: The flair text to associate with the :class:`.Redditor` or :class:`.Submission` (default: ``""``). :param css_class: The css class to associate with the flair html (default: ``""``). Use either this or ``flair_template_id``. :param flair_template_id: The ID of the flair template to be used (default: ``None``). Use either this or ``css_class``. This method can only be used by an authenticated user who is a moderator of the associated :class:`.Subreddit`. For example: .. code-block:: python reddit.subreddit("test").flair.set("bboe", text="PRAW author", css_class="mods") template = "6bd28436-1aa7-11e9-9902-0e05ab0fad46" reddit.subreddit("test").flair.set( "spez", text="Reddit CEO", flair_template_id=template ) NzMParameter 'css_class' cannot be used in conjunction with 'flair_template_id'.)rrr select_flairr@rflairrw) TypeErrorrIrrr8r9rY)r:rrrrmsgrxrs r;setSubredditFlair.setsB *6aCC. H t4  ((9$ %>*11DNN1KC ) 7#**T^^*DC ##C#3r> flair_list)rrc [5nUHn[U[5(aK[U5R [ US5UR SU5UR SU5/5 Mc[U5R [ U5X#/5 M UR5R5nUR5 /n[SRURS9nU(aVSSRUSS 50n URURRR!XS 95 US SnU(aMVU$) a&Set or clear the flair for many redditors at once. :param flair_list: Each item in this list should be either: - The name of a redditor. - An instance of :class:`.Redditor`. - A dictionary mapping keys ``"user"``, ``"flair_text"``, and ``"flair_css_class"`` to their respective values. The ``"user"`` key should map to a redditor, as described above. When a dictionary isn't provided, or the dictionary is missing either ``"flair_text"`` or ``"flair_css_class"`` keys, the default values will come from the other arguments. :param css_class: The css class to use when not explicitly provided in ``flair_list`` (default: ``""``). :param text: The flair text to use when not explicitly provided in ``flair_list`` (default: ``""``). :returns: List of dictionaries indicating the success or failure of each update. For example, to clear the flair text, and set the ``"praw"`` flair css class on a few users try: .. code-block:: python subreddit.flair.update(["bboe", "spez", "spladug"], css_class="praw") r flair_textflair_css_classflaircsvr@ flair_csv Ndrw)r isinstancedictrwriterowrIrgetvalue splitlinescloserrr8rNextendr9rY) r:rrr temp_linesitemlinesrZrrxs r;rSubredditFlair.update4s!JZ D$%%z"++DL)t4!2I>z"++SY,HI##%002z"))DNN)C5#;!78D OODNN22777G H#$KEer>r@)rz8praw.models.reddit.subreddit.SubredditLinkFlairTemplates)rzr;rr~swT; A;;"? E??&7;Q3Q Q ( Q8#ZAST$!&! %4%4 %4  %4  %4%4U%4N G6Z6IJ (, *4,*4 *4 & *4  *4K*4X\6;79 9  99 6989r>rc \rSrSrSr\SSj5rSSjrSrSSSSSSSSS .SSjjr SS.S Sjjr SS.S!Sjjr S"Sjr \ "SSS SS SSS S S5 SSSSSSSSSS. S#Sjj5rSrg)$SubredditFlairTemplatesiqzKProvide functions to interact with a :class:`.Subreddit`'s flair templates.cU(aS$S$)zKReturn ``"LINK_FLAIR"`` or ``"USER_FLAIR"`` depending on ``is_link`` value. LINK_FLAIR USER_FLAIRrhis_links r; flair_type"SubredditFlairTemplates.flair_typets '|8L8r>cXlg)aJInitialize a :class:`.SubredditFlairTemplates` instance. :param subreddit: The subreddit whose flair templates to work with. .. note:: This class should not be initialized directly. Instead, obtain an instance via: ``reddit.subreddit("test").flair.templates`` or ``reddit.subreddit("test").flair.link_templates``. Nr@rAs r;rB SubredditFlairTemplates.__init__y #r>c[e)z*Abstract method to return flair templates.)NotImplementedErrorrs r;r SubredditFlairTemplates.__iter__s!!r>NrF)allowable_contentbackground_colorrr  max_emojismod_only text_color text_editablerrrrrrrrc [SRURS9n UUUURU5U[ U5UU[ U 5S. n URR R XS9 g)Nflairtemplate_v2r@) rrrr rrrrrrw)rrr8r rr9rY) r:rrrr rrrrrrrxs r;_addSubredditFlairTemplates._addsr)*11DNN1K!2 0"//'2$X$!-0   ##C#3r>r c[SRURS9nURRR USUR U50S9 g)Nflairtemplateclearr@r rw)rrr8r9rYr )r:r rs r;_clearSubredditFlairTemplates._clearsJ+,33dnn3M ##C|T__W=U.V#Wr>c[SRURS9nURRR UUR U5URR S.US9 g)Nflairtemplatereorderr@)r r8)rWjson)rrr8r9patchr r})r:rr rs r;_reorder SubredditFlairTemplates._reordersb-.555O $$ "oog6!^^88 % r> template_idc[SRURS9nURRR USU0S9 g)aRemove a flair template provided by ``template_id``. For example, to delete the first :class:`.Redditor` flair template listed, try: .. code-block:: python template_info = list(subreddit.flair.templates)[0] subreddit.flair.templates.delete(template_info["id"]) flairtemplatedeleter@rrwNrrr8r9rY)r:r(rs r;rSubredditFlairTemplates.deletesD,-44t~~4N ##C/BK.P#Qr>fetchT) rrrr-rrrrrc [SRURS9n UUUUUUUU U S. n U(aw[U5V s/sHoSU:XdM U PM nn [ U5S:wa [ U5eUSnUR 5HunnU RU5bMUU U'M! URRRXS9 gs sn f) aUpdate the flair template provided by ``template_id``. :param template_id: The flair template to update. If not valid then an exception will be thrown. :param allowable_content: If specified, most be one of ``"all"``, ``"emoji"``, or ``"text"`` to restrict content to that type. If set to ``"emoji"`` then the ``"text"`` param must be a valid emoji string, for example, ``":snoo:"``. :param background_color: The flair template's new background color, as a hex color. :param css_class: The flair template's new css_class (default: ``""``). :param fetch: Whether PRAW will fetch existing information on the existing flair before updating (default: ``True``). :param max_emojis: Maximum emojis in the flair (Reddit defaults this value to ``10``). :param mod_only: Indicate if the flair can only be used by moderators. :param text: The flair template's new text. :param text_color: The flair template's new text color, either ``"light"`` or ``"dark"``. :param text_editable: Indicate if the flair text can be modified for each redditor that sets it (default: ``False``). .. warning:: If parameter ``fetch`` is set to ``False``, all parameters not provided will be reset to their default (``None`` or ``False``) values. For example, to make a user flair template text editable, try: .. code-block:: python template_info = list(subreddit.flair.templates)[0] subreddit.flair.templates.update( template_info["id"], text=template_info["flair_text"], text_editable=True, ) rr@) rrrrrrrrrr6r$rNrw) rrr8iterlenritemsrr9rY)r:r(rrrr-rrrrrrrxtemplate_existing_data existing_datarfrs r;rSubredditFlairTemplates.updatesB)*11DNN1K!2 0"!,$ $*   )-d)3X~7T >"a',[99*1-M+113 U88C=( %DI4 ##C#3s  CCr@)r rrrIr)rrrrrrIr  bool | Noner int | Nonerr6rrIrrrr)r r6)rlistr r6)r(rI)r(rIrrrrrrr-rrr7rr6rrrrrr6)rrrrr staticmethodr rBrrr r&rrrrrhr>r;rrqsyU99 #")-'+#!% $!%#4&4% 4  4  444444604XDH   R  )-'+ $!% $!%%)K4K4& K4 % K4  K4K4K4K4K4K4#K4 K4r>rc\rSrSrSr\SSj5r\SSj5r\SSj5r \SSj5r SSjr S r \ "S5S S .SS jj5rS S jr\ "SS5S S S.S!Sjj5r\ "S5S S .S"Sjj5r\ "S5S S .S"Sjj5rS#Sjr\ "S5S S .S"Sjj5rS$SjrS SjrS%SjrSrg )&SubredditModerationizProvides 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() onlycHUbUS:XaSn[R"USUS9 gg)N submissionslinksrW)rerfr<)r%rkrlr<s r; _handle_only SubredditModeration._handle_only(s/  }$  , ,*t  r>cXSSKJn U"URRURS9$)azProvide 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)SubredditModNotesr@)praw.models.mod_notesrDr8r9)r:rDs r;notesSubredditModeration.notes1s" < !7!74>>RRr>c,[UR5$)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 an nonexistent removal reason will result in a :class:`.ClientException`. )r+r8rs r;removal_reasons#SubredditModeration.removal_reasonsEs2't~~66r>c,[UR5$)aVProvide 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}") )SubredditModerationStreamr8rs r;streamSubredditModeration.stream`s)88r>cXlSUlg)zdInitialize a :class:`.SubredditModeration` instance. :param subreddit: The subreddit to moderate. N)r8_streamrAs r;rBSubredditModeration.__init__os # r>c[SRURS9nURRR U5 g)z5Accept an invitation as a moderator of the community.accept_mod_inviter@Nr+r:rs r; accept_invite!SubredditModeration.accept_invitexs7*+22T^^2L ##C(r>Nr<c URX!S9 [URR[SR URS940UD6$)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@rAr r8r9rrr:r<rls r;editedSubredditModeration.edited}sT( +;G NN " " ^ $ + +dnn + E   r>c [S[SS9 [URR[ SR URS940UD6$)aReturn a :class:`.ListingGenerator` for moderator messages. .. warning:: Legacy modmail is being deprecated in June 2021. Please see https://www.reddit.com/r/modnews/comments/mar9ha/even_more_modmail_improvements/ for more info. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. .. seealso:: :meth:`.unread` for unread moderator messages. To print the last 5 moderator mail messages and their replies, try: .. code-block:: python for message in reddit.subreddit("mod").mod.inbox(limit=5): print(f"From: {message.author}, Body: {message.body}") for reply in message.replies: print(f"From: {reply.author}, Body: {reply.body}") Legacy modmail is being deprecated in June 2021. Please see https://www.reddit.com/r/modnews/comments/mar9ha/even_more_modmail_improvements/ for more info.rramoderator_messagesr@rrir r8r9rrr:rls r;inboxSubredditModeration.inboxsZ4  (   NN " " ) * 1 1DNN 1 K   r>actionmodrerfc U(a [U5OUUS.n[R"SUSS.UD6 [URR [ SRURS940UD6$)aReturn 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}") )rftyperW)rerf about_logr@rh)rIrjrkr r8r9rr)r:rerfrlrWs r;logSubredditModeration.logsv2&)Sc6B'' &H 8>  NN " " [ ! ( (4>> ( B   r>c URX!S9 [URR[SR URS940UD6$)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) r@about_modqueuer@rZr[s r;modqueueSubredditModeration.modqueuesU( +;G NN " " % & - - - G   r>c URX!S9 [URR[SR URS940UD6$)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@rZr[s r;reportsSubredditModeration.reportssT* +;G NN " " _ % , ,t~~ , F   r>c[SRURS9nURRR U5S$)zBReturn a dictionary of the :class:`.Subreddit`'s current settings.subreddit_settingsr@rxrrr8r9rrTs r;rSubredditModeration.settingss?+,33dnn3M~~%%))#.v66r>c URX!S9 [URR[SR URS940UD6$)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@rZr[s r;spamSubredditModeration.spamsT( +;G NN " " \ " ) )DNN ) C   r>c [URR[SR URS940UD6$)a:Return 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@)r r8r9rrrbs r; unmoderatedSubredditModeration.unmoderated9sC NN " " ( ) 0 04>> 0 J   r>c [S[SS9 [URR[ SR URS940UD6$)aPReturn a :class:`.ListingGenerator` for unread moderator messages. .. warning:: Legacy modmail is being deprecated in June 2021. Please see https://www.reddit.com/r/modnews/comments/mar9ha/even_more_modmail_improvements/ for more info. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. .. seealso:: :meth:`.inbox` for all messages. To print the mail in the unread modmail queue try: .. code-block:: python for message in reddit.subreddit("mod").mod.unread(): print(f"From: {message.author}, To: {message.dest}") r_rramoderator_unreadr@rarbs r;unreadSubredditModeration.unreadMsZ0  (   NN " " ' ( / /$.. / I   r>c SSSSSS.nUR5VVs0sHup4URX35U_M nnnURRUS'URRR [ SUS 9$s snnf) aUpdate 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_titlelangri)content_options default_setheader_hover_textlanguagesubreddit_typesrupdate_settingsr$)r1rr8fullnamer9r%r)r:rremaprfrs r;rSubredditModeration.updatersF +&!/$  BJAQRAQ:3EIIc'.AQR00~~%%++H5F,Gh+WWSsB)rPr8)rldict[str, Any]r<r)rzpraw.models.SubredditModNotes)rr+)rz6praw.models.reddit.subreddit.SubredditModerationStreamr)r<rrlr rz6Iterator[praw.models.Comment | praw.models.Submission])rlr rz&Iterator[praw.models.SubredditMessage])rerrfrrlr rzIterator[praw.models.ModAction])r<rrlr rz6Iterator[praw.models.Submission | praw.models.Comment]rdict[str, str | int | bool])rlr r Iterator[praw.models.Submission])rzstr | int | boolrr)rrrrrr9rArrFrIrMrBrUrr\rcrkrorsrr{rrrrrhr>r;r;r;sSS&774 9 9) V$( ! >A ?  4% NXu%"15    /    )  &  DV$( ! >A ?  4V$( ! >A ?  67 V$( ! >A ?  4 (# JkXr>r;c\rSrSrSrSSjr\"S5SS.SSjj5r\"SS 5SSS .SS jj5r\"S S S5SSSS.SSjj5r \"S5SS.SSjj5r \"S5SS.SSjj5r \"S5SS.SSjj5r SSjr SSjrSrg)rLizProvides moderator streams.cXlg)zInitialize a :class:`.SubredditModerationStream` instance. :param subreddit: The moderated subreddit associated with the streams. Nr@rAs r;rB"SubredditModerationStream.__init__rr>r<NrWc Z[URRR4SU0UD6$)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#r8rfr\r:r<stream_optionss r;r\ SubredditModerationStream.editeds)(  2 2 9 9WWWWr>rerfrgc ^[URRR4SUUS.UD6$)aYield 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}") r6)attribute_namererf)r#r8rfrk)r:rerfrs r;rkSubredditModerationStream.logs<. NN   " "      r>rDr_rR)rDr_rRc URS:Xa*URRRS5Ul[URRR4SSUUUS.UD6$)aYield 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}") rfrdr6T)rexclude_beforerDr_rR)r8r9r#modmailrm)r:rDr_rRrs r;rg/SubredditModerationStream.modmail_conversations sk@ >>U "!^^33==eDDN NN " " 0 0 -    r>c Z[URRR4SU0UD6$)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#r8rfrors r;ro"SubredditModerationStream.modqueueLs4& NN   ' ' .2 6D  r>c Z[URRR4SU0UD6$)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#r8rfrsrs r;rs!SubredditModerationStream.reportscs)&  2 2 : :XXXXr>c Z[URRR4SU0UD6$)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#r8rfr{rs r;r{SubredditModerationStream.spamxs)&  2 2 7 7UdUnUUr>c V[URRR40UD6$)a"Yield 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#r8rfrr:rs r;r%SubredditModerationStream.unmoderateds$  2 2 > >Q.QQr>c V[URRR40UD6$)aYield unread old modmail messages as they become available. Keyword arguments are passed to :func:`.stream_generator`. .. seealso:: :meth:`.SubredditModeration.inbox` for all messages. To print new mail in the unread modmail queue try: .. code-block:: python for message in reddit.subreddit("mod").mod.stream.unread(): print(f"From: {message.author}, To: {message.dest}") )r#r8rfrrs r;r SubredditModerationStream.unreads$&  2 2 9 9L^LLr>r@r)r<rrr rzCGenerator[praw.models.Comment | praw.models.Submission, None, None])rerrf!str | praw.models.Redditor | Nonerr rz,Generator[praw.models.ModAction, None, None]) rDrr_rrRrrr rz*Generator[ModmailConversation, None, None]rr rz-Generator[praw.models.Submission, None, None])rr rz3Generator[praw.models.SubredditMessage, None, None])rrrrrrBrr\rkrgrorsr{rrrrhr>r;rLrLs%#V$(X!XrLc.\rSrSrSrSSjrSrSrSrg) SubredditQuarantineizProvides subreddit quarantine related methods. To opt-in into a quarantined subreddit: .. code-block:: python reddit.subreddit("test").quaran.opt_in() cXlg)zInitialize a :class:`.SubredditQuarantine` instance. :param subreddit: The :class:`.Subreddit` associated with the quarantine. Nr@rAs r;rBSubredditQuarantine.__init__rr>cSUR0n[R"[5 URRR [ SUS9 SSS5 g!,(df  g=f)aPermit your user access to the quarantined subreddit. Usage: .. code-block:: python subreddit = reddit.subreddit("QUESTIONABLE") next(subreddit.hot()) # Raises prawcore.Forbidden subreddit.quaran.opt_in() next(subreddit.hot()) # Returns Submission sr_namequarantine_opt_inrwNr8 contextlibsuppressrr9rYrr:rxs r;opt_inSubredditQuarantine.opt_insO4>>*   * NN " " ' '1D(ED ' Q+ * * ,A A,cSUR0n[R"[5 URRR [ SUS9 SSS5 g!,(df  g=f)aRemove access to the quarantined subreddit. Usage: .. code-block:: python subreddit = reddit.subreddit("QUESTIONABLE") next(subreddit.hot()) # Returns Submission subreddit.quaran.opt_out() next(subreddit.hot()) # Raises prawcore.Forbidden rquarantine_opt_outrwNrrs r;opt_outSubredditQuarantine.opt_outsO4>>*   * NN " " ' '1E(FT ' R+ * *rr@Nr) rrrrrrBrrrrhr>r;rrs#R$Sr>rcP\rSrSrSrS S SjjrS SjrS SjrS SjrSr g)SubredditRelationshipia~Represents a relationship between a :class:`.Redditor` and :class:`.Subreddit`. Instances of this class can be iterated through in order to discover the Redditors that make up the relationship. For example, banned users of a subreddit can be iterated through like so: .. code-block:: python for ban in reddit.subreddit("test").banned(): print(f"{ban}: {ban.note}") Nc [RUSUS9 [SUR3R UR S9n[ UR RU40UD6$)aReturn a :class:`.ListingGenerator` for :class:`.Redditor`\ s in the relationship. :param redditor: When provided, yield at most a single :class:`.Redditor` instance. This is useful to confirm if a relationship exists, or to fetch the metadata associated with a particular relationship (default: ``None``). Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. rW)rerfrlist_r@)rjrkr relationshiprr8r r9rs r;r<SubredditRelationship.__call__sg ''&H8 ( t00123::T^^:T 6 6P?OPPr>cX lXlg)zInitialize a :class:`.SubredditRelationship` instance. :param subreddit: The :class:`.Subreddit` for the relationship. :param relationship: The name of the relationship. Nrr8)r:r8rs r;rBSubredditRelationship.__init__s)"r>c [U5URS.nURU5 [SR UR S9nUR R RXCS9 g)zjAdd ``redditor`` to this relationship. :param redditor: A redditor name or :class:`.Redditor` instance. rrifriendr@rwN)rIrrrrr8r9rY)r:rother_settingsrxrs r;rSubredditRelationship.adds[ H t/@/@A N#x ''$..'A ##C#3r>c[U5URS.n[SRURS9nURR R X2S9 g)zoRemove ``redditor`` from this relationship. :param redditor: A redditor name or :class:`.Redditor` instance. runfriendr@rwN)rIrrrr8r9rYr:rrxrs r;rSubredditRelationship.remove%sO H t/@/@Az"))DNN)C ##C#3r>rrHrrrlr rr)r8rrrI)rrrr rr) rrrrrr<rBrrrrhr>r;rrs@  7;Q3Q Q ( Q*# 44r>rcF\rSrSrSrSSjrS SjrS SjrSrg) SubredditStreami0z(Provides submission and comment streams.cXlg)zpInitialize a :class:`.SubredditStream` instance. :param subreddit: The subreddit associated with the streams. Nr@rAs r;rBSubredditStream.__init__3rr>c B[URR40UD6$)aYield new comments as they become available. Comments are yielded oldest first. Up to 100 historical comments will initially be returned. Keyword arguments are passed to :func:`.stream_generator`. .. note:: While PRAW tries to catch all new comments, some high-volume streams, especially the r/all stream, may drop some comments. For example, to retrieve all new comments made to r/test, try: .. code-block:: python for comment in reddit.subreddit("test").stream.comments(): print(comment) To only retrieve new submissions starting when the stream is created, pass ``skip_existing=True``: .. code-block:: python subreddit = reddit.subreddit("test") for comment in subreddit.stream.comments(skip_existing=True): print(comment) )r#r8commentsrs r;rSubredditStream.comments;s@  7 7J>JJr>c B[URR40UD6$)a3Yield new :class:`.Submission`\ s as they become available. Submissions are yielded oldest first. Up to 100 historical submissions will initially be returned. Keyword arguments are passed to :func:`.stream_generator`. .. note:: While PRAW tries to catch all new submissions, some high-volume streams, especially the r/all stream, may drop some submissions. For example, to retrieve all new submissions made to all of Reddit, try: .. code-block:: python for submission in reddit.subreddit("all").stream.submissions(): print(submission) )r#r8newrs r;r>SubredditStream.submissions]s.  2 2EnEEr>r@Nr)rr rz*Generator[praw.models.Comment, None, None]r) rrrrrrBrr>rrhr>r;rr0s;2# K # K 3 KDF #F 6Fr>rcB\rSrSrSrS"SjrS#SjrS$SjrS%SjrS&Sjr S r S r S r S r S'SjrSrSrSr\"SS5SS.S(Sjj5r\"S S5S)Sj5rS*Sjr\"SS5SS.S+Sjj5rS*SjrS,SjrS*SjrS,SjrS,S jrS!rg)-SubredditStylesheetiwahProvides a set of stylesheet functions to a :class:`.Subreddit`. For example, to add the css data ``.test{color:blue}`` to the existing stylesheet: .. code-block:: python subreddit = reddit.subreddit("test") stylesheet = subreddit.stylesheet() stylesheet.stylesheet += ".test{color:blue}" subreddit.stylesheet.update(stylesheet.stylesheet) c[SRURS9nURRR U5$)zReturn the :class:`.Subreddit`'s stylesheet. To be used as: .. code-block:: python stylesheet = reddit.subreddit("test").stylesheet() about_stylesheetr@rwrTs r;r<SubredditStylesheet.__call__s<)*11DNN1K~~%%))#..r>cXlg)zInitialize a :class:`.SubredditStylesheet` instance. :param subreddit: The :class:`.Subreddit` associated with the stylesheet. An instance of this class is provided as: .. code-block:: python reddit.subreddit("test").stylesheet Nr@rAs r;rBSubredditStylesheet.__init__rr>c[SRURS9nURRR X!S9 g)Nstructured_stylesr@rw)rrr8r9r%)r: style_datars r;_update_structured_styles-SubredditStylesheet._update_structured_styless:*+22T^^2L $$S$:r> image_pathc[U5RS5nUR[[55nUR S5 U[:XaSOSUS'[ SRURS9nURRRXQSU0S 9nUS (a9US SnURS S /5SnUS ;dS5e[XxS//5eUsSSS5 $!,(df  g=f)Nrbrjpgpngimg_type upload_imager@filerxfileserrors errors_valuesr) BAD_CSS_NAME IMAGE_ERRORzPlease file a bug with PRAW.) r openreadr0rseekrrr8r9rYrr) r:rxrimageheaderrrZ error_type error_values r; _upload_image!SubredditStylesheet._upload_images*  " "4 (EZZK 01F JJqM(.+(=u5D >*11DNN1KC~~--22vuo3H!%h/2 &ll?RDA!D !&222):D*I)JKK!) ( (s C C00 C>c~[U5nX#RS.nSUS'UR5RS5(aSUS'[SR UR S9nUR RRXTS9S nUS Vs0sH owS US _M nnS US3n URS5n UR RRRRRXSU 0S9n SSS5 W R5 U SUS3$s snf!,(df  N-=f)N) imagetypefilepath image/jpegmimetypez.png image/pngstyle_asset_leaser@rw s3UploadLeasefieldsrrhttps:rerrr/rf)r rlowerendswithrrr8r9rYr_core _requestor_httpraise_for_status) r:r image_typerrxr upload_leaser upload_data upload_urlrrZs r;_upload_style_asset'SubredditStylesheet._upload_style_assets=J'YY?'Z     & &v . .*D *+22T^^2L~~--2232B?S ?KH?UV?UtF|T']2?U Vl8456 YYt_~~--33>>DDIIVUOJH !!#Q{51233W_sD)AD.. D<c.SS0nURU5 g)zRemove the current :class:`.Subreddit` (redesign) banner image. Succeeds even if there is no banner image. For example: .. code-block:: python reddit.subreddit("test").stylesheet.delete_banner() bannerBackgroundImagerNrrs r; delete_banner!SubredditStylesheet.delete_banners(, &&t,r>c0SSS.nURU5 g)aRemove the current :class:`.Subreddit` (redesign) banner additional image. Succeeds even if there is no additional image. Will also delete any configured hover image. For example: .. code-block:: python reddit.subreddit("test").stylesheet.delete_banner_additional_image() r)bannerPositionedImagesecondaryBannerPositionedImageNr rs r;delete_banner_additional_image2SubredditStylesheet.delete_banner_additional_images*,rR &&t,r>c.SS0nURU5 g)zRemove the current :class:`.Subreddit` (redesign) banner hover image. Succeeds even if there is no hover image. For example: .. code-block:: python reddit.subreddit("test").stylesheet.delete_banner_hover_image() r%rNr rs r;delete_banner_hover_image-SubredditStylesheet.delete_banner_hover_images1"5 &&t,r>c[SRURS9nURRR U5 g)zRemove the current :class:`.Subreddit` header image. Succeeds even if there is no header image. For example: .. code-block:: python reddit.subreddit("test").stylesheet.delete_header() delete_sr_headerr@Nr+rTs r; delete_header!SubredditStylesheet.delete_header9)*11DNN1K ##C(r>rc[SRURS9nURRR USU0S9 g)zRemove the named image from the :class:`.Subreddit`. Succeeds even if the named image does not exist. For example: .. code-block:: python reddit.subreddit("test").stylesheet.delete_image("smile") delete_sr_imager@img_namerwNr+)r:rrs r; delete_image SubredditStylesheet.delete_image sC()004>>0J ##Cz4.@#Ar>c.SS0nURU5 g)zRemove the current :class:`.Subreddit` (redesign) mobile banner. Succeeds even if there is no mobile banner. For example: .. code-block:: python subreddit = reddit.subreddit("test") subreddit.stylesheet.delete_banner_hover_image() mobileBannerImagerNr rs r;delete_mobile_banner(SubredditStylesheet.delete_mobile_banners$R( &&t,r>c[SRURS9nURRR U5 g)zRemove the current :class:`.Subreddit` mobile header. Succeeds even if there is no mobile header. For example: .. code-block:: python reddit.subreddit("test").stylesheet.delete_mobile_header() r,r@Nr+rTs r;delete_mobile_header(SubredditStylesheet.delete_mobile_header)r/r>c[SRURS9nURRR U5 g)zRemove the current :class:`.Subreddit` mobile icon. Succeeds even if there is no mobile icon. For example: .. code-block:: python reddit.subreddit("test").stylesheet.delete_mobile_icon() delete_sr_iconr@Nr+rTs r;delete_mobile_icon&SubredditStylesheet.delete_mobile_icon8s9'(//$../I ##C(r> stylesheetreasonNrAcSX!S.n[SRURS9nURRR XCS9 g)a/Update the :class:`.Subreddit`'s stylesheet. :param stylesheet: The CSS for the new stylesheet. :param reason: The reason for updating the stylesheet. For example: .. code-block:: python reddit.subreddit("test").stylesheet.update( "p { color: green; }", reason="color text green" ) save)oprAstylesheet_contentssubreddit_stylesheetr@rwNr+)r:r@rArxrs r;rSubredditStylesheet.updateGsF R-.555O ##C#3r>c(URUSS.US9$)aUpload an image to the :class:`.Subreddit`. :param image_path: A path to a jpeg or png image. :param name: The name to use for the image. If an image already exists with the same name, it will be replaced. :returns: A dictionary containing a link to the uploaded image under the key ``img_src``. :raises: ``prawcore.TooLarge`` if the overall request body is too large. :raises: :class:`.RedditAPIException` if there are other issues with the uploaded image. Unfortunately the exception info might not be very specific, so try through the website with the same image to see what the problem actually might be. For example: .. code-block:: python reddit.subreddit("test").stylesheet.upload(name="smile", image_path="img.png") img)r upload_typerxrr)r:rrs r;uploadSubredditStylesheet.upload[s&0!!u5*"  r>cJSnURXS9nURX#05 g)a,Upload an image for the :class:`.Subreddit`'s (redesign) banner image. :param image_path: A path to a jpeg or png image. :raises: ``prawcore.TooLarge`` if the overall request body is too large. :raises: :class:`.RedditAPIException` if there are other issues with the uploaded image. Unfortunately the exception info might not be very specific, so try through the website with the same image to see what the problem actually might be. For example: .. code-block:: python reddit.subreddit("test").stylesheet.upload_banner("banner.png") rrrNrrr:rr image_urls r; upload_banner!SubredditStylesheet.upload_bannerws4$- ,,!-  && '>?r>align)rWc0nUbUS;a Sn[U5eX#S'SnURXS9nXV0nU(aURU5 URU5 g)aUpload an image for the :class:`.Subreddit`'s (redesign) additional image. :param image_path: A path to a jpeg or png image. :param align: Either ``"left"``, ``"centered"``, or ``"right"``. (default: ``"left"``). :raises: ``prawcore.TooLarge`` if the overall request body is too large. :raises: :class:`.RedditAPIException` if there are other issues with the uploaded image. Unfortunately the exception info might not be very specific, so try through the website with the same image to see what the problem actually might be. For example: .. code-block:: python subreddit = reddit.subreddit("test") subreddit.stylesheet.upload_banner_additional_image("banner.png") N>rrcenteredz>'align' argument must be either 'left', 'centered', or 'right'bannerPositionedImagePositionr$rQ) ValueErrorrrr)r:rrW alignmentrrrTrs r;upload_banner_additional_image2SubredditStylesheet.upload_banner_additional_imagesv6  99V o%9>5 6, ,,!- !,    i ( &&z2r>cJSnURXS9nURX#05 g)aUpload an image for the :class:`.Subreddit`'s (redesign) additional image. :param image_path: A path to a jpeg or png image. Fails if the :class:`.Subreddit` does not have an additional image defined. :raises: ``prawcore.TooLarge`` if the overall request body is too large. :raises: :class:`.RedditAPIException` if there are other issues with the uploaded image. Unfortunately the exception info might not be very specific, so try through the website with the same image to see what the problem actually might be. For example: .. code-block:: python subreddit = reddit.subreddit("test") subreddit.stylesheet.upload_banner_hover_image("banner.png") r%rQNrRrSs r;upload_banner_hover_image-SubredditStylesheet.upload_banner_hover_images4*6 ,,!-  && '>?r>c&URSS0US9$)aUpload an image to be used as the :class:`.Subreddit`'s header image. :param image_path: A path to a jpeg or png image. :returns: A dictionary containing a link to the uploaded image under the key ``img_src``. :raises: ``prawcore.TooLarge`` if the overall request body is too large. :raises: :class:`.RedditAPIException` if there are other issues with the uploaded image. Unfortunately the exception info might not be very specific, so try through the website with the same image to see what the problem actually might be. For example: .. code-block:: python reddit.subreddit("test").stylesheet.upload_header("header.png") rKrrLrMr:rs r; upload_header!SubredditStylesheet.upload_header*!! x'@Z!XXr>cJSnURXS9nURX#05 g)aUpload an image for the :class:`.Subreddit`'s (redesign) mobile banner. :param image_path: A path to a JPEG or PNG image. For example: .. code-block:: python subreddit = reddit.subreddit("test") subreddit.stylesheet.upload_mobile_banner("banner.png") Fails if the :class:`.Subreddit` does not have an additional image defined. :raises: ``prawcore.TooLarge`` if the overall request body is too large. :raises: :class:`.RedditAPIException` if there are other issues with the uploaded image. Unfortunately the exception info might not be very specific, so try through the website with the same image to see what the problem actually might be. r6rQNrRrSs r;upload_mobile_banner(SubredditStylesheet.upload_mobile_banners4*) ,,!-  && '>?r>c&URSS0US9$)aUpload an image to be used as the :class:`.Subreddit`'s mobile header. :param image_path: A path to a jpeg or png image. :returns: A dictionary containing a link to the uploaded image under the key ``img_src``. :raises: ``prawcore.TooLarge`` if the overall request body is too large. :raises: :class:`.RedditAPIException` if there are other issues with the uploaded image. Unfortunately the exception info might not be very specific, so try through the website with the same image to see what the problem actually might be. For example: .. code-block:: python reddit.subreddit("test").stylesheet.upload_mobile_header("header.png") rKbannerrLrMrcs r;upload_mobile_header(SubredditStylesheet.upload_mobile_headerrfr>c&URSS0US9$)aUpload an image to be used as the :class:`.Subreddit`'s mobile icon. :param image_path: A path to a jpeg or png image. :returns: A dictionary containing a link to the uploaded image under the key ``img_src``. :raises: ``prawcore.TooLarge`` if the overall request body is too large. :raises: :class:`.RedditAPIException` if there are other issues with the uploaded image. Unfortunately the exception info might not be very specific, so try through the website with the same image to see what the problem actually might be. For example: .. code-block:: python reddit.subreddit("test").stylesheet.upload_mobile_icon("icon.png") rKiconrLrMrcs r;upload_mobile_icon&SubredditStylesheet.upload_mobile_icons*!! v'>:!VVr>r@)rzpraw.models.Stylesheetr)rdict[str, str | Any])rxrrrrIrr)rrIrrIrrI)rrI)r@rIrAr)rrIrrIrdict[str, str])rrI)rrIrWr)rrIrrs)rrrrrr<rBrrrr!r&r)r-r3r7r:r>rrrNrUr]r`rdrhrlrprrhr>r;rrws  / #;+9< *4( -- - ) B- ) )\8,>B4-4&V\* + 6@0\7+ ! (3(3 (3,(3T@6Y.@6Y.Wr>rc~\rSrSrSrSSjrSSjrSSjr\"SSS5S S .SS jj5r SS jr S r g ) SubredditWikii6z:Provides a set of wiki functions to a :class:`.Subreddit`.ct[URRURUR55$)aLazily return the :class:`.WikiPage` for the :class:`.Subreddit` named ``page_name``. This method is to be used to fetch a specific wikipage, like so: .. code-block:: python wikipage = reddit.subreddit("test").wiki["proof"] print(wikipage.content_md) )r0r8r9r)r: page_names r; __getitem__SubredditWiki.__getitem__9s(.. @QRRr>cT[US5Ul[US5UlXlg)zjInitialize a :class:`.SubredditWiki` instance. :param subreddit: The subreddit whose wiki to work with. wikibannedwikicontributorN)rbanned contributorr8rAs r;rBSubredditWiki.__init__Fs' ,I|D 0c#B# URRR[SR URS9SURRR 0S9nUSH0n[ URRURU5v M2 g7f)zIterate through the pages of the wiki. This method is to be used to discover all wikipages for a subreddit: .. code-block:: python for wikipage in reddit.subreddit("test").wiki: print(wikipage) wiki_pagesr@rrVrxN)r8r9rrrrr0)r:rZrws r;rSubredditWiki.__iter__Ps>>))-- \ " ) )DNN ) Cdnn44AAB. "&)I4>>114>>9M M*sBBrcontentrANrBc URSS5R5n[URRURU5nUR "SXS.UD6 U$)aCreate a new :class:`.WikiPage`. :param name: The name of the new :class:`.WikiPage`. This name will be normalized. :param content: The content of the new :class:`.WikiPage`. :param reason: The reason for the creation. :param other_settings: Additional keyword arguments to pass. To create the wiki page ``"praw_test"`` in r/test try: .. code-block:: python reddit.subreddit("test").wiki.create( name="praw_test", content="wiki body text", reason="PRAW Test Creation" )  _)rrArh)replacerr0r8r9edit)r:rrrArrs r;rySubredditWiki.createbsR4||C%++-t~~--t~~tD BB>B r>c [SRURS9n[R"XRUS9$)aRReturn a :class:`.ListingGenerator` for recent wiki revisions. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. To view the wiki revisions for ``"praw_test"`` in r/test try: .. code-block:: python for item in reddit.subreddit("test").wiki["praw_test"].revisions(): print(item) wiki_revisionsr@)rlr8r)rrr8r0_revision_generator)r:rlrs r; revisionsSubredditWiki.revisionss=$'(//$../I++-S  r>)r}r~r8)rwrIrr0r)rzGenerator[WikiPage, None, None]) rrIrrIrArrr rr0)rlr rz[Generator[dict[str, praw.models.Redditor | WikiPage | str | int | bool | None], None, None]) rrrrrrxrBrrryrrrhr>r;ruru6soD S#N$VY1 "       2< r>ruc\rSrSrSrSrSrg)ContributorRelationshipia/Provides methods to interact with a :class:`.Subreddit`'s contributors. Contributors are also known as approved submitters. Contributors of a subreddit can be iterated through like so: .. code-block:: python for contributor in reddit.subreddit("test").contributor(): print(contributor) cURRR[SSURR0S9 g)z"Abdicate the contributor position.leavecontributorr6rwN)r8r9rYrrrs r;leaveContributorRelationship.leaves9 ## ' (dnn6M6M/N $ r>rhN)rrrrrrrrhr>r;rrs   r>rcv^\rSrSrSr1Skr\SSS.SSjj5rSSS jjr\ "SS5SS .SU4S jjj5r \ "SS5SS .SS jj5r \ "S5SS .SSjj5r Sr SSjr\ "SS5SS .SSjj5r\ "SS5SS .SSjj5rSrU=r$)ModeratorRelationshipizProvides methods to interact with a :class:`.Subreddit`'s moderators. Moderators of a subreddit can be iterated through like so: .. code-block:: python for moderator in reddit.subreddit("test").moderator(): print(moderator) >mailwikirpostsaccessconfig chat_config chat_operatorNr permissionsrcdU(a [U5O0n[[RUS9US'U$)N)known_permissionsrr)rr"r PERMISSIONSrs r;_handle_permissions)ModeratorRelationship._handle_permissionss5 6D.1(:3??[) }%r>rcUc0OSU0n[SUR3RURS9nURRR X2S9$)aReturn a list of :class:`.Redditor`\ s who are moderators. :param redditor: When provided, return a list containing at most one :class:`.Redditor` instance. This is useful to confirm if a relationship exists, or to fetch the metadata associated with a particular relationship (default: ``None``). .. note:: To help mitigate targeted moderator harassment, this call requires the :class:`.Reddit` instance to be authenticated i.e., :attr:`.read_only` must return ``False``. This call, however, only makes use of the ``read`` scope. For more information on why the moderator list is hidden can be found here: https://reddit.zendesk.com/hc/en-us/articles/360049499032-Why-is-the-moderator-list-hidden- .. note:: Unlike other relationship callables, this relationship is not paginated. Thus, it simply returns the full list, rather than an iterator for the results. To be used like: .. code-block:: python moderators = reddit.subreddit("test").moderator() For example, to list the moderators along with their permissions try: .. code-block:: python for moderator in reddit.subreddit("test").moderator(): print(f"{moderator}: {moderator.mod_permissions}") rrr@rV)rrrr8r9r)r:rrWrs r;r<ModeratorRelationship.__call__s^L 'fh-?t00123::T^^:T~~%%))#)==r>)rc F>URX2S9n[TU]"U40UD6 g)aAdd or invite ``redditor`` to be a moderator of the :class:`.Subreddit`. :param redditor: A redditor name or :class:`.Redditor` instance. :param permissions: When provided (not ``None``), permissions should be a list of strings specifying which subset of permissions to grant. An empty list ``[]`` indicates no permissions, and when not provided ``None``, indicates full permissions (default: ``None``). An invite will be sent unless the user making this call is an admin user. For example, to invite u/spez with ``"posts"`` and ``"mail"`` permissions to r/test, try: .. code-block:: python reddit.subreddit("test").moderator.add("spez", permissions=["posts", "mail"]) rN)rsuperr)r:rrr __class__s r;rModeratorRelationship.adds0411)2   H//r>c URX2S9nUR[U5SS.5 [SR UR S9nUR R RXTS9 g)adInvite ``redditor`` to be a moderator of the :class:`.Subreddit`. :param redditor: A redditor name or :class:`.Redditor` instance. :param permissions: When provided (not ``None``), permissions should be a list of strings specifying which subset of permissions to grant. An empty list ``[]`` indicates no permissions, and when not provided ``None``, indicates full permissions (default: ``None``). For example, to invite u/spez with ``"posts"`` and ``"mail"`` permissions to r/test, try: .. code-block:: python reddit.subreddit("test").moderator.invite("spez", permissions=["posts", "mail"]) rmoderator_inviterrr@rwN)rrrIrrr8r9rY)r:rrrrxrs r;inviteModeratorRelationship.invite sk0'')(  S]4FGHx ''$..'A ##C#3r>)rc U(aSU0OSUS'[SRURS9n[URRU40UD6$)aReturn a :class:`.ListingGenerator` for :class:`.Redditor`\ s invited to be moderators. :param redditor: When provided, return a list containing at most one :class:`.Redditor` instance. This is useful to confirm if a relationship exists, or to fetch the metadata associated with a particular relationship (default: ``None``). Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. .. note:: Unlike other usages of :class:`.ListingGenerator`, ``limit`` has no effect in the quantity returned. This endpoint always returns moderators in batches of 25 at a time regardless of what ``limit`` is set to. Usage: .. code-block:: python for invited_mod in reddit.subreddit("test").moderator.invited(): print(invited_mod) usernameNrWlist_invited_moderatorr@)rrr8r r9rs r;invitedModeratorRelationship.invited9 sT>@Hj(%;T"/077$..7Q 6 6P?OPPr>cURURRRR=(d. URRR R 55 g)zAbdicate the moderator position (use with care). For example: .. code-block:: python reddit.subreddit("test").moderator.leave() N)rr8r9rrrrrs r;rModeratorRelationship.leave\ sG NN " " ) ) 2 2 Vdnn6L6L6Q6Q6T6T6V r>c[U5SS.n[SRURS9nURRR X2S9 g)zRemove the moderator invite for ``redditor``. :param redditor: A redditor name or :class:`.Redditor` instance. For example: .. code-block:: python reddit.subreddit("test").moderator.remove_invite("spez") rrrr@rwN)rIrrr8r9rYrs r; remove_invite#ModeratorRelationship.remove_invitej sJH /ABz"))DNN)C ##C#3r>c[SRURS9nUR[ U5SS.US9nURR R X4S9 g)aUpdate the moderator permissions for ``redditor``. :param redditor: A redditor name or :class:`.Redditor` instance. :param permissions: When provided (not ``None``), permissions should be a list of strings specifying which subset of permissions to grant. An empty list ``[]`` indicates no permissions, and when not provided, ``None``, indicates full permissions (default: ``None``). For example, to add all permissions to the moderator, try: .. code-block:: python subreddit.moderator.update("spez") To remove all permissions from the moderator, try: .. code-block:: python subreddit.moderator.update("spez", permissions=[]) setpermissionsr@ moderatorrrrwNrrr8rrIr9rYr:rrrrxs r;rModeratorRelationship.updatez sb8'(//$../I''$'M;G#(  ##C#3r>c[SRURS9nUR[ U5SS.US9nURR R X4S9 g)aZUpdate the moderator invite permissions for ``redditor``. :param redditor: A redditor name or :class:`.Redditor` instance. :param permissions: When provided (not ``None``), permissions should be a list of strings specifying which subset of permissions to grant. An empty list ``[]`` indicates no permissions, and when not provided, ``None``, indicates full permissions (default: ``None``). For example, to grant the ``"flair"`` and ``"mail"`` permissions to the moderator invite, try: .. code-block:: python subreddit.moderator.update_invite("spez", permissions=["flair", "mail"]) rr@rrrrwNrrs r; update_invite#ModeratorRelationship.update_invite sc.'(//$../I''$'M;MN#(  ##C#3r>rh)rz dict | Nonerlist[str] | NonerrrH)rrrzlist[praw.models.Redditor])rrrrrr rr)rrrr)rrrrrrr9rr<rrrrrrrrr __classcell__rs@r;rrs  K'+(, # &    =A(>9(> #(>TZ/ )- 0,0& 0  000<Z/ )- 4,4& 4  404<Z 7; Q4 Q Q ( Q! QD  4 Z/ )- 4, 4& 40 4DZ/ )- 4,4& 404r>rc#^\rSrSrSrSrSr\SSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSS.!S_Sjj5r\S`S j5r \SaS j5r \SbSj5r \ ScSj5r \ SdSj5r\ SeSj5r\ SfSj5r\ SgSj5r\ ShSj5r\ SiSj5r\ SjSj5r\ SkSj5r\ ScSj5r\ SlSj5r\ SmSj5r\ SnSj5r\ SoSj5r\ SpSj5r\ SqSj5r\SrSj5rSsStU4S jjjrSuS!jr U4S"jr!S#r"SvS$jr#SwS%jr$SxS(jr%SbS)jr&SS*S+.SyS,jjr'SzS-jr(S{S.jr)\*"S/S0S1S25S3S4S5S6.S|S7jj5r+\*"S85S9S:.S}S;jj5r,\*"SSS?S@SASBSCSDSES SF5 SSSSSSSGSHSSHSGSSI. S~SJjj5r-\*"SS SDSES>S?SBSASC5 SSSSSGSHSGSK.SSLjj5r.\*"SSMS>S?S@SASBSCS&SDS'SE5 SSSSSGSHSHSGSNSGSO. SSPjj5r/\*"SSS?S@SASBSCSDSE5 SSSSSGSHSHSGSS.SSTjj5r0\*"SSUSVSWS>S?S@SASBSCS&SDS'SE5SSSSSGSHSHSGSSNSGSGSX. SSYjj5r1\*"S 5SSZ.SS[jj5r2SS\jr3\*"S 5SSZ.SS]jj5r4S^r5U=r6$)rji a A class for Subreddits. To obtain an instance of this class for r/test execute: .. code-block:: python subreddit = reddit.subreddit("test") While r/all is not a real subreddit, it can still be treated like one. The following outputs the titles of the 25 hottest submissions in r/all: .. code-block:: python for submission in reddit.subreddit("all").hot(limit=25): print(submission.title) Multiple subreddits can be combined with a ``+`` like so: .. code-block:: python for submission in reddit.subreddit("redditdev+learnpython").top(time_filter="all"): print(submission) Subreddits can be filtered from combined listings as follows. .. note:: These filters are ignored by certain methods, including :attr:`.comments`, :meth:`.gilded`, and :meth:`.SubredditStream.comments`. .. code-block:: python for submission in reddit.subreddit("all-redditdev").new(): print(submission) .. include:: ../../typical_attributes.rst ========================= ========================================================== Attribute Description ========================= ========================================================== ``can_assign_link_flair`` Whether users can assign their own link flair. ``can_assign_user_flair`` Whether users can assign their own user flair. ``created_utc`` Time the subreddit was created, represented in `Unix Time`_. ``description`` Subreddit description, in Markdown. ``description_html`` Subreddit description, in HTML. ``display_name`` Name of the subreddit. ``icon_img`` The URL of the subreddit icon image. ``id`` ID of the subreddit. ``name`` Fullname of the subreddit. ``over18`` Whether the subreddit is NSFW. ``public_description`` Description of the subreddit, shown in searches and on the "You must be invited to visit this community" page (if applicable). ``spoilers_enabled`` Whether the spoiler tag feature is enabled. ``subscribers`` Count of subscribers. ``user_is_banned`` Whether the authenticated user is banned. ``user_is_moderator`` Whether the authenticated user is a moderator. ``user_is_subscriber`` Whether the authenticated user is subscribed. ========================= ========================================================== .. note:: Trying to retrieve attributes of quarantined or private subreddits will result in a 403 error. Trying to retrieve attributes of a banned subreddit will result in a 404 error. .. _unix time: https://en.wikipedia.org/wiki/Unix_time r}#N)! allow_imagesallow_post_crosspostsrcollapse_deleted_commentscomment_score_hide_mins descriptiondomainexclude_banned_modqueuerhide_adsr key_colorrrover_18public_descriptionpublic_traffic show_mediashow_media_preview spam_comments spam_linksspam_selfpostsspoilers_enabledrsubmit_link_label submit_textsubmit_text_labelrsuggested_comment_sorttitle wiki_edit_agewiki_edit_karmawikimoderc" "0SU_SU_SU_SU_SU_SU_SU_SU_S U _S U _S U _S U _S U _SU_SU_SU_SU_0SU_SU_SU_SU_SU_SU_SU_SU_SU_SU_SU_SU_SU_SU_S U _S!U!_En#U#RU"5 UR[S"U#S#9 g)$Nrrrrrrrrz header-titlerrrrrrrrrrrrrrrrrrrrrirrr site_adminrw)rrYr)$r9rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrs$ r;_create_or_updateSubreddit._create_or_update sN" L" #%:"  "  ()B " &'> " ; "  f"  &'>"  -"  "  "  D"  "  D"  w" !"4!" " n#" $ *%" & !"4'" ( ])" * *+" , n-" .  0/" 0 "1" 2 !23" 4 ;5" 6 !27" 8 %&<9" : U;" < N=" > ]?" @ A" B C" H  ^$ Xl+% 8r>rDc U(a8SR[U5/UVs/sHn[U5PM sn-5$[U5$s snf)NrF)rNrI)rDr8rs r;_subreddit_listSubreddit._subreddit_listV sH 88S^,@P/Q@P1A@P/QQR R9~0RsA imagescUHnURSS5nU(a0[U5R5(dU<S3n[U5eO Sn[U5e[ URSS55S::aMzSn[U5e g)Nrrz is not a valid image path.z'image_path' is required.captionz'Caption must be 180 characters or less.)rr is_filerr0)rrrrs r;_validate_gallerySubreddit._validate_gallery` sE<4JJ'//11'N*EFC#C.(22n$uyyB/0C7?n$r> inline_mediac[UR5R5(dUR<S3n[U5eg)Nz is not a valid file path.)r pathrr[)rrs r;_validate_inline_media Subreddit._validate_inline_mediao s?L%%&..00!&&))CDCS/ !1r>c[US5$)aYProvide an instance of :class:`.SubredditRelationship`. For example, to ban a user try: .. code-block:: python reddit.subreddit("test").banned.add("spez", ban_reason="...") To list the banned users along with any notes, try: .. code-block:: python for ban in reddit.subreddit("test").banned(): print(f"{ban}: {ban.note}") r}rrs r;r}Subreddit.bannedu s$%T844r>c:URURU5$)aEProvide an instance of :class:`.SubredditCollections`. To see the permalinks of all :class:`.Collection`\ s that belong to a subreddit, try: .. code-block:: python for collection in reddit.subreddit("test").collections: print(collection.permalink) To get a specific :class:`.Collection` by its UUID or permalink, use one of the following: .. code-block:: python collection = reddit.subreddit("test").collections("some_uuid") collection = reddit.subreddit("test").collections( permalink="https://reddit.com/r/SUBREDDIT/collection/some_uuid" ) )_subreddit_collections_classr9rs r; collectionsSubreddit.collections s.00tDDr>c[US5$)zProvide an instance of :class:`.ContributorRelationship`. Contributors are also known as approved submitters. To add a contributor try: .. code-block:: python reddit.subreddit("test").contributor.add("spez") r~)rrs r;r~Subreddit.contributor s't];;r>c[U5$)aProvide an instance of :class:`.SubredditEmoji`. This attribute can be used to discover all emoji for a subreddit: .. code-block:: python for emoji in reddit.subreddit("test").emoji: print(emoji) A single emoji can be lazily retrieved via: .. code-block:: python reddit.subreddit("test").emoji["emoji_name"] .. note:: Attempting to access attributes of a nonexistent emoji will result in a :class:`.ClientException`. r&rs r;emojiSubreddit.emoji .d##r>c[U5$)zProvide an instance of :class:`.SubredditFilters`. For example, to add a filter, run: .. code-block:: python reddit.subreddit("all").filters.add("test") )rrs r;filtersSubreddit.filters s %%r>c[U5$)aProvide an instance of :class:`.SubredditFlair`. Use this attribute for interacting with a :class:`.Subreddit`'s flair. For example, to list all the flair for a subreddit which you have the ``flair`` moderator permission on try: .. code-block:: python for flair in reddit.subreddit("test").flair(): print(flair) Flair templates can be interacted with through this attribute via: .. code-block:: python for template in reddit.subreddit("test").flair.templates: print(template) )rrs r;rSubreddit.flair s*d##r>c[U5$)zProvide an instance of :class:`.SubredditModeration`. For example, to accept a moderation invite from r/test: .. code-block:: python reddit.subreddit("test").mod.accept_invite() )r;rs r;rf Subreddit.mod s#4((r>c[US5$)atProvide an instance of :class:`.ModeratorRelationship`. For example, to add a moderator try: .. code-block:: python reddit.subreddit("test").moderator.add("spez") To list the moderators along with their permissions try: .. code-block:: python for moderator in reddit.subreddit("test").moderator(): print(f"{moderator}: {moderator.mod_permissions}") r)rrs r;rSubreddit.moderator s$%T;77r>c[U5$)a Provide an instance of :class:`.Modmail`. For example, to send a new modmail from r/test to u/spez with the subject ``"test"`` along with a message body of ``"hello"``: .. code-block:: python reddit.subreddit("test").modmail.create(subject="test", body="hello", recipient="spez") )r3rs r;rSubreddit.modmail st}r>c[US5$)zProvide an instance of :class:`.SubredditRelationship`. For example, muted users can be iterated through like so: .. code-block:: python for mute in reddit.subreddit("test").muted(): print(f"{mute}: {mute.date}") mutedrrs r;r Subreddit.muted s%T733r>c[U5$)aCProvide an instance of :class:`.SubredditQuarantine`. This property is named ``quaran`` because ``quarantine`` is a subreddit attribute returned by Reddit to indicate whether or not a subreddit is quarantined. To opt-in into a quarantined subreddit: .. code-block:: python reddit.subreddit("test").quaran.opt_in() )rrs r;quaranSubreddit.quaran+ #4((r>c[U5$)aProvide an instance of :class:`.SubredditRules`. Use this attribute for interacting with 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" ) r,rs r;rulesSubreddit.rules< rr>c[U5$)aProvide an instance of :class:`.SubredditStream`. Streams can be used to indefinitely retrieve new comments made to a subreddit, like: .. code-block:: python for comment in reddit.subreddit("test").stream.comments(): print(comment) Additionally, new submissions can be retrieved via the stream. In the following example all submissions are fetched via the special r/all: .. code-block:: python for submission in reddit.subreddit("all").stream.submissions(): print(submission) )rrs r;rMSubreddit.streamU s*t$$r>c[U5$)a]Provide an instance of :class:`.SubredditStylesheet`. For example, to add the css data ``.test{color:blue}`` to the existing stylesheet: .. code-block:: python subreddit = reddit.subreddit("test") stylesheet = subreddit.stylesheet() stylesheet.stylesheet += ".test{color:blue}" subreddit.stylesheet.update(stylesheet.stylesheet) )rrs r;r@Subreddit.stylesheetl rr>c[U5$)a.Provide an instance of :class:`.SubredditWidgets`. **Example usage** Get all sidebar widgets: .. code-block:: python for widget in reddit.subreddit("test").widgets.sidebar: print(widget) Get ID card widget: .. code-block:: python print(reddit.subreddit("test").widgets.id_card) )r.rs r;widgetsSubreddit.widgets} s( %%r>c[U5$)azProvide an instance of :class:`.SubredditWiki`. This attribute can be used to discover all wikipages for a subreddit: .. code-block:: python for wikipage in reddit.subreddit("test").wiki: print(wikipage) To fetch the content for a given wikipage try: .. code-block:: python wikipage = reddit.subreddit("test").wiki["proof"] print(wikipage.content_md) )rurs r;rSubreddit.wiki s&T""r>cHURRRS$)zReturn the class's kind.r8)r9rkindsrs r;_kindSubreddit._kind s||""((55r>c>X#4RS5S:wa Sn[U5eU(aX l[TU]XS9 [ SR US9Ulg)a;Initialize a :class:`.Subreddit` instance. :param reddit: An instance of :class:`.Reddit`. :param display_name: The name of the subreddit. .. note:: This class should not be initialized directly. Instead, obtain an instance via: .. code-block:: python subreddit = reddit.subreddit("test") Nr$z2Either 'display_name' or '_data' must be provided._datar8r@)countrr}rrBrr_path)r:redditr}r%rrs r;rBSubreddit.__init__ s]*  & &t , 1FCC.  ,  -k*11D1A r>cTSUS.nURR[SUS9S$)zConvert a Markdown string to a dict for use with the ``richtext_json`` param. :param markdown_text: A Markdown string to convert. :returns: A dict in ``richtext_json`` format. rtjson) output_mode markdown_textconvert_rte_bodyrwoutput)r9rYr)r:r- text_datas r;_convert_to_fancypants Subreddit._convert_to_fancypants s3%-}M ||  *c>UR5nUSn[U5"URUS9nURR UR5 [ TU]5 g)Nrxr$) _fetch_datarir9__dict__rr_fetch)r:rxotherrs r;r6Subreddit._fetch sN!F|T 4<cSSU0S4$)Nsubreddit_aboutr8rhrs r; _fetch_infoSubreddit._fetch_info s ;"5t;;r>cURn[U5nUVs/sHoDRPM nnUSS/SQ:Xa+SUSS5upgp[[ U5[ U 5S9egs snf)z9Parse the XML from a response and raise any errors found.N)CodeMessage ProposedSizeMaxSizeAllowedc38# UHoRv M g7frHr)rJelements r;rK0Subreddit._parse_xml_response.. s2XxG<link)expected_mime_prefixrKcZUcD[[5R5nURRRS- S- nO [U5nURR 5nUR S5SnSSSS S S S .RUS 5nUb2URS 5S U:waSU<SU<SU<S3n[U5eXWS.n [Sn URRXS9n U Sn SU S3n U SVs0sH oSUS_M nnURXMU5nUR(dURU5 UR!5 U SS US:Xa U S US3$U SS $s snf!["an[%UR&S9SeSnAff=f)!aUpload media and return its URL and a websocket (Undocumented endpoint). :param expected_mime_prefix: If provided, enforce that the media has a mime type that starts with the provided prefix. :param upload_type: One of ``"link"``, ``"gallery"'', or ``"selfpost"`` (default: ``"link"``). :returns: A tuple containing ``(media_url, websocket_url)`` for the piece of media. The websocket URL can be used to determine when media processing is finished, or it can be ignored. Nrz PRAW logo.png.rr zvideo/quicktimez video/mp4r z image/gif)rmovmp4rjpeggifrrz"Expected a mimetype starting with z but got mimetype z (from file extension z).)r r  media_assetrwargsrrerrr)rZassetrZrqrfasset_id)r __file__absoluteparentrr rpartitionr partitionrrr9rYrTokrPrrrrZ)r:rrrlrKr file_namefile_extension mime_typerimg_datarupload_responserrrrrZerrs r;rmSubreddit._upload_media' s&  >**,D++22X=OJ #DIIOO% "--c215$    # L   ! ,##C(+/CC67K6NN`aj`mnDESDVVXYC!#& & )A}%,,++C+?&v. l8456 ?KH?UV?UtF|T']2?U V,,T{K{{  $ $X . ?  % % '  1 &  \;u#5"67 7w' 33W ?s||4$ > ?s FF F*F%%F*crURR[SR[ U5S95$)aGet the post requirements for a subreddit. :returns: A dict with the various requirements. The returned dict contains the following keys: - ``domain_blacklist`` - ``body_restriction_policy`` - ``domain_whitelist`` - ``title_regexes`` - ``body_blacklisted_strings`` - ``body_required_strings`` - ``title_text_min_length`` - ``is_flair_required`` - ``title_text_max_length`` - ``body_regexes`` - ``link_repost_age`` - ``body_text_min_length`` - ``link_restriction_policy`` - ``body_text_max_length`` - ``title_required_strings`` - ``title_blacklisted_strings`` - ``guidelines_text`` - ``guidelines_display_policy`` For example, to fetch the post requirements for r/test: .. code-block:: python print(reddit.subreddit("test").post_requirements) post_requirementsr@)r9rrrrIrs r;rSubreddit.post_requirementsi s7B|| ( ) 0 03t9 0 E  r>c|[SRUS9nURRUSURR0S9 URUR[URRRW5S9$![ anUR nSnAN^SnAff=f![a gf=f)aOReturn a random :class:`.Submission`. Returns ``None`` on subreddits that do not support the random feature. One example, at the time of writing, is r/wallpapers. For example, to get a random submission off of r/AskReddit: .. code-block:: python submission = reddit.subreddit("AskReddit").random() print(submission.title) subreddit_randomr@rrVNr^) rrr9rrrr_submission_classrr reddit_urlr)r:rr]rs r;randomSubreddit.random s)*11D1A ! LL  S(DLL4M4M)N  O )) '$,,*=*=*H*H$"O*  !==D !   s*0B AB. B+ B&&B+. B;:B;queryr_syntax time_filter relevancelucenerd)r_rrc URU5 URR5S:gnURUSUUUUUS9 [SR US9n[ URU40UD6$)aReturn a :class:`.ListingGenerator` for items that match ``query``. :param query: The query string to search for. :param sort: Can be one of: ``"relevance"``, ``"hot"``, ``"top"``, ``"new"``, or ``"comments"``. (default: ``"relevance"``). :param syntax: Can be one of: ``"cloudsearch"``, ``"lucene"``, or ``"plain"`` (default: ``"lucene"``). :param time_filter: Can be one of: ``"all"``, ``"day"``, ``"hour"``, ``"month"``, ``"week"``, or ``"year"`` (default: ``"all"``). For more information on building a search query see: https://www.reddit.com/wiki/search For example, to search all subreddits for ``"praw"`` try: .. code-block:: python for submission in reddit.subreddit("all").search("praw"): print(submission.title) rdrW)rerfq restrict_srr_rtsearchr@)_validate_time_filterr}rrkrrr r9)r:rr_rrrlnot_allrs r;rSubreddit.search s> "";/##))+u4 ""& # x ''$'7 cF5EFFr>numberr$)rc2[SRUS9nURRUSU0S9 UR UR[URRRW5S9$![anUR nSnAN]SnAff=f)aOReturn a :class:`.Submission` object for a sticky of the subreddit. :param number: Specify which sticky to return. 1 appears at the top (default: ``1``). :raises: ``prawcore.NotFound`` if the sticky does not exist. For example, to get the stickied post on r/test: .. code-block:: python reddit.subreddit("test").sticky() about_stickyr@numrVNr^) rrr9rrrrrrr)r:rrr]rs r;stickySubreddit.sticky s ~&---= ! LL  S%  9%% LLgdll&9&9&D&DdK&   !==D !sA66 B BBselftextrflair_idrresubmit send_repliesnsfwspoiler collection_iddiscussion_typedraft_idFT) rrrrrrrrrrrrc [U 5=(d U S:H[U 5:Xa Sn[U5e[U5[U 5[U 5U[U5[U 5URRS.nSU4SU4SU4SU4SU44HunnUcM UUU'M U bUR S S 9 U(apU R "S0UR5VVs0sHunnUURU5_M snnD6nURU5nUR [U5S 9 O UR U S 9 OUR S U S9 URR[SUS9$s snnf)a Add a submission to the :class:`.Subreddit`. :param title: The title of the submission. :param collection_id: The UUID of a :class:`.Collection` to add the newly-submitted post to. :param discussion_type: Set to ``"CHAT"`` to enable live discussion instead of traditional comments (default: ``None``). :param draft_id: The ID of a draft to submit. :param flair_id: The flair template to select (default: ``None``). :param flair_text: If the template's ``flair_text_editable`` value is ``True``, this value will set a custom text (default: ``None``). ``flair_id`` is required when ``flair_text`` is provided. :param inline_media: A dict of :class:`.InlineMedia` objects where the key is the placeholder name in ``selftext``. :param nsfw: Whether the submission should be marked NSFW (default: ``False``). :param resubmit: When ``False``, an error will occur if the URL has already been submitted (default: ``True``). :param selftext: The Markdown formatted content for a ``text`` submission. Use an empty string, ``""``, to make a title-only submission. :param send_replies: When ``True``, messages will be sent to the submission author when comments are made to the submission (default: ``True``). :param spoiler: Whether the submission should be marked as a spoiler (default: ``False``). :param url: The URL for a ``link`` submission. :returns: A :class:`.Submission` object for the newly created submission. Either ``selftext`` or ``url`` can be provided, but not both. For example, to submit a URL to r/test do: .. code-block:: python title = "PRAW documentation" url = "https://praw.readthedocs.io" reddit.subreddit("test").submit(title, url=url) For example, to submit a self post with inline media do: .. code-block:: python from praw.models import InlineGif, InlineImage, InlineVideo gif = InlineGif(path="path/to/image.gif", caption="optional caption") image = InlineImage(path="path/to/image.jpg", caption="optional caption") video = InlineVideo(path="path/to/video.mp4", caption="optional caption") selftext = "Text with a gif {gif1} an image {image1} and a video {video1} inline" media = {"gif1": gif, "image1": image, "video1": video} reddit.subreddit("test").submit("title", inline_media=media, selftext=selftext) .. note:: Inserted media will have a padding of ``\\n\\n`` automatically added. This is due to the weirdness with Reddit's API. Using the example above, the result selftext body will look like so: .. code-block:: Text with a gif ![gif](u1rchuphryq51 "optional caption") an image ![img](srnr8tshryq51 "optional caption") and video ![video](gmc7rvthryq51 "optional caption") inline .. note:: To submit a post to a subreddit with the ``"news"`` flair, you can get the flair id like this: .. code-block:: choices = list(subreddit.flair.link_templates.user_selectable()) template_id = next(x for x in choices if x["flair_text"] == "news")["flair_template_id"] subreddit.submit("title", flair_id=template_id, url="https://www.news.com/") .. seealso:: - :meth:`~.Subreddit.submit_gallery` to submit more than one image in the same post - :meth:`~.Subreddit.submit_image` to submit images - :meth:`~.Subreddit.submit_poll` to submit polls - :meth:`~.Subreddit.submit_video` to submit videos and videogifs rz,Either 'selftext' or 'url' must be provided.rr sendrepliesrrrvalidate_on_submitrrrrrr:)kind) richtext_jsonrDrqrrrYrwrh) rrrIr9rrrr1ror1rrYr)r:rrrrrrrrrrrrrrrxrfr placeholderrSrp converteds r;rYSubreddit.submit sx N ,h"nc :@CC. d)X -JG}"&,,"A"A  " : & m ,  0  "  JC !S     KKVK $3?2D2D2F2F.K$T%>%>u%EE2F !77=  % *: ;  * KKVK -||  (!3$ ??sE,)rrrrrrrc JURU5 S/[U5[U5S[U 5[U5UURRS. n SU4SU4SU4SU44HupU cM XU 'M UHMn U SR U R S S 5U R S S 5URS U S SS9S.5 MO URRU S[SS9SnUS(a[US5eURRUSSS9$)aQAdd an image gallery submission to the subreddit. :param title: The title of the submission. :param images: The images to post in dict with the following structure: ``{"image_path": "path", "caption": "caption", "outbound_url": "url"}``, only ``image_path`` is required. :param collection_id: The UUID of a :class:`.Collection` to add the newly-submitted post to. :param discussion_type: Set to ``"CHAT"`` to enable live discussion instead of traditional comments (default: ``None``). :param flair_id: The flair template to select (default: ``None``). :param flair_text: If the template's ``flair_text_editable`` value is ``True``, this value will set a custom text (default: ``None``). ``flair_id`` is required when ``flair_text`` is provided. :param nsfw: Whether the submission should be marked NSFW (default: ``False``). :param send_replies: When ``True``, messages will be sent to the submission author when comments are made to the submission (default: ``True``). :param spoiler: Whether the submission should be marked asa spoiler (default: ``False``). :returns: A :class:`.Submission` object for the newly created submission. :raises: :class:`.ClientException` if ``image_path`` in ``images`` refers to a file that is not an image. For example, to submit an image gallery to r/test do: .. code-block:: python title = "My favorite pictures" image = "/path/to/image.png" image2 = "/path/to/image2.png" image3 = "/path/to/image3.png" images = [ {"image_path": image}, { "image_path": image2, "caption": "Image caption 2", }, { "image_path": image3, "caption": "Image caption 3", "outbound_url": "https://example.com/link3", }, ] reddit.subreddit("test").submit_gallery(title, images) .. seealso:: - :meth:`~.Subreddit.submit` to submit url posts and selftexts - :meth:`~.Subreddit.submit_image` to submit single images - :meth:`~.Subreddit.submit_poll` to submit polls - :meth:`~.Subreddit.submit_video` to submit videos and videogifs r$T) api_typer1rrshow_error_listrrrrrrrrr1rr outbound_urlrrgallery)rrrlrK)rrrnPOSTsubmit_gallery_post)r$methodrrrxrr^) rrrIr9rappendrrmrequestrrrd)r:rrrrrrrrrrxrfrrrZs r;submit_gallerySubreddit.submit_gallery s[^ v&J -#G}d)"&,,"A"A   " : & m ,  0  JC  !S  E M $yyB7$)IInb$A $ 2 2-4#(#6$-!3! <<''f84I+J(  H $Xh%78 8||&&8F+;E+B&CCr>r ) rrrrrrrrrVrWc 8[U5[U5[U 5U[U5[U 5URRS.n SU4SU4SU4SU44HupUcM XU'M UR SUS9nU R SUS9 UR XU S 9$) a Add an image submission to the subreddit. :param collection_id: The UUID of a :class:`.Collection` to add the newly-submitted post to. :param discussion_type: Set to ``"CHAT"`` to enable live discussion instead of traditional comments (default: ``None``). :param flair_id: The flair template to select (default: ``None``). :param flair_text: If the template's ``flair_text_editable`` value is ``True``, this value will set a custom text (default: ``None``). ``flair_id`` is required when ``flair_text`` is provided. :param image_path: The path to an image, to upload and post. :param nsfw: Whether the submission should be marked NSFW (default: ``False``). :param resubmit: When ``False``, an error will occur if the URL has already been submitted (default: ``True``). :param send_replies: When ``True``, messages will be sent to the submission author when comments are made to the submission (default: ``True``). :param spoiler: Whether the submission should be marked as a spoiler (default: ``False``). :param timeout: Specifies a particular timeout, in seconds. Use to avoid "Websocket error" exceptions (default: ``10``). :param title: The title of the submission. :param without_websockets: Set to ``True`` to disable use of WebSockets (see note below for an explanation). If ``True``, this method doesn't return anything (default: ``False``). :returns: A :class:`.Submission` object for the newly created submission, unless ``without_websockets`` is ``True``. :raises: :class:`.ClientException` if ``image_path`` refers to a file that is not an image. .. note:: Reddit's API uses WebSockets to respond with the link of the newly created post. If this fails, the method will raise :class:`.WebSocketException`. Occasionally, the Reddit post will still be created. More often, there is an error with the image file. If you frequently get exceptions but successfully created posts, try setting the ``timeout`` parameter to a value above 10. To disable the use of WebSockets, set ``without_websockets=True``. This will make the method return ``None``, though the post will still be created. You may wish to do this if you are running your program in a restricted network environment, or using a proxy that doesn't support WebSockets connections. For example, to submit an image to r/test do: .. code-block:: python title = "My favorite picture" image = "/path/to/image.png" reddit.subreddit("test").submit_image(title, image) .. seealso:: - :meth:`~.Subreddit.submit` to submit url posts and selftexts - :meth:`~.Subreddit.submit_gallery` to submit more than one image in the same post - :meth:`~.Subreddit.submit_poll` to submit polls - :meth:`~.Subreddit.submit_video` to submit videos and videogifs rrrrrrrrrlrrxrVrWrIrr9rrmrrh)r:rrrrrrrrrrrVrWrxrfrrTs r; submit_imageSubreddit.submit_imagesxd)X -JG}"&,,"A"A  " : & m ,  0  JC  !S  &&!(Z'  i 0!!;M"  r>optionsduration)rrrrrrrrc  [U5U UU[U 5[U 5U[U5[U 5URRS. n SU4SU4SU4SU44HupUcM XU'M URR [ SU S9$)aAdd a poll submission to the subreddit. :param title: The title of the submission. :param collection_id: The UUID of a :class:`.Collection` to add the newly-submitted post to. :param discussion_type: Set to ``"CHAT"`` to enable live discussion instead of traditional comments (default: ``None``). :param duration: The number of days the poll should accept votes, as an ``int``. Valid values are between ``1`` and ``7``, inclusive. :param flair_id: The flair template to select (default: ``None``). :param flair_text: If the template's ``flair_text_editable`` value is ``True``, this value will set a custom text (default: ``None``). ``flair_id`` is required when ``flair_text`` is provided. :param nsfw: Whether the submission should be marked NSFW (default: ``False``). :param options: A list of two to six poll options as ``str``. :param resubmit: When ``False``, an error will occur if the URL has already been submitted (default: ``True``). :param selftext: The Markdown formatted content for the submission. Use an empty string, ``""``, to make a submission with no text contents. :param send_replies: When ``True``, messages will be sent to the submission author when comments are made to the submission (default: ``True``). :param spoiler: Whether the submission should be marked as a spoiler (default: ``False``). :returns: A :class:`.Submission` object for the newly created submission. For example, to submit a poll to r/test do: .. code-block:: python title = "Do you like PRAW?" reddit.subreddit("test").submit_poll( title, selftext="", options=["Yes", "No"], duration=3 ) .. seealso:: - :meth:`~.Subreddit.submit` to submit url posts and selftexts - :meth:`~.Subreddit.submit_gallery` to submit more than one image in the same post - :meth:`~.Subreddit.submit_image` to submit single images - :meth:`~.Subreddit.submit_video` to submit videos and videogifs ) rrrrrrrrrrrrrrsubmit_poll_postr)rIrr9rrYr)r:rrrrrrrrrrrrrxrfrs r; submit_pollSubreddit.submit_poll}sVd) X -JG}"&,,"A"A   " : & m ,  0  JC  !S  ||  * video_pathvideogifthumbnail_path) rrrrrrrrrrVrrWc j[U5[U5[U 5U[U5[U 5URRS.nSU4SU4SU4SU44HunnUcM UUU'M UR SUS9nUR U (aSOSUUR U S 9S 9 UR XUS 9$) a7 Add a video or videogif submission to the subreddit. :param title: The title of the submission. :param video_path: The path to a video, to upload and post. :param collection_id: The UUID of a :class:`.Collection` to add the newly-submitted post to. :param discussion_type: Set to ``"CHAT"`` to enable live discussion instead of traditional comments (default: ``None``). :param flair_id: The flair template to select (default: ``None``). :param flair_text: If the template's ``flair_text_editable`` value is ``True``, this value will set a custom text (default: ``None``). ``flair_id`` is required when ``flair_text`` is provided. :param nsfw: Whether the submission should be marked NSFW (default: ``False``). :param resubmit: When ``False``, an error will occur if the URL has already been submitted (default: ``True``). :param send_replies: When ``True``, messages will be sent to the submission author when comments are made to the submission (default: ``True``). :param spoiler: Whether the submission should be marked as a spoiler (default: ``False``). :param thumbnail_path: The path to an image, to be uploaded and used as the thumbnail for this video. If not provided, the PRAW logo will be used as the thumbnail. :param timeout: Specifies a particular timeout, in seconds. Use to avoid "Websocket error" exceptions (default: ``10``). :param videogif: If ``True``, the video is uploaded as a videogif, which is essentially a silent video (default: ``False``). :param without_websockets: Set to ``True`` to disable use of WebSockets (see note below for an explanation). If ``True``, this method doesn't return anything (default: ``False``). :returns: A :class:`.Submission` object for the newly created submission, unless ``without_websockets`` is ``True``. :raises: :class:`.ClientException` if ``video_path`` refers to a file that is not a video. .. note:: Reddit's API uses WebSockets to respond with the link of the newly created post. If this fails, the method will raise :class:`.WebSocketException`. Occasionally, the Reddit post will still be created. More often, there is an error with the image file. If you frequently get exceptions but successfully created posts, try setting the ``timeout`` parameter to a value above 10. To disable the use of WebSockets, set ``without_websockets=True``. This will make the method return ``None``, though the post will still be created. You may wish to do this if you are running your program in a restricted network environment, or using a proxy that doesn't support WebSockets connections. For example, to submit a video to r/test do: .. code-block:: python title = "My favorite movie" video = "/path/to/video.mp4" reddit.subreddit("test").submit_video(title, video) .. seealso:: - :meth:`~.Subreddit.submit` to submit url posts and selftexts - :meth:`~.Subreddit.submit_image` to submit images - :meth:`~.Subreddit.submit_gallery` to submit more than one image in the same post - :meth:`~.Subreddit.submit_poll` to submit polls rrrrrvideorr)rl)rrvideo_poster_urlrr)r:rrrrrrrrrrrrVrrWrxrfr video_urls r; submit_videoSubreddit.submit_videosJd)X -JG}"&,,"A"A  " : & m ,  0  JC  !S  &&!(Z'  'W!//>/J  !!;M"  r>)rDclSSURXS9S.nURR[SUS9 g)zSubscribe to the subreddit. :param other_subreddits: When provided, also subscribe to the provided list of subreddits. For example, to subscribe to r/test: .. code-block:: python reddit.subreddit("test").subscribe() subTrDr8)reskip_inital_defaultsr subscriberwNrr9rYrr:rDrxs r;rSubreddit.subscribeasE$(++!1,  (;/d;r>c`URR[SRUS95$)aReturn a dictionary of the :class:`.Subreddit`'s traffic statistics. :raises: ``prawcore.NotFound`` when the traffic stats aren't available to the authenticated user, that is, they are not public and the authenticated user is not a moderator of the subreddit. The traffic method returns a dict with three keys. The keys are ``day``, ``hour`` and ``month``. Each key contains a list of lists with 3 or 4 values. The first value is a timestamp indicating the start of the category (start of the day for the ``day`` key, start of the hour for the ``hour`` key, etc.). The second, third, and fourth values indicate the unique pageviews, total pageviews, and subscribers, respectively. .. note:: The ``hour`` key does not contain subscribers, and therefore each sub-list contains three values. For example, to get the traffic stats for r/test: .. code-block:: python stats = reddit.subreddit("test").traffic() about_trafficr@)r9rrrrs r;trafficSubreddit.trafficxs,4|| 9 @ @4 @ PQQr>cjSURXS9S.nURR[SUS9 g)zUnsubscribe from the subreddit. :param other_subreddits: When provided, also unsubscribe from the provided list of subreddits. To unsubscribe from r/test: .. code-block:: python reddit.subreddit("test").unsubscribe() unsubr)rerrrwNrrs r; unsubscribeSubreddit.unsubscribesB"++!1,  (;/d;r>)r'r})Fr9 praw.Redditrr6rr6rr6rr6rr7rrrrrr6rrrr6rrrrrrrrrr6rrrr6rr6rr6rr6rr6rr6rr6rrrrrrrrrrrrrrrr7rr7rrrr )rDz!list[str | praw.models.Subreddit]r8rrrI)rlist[dict[str, str]])rzpraw.models.InlineMedia)rz2praw.models.reddit.subreddit.SubredditRelationship)rz3praw.models.reddit.collections.SubredditCollections)rz4praw.models.reddit.subreddit.ContributorRelationship)rr')rz-praw.models.reddit.subreddit.SubredditFilters)rz+praw.models.reddit.subreddit.SubredditFlair)rr;)rz2praw.models.reddit.subreddit.ModeratorRelationship)rz$praw.models.reddit.subreddit.Modmail)rz0praw.models.reddit.subreddit.SubredditQuarantine)rr-)rz,praw.models.reddit.subreddit.SubredditStream)rz0praw.models.reddit.subreddit.SubredditStylesheet)rzpraw.models.SubredditWidgets)rz*praw.models.reddit.subreddit.SubredditWiki)rrI)NN)r(rr}rr%zdict[str, Any] | None)r-rIrr)rZr1)rr rrIrrrr1)rxzdict[Any, Any]rVrJrWr)rrrrlrIrKrIr)rpraw.models.Submission | None) rrIr_rIrrIrrIrlr rr)rrJrpraw.models.Submission)rrIrrrrrrrrrrrz)dict[str, praw.models.InlineMedia] | Nonerrrrrrrrrrrrrr)rrIrrrrrrrrrrrrrrrrrr)rrIrrIrrrrrrrrrrrrrrrrrVrJrWrrr)rrIrrrrrrJrrrrrrr list[str]rrrrIrrrrrr)rrIrrIrrrrrrrrrrrrrrrrrrrVrJrrrWrrrr)rzdict[str, list[list[int]]])7rrrrr STR_FIELDMESSAGE_PREFIXr9rrrrrr}rr~rrrrfrrr rrrMr@rrpropertyr!rBr1r6r;rPrTrhrormrrrrrrYrrrrrrrrrrs@r;rjrj s. ENIN%)-1!%15.2"&!/3(, $ $ $#)-&*"&*.%)"&&*(,(,"&(,%)-1 $(&*#GL9L9"L9 + L9  L9 $/ L9",L9 L9L9"-L9&L9L9L9L9L9 !L9"#L9$'%L9&$'L9( )L9*(+L9,#-L9. /L90$1L92&3L94 5L96&7L98 9L9:&;L9<#=L9>!+?L9@AL9B"CL9D$EL9FGL9HIL9L9\;)  % %"" 55&EE0 < <$$0 & &$$, ) )88&   4 4)) $$0%%,)) &&*##(66$('+ BB!B% BB: Y< &)8F &0%&003&0IM&0P ,0! @4)@4 @4  @4D# J4Wfh >   *G*G *G  *G  *G *G **G?*GXX&'  0 &%)&*##!%BF#!S@S@" S@ $ S@  S@S@S@@S@S@S@S@S@S@S@ !S@S@j  %)&*#!%!iDiD%iD " iD $ iDiDiDiDiDiD iD iDV &%)&*#!%!#(e e e " e $ e e e e e e e e !e  'e  e N $%)&*#!%!QJQJ" QJ $ QJ  QJQJQJQJQJQJQJQJQJ QJ QJf*%)&*#!%!%)#(!q q q " q $ q q q q q q q #q q q !!q " '#q ! q f'(RV<)<,R8'(HL<#E<)rjc \rSrSrSrSSjr\"SSSSSS S S 5S S S S S S SS.SSjj5rSrSSjr SSjr Sr g )riz8Provide functions to interact with link flair templates.c## [SRURS9nURRR U5ShvN gN7f)zIterate through the link flair templates as a moderator. For example: .. code-block:: python for template in reddit.subreddit("test").flair.link_templates: print(template) link_flairr@NrwrTs r;r$SubredditLinkFlairTemplates.__iter__sA|$++dnn+E>>))--c222sA A A ArrrrrrrrNrFrrrrrrrc 2URUUUSUUUUUS9 g)a8Add a link flair template to the associated subreddit. :param text: The flair template's text. :param allowable_content: If specified, most be one of ``"all"``, ``"emoji"``, or ``"text"`` to restrict content to that type. If set to ``"emoji"`` then the ``"text"`` param must be a valid emoji string, for example, ``":snoo:"``. :param background_color: The flair template's new background color, as a hex color. :param css_class: The flair template's css_class (default: ``""``). :param max_emojis: Maximum emojis in the flair (Reddit defaults this value to ``10``). :param mod_only: Indicate if the flair can only be used by moderators. :param text_color: The flair template's new text color, either ``"light"`` or ``"dark"``. :param text_editable: Indicate if the flair text can be modified for each redditor that sets it (default: ``False``). For example, to add an editable link flair try: .. code-block:: python reddit.subreddit("test").flair.link_templates.add( "PRAW", css_class="praw", text_editable=True, ) T rrrr rrrrrNr r:rrrrrrrrs r;rSubredditLinkFlairTemplates.adds1f /-!!'  r>c"URSS9 g)zRemove all link flair templates from the subreddit. For example: .. code-block:: python reddit.subreddit("test").flair.link_templates.clear() Tr Nr rs r;clear!SubredditLinkFlairTemplates.clears D !r>c$URUSS9 g)aOReorder a list of flairs. :param flair_list: A list of flair IDs. For example, to reverse the order of the link flair list try: .. code-block:: python subreddit = reddit.subreddit("test") flairs = [flair["id"] for flair in subreddit.flair.link_templates] subreddit.flair.link_templates.reorder(list(reversed(flairs))) Tr Nr&r:rs r;reorder#SubredditLinkFlairTemplates.reorders j$ /r>c## [SRURS9nURRR USS0S9SShvN gN7f)zIterate through the link flair templates as a regular user. For example: .. code-block:: python for template in reddit.subreddit("test").flair.link_templates.user_selectable(): print(template) flairselectorr@ is_newlinkTrwchoicesNr+rTs r;user_selectable+SubredditLinkFlairTemplates.user_selectablesW'...H>>))..s,9M.N    sA AAArhrzIGenerator[dict[str, str | int | bool | list[dict[str, str]]], None, None]rrIrrrrrrIrr7rr6rrrrrr)rz,Generator[dict[str, str | bool], None, None]) rrrrrrrrrrr rrhr>r;rrsB3 R3  )-'+!% $!%#3 3 & 3 % 3  3 3 3 3 3  3 j "0  5 r>rc \rSrSrSrSSjr\"SSSSSS S S 5S S S S S S SS.SSjj5rSrSSjr Sr g )ri1zFProvide functions to interact with :class:`.Redditor` flair templates.c## [SRURS9nSURRR0nURRR XS9ShvN gN7f)zIterate through the user flair templates. For example: .. code-block:: python for template in reddit.subreddit("test").flair.templates: print(template) user_flairr@rrVN)rrr8r9rr)r:rrWs r;r(SubredditRedditorFlairTemplates.__iter__4s^|$++dnn+EDNN22??@>>))--c-AAAsA)A3+A1,A3rrrrrrrrNrFrc 2URUUUSUUUUUS9 g)a;Add a redditor flair template to the associated subreddit. :param text: The flair template's text. :param allowable_content: If specified, most be one of ``"all"``, ``"emoji"``, or ``"text"`` to restrict content to that type. If set to ``"emoji"`` then the ``"text"`` param must be a valid emoji string, for example, ``":snoo:"``. :param background_color: The flair template's new background color, as a hex color. :param css_class: The flair template's css_class (default: ``""``). :param max_emojis: Maximum emojis in the flair (Reddit defaults this value to ``10``). :param mod_only: Indicate if the flair can only be used by moderators. :param text_color: The flair template's new text color, either ``"light"`` or ``"dark"``. :param text_editable: Indicate if the flair text can be modified for each redditor that sets it (default: ``False``). For example, to add an editable redditor flair try: .. code-block:: python reddit.subreddit("test").flair.templates.add( "PRAW", css_class="praw", text_editable=True, ) FrNrrs r;r#SubredditRedditorFlairTemplates.addEs1f /-!!'  r>c"URSS9 g)zRemove all :class:`.Redditor` flair templates from the subreddit. For example: .. code-block:: python reddit.subreddit("test").flair.templates.clear() Fr Nrrs r;r%SubredditRedditorFlairTemplates.clears E "r>c$URUSS9 g)a]Reorder a list of flairs. :param flair_list: A list of flair IDs. For example, to reverse the order of the :class:`.Redditor` flair templates list try: .. code-block:: python subreddit = reddit.subreddit("test") flairs = [flair["id"] for flair in subreddit.flair.templates] subreddit.flair.templates.reorder(list(reversed(flairs))) Fr Nrrs r;r'SubredditRedditorFlairTemplates.reorders j% 0r>rhr r r) rrrrrrrrrrrrhr>r;rr1sPB RB" )-'+!% $!%#3 3 & 3 % 3  3 3 3 3 3  3 j #1r>r)[r __future__rrcopyrcsvriorr$rrpathlibr typingr r r r urllib.parserwarningsrxml.etree.ElementTreerr_prawcorerprawcore.exceptionsrrequests.exceptionsrconstrr exceptionsrrrrrrutilrrlisting.generatorr listing.mixinsr!r"r#baser%rr'mixinsr(r)rr*rIr+rr-rr.r/wikipager0requestsr1 praw.modelsprawr3rrrr;rLrrrrrurrrj_subreddit_classrrrhr>r;r1sj"":: %+)*4027!3(4!4!xLxLvO+O+dppfi4i4X@X@XFQMQMh5S5SpA4A4HDFDFN|W|W~ ` ` F 3 *K41K4\n< "7 n