FjYdZddlmZddlmZddlmZddlmZm Z m Z ddl m Z ddl mZddlmZdd lmZdd lmZer dd lmZdd lmZGd dZGddZGddeZGddeZy)z*Provide the SubredditFlairTemplates class.) annotations)writer)StringIO) TYPE_CHECKINGAnycast)API_PATH)InvalidFlairTemplateID)ListingGenerator) RedditBase)cachedproperty)Iterator)modelsceZdZdZe ddZe ddZ d ddZddZddd dd  dd Z dd Z dd Z dddd ddZ ddd ddZ y)SubredditFlairzJProvide a set of functions to interact with a :class:`.Subreddit`'s flair.c,t|jS)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) )SubredditLinkFlairTemplates subredditselfs `/root/workspace/ytshorts/venv/lib/python3.12/site-packages/praw/models/reddit/subreddit/flair.pylink_templateszSubredditFlair.link_templatess +4>>::c,t|jS)aProvide 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) )SubredditRedditorFlairTemplatesrrs r templateszSubredditFlair.templates*s /t~~>>rNc tj|d||jddtdj |j }t |j j|fi|S)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) params) argumentskeynamelimitN flairlistr)r _safely_add_arguments setdefaultr formatrr _reddit)rredditorgenerator_kwargsurls r__call__zSubredditFlair.__call__<sa* ((3CX`a##GT2{#**T^^*D 6 6P?OPPrc||_y)z|Initialize a :class:`.SubredditFlair` instance. :param subreddit: The subreddit whose flair to work with. Nr$rrs r__init__zSubredditFlair.__init__Vs #rleftFright) link_positionlink_self_assignposition self_assignc t||xsd||xsd|d}|j|tdj|j}|jj j ||y)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. r1) flair_enabledflair_positionflair_self_assign_enabledlink_flair_positionlink_flair_self_assign_enabled flairconfigr$dataN)boolupdater r'rr(post)rr2r3r4r5settingsr?r+s r configurezSubredditFlair.configure^so:"(^&1')4#0#6B.>   H}%,,t~~,F ##Cd#3rctdj|j}|jjj |dt |iy)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$r!r>N)r r'rr(rBstr)rr)r+s rdeletezSubredditFlair.deletesF}%,,t~~,F ##Cvs8}.E#Frc<|jd|DS)zDelete all :class:`.Redditor` flair in the :class:`.Subreddit`. :returns: List of dictionaries indicating the success or failure of each delete. c3:K|]}td|dyw)z dict[str, str | models.Redditor]userN)r).0xs r z,SubredditFlair.delete_all..s_ST4 BAFvN_s)rArs r delete_allzSubredditFlair.delete_alls {{_X\X^___rr7) css_classflair_template_idtextc6|r| d}t|t||d}|)||d<tdj|j}n(||d<tdj|j}|jj j || y) aSet 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'.)r!rRrQ select_flairr$rPflairr>) TypeErrorrGr r'rr(rB)rr)rPrQrRmsgr?r+s rsetzSubredditFlair.sets@ *6aCC. H t4  ((9D$ %>*11DNN1KC )D 7#**T^^*DC ##Cd#3r)rPrRc zt}|D]}t|trJt|j t |d|j d||j d|g]t|j t |||g|jj}|jg}tdj|j}|rTddj|dd i} |j|jjj!|| |d d}|rT|S) aSet 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") rK flair_textflair_css_classflaircsvr$ flair_csv Ndr>)r isinstancedictrwriterowrGgetgetvalue splitlinescloser r'rjoinextendr(rB) r flair_listrPrR temp_linesitemlinesresponser+r?s rrAzSubredditFlair.updates'DZ  JD$%z"++V %HH\40HH. :- z"++SYi,HI J##%002z"))DNN)C5#;!78D OODNN2277$7G H#$KEr)returnr)rnr)N)r)zmodels.Redditor | str | Noner*rrnzIterator[models.Redditor]rzmodels.SubredditrnNone) r2rGr3r@r4rGr5r@rCrrnrp)r)models.Redditor | strrnrp)rn,list[dict[str, str | bool | dict[str, str]]]) r)rqrPrGrQ str | NonerRrGrnrp)rizBIterator[str | models.Redditor | dict[str, str | models.Redditor]]rPrGrRrGrnrr)__name__ __module__ __qualname____doc__r rrr,r/rDrHrOrXrArrrrs:T; $;;"? (??&26Q.Q Q # Q4#$!&! %4%4 %4  %4  %4%4 %4N G`(, *4'*4 *4 & *4  *4 *4` 5V5 5  5 6 5rrc eZdZdZeddZddZddZddddddddd dd Zdd dd Z dd dd Z dd Z dddddddddd ddZ y)SubredditFlairTemplateszKProvide functions to interact with a :class:`.Subreddit`'s flair templates.c|rdSdS)zKReturn ``"LINK_FLAIR"`` or ``"USER_FLAIR"`` depending on ``is_link`` value. LINK_FLAIR USER_FLAIRrxis_links r flair_typez"SubredditFlairTemplates.flair_types '|8L8rc||_y)azInitialize 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$r.s rr/z SubredditFlairTemplates.__init__s #rct)z*Abstract method to return flair templates.)NotImplementedErrorrs r__iter__z SubredditFlairTemplates.__iter__s!!rNr7F)allowable_contentbackground_colorrPr max_emojismod_only text_color text_editablec tdj|j} ||||j||t |||t | d } |jj j | | y)Nflairtemplate_v2r$r~) rrrPrrrrRrrr>)r r'rrr@r(rB) rrrrPrrrrRrrr+r?s r_addzSubredditFlairTemplates._addsv)*11DNN1K!2 0"//'/:$X$!-0   ##Cd#3rr~ctdj|j}|jjj |d|j |iy)Nflairtemplateclearr$rr~r>)r r'rr(rBr)rrr+s r_clearzSubredditFlairTemplates._clear4sM+,33dnn3M ##C|T__U\_=].^#_rctdj|j}|jjj |||j ||jj dy)Nflairtemplatereorderr$r~)rr)jsonr)r r'rr(patchr display_name)rrirr+s r_reorderz SubredditFlairTemplates._reorder8sb-.555O $$ "oogo>!^^88 % rctdj|j}|jjj |d|iy)a9Remove 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$rQr>Nr r'rr(rB)r template_idr+s rrHzSubredditFlairTemplates.deleteCsD,-44t~~4N ##C/BK.P#QrT) rrrPfetchrrrRrrc tdj|j} |||||||| | d } |rnt|D cgc] } | d|k(s | }} t |dk7r t ||d}|j D]\}}| j||| |<|jjj| | ycc} w) 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$) rrrPrQrrrRrridrNr>) r r'riterlenr itemsrcr(rB)rrrrrPrrrrRrrr+r?templateexisting_data_ existing_datar values rrAzSubredditFlairTemplates.updateQsj)*11DNN1K!2 0"!,$ $*   7;Dzc8Xd^WbEbhcNc>"a',[99*1-M+113 & U88C=( %DI & ##Cd#3ds C C)r bool | NonernrGrornz>))--c222sA AAANr7FrrrPrrrrc 8|j|||d||||| y)aAdd 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 rrrPrrrrRrrNr rrRrrrPrrrrs raddzSubredditLinkFlairTemplates.adds1R /-!!'  rc(|jdy)zRemove all link flair templates from the subreddit. For example: .. code-block:: python reddit.subreddit("test").flair.link_templates.clear() Tr~Nrrs rclearz!SubredditLinkFlairTemplates.clears D !rc*|j|dy)aReorder 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~Nrrris rreorderz#SubredditLinkFlairTemplates.reorders j$ /rc#Ktdj|j}|jjj |ddidEd{y7w)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_newlinkTr>choicesNrrs ruser_selectablez+SubredditLinkFlairTemplates.user_selectablesQ'...H>>))..s,9M.NyYYYsAAAArrRrGrrsrrsrPrGrrrrrrsrr@rnrprnrpriz list[str]rnrp)rnzIterator[dict[str, str | bool]]) rtrurvrwrrrrrrxrrrrsB3 E3()-'+!% $!%#3 3 & 3 % 3  3 3 3 3 3  3 j "0 Z (ZrrcheZdZdZ d dZdddddddd d dZd dZd d Zy)rzFProvide functions to interact with :class:`.Redditor` flair templates.c#Ktdj|j}d|jjji}|jjj ||Ed{y7w)zIterate through the user flair templates. For example: .. code-block:: python for template in reddit.subreddit("test").flair.templates: print(template) user_flairr$unique)rN)r r'rr( _next_uniquerc)rr+rs rrz(SubredditRedditorFlairTemplates.__iter__sa|$++dnn+E(0$..2H2H2U2U'V>>))--c&-AAAsA0A:2A83A:Nr7Frc 8|j|||d||||| y)aAdd 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 rrz#SubredditRedditorFlairTemplates.add&s1R /-!!'  rc(|jdy)zRemove all :class:`.Redditor` flair templates from the subreddit. For example: .. code-block:: python reddit.subreddit("test").flair.templates.clear() Fr~Nrrs rrz%SubredditRedditorFlairTemplates.clear[s E "rc*|j|dy)aReorder 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 rrz'SubredditRedditorFlairTemplates.reordergs j% 0rrrrr)rtrurvrwrrrrrxrrrrsPB EB*)-'+!% $!%#3 3 & 3 % 3  3 3 3 3 3  3 j #1rrN)rw __future__rcsvriortypingrrr praw.constr praw.exceptionsr praw.models.listing.generatorr praw.models.reddit.baser praw.utilr collections.abcrprawrrrzrrrxrrrsj0"++2:.$(ggT[4[4|rZ"9rZjd1&=d1r