Fj3dZddlmZddlmZddlmZmZddlm Z ddl m Z ddl m Z ddlmZer dd lmZdd lmZGd d ZGd deZGddeZy)z(Provide the SubredditRelationship class.) annotations)deepcopy) TYPE_CHECKINGAny)API_PATH)ListingGenerator) RedditBase)permissions_string)Iterator)modelsc>eZdZdZ d ddZd dZd dZd dZy) SubredditRelationshipaRepresents 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 tj|d|td|jj |j }t |j j|fi|S)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`. params) argumentskeyuserlist_ subreddit)r _safely_add_argumentsr relationshipformatrr_redditselfredditorgenerator_kwargsurls g/root/workspace/ytshorts/venv/lib/python3.12/site-packages/praw/models/reddit/subreddit/relationship.py__call__zSubredditRelationship.__call__"s_ ((3CX`at00123::T^^:T 6 6P?OPPc ||_||_y)zInitialize a :class:`.SubredditRelationship` instance. :param subreddit: The :class:`.Subreddit` for the relationship. :param relationship: The name of the relationship. N)rr)rrrs r __init__zSubredditRelationship.__init__5s)"r"c t||jd}|j|tdj |j }|j j j||y)zzAdd ``redditor`` to this relationship. :param redditor: A redditor name or :class:`.Redditor` instance. nametypefriendrdataN)strrupdaterrrrpost)rrother_settingsr+rs r addzSubredditRelationship.add?s] H t/@/@A N#x ''$..'A ##Cd#3r"ct||jd}tdj|j}|jj j ||y)zRemove ``redditor`` from this relationship. :param redditor: A redditor name or :class:`.Redditor` instance. r&unfriendrr*N)r,rrrrrr.rrr+rs r removezSubredditRelationship.removeJsQ H t/@/@Az"))DNN)C ##Cd#3r"Nrstr | models.Redditor | NonerrreturnzIterator[models.Redditor])rzmodels.Subredditrr,r8None)rstr | models.Redditorr/rr8r9rr:r8r9)__name__ __module__ __qualname____doc__r!r$r0r4r"r rrs@  26Q.Q Q # Q&# 44r"rceZdZdZddZy)ContributorRelationshipaGProvides 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) c|jjjtdd|jjiy)z"Abdicate the contributor position.leavecontributoridr*N)rrr.rfullname)rs r leavezContributorRelationship.leavecs4 ##H-?$@dnnNeNeGf#gr"Nr8r9)r<r=r>r?rGr@r"r rBrBUs  hr"rBceZdZdZehdZeddd ddZ d ddZdd dfdZ dd dd Z dd  dd Z dd Z dd Z dd ddZdd ddZxZS)ModeratorRelationshipaProvides 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) >mailwikiflairpostsaccessconfig chat_config chat_operatorNr/ permissionscr|r t|ni}tttj||d<|S)N)known_permissionsrTrT)rr setrJ PERMISSIONSrSs r _handle_permissionsz)ModeratorRelationship._handle_permissionss< 6D.1(:!"7"C"CDR]) }%r"c|in dt|i}td|jj|j}|jj j ||S)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://support.reddithelp.com/hc/en-us/articles/360049499032-Why-can-t-I-see-the-list-of-moderators-in-a-community- .. 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)r)r,rrrrrget)rrrrs r r!zModeratorRelationship.__call__seL.6-=rFCPXMCZt00123::T^^:T~~%%))#f)==r")rTc L|j||}t||fi|y)a Add 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"]) rSN)rYsuperr0)rrrTr/ __class__s r r0zModeratorRelationship.adds,211]h1i  H//r"c |j||}|jt|ddtdj |j }|j j j||y)aInvite ``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"]) rSmoderator_inviter&r)rr*N)rYr-r,rrrrr.)rrrTr/r+rs r invitezModeratorRelationship.invitesi.''~S^'_ S]4FGHx ''$..'A ##Cd#3r")rc |rd|ind|d<tdj|j}t|jj|fi|S)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) usernameNrlist_invited_moderatorr)rrrrrrs r invitedzModeratorRelationship.invitedsT<@Hj(%;T"/077$..7Q 6 6P?OPPr"c|jjjjxs.|jjjj }|J|j |y)zAbdicate the moderator position (use with care). For example: .. code-block:: python reddit.subreddit("test").moderator.leave() N)rrrPrcrmer4)rrs r rGzModeratorRelationship.leavesU>>))0099]T^^=S=S=X=X=[=[=]### Hr"ct|dd}tdj|j}|jjj ||y)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") r`r&r2rr*N)r,rrrrr.r3s r remove_invitez#ModeratorRelationship.remove_invitesLH /ABz"))DNN)C ##Cd#3r"ctdj|j}|jt |dd|}|jj j ||y)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 moderatorr&rSr*NrrrrYr,rr.rrrTrr+s r r-zModeratorRelationship.update-sd6'(//$../I''$'M;G#(  ##Cd#3r"ctdj|j}|jt |dd|}|jj j ||y)aUpdate 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"]) rkrr`r&rSr*Nrmrns r update_invitez#ModeratorRelationship.update_inviteOse,'(//$../I''$'M;MN#(  ##Cd#3r")r/z dict | NonerTlist[str] | Noner8zdict[str, Any]r5)rr7r8zlist[models.Redditor])rr:rTrqr/rr8r9r6rHr;)rr:rTrqr8r9)r<r=r>r? frozensetrX staticmethodrYr!r0rarerGrir-rp __classcell__)r^s@r rJrJhsQ   K'+(, # &    8<(>4(> (>\)- 0'0& 0  0  0@)- 4'4& 4  4  4>26 Q/ Q Q # QD 4()- 4' 4& 4  4L)- 4'4& 4  4r"rJN)r? __future__rcopyrtypingrr praw.constrpraw.models.listing.generatorrpraw.models.reddit.baser praw.models.utilr collections.abcr prawr rrBrJr@r"r r~sO."%:./(?4?4Dh3h&B41B4r"