o 2g/@sdZddlmZddlmZmZddlmZddlm Z m Z ddl m Z er*dd l Z Gd d d e ZGd d d e ZGdddeZGdddeZd S)zProvide models for new modmail.) annotations) TYPE_CHECKINGAny)API_PATH)_deprecate_argssnake_case_keys) RedditBaseNcs*eZdZdZdZdZd fdd ZZS) ModmailObjectz7A base class for objects within a modmail conversation.authorid attributestrvaluercs*||jkr |jj|}t||dS)z)Objectify the AUTHOR_ATTRIBUTE attribute.N)AUTHOR_ATTRIBUTE_reddit _objector objectifysuper __setattr__)selfrr __class__R/home/garg/my-data/venv/lib/python3.10/site-packages/praw/models/reddit/modmail.pyrs zModmailObject.__setattr__)rrrr)__name__ __module__ __qualname____doc__r STR_FIELDr __classcell__rrrrr s r cseZdZdZdZed=ddZed=d d Zed>d d Z   d?d@fdd Z dAddZ fddZ ddZ d d!Zd"d#Zed$d%d&dBd(d)Zeddd*dCd,d-Zed.d/d0ddd1dDd3d4Zd5d6Zd7d8Zd9d:Zeddd*dCd;d<ZZS)EModmailConversationaA class for modmail conversations. .. include:: ../../typical_attributes.rst ==================== =============================================================== Attribute Description ==================== =============================================================== ``authors`` Provides an ordered list of :class:`.Redditor` instances. The authors of each message in the modmail conversation. ``id`` The ID of the :class:`.ModmailConversation`. ``is_highlighted`` Whether or not the :class:`.ModmailConversation` is highlighted. ``is_internal`` Whether or not the :class:`.ModmailConversation` is a private mod conversation. ``last_mod_update`` Time of the last mod message reply, represented in the `ISO 8601`_ standard with timezone. ``last_updated`` Time of the last message reply, represented in the `ISO 8601`_ standard with timezone. ``last_user_update`` Time of the last user message reply, represented in the `ISO 8601`_ standard with timezone. ``num_messages`` The number of messages in the :class:`.ModmailConversation`. ``obj_ids`` Provides a list of dictionaries representing mod actions on the :class:`.ModmailConversation`. Each dict contains attributes of ``"key"`` and ``"id"``. The key can be either ``""messages"`` or ``"ModAction"``. ``"ModAction"`` represents archiving/highlighting etc. ``owner`` Provides an instance of :class:`.Subreddit`. The subreddit that the :class:`.ModmailConversation` belongs to. ``participant`` Provides an instance of :class:`.Redditor`. The participating user in the :class:`.ModmailConversation`. ``subject`` The subject of the :class:`.ModmailConversation`. ==================== =============================================================== .. _iso 8601: https://en.wikipedia.org/wiki/ISO_8601 r datadict[str, Any]reddit praw.RedditcCsTggd}|dD]}|d}|||d}|||j|q ||dS)z1Convert messages and mod actions to PRAW objects.)messages modActionsobjIdskeyr N)appendrrupdate)r#r%resultthingr* thing_datarrr_convert_conversation_objectsDs  z1ModmailConversation._convert_conversation_objectsc Cs|jj|jjdt|jj|jjdd}|D]C\}}g}||D]+\}}|||dddd}|tur=|d=|D] \} } t|| | qA||q&t |d d d d ||<qd S)z`sz;ModmailConversation._convert_user_summary..T)r*reverseN) rparsersconfigkindsr"itemsrsplitsetattrr+sorted) r#r%r@kindparserobjectsthing_idsummaryr.r*rrrr_convert_user_summaryNs z)ModmailConversation._convert_user_summaryreturncszfdd|dD|d<dD] }j||||<q|dr3||dj|d|d<t|}||dS)zReturn an instance of :class:`.ModmailConversation` from ``data``. :param data: The structured data. :param reddit: An instance of :class:`.Reddit`. csg|]}j|qSr)rr).0r r%rr ns z-ModmailConversation.parse..authors)owner participantuser_data)rrgetrLr)clsr#r%entityrrOrparsebs    zModmailConversation.parseNF str | None mark_readboolrVdict[str, Any] | NonecsRt|t|krd}t||r||_tj||d|r$ddi|_dSd|_dS)zInitialize a :class:`.ModmailConversation` instance. :param mark_read: If ``True``, conversation is marked as read (default: ``False``). z(Either 'id' or '_data' must be provided.rUmarkReadTN)r] TypeErrorr r__init__ _info_params)rr%r r\rVmsgrrrra|s zModmailConversation.__init__other_conversationslist[ModmailConversation]rcCs"|g|pg}ddd|DS)z2Return a comma-separated list of conversation IDs.,css|]}|jVqdSNr8)rN conversationrrr sz?ModmailConversation._build_conversation_list..)join)rrd conversationsrrr_build_conversation_listsz,ModmailConversation._build_conversation_listcs2|}|jj|}|j|jtdSrg) _fetch_datarrr__dict__r,r_fetch)rr#otherrrrroszModmailConversation._fetchcCsdd|ji|jfS)Nmodmail_conversationr )r rbrrrr _fetch_infoszModmailConversation._fetch_infocC|jtdj|jddS)zArchive the conversation. For example: .. code-block:: python reddit.subreddit("test").modmail("2gmz").archive() modmail_archiver8Nrpostrformatr rrrrrarchive zModmailConversation.archivecCrt)zHighlight the conversation. For example: .. code-block:: python reddit.subreddit("test").modmail("2gmz").highlight() modmail_highlightr8Nrvrrrrr highlightrzzModmailConversation.highlightnum_daysr)r}r<cCs<|dkr d|dini}|jjd|tdj|jdddS) aMute the non-mod user associated with the conversation. :param num_days: Duration of mute in days. Valid options are ``3``, ``7``, or ``28`` (default: ``3``). For example: .. code-block:: python reddit.subreddit("test").modmail("2gmz").mute() To mute for 7 days: .. code-block:: python reddit.subreddit("test").modmail("2gmz").mute(num_days=7) r num_hoursPOST modmail_muter8)methodparamspathNrrequestrrxr )rr}rrrrmutes  zModmailConversation.mute)rd list[ModmailConversation] | NonecC&d||i}|jjtd|ddS)aMark the conversation(s) as read. :param other_conversations: A list of other conversations to mark (default: ``None``). For example, to mark the conversation as read along with other recent conversations from the same user: .. code-block:: python subreddit = reddit.subreddit("test") conversation = subreddit.modmail.conversation("2gmz") conversation.read(other_conversations=conversation.user.recent_convos) conversationIds modmail_readr#Nrlrrwrrrdr#rrrreadzModmailConversation.readbody author_hiddeninternal)rrModmailMessagec Cs|||d}|jjtdj|jd|d}t|tr1|dddd}|d |}|jj|S|j D]}|j|j ddkrD|Sq4d S) a[Reply to the conversation. :param author_hidden: When ``True``, author is hidden from non-moderators (default: ``False``). :param body: The Markdown formatted content for a message. :param internal: When ``True``, message is a private moderator note, hidden from non-moderators (default: ``False``). :returns: A :class:`.ModmailMessage` object for the newly created message. For example, to reply to the non-mod user while hiding your username: .. code-block:: python conversation = reddit.subreddit("test").modmail("2gmz") conversation.reply(body="Message body", author_hidden=True) To create a private moderator note on the conversation: .. code-block:: python conversation.reply(body="Message body", internal=True) )risAuthorHidden isInternalrqr8rrhr)r7r r'N) rrwrrxr isinstancedictrrr'obj_ids) rrrrr#response message_id message_datamessagerrrreplys    zModmailConversation.replycCrt)zUnarchive the conversation. For example: .. code-block:: python reddit.subreddit("test").modmail("2gmz").unarchive() modmail_unarchiver8Nrvrrrrr unarchiverzzModmailConversation.unarchivecCrt)zUn-highlight the conversation. For example: .. code-block:: python reddit.subreddit("test").modmail("2gmz").unhighlight() r{r8N)rdeleterrxr rrrrr unhighlight$rzzModmailConversation.unhighlightcCs"|jjdtdj|jdddS)zUnmute the non-mod user associated with the conversation. For example: .. code-block:: python reddit.subreddit("test").modmail("2gmz").unmute() rmodmail_unmuter8)rrNrrrrrrunmute0s  zModmailConversation.unmutecCr)aMark the conversation(s) as unread. :param other_conversations: A list of other conversations to mark (default: ``None``). For example, to mark the conversation as unread along with other recent conversations from the same user: .. code-block:: python subreddit = reddit.subreddit("test") conversation = subreddit.modmail.conversation("2gmz") conversation.unread(other_conversations=conversation.user.recent_convos) rmodmail_unreadrNrrrrrunread>rzModmailConversation.unread)r#r$r%r&)r#r$r%r&rMr")NFN)r%r&r r[r\r]rVr^)rdrerMr)r}r<)rdr)rr]rrrr]rMr)rrrrr staticmethodr0rL classmethodrZrarlrorsryr|rrrrrrrrr!rrrrr"s<%        ,  r"c@eZdZdZdS) ModmailActionz7A class for moderator actions on modmail conversations.NrrrrrrrrrSrc@r)rzA class for modmail messages.NrrrrrrWrr)r __future__rtypingrrconstrutilrrr;r prawr r"rrrrrrs    9