ljKaddlmZddlmZddlmZmZddlmZm Z ddl m Z m Z m Z ddlmZmZddlmZej&Gdd eeZy ) )Path) quote_plus)mediautils)PlexPartialObjectcached_data_property) BadRequestNotFound Unsupported)LibrarySection ManagedHub)CollectionMixinsceZdZdZdZdZdZedZedZ edZ edZ d Z d Z d Zd Zed ZedZedZedZedZedZdZefdZdZdZedZdZdZdZd(dZd(dZ d(dZ!dZ"dZ#d(d Z$d)d!Z%fd"Z&e'd#Z(e'd)d$Z)e' d*d%Z* d+d&Z+ed'Z,xZ-S), Collectiona Represents a single Collection. Attributes: TAG (str): 'Directory' TYPE (str): 'collection' addedAt (datetime): Datetime the collection was added to the library. art (str): URL to artwork image (/library/metadata//art/). artBlurHash (str): BlurHash string for artwork image. audienceRating (float): Audience rating. childCount (int): Number of items in the collection. collectionFilterBasedOnUser (int): Which user's activity is used for the collection filtering. collectionMode (int): How the items in the collection are displayed. collectionPublished (bool): True if the collection is published to the Plex homepage. collectionSort (int): How to sort the items in the collection. content (str): The filter URI string for smart collections. contentRating (str) Content rating (PG-13; NR; TV-G). fields (List<:class:`~plexapi.media.Field`>): List of field objects. guid (str): Plex GUID for the collection (collection://XXXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXX). images (List<:class:`~plexapi.media.Image`>): List of image objects. index (int): Plex index number for the collection. key (str): API URL (/library/metadata/). labels (List<:class:`~plexapi.media.Label`>): List of label objects. lastRatedAt (datetime): Datetime the collection was last rated. librarySectionID (int): :class:`~plexapi.library.LibrarySection` ID. librarySectionKey (str): :class:`~plexapi.library.LibrarySection` key. librarySectionTitle (str): :class:`~plexapi.library.LibrarySection` title. maxYear (int): Maximum year for the items in the collection. minYear (int): Minimum year for the items in the collection. rating (float): Collection rating (7.9; 9.8; 8.1). ratingCount (int): The number of ratings. ratingKey (int): Unique key identifying the collection. smart (bool): True if the collection is a smart collection. subtype (str): Media type of the items in the collection (movie, show, artist, or album). summary (str): Summary of the collection. theme (str): URL to theme resource (/library/metadata//theme/). thumb (str): URL to thumbnail image (/library/metadata//thumb/). thumbBlurHash (str): BlurHash string for thumbnail image. title (str): Name of the collection. titleSort (str): Title to use when sorting (defaults to title). type (str): 'collection' ultraBlurColors (:class:`~plexapi.media.UltraBlurColors`): Ultra blur color object. updatedAt (datetime): Datetime the collection was updated. userRating (float): Rating of the collection (0.0 - 10.0) equaling (0 stars - 5 stars). Directory collectionc tj|jjd|_|jjd|_|jjd|_tjt|jjd|_ tjt|jjd|_ tjt|jjdd|_ tjt|jjdd |_ tjt|jjd d|_tjt|jjd d|_|jjd |_|jjd |_|jjd|_tjt|jjd|_|jjddj+dd|_tj|jjd|_tjt|jjd|_|jjd|_|jjd|_tjt|jjd|_tjt|jjd|_tjt|jjd|_tjt|jjd|_tjt|jjd|_tjt|jjdd|_ |jjd|_!|jjd|_"|jjd|_#|jjd |_$|jjd!|_%|jjd"|_&|jjd#|jL|_'|jjd$|_(tj|jjd%|_)tjt|jjd&|_*y')(z/ Load attribute values from Plex XML response. addedAtart artBlurHashaudienceRating childCountcollectionFilterBasedOnUser0collectionModez-1collectionPublishedcollectionSortcontent contentRatingguidindexkey /children lastRatedAtlibrarySectionIDlibrarySectionKeylibrarySectionTitlemaxYearminYearrating ratingCount ratingKeysmartsubtypesummarythemethumb thumbBlurHashtitle titleSorttype updatedAt userRatingN)+r toDatetimeattribgetrrrcastfloatrintrrrboolrrrrr r!replacer"r%r&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5r6r7r8)selfdatas ?/DATA/.local/lib/python3.12/site-packages/plexapi/collection.py _loadDatazCollection._loadData>s''  (BC ;;??5);;??=9#jj @P0QR**S$++//,*GH+0::c4;;??Khjm;n+o(#jjdkkoo>NPT.UV#(::dDKKOODY[^4_#` #jjdkkoo>NPS.TU{{y1 ![[___=KKOOF+ ZZT[[__W%=> ;;??5"-55k2F ++DKKOOM,JK % 3 @R0S T!%1D!E#';;??3H#I zz#t{{y'AB zz#t{{y'AB jj (AB  ::c4;;??=+IJC)EFZZdkkoogs&CD {{y1 {{y1 [[__W- [[__W- ![[___=[[__W- djjAKKOOF+ ))$++//+*FG**UDKKOOL,IJcV|j|jtjSN) findItems_datarFieldrAs rCfieldszCollection.fieldsc~~djj%++66rEcV|j|jtjSrG)rHrIrImagerKs rCimageszCollection.imagesgrMrEcV|j|jtjSrG)rHrIrLabelrKs rClabelszCollection.labelskrMrEcV|j|jtjSrG)findItemrIrUltraBlurColorsrKs rCultraBlurColorszCollection.ultraBlurColorsos}}TZZ)>)>??rEc4t|jSrG)lenitemsrKs rC__len__zCollection.__len__ss4::<  rEc#>K|jD]}|ywrGrZ)rAitems rC__iter__zCollection.__iter__vsJJLDJ!scHtfd|jDS)Nc3PK|]}|jjk(ywrG)r").0iothers rC z*Collection.__contains__..{s<|!155EII%|s#&)anyrZ)rArds `rC __contains__zCollection.__contains__zsshowmovieseasonepisodertrKs rCrozCollection.isVideos||EEErEc|jdvS)z. Returns True if this is an audio collection. >albumtrackartistrtrKs rCrpzCollection.isAudios||;;;rEc|jdvS)z- Returns True if this is a photo collection. >rn photoalbumrtrKs rCrqzCollection.isPhotos||666rEc8|j|jS)z Cache for filters. ) _parseFiltersrrKs rC_filterszCollection._filterss!!$,,//rEc|jS)z Returns the search filter dict for smart collection. The filter dict be passed back into :func:`~plexapi.library.LibrarySection.search` to get the list of items. )rrKs rCfilterszCollection.filterss }}rEc(tt| S)z Cache for section. )superrsectionrA __class__s rC_sectionzCollection._sectionsZ.00rEc|jS)zZ Returns the :class:`~plexapi.library.LibrarySection` this collection belongs to. )rrKs rCrzCollection.sections}}rEc|jD]1}|jj|jk(s/|cStd|d)a Returns the item in the collection that matches the specified title. Parameters: title (str): Title of the item to return. Raises: :class:`plexapi.exceptions.NotFound`: When the item is not found in the collection. zItem with title "z" not found in the collection)rZr4lowerr )rAr4r^s rCr^zCollection.itemsLJJLDzz!U[[]2 !*5'1NOPPrEcB|jd}|j|S)z Cache for the items. r$)r" fetchItemsris rC_itemszCollection._itemss# )$s##rEc|jS)z0 Returns a list of all items in the collection. )rrKs rCrZzCollection.itemss {{rEcHd|jd|j}|jj|}|j |t }|Qt |j||}d|jd|j|_|j|_d|_|S)zG Returns the :class:`~plexapi.library.ManagedHub` for this collection. z/hubs/sections/z/manage?metadataItemId=)cls)parentzcustom.collection..F) r&r-_serverqueryrUr identifierr4 _promoted)rAr"rBhubs rC visibilityzCollection.visibilitys 5 566MdnnM]^||!!#&mmDjm1 ;T\\4=C1$2G2G1H$..IYZCN CI!CM rEc$|j|S)z4 Alias to :func:`~plexapi.library.Collection.item`. )r^)rAr4s rCr;zCollection.getsyyrEc|js tdddd}|j|}|td|dt||j |S)a Update the collection filtering user advanced setting. Parameters: user (str): One of the following values: "admin" (Always the server admin user), "user" (User currently viewing the content) Example: .. code-block:: python collection.updateMode(user="user") zCCannot change collection filtering user for a non-smart collection.r)adminuserz#Unknown collection filtering user: . Options )rr.r r;list editAdvanced)rAr user_dictr"s rCfilterUserUpdatezCollection.filterUserUpdatespzzbc c mmD! ;B4& SWXaSbRcde e  S AArEcddddd}|j|}|td|dt||j|S) a Update the collection mode advanced setting. Parameters: mode (str): One of the following values: "default" (Library default), "hide" (Hide Collection), "hideItems" (Hide Items in this Collection), "showItems" (Show this Collection and its Items) Example: .. code-block:: python collection.updateMode(mode="hide") rr)defaulthide hideItems showItemszUnknown collection mode: r)r)r;r rr)rAmode mode_dictr"s rC modeUpdatezCollection.modeUpdates^$  mmD! ;8jiHYZ[ [   44rEc|jr tddddd}|j|}|td|dt||j |S) a Update the collection order advanced setting. Parameters: sort (str): One of the following values: "release" (Order Collection by release dates), "alpha" (Order Collection alphabetically), "custom" (Custom collection order) Example: .. code-block:: python collection.sortUpdate(sort="alpha") z6Cannot change collection order for a smart collection.rrr)releasealphacustomzUnknown sort dir: z . Options: )rr)rAsort sort_dictr"s rC sortUpdatezCollection.sortUpdatesp ::UV V mmD! ;1${4 ?BSTU U   44rEcf|jr td|rt|ttfs|g}g}|D]d}|j |j k7r%td|j d|j |jt|jfdj|}|jjd|}d|i}|jdtj|}|jj!||jj"j$|S) a| Add items to the collection. Parameters: items (List): List of :class:`~plexapi.audio.Audio`, :class:`~plexapi.video.Video`, or :class:`~plexapi.photo.Photo` objects to be added to the collection. Raises: :class:`plexapi.exceptions.BadRequest`: When trying to add items to a smart collection. z'Cannot add items to a smart collection.z4Can not mix media types when building a collection: z and ,/library/metadata/uri/itemsmethod)r.r isinstancertupler6r/appendstrr-joinr_uriRootr"rjoinArgsr_sessionput)rArZ ratingKeysr^rargsr"s rCaddItemszCollection.addItems2s ::FG G ED%=9GE DyyDLL( #WX\XdXdWeejkoktktju!vww   c$..1 2 XXj) &&());J<Hs| &!5 67 3t||'<'<'@'@A rEc$|jr td|rt|ttfs|g}|D]X}|j d|j }|jj||jjjZ|S)a Remove items from the collection. Parameters: items (List): List of :class:`~plexapi.audio.Audio`, :class:`~plexapi.video.Video`, or :class:`~plexapi.photo.Photo` objects to be removed from the collection. Raises: :class:`plexapi.exceptions.BadRequest`: When trying to remove items from a smart collection. z,Cannot remove items from a smart collection./items/r) r.r rrrr"r-rrrdelete)rArZr^r"s rC removeItemszCollection.removeItemsPs ::KL L ED%=9GEDXXJgdnn%56C LL  s4<<+@+@+G+G  H rEc |jr td|jd|jd}|r|d|jz }|jj ||jj j|S)aH Move an item to a new position in the collection. Parameters: item (obj): :class:`~plexapi.audio.Audio`, :class:`~plexapi.video.Video`, or :class:`~plexapi.photo.Photo` object to be moved in the collection. after (obj): :class:`~plexapi.audio.Audio`, :class:`~plexapi.video.Video`, or :class:`~plexapi.photo.Photo` object to move the item after in the collection. Raises: :class:`plexapi.exceptions.BadRequest`: When trying to move items in a smart collection. z(Cannot move items in a smart collection.rz/movez?after=r)r.r r"r-rrrr)rAr^afterr"s rCmoveItemzCollection.moveItemesw ::GH H '$..!17  WU__-. .C 3t||'<'<'@'@A rEc |js td|j}|jd||||d|}|jj |}d|i} |j dtj| } |jj| |jjj|S)a Update the filters for a smart collection. Parameters: libtype (str): The specific type of content to filter (movie, show, season, episode, artist, album, track, photoalbum, photo, collection). limit (int): Limit the number of items in the collection. sort (str or list, optional): A string of comma separated sort fields or a list of sort fields in the format ``column:dir``. See :func:`~plexapi.library.LibrarySection.search` for more info. filters (dict): A dictionary of advanced filters. See :func:`~plexapi.library.LibrarySection.search` for more info. **kwargs (dict): Additional custom filters to apply to the search results. See :func:`~plexapi.library.LibrarySection.search` for more info. Raises: :class:`plexapi.exceptions.BadRequest`: When trying update filters for a regular collection. z/Cannot update filters for a regular collection.rlibtypelimitrrrr) r.r r_buildSearchKeyrrr"rrrrr) rArrrrkwargsr searchKeyrrr"s rC updateFilterszCollection.updateFilters|s$zzNO O,,.+G++PweWPHNP &&())5s| &!5 67 3t||'<'<'@'@A rEc*tt| y)z Delete the collection. N)rrrrs rCrzCollection.deletes j$&(rEc|s tdt|ts|jj |}|rt|t t fs|g}|dj}g}|D]@}|j|k7r td|jt|jBdj|}|jd|}|tj||d|jd} dtj | } |j#| |j$j&d} ||| | S) z Create a regular collection. z7Must include items to add when creating new collection.rz3Can not mix media types when building a collection.rrrr6r4r. sectionId/library/collectionsrinitpath)r rr libraryrrrr6rrr-rrr searchTyper"rrrpost) rserverr4rrZitemTyperr^rrr"rBs rC_createzCollection._creates%VW W'>2nn,,W5G ED%=9GE8== DyyH$ !VWW   c$..1 2 XXj) "##5j\BE$4$4X$>YZipititu$U^^D%9$:;||C(<(<|=a@64#..rEc t|ts|jj|}|xs |j}|j d||||d|} |j | } | tj||d|jd} dtj| } |j| |jjd} ||| | S) z Create a smart collection. rrrrrrrr)rr rrTYPErrrrr"rrrr)rrr4rrrrrrrrrr"rBs rC _createSmartzCollection._createSmarts'>2nn,,W5G)W\\+G++PweWPHNP "#I;/E$4$4W$=XYhohshst$U^^D%9$:;||C(<(<|=a@64#..rEc z|r&|r td|j||||||| fi| S|j||||S)av Create a collection. Parameters: server (:class:`~plexapi.server.PlexServer`): Server to create the collection on. title (str): Title of the collection. section (:class:`~plexapi.library.LibrarySection`, str): The library section to create the collection in. items (List): Regular collections only, list of :class:`~plexapi.audio.Audio`, :class:`~plexapi.video.Video`, or :class:`~plexapi.photo.Photo` objects to be added to the collection. smart (bool): True to create a smart collection. Default False. limit (int): Smart collections only, limit the number of items in the collection. libtype (str): Smart collections only, the specific type of content to filter (movie, show, season, episode, artist, album, track, photoalbum, photo). sort (str or list, optional): Smart collections only, a string of comma separated sort fields or a list of sort fields in the format ``column:dir``. See :func:`~plexapi.library.LibrarySection.search` for more info. filters (dict): Smart collections only, a dictionary of advanced filters. See :func:`~plexapi.library.LibrarySection.search` for more info. **kwargs (dict): Smart collections only, additional custom filters to apply to the search results. See :func:`~plexapi.library.LibrarySection.search` for more info. Raises: :class:`plexapi.exceptions.BadRequest`: When no items are included to create the collection. :class:`plexapi.exceptions.BadRequest`: When mixing media types in the collection. Returns: :class:`~plexapi.collection.Collection`: A new instance of the created Collection. z,Cannot create a smart collection with items.)r rr) rrr4rrZr.rrrrrs rCcreatezCollection.createsQ<  !OPP#3##FE7E7DRYd]cd d;;vugu= =rEc |jjs tdddlm} m} m} |jj} | |jd} |r|n |j| _ |j| _ |j| _ |j| _ |jj| _t|j d}d|| _| j%||| _|j(r| j+|| _nQ|j.r| j1|| _n.|j2r| j5|| _n t7d| j9| ||S) a! Add the collection as sync item for the specified device. See :func:`~plexapi.myplex.MyPlexAccount.sync` for possible exceptions. Parameters: videoQuality (int): idx of quality of the video, one of VIDEO_QUALITY_* values defined in :mod:`~plexapi.sync` module. Used only when collection contains video. photoResolution (str): maximum allowed resolution for synchronized photos, see PHOTO_QUALITY_* values in the module :mod:`~plexapi.sync`. Used only when collection contains photos. audioBitrate (int): maximum bitrate for synchronized music, better use one of MUSIC_BITRATE_* values from the module :mod:`~plexapi.sync`. Used only when collection contains audio. client (:class:`~plexapi.myplex.MyPlexDevice`): sync destination, see :func:`~plexapi.myplex.MyPlexAccount.sync`. clientId (str): sync destination, see :func:`~plexapi.myplex.MyPlexAccount.sync`. limit (int): maximum count of items to sync, unlimited if `None`. unwatched (bool): if `True` watched videos wouldn't be synced. title (str): descriptive title for the new :class:`~plexapi.sync.SyncItem`, if empty the value would be generated from metadata of current photo. Raises: :exc:`~plexapi.exceptions.BadRequest`: When collection is not allowed to sync. :exc:`~plexapi.exceptions.Unsupported`: When collection content is unsupported. Returns: :class:`~plexapi.sync.SyncItem`: A new instance of the created sync item. z%The collection is not allowed to syncr)SyncItemPolicy MediaSettingsNz/children?excludeAllLeaves=1zlibrary:///directory/zUnsupported collection content)clientclientId)r allowSyncr plexapi.syncrrrr myPlexAccountr4 rootTitlerr contentTyperumachineIdentifierrr"locationrpolicyro createVideo mediaSettingsrp createMusicrq createPhotor sync)rA videoQualityphotoResolution audioBitraterrr unwatchedr4rrrmyplex sync_itemr"s rCrzCollection.syncs56||~''DE E@@++-T\\40 #(%djj "jj  $ !%!2!2 &*ll&D&D #DHH:%ABC4SE: !== :  <<&3&?&? &MI # \\&3&?&? &MI # \\&3&?&?&PI #>? ?{{9Vh{GGrEctj|j}tt ddz |dz |dddz S)zL Returns the Plex Media Server data directory where the metadata is stored. Metadata CollectionsrrNz.bundle)rsha1hashr rr)rA guid_hashs rCmetadataDirectoryzCollection.metadataDirectory'sINN499- 4 #m3ilB RSRT V]E^^__rErG)NNNN)NFNNNN)NNNNNNFN).__name__ __module__ __qualname____doc__TAGrrDrrLrPrSrWr[r_rgrjpropertyrrrurorprqrrrrr^rrZrr;rrrrrrrr classmethodrrrrr  __classcell__)rs@rCrr s+X C D#KJ777777@@!=! < <FF<<770011 Q$$   B6585:<*.>)//4// KO04">">Hrv$(5Hn``rErN)pathlibr urllib.parserplexapirr plexapi.baserrplexapi.exceptionsr r r plexapi.libraryr r plexapi.mixinsrregisterPlexObjectrrrErCrsH# @@@6+_`'_`_`rE