o 2g_*@s|dZddlmZddlmZmZddlmZddlm Z ddl m Z dd l m Z dd lmZer4dd lZGd d d e Zd S)zProvide the Front class.) annotations) TYPE_CHECKINGIterator)API_PATH)_deprecate_args)PRAWBase)ListingGenerator)stream_generatorNc@seZdZdZd1ddZd2d d Zd3d dZddZd4ddZd4ddZ d3ddZ d5ddZ d6ddZ d6d d!Z d7d$d%Zd3d&d'Zd2d(d)Zed*d+d,d8d.d/Zd0S)9Inboxz3Inbox is a Listing class that represents the inbox.generator_kwargsstr | int | dict[str, str]return3Iterator[praw.models.Message | praw.models.Comment]cKt|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 _redditrselfr rI/home/garg/my-data/venv/lib/python3.10/site-packages/praw/models/inbox.pyallz Inbox.allitemslist[praw.models.Message]cCP|r&dddd|ddDi}|jjtd|d|dd}|sdSdS) 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,cs|]}|jVqdSNfullname.0xrrr ?z!Inbox.collapse..Ncollapsedatajoinrpostrrrr,rrrr*&    zInbox.collapseIterator[praw.models.Comment]cKr)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_repliesrrrrrr3C  zInbox.comment_repliescCs|jtddS)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)rrrr mark_all_readWszInbox.mark_all_read/list[praw.models.Comment | praw.models.Message]cCr) 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` rrcsr r!r"r$rrrr'r(z"Inbox.mark_read..Nr) read_messager+r-r0rrr mark_readhs    zInbox.mark_readcCr) 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` rrcsr r!r"r$rrrr'r(z$Inbox.mark_unread..Nr)unread_messager+r-r0rrr mark_unreads    zInbox.mark_unreadcKr)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") mentionsrrrrrr<szInbox.mentions message_idstrpraw.models.MessagecCsj|jtdj|d}dd|dg|djD}|D] \}}||jd|_q|d|S)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)rcSsi|]}|j|qSrr")r%r@rrr sz!Inbox.message..rNt4_) rgetrformatrepliesr parent_idparentlower)rr=listingmessages _fullnamer@rrrr@s z Inbox.messageIterator[praw.models.Message]cKr)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) rJrrrrrrJrzInbox.messagescKr)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) sentrrrrrrMrz Inbox.sentstream_options3Iterator[praw.models.Comment | praw.models.Message]cKst|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)rrNrrrstreamsz Inbox.streamcKr)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_repliesrrrrrrRr4zInbox.submission_repliescCr) 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` rrcsr r!r"r$rrrr'1r(z#Inbox.uncollapse..Nr) uncollapser+r-r0rrrrSr1zInbox.uncollapser9F)r9boolcKs(|j|d|dt|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) argumentskeymarkrP)_safely_add_argumentsr rr)rr9r rrrrP5sz Inbox.unreadN)r rrr)rr)r rrr2)rr7)r=r>rr?)r rrrL)rNrrrO)r9rTr rrrO)__name__ __module__ __qualname____doc__rr*r3r6r9r;r<r@rJrMrQrRrSrrPrrrrr s$           r )r] __future__rtypingrrconstrutilrbaser listing.generatorr r praw.modelsprawr rrrrs