Fj(dZddlmZddlmZmZddlmZddlm Z ddl m Z ddl m Z er ddlmZdd lmZGd d e Zy ) zProvide the Front class.) annotations) TYPE_CHECKINGAny)API_PATH)PRAWBase)ListingGenerator)stream_generator)Iterator)modelsceZdZdZddZddZddZddZddZddZ ddZ dd Z dd Z dd Z dd Zdd ZddZdd ddZy)Inboxz3Inbox is a Listing class that represents the inbox.c >t|jtdfi|S)aReturn a :class:`.ListingGenerator` for all inbox comments and messages. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. To output the type and ID of all items available via this listing do: .. code-block:: python for item in reddit.inbox.all(limit=None): print(repr(item)) inboxr_redditrselfgenerator_kwargss O/root/workspace/ytshorts/venv/lib/python3.12/site-packages/praw/models/inbox.pyallz Inbox.alls   hw.?TCSTTc|rJddjd|ddDi}|jjtd||dd}|rIyy)aeMark an inbox message as collapsed. :param items: A list containing instances of :class:`.Message`. Requests are batched at 25 items (reddit limit). For example, to collapse all unread Messages, try: .. code-block:: python from praw.models import Message unread_messages = [] for item in reddit.inbox.unread(limit=None): if isinstance(item, Message): unread_messages.append(item) reddit.inbox.collapse(unread_messages) .. seealso:: :meth:`.Message.uncollapse` id,c34K|]}|jywNfullname.0xs r z!Inbox.collapse..>"B!1::"BNcollapsedatajoinrpostrritemsr(s rr&zInbox.collapse%sR0#(("BuSbz"BBCD LL  hz2  >"#JErc >t|jtdfi|S)ayReturn a :class:`.ListingGenerator` for comment replies. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. To output the author of one request worth of comment replies try: .. code-block:: python for reply in reddit.inbox.comment_replies(): print(reply.author) comment_repliesrrs rr/zInbox.comment_repliesBs!  h7H.I^M]^^rcH|jjtdy)a6Mark all messages as read with just one API call. Example usage: .. code-block:: python reddit.inbox.mark_all_read() .. note:: This method returns after Reddit acknowledges your request, instead of after the request has been fulfilled. read_all_messagesN)rr+r)rs r mark_all_readzInbox.mark_all_readRs (#678rc|rJddjd|ddDi}|jjtd||dd}|rIyy)aMark Comments or Messages as read. :param items: A list containing instances of :class:`.Comment` and/or :class:`.Message` to be marked as read relative to the authorized user's inbox. Requests are batched at 25 items (reddit limit). For example, to mark all unread Messages as read, try: .. code-block:: python from praw.models import Message unread_messages = [] for item in reddit.inbox.unread(limit=None): if isinstance(item, Message): unread_messages.append(item) reddit.inbox.mark_read(unread_messages) .. seealso:: - :meth:`.Comment.mark_read` - :meth:`.Message.mark_read` rrc34K|]}|jywrrrs rr"z"Inbox.mark_read..r#r$Nr% read_messager'r)r,s r mark_readzInbox.mark_readcsR6#(("BuSbz"BBCD LL  h~6T  B"#JErc|rJddjd|ddDi}|jjtd||dd}|rIyy)aXUnmark Comments or Messages as read. :param items: A list containing instances of :class:`.Comment` and/or :class:`.Message` to be marked as unread relative to the authorized user's inbox. Requests are batched at 25 items (Reddit limit). For example, to mark the first 10 items as unread try: .. code-block:: python to_unread = list(reddit.inbox.all(limit=10)) reddit.inbox.mark_unread(to_unread) .. seealso:: - :meth:`.Comment.mark_unread` - :meth:`.Message.mark_unread` rrc34K|]}|jywrrrs rr"z$Inbox.mark_unread..r#r$Nr%unread_messager'r)r,s r mark_unreadzInbox.mark_unreadsS,#(("BuSbz"BBCD LL  h'78t  D"#JErc >t|jtdfi|S)a Return a :class:`.ListingGenerator` for mentions. A mention is :class:`.Comment` in which the authorized redditor is named in its body like u/spez. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. For example, to output the author and body of the first 25 mentions try: .. code-block:: python for mention in reddit.inbox.mentions(limit=25): print(f"{mention.author}\\n{mention.body}\\n") mentionsrrs rr<zInbox.mentionss "  hz.BWFVWWrc`|jjtdj|}|dg|djDcic]}|j |}}|j D]"}|j|j|_$|d|jScc}w)zReturn a :class:`.Message` corresponding to ``message_id``. :param message_id: The base36 ID of a message. For example: .. code-block:: python message = reddit.inbox.message("7bnlgu") message)rrt4_) rgetrformatrepliesrvalues parent_idparentlower)r message_idlistingr>messagess rr>z Inbox.messages,,""8I#6#=#=#=#LM>Eaj=^7ST:K]K]=^_'G$$g-__( =G%\\'*;*;t|jtdfi|S)aReturn a :class:`.ListingGenerator` for inbox messages. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. For example, to output the subject of the most recent 5 messages try: .. code-block:: python for message in reddit.inbox.messages(limit=5): print(message.subject) rIrrs rrIzInbox.messagess   hz.BWFVWWrc >t|jtdfi|S)a}Return a :class:`.ListingGenerator` for sent messages. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. For example, to output the recipient of the most recent 15 messages try: .. code-block:: python for message in reddit.inbox.sent(limit=15): print(message.dest) sentrrs rrLz Inbox.sents   hv.>SBRSSrc .t|jfi|S)aYield new inbox items as they become available. Items are yielded oldest first. Up to 100 historical items will initially be returned. Keyword arguments are passed to :func:`.stream_generator`. For example, to retrieve all new inbox items, try: .. code-block:: python for item in reddit.inbox.stream(): print(item) )r unread)rstream_optionss rstreamz Inbox.streams   >~>>rc >t|jtdfi|S)aReturn a :class:`.ListingGenerator` for submission replies. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. To output the author of one request worth of submission replies try: .. code-block:: python for reply in reddit.inbox.submission_replies(): print(reply.author) submission_repliesrrs rrRzInbox.submission_repliess!  h7K.LaP`aarc|rJddjd|ddDi}|jjtd||dd}|rIyy)aiMark an inbox message as uncollapsed. :param items: A list containing instances of :class:`.Message`. Requests are batched at 25 items (reddit limit). For example, to uncollapse all unread Messages, try: .. code-block:: python from praw.models import Message unread_messages = [] for item in reddit.inbox.unread(limit=None): if isinstance(item, Message): unread_messages.append(item) reddit.inbox.uncollapse(unread_messages) .. seealso:: :meth:`.Message.collapse` rrc34K|]}|jywrrrs rr"z#Inbox.uncollapse..r#r$Nr% uncollapser'r)r,s rrUzInbox.uncollapsesR0#(("BuSbz"BBCD LL  h|44  @"#JErF)r6c f|j|d|t|jtdfi|S)aReturn a :class:`.ListingGenerator` for unread comments and messages. :param mark_read: Marks the inbox as read (default: ``False``). .. note:: This only marks the inbox as read not the messages. Use :meth:`.Inbox.mark_read` to mark the messages. Additional keyword arguments are passed in the initialization of :class:`.ListingGenerator`. For example, to output the author of unread comments try: .. code-block:: python from praw.models import Comment for item in reddit.inbox.unread(limit=None): if isinstance(item, Comment): print(item.author) params) argumentskeymarkrN)_safely_add_argumentsrrr)rr6rs rrNz Inbox.unread"s7: ""-=8R["\ hx.@UDTUUrN)rrreturnz)Iterator[models.Message | models.Comment])r-zlist[models.Message]r\None)rrr\zIterator[models.Comment])r\r])r-z%list[models.Comment | models.Message]r\r])rGstrr\zmodels.Message)rrr\zIterator[models.Message])rOrr\)Iterator[models.Comment | models.Message])r6boolrz Any | Noner\r_)__name__ __module__ __qualname____doc__rr&r/r2r6r:r<r>rIrLrPrRrUrNrrr r sz=U :_ 9"@6X&4$X T ?$b @ VV' V 3 Vrr N)rd __future__rtypingrr praw.constrpraw.models.baserpraw.models.listing.generatorrpraw.models.utilr collections.abcr prawr r rerrrns3"%%:-(nVHnVr