FjNHdZddlmZddlmZmZmZddlmZddl m Z ddl m Z ddl mZddlmZdd lmZdd lmZdd lmZerdd lZdd lmZdd lZddlmZGddeeZGdde ZGdde ZGdde Zee_ y )z"Provide Collections functionality.) annotations) TYPE_CHECKINGAnycast)API_PATH)ClientException)PRAWBase) RedditBase) CreatedMixin) Submission) Subreddit)cachedpropertyN)Iterator)modelsceZdZdZdZdZeddZeddZe ddZ d dfd Z ddZ dd Z dfd Zdfd Zdd Zdd ZddZxZS) CollectionaClass to represent a :class:`.Collection`. Obtain an instance via: .. code-block:: python collection = reddit.subreddit("test").collections("some_uuid") or .. code-block:: python collection = reddit.subreddit("test").collections( permalink="https://reddit.com/r/test/collection/some_uuid" ) .. include:: ../../typical_attributes.rst =================== ============================================================= Attribute Description =================== ============================================================= ``author`` The :class:`.Redditor` who created the collection. ``collection_id`` The UUID of the collection. ``created_at_utc`` Time the collection was created, represented in `Unix Time`_. ``description`` The collection description. ``display_layout`` The collection display layout. ``last_update_utc`` Time the collection was last updated, represented in `Unix Time`_. ``link_ids`` A list of :class:`.Submission` fullnames. ``permalink`` The collection's permalink (to view on the web). ``sorted_links`` An iterable listing of the posts in this collection. ``title`` The title of the collection. =================== ============================================================= .. _unix time: https://en.wikipedia.org/wiki/Unix_time collection_idcreated_at_utccBt|j|jS)aGet an instance of :class:`.CollectionModeration`. Provides access to various methods, including :meth:`~.CollectionModeration.add_post`, :meth:`~.CollectionModeration.delete`, :meth:`~.CollectionModeration.reorder`, and :meth:`~.CollectionModeration.update_title`. Example usage: .. code-block:: python collection = reddit.subreddit("test").collections("some_uuid") collection.mod.update_title("My new title!") )CollectionModeration_redditrselfs \/root/workspace/ytshorts/venv/lib/python3.12/site-packages/praw/models/reddit/collections.pymodzCollection.modBs"$DLL$2D2DEEcvtdt|jj|jgS)zGet the subreddit that this collection belongs to. For example: .. code-block:: python collection = reddit.subreddit("test").collections("some_uuid") subreddit = collection.subreddit models.Subreddit) fullnames)rnextrinfo subreddit_idrs r subredditzCollection.subredditUs2&T\\->->$J[J[I\->-](^__rc8|j|jS)zThe last update time as a timezone-aware :class:`datetime.datetime`. The returned object is localized to the system's timezone. )_to_local_datetimelast_update_utcrs rupdated_datetimezCollection.updated_datetimecs&&t';';<Initialize a :class:`.Collection` instance. :param reddit: An instance of :class:`.Reddit`. :param _data: Any data associated with the :class:`.Collection`. :param collection_id: The ID of the :class:`.Collection`. :param permalink: The permalink of the :class:`.Collection`. c3&K|] }|d yw)N).0values r z&Collection.__init__..{sUU5CTqUsr*zIExactly one of '_data', 'collection_id', or 'permalink' must be provided.T)r include_linksN)sum TypeError _url_partsrsuper__init__ _info_params)rreddit_datar permalinkmsg __class__s rr5zCollection.__init__lsw UumY?U UYZ Z]CC.  OOI6q9M !.D  '"//! rc#8K|jEd{y7w)a;Provide a way to iterate over the posts in this :class:`.Collection`. Example usage: .. code-block:: python collection = reddit.subreddit("test").collections("some_uuid") for submission in collection: print(submission.title, submission.permalink) N) sorted_linksrs r__iter__zCollection.__iter__s$$$$s c,t|jS)zGet the number of posts in this :class:`.Collection`. Example usage: .. code-block:: python collection = reddit.subreddit("test").collections("some_uuid") print(len(collection)) )lenlink_idsrs r__len__zCollection.__len__s4==!!rc|dk(r!|jj||_n+|dk(r&|jjj |}t |||y)z9Objectify author, subreddit, and sorted_links attributes. author_namer=dataN)rredditorauthor _objector objectifyr4 __setattr__)r attributer-r;s rrKzCollection.__setattr__sU  %,,//6DK . (LL**44%4@E Iu-rcd|j} |jjj|t ||j|}|jj|jt|)y#t$rd|j d}t |dwxYw)Nz(Error during fetch. Check collection ID z is correct.r8) _fetch_datarrI check_errorrrtype__dict__updater4_fetch)rrFr:otherr;s rrTzCollection._fetchs! 1 LL " " . .t 4T 4<rBrKrTrXr\r` __classcell__r;s@rrrs$L I,FF$ ` `==(,$( $   % "      @ % ". 3 & rrcdeZdZdZd fd Zd dZd dZddZd dZddZ ddZ dd Z dd Z xZ S)rzClass to support moderation actions on a :class:`.Collection`. Obtain an instance via: .. code-block:: python reddit.subreddit("test").collections("some_uuid").mod c6t||d||_y)zInitialize a :class:`.CollectionModeration` instance. :param collection_id: The ID of a :class:`.Collection`. NrN)r4r5r)rr7rr;s rr5zCollectionModeration.__init__s t,*rct|tr |jSt|tsdt |d}t ||j |jjjddr|S |jj|jS#t$r(|jj|jcYSwxYw)zGet a post's fullname. :param post: A fullname, a :class:`.Submission`, a permalink, or an ID. :returns: The fullname of the post. z(Cannot get fullname from object of type . submission_)url) isinstancer fullnamergrQr2 startswithrconfigkindsrvr)rr^r:s r_post_fullnamez#CollectionModeration._post_fullnames dJ '== $$cdrc|j|}|jjtd|j|dy)aRemove a post from the collection. :param submission: The post to remove, a :class:`.Submission`, its permalink as a ``str``, its fullname as a ``str``, or its ID as a ``str``. Example usage: .. code-block:: python collection = reddit.subreddit("test").collections("some_uuid") collection.mod.remove_post("bgibu9") .. seealso:: :meth:`.add_post` collection_remove_postrrENrrs r remove_postz CollectionModeration.remove_post9sB$++J7   - .#'#5#5 V  rcdjfd|D}jjtdj|dy)aReorder posts in the collection. :param links: A list of :class:`.Submission`\ s or a ``str`` that is either a fullname or an ID. Example usage: .. code-block:: python collection = reddit.subreddit("test").collections("some_uuid") current_order = collection.link_ids new_order = reversed(current_order) collection.mod.reorder(new_order) ,c3@K|]}j|ywN)r~)r,r^rs rr.z/CollectionModeration.reorder..bsH$D//5Hscollection_reorder)rrArEN)joinrr^rr)rlinksrAs` rreorderzCollectionModeration.reorderRsG 88H%HH  ) *#'#5#58L  rcf|jjtd|j|dy)ahUpdate the collection's description. :param description: The new description. Example usage: .. code-block:: python collection = reddit.subreddit("test").collections("some_uuid") collection.mod.update_description("Please enjoy these links!") .. seealso:: :meth:`.update_title` collection_desc)r descriptionrENr])rrs rupdate_descriptionz'CollectionModeration.update_descriptionhs2"  & '#'#5#5kR  rcf|jjtd|j|dy)aWUpdate the collection's display layout. :param display_layout: Either ``"TIMELINE"`` for events or discussions or ``"GALLERY"`` for images or memes. Passing ``None`` will clear the set layout and ``collection.display_layout`` will be ``None``, however, the collection will appear on Reddit as if ``display_layout`` is set to ``"TIMELINE"``. Example usage: .. code-block:: python collection = reddit.subreddit("test").collections("some_uuid") collection.mod.update_display_layout("GALLERY") collection_layout)rdisplay_layoutrENr])rrs rupdate_display_layoutz*CollectionModeration.update_display_layout~s5"  ( )!%!3!3"0  rcf|jjtd|j|dy)aOUpdate the collection's title. :param title: The new title. Example usage: .. code-block:: python collection = reddit.subreddit("test").collections("some_uuid") collection.mod.update_title("Titley McTitleface") .. seealso:: :meth:`.update_description` collection_title)rtitlerENr])rrs r update_titlez!CollectionModeration.update_titles2"  ' (#'#5#5F  r)r7rbrrgrare)r^zstr | models.Submissionrarg)rvzmodels.Submissionrarerh)rzlist[str | models.Submission]rare)rrgrare)rrgrare)rrgrare)rirjrkrlr5r~rrrrrrrrprqs@rrrs6+:( 2e  2 , , 2 rrcheZdZdZeddZ d ddZ d d fd Zd dZxZ S) SubredditCollectionszClass to represent a :class:`.Subreddit`'s :class:`.Collection`\ s. Obtain an instance via: .. code-block:: python reddit.subreddit("test").collections cVt|j|jjS)a5Get an instance of :class:`.SubredditCollectionsModeration`. Provides :meth:`~SubredditCollectionsModeration.create`: .. code-block:: python my_sub = reddit.subreddit("test") new_collection = my_sub.collections.mod.create(title="Title", description="desc") )SubredditCollectionsModerationrr#rzrs rrzSubredditCollections.mods.dllDNN T !yD'8 9SCC. $,,myYYrc4t|||||_y)z5Initialize a :class:`.SubredditCollections` instance.N)r4r5r#)rr7r#r8r;s rr5zSubredditCollections.__init__s '"rc#K|jjtdd|jjiEd{y7w)zIterate over the :class:`.Subreddit`'s :class:`.Collection`\ s. Example usage: .. code-block:: python for collection in reddit.subreddit("test").collections: print(collection.permalink) collection_subreddit sr_fullname)paramsN)rgetrr#rzrs rr>zSubredditCollections.__iter__sD<<## + ,!4>>#:#:;$   s>AAA)rar)NN)rrdr9rdrarr)r7rbr#rr8rcrare)razIterator[Collection]) rirjrkrlrrrr5r>rprqs@rrrs U U%) $"Z!"Z"Z  "ZP(, ##$#% #  # rrcDeZdZdZ d dfd ZddddZxZS) rzClass to represent moderator actions on a :class:`.Subreddit`'s :class:`.Collection`\ s. Obtain an instance via: .. code-block:: python reddit.subreddit("test").collections.mod Nc4t|||||_y)z?Initialize a :class:`.SubredditCollectionsModeration` instance.N)r4r5subreddit_fullname)rr7 sub_fullnamer8r;s rr5z'SubredditCollectionsModeration.__init__s '".r)rcx||j|d}|r||d<|jjtd|S)a<Create a new :class:`.Collection`. The authenticated account must have appropriate moderator permissions in the subreddit this collection belongs to. :param description: The description, up to 500 characters. :param display_layout: Either ``"TIMELINE"`` for events or discussions or ``"GALLERY"`` for images or memes. Passing ``""`` or ``None`` will make the collection appear on Reddit as if this is set to ``"TIMELINE"`` (default: ``None``). :param title: The title of the collection, up to 300 characters. :returns: The newly created :class:`.Collection`. Example usage: .. code-block:: python my_sub = reddit.subreddit("test") new_collection = my_sub.collections.mod.create(title="Title", description="desc") new_collection.mod.add_post("bgibu9") To specify the display layout as ``"GALLERY"`` when creating the collection: .. code-block:: python my_sub = reddit.subreddit("test") new_collection = my_sub.collections.mod.create( title="Title", description="desc", display_layout="GALLERY" ) new_collection.mod.add_post("bgibu9") .. seealso:: :meth:`~.CollectionModeration.delete` )rrrrcollection_createrE)rrr^r)rrrrrFs rcreatez%SubredditCollectionsModeration.createsSN'22  %3D! "||  ( )!  rr)r7rbrrgr8rcrare)rrgrrdrrgrar)rirjrkrlr5rrprqs@rrrsI(, ///% /  /HL0 0 rr)!rl __future__rtypingrrr praw.constrpraw.exceptionsrpraw.models.baser praw.models.reddit.baser praw.models.reddit.mixinsr praw.models.reddit.submissionr praw.models.reddit.subredditr praw.util.cacherdatetimecollections.abcrprawrrrrr_subreddit_collections_classr+rrrs("+++%.242*(M zM `C 8C LU 8U pE XE P*> &r