g1 ddlmZddlZddlmZmZddlZddlmZddl m Z ddl m Z ddl m Z mZmZmZddlmZmZmZdd lmZmZdd lmZmZdd lmZmZmZmZm Z m!Z!m"Z"m#Z#m$Z$dd l%m&Z&dd l'm(Z(erddl)m*Z*GddeZ+GddeZ,Gdde,eZ-Gdde,eeeZ.Gdde,e e!e"Z/Gdde,e#e$Z0ejbGddeZ2ejbGddeZ3ejbGdd eZ4Gd!d"eZ5ejbGd#d$e5Z6ejbGd%d&e5Z7ejbGd'd(e5Z8ejbGd)d*e5Z9ejbGd+d,e5Z:ejbGd-d.e5Z;ejbGd/d0e5ZejbGd5d6e5Z?ejbGd7d8e5Z@ejbGd9d:e5ZAejbGd;de5ZCejbGd?d@e5ZDejbGdAdBe5ZEejbGdCdDe5ZFejbGdEdFe5ZGejbGdGdHe5ZHejbGdIdJe5ZIejbGdKdLe5ZJejbGdMdNe5ZKejbGdOdPe5ZLejbGdQdRe5ZMejbGdSdTe5ZNejbGdUdVe5ZOejbGdWdXe5ZPejbGdYdZe5ZQejbGd[d\e5ZRejbGd]d^e5ZSejbGd_d`e5ZTejbGdadbe5ZUejbGdcdde5ZVejbGdedfe5ZWGdgdheZXGdidjeZYGdkdleZZGdmdneZ[GdodpeZ\GdqdreZ]GdsdteZ^GdudveZ_GdwdxeZ`GdydzeZaejbGd{d|eZbejbGd}d~eZcejbGddeZdy)) annotationsN)Any TYPE_CHECKING) defaultdict)datetime)cached_property)parse_qs quote_plus urlencodeurlparse)logmediautils) OPERATORS PlexObject) BadRequestNotFound) MovieEditMixinsShowEditMixinsSeasonEditMixinsEpisodeEditMixinsArtistEditMixinsAlbumEditMixinsTrackEditMixinsPhotoalbumEditMixinsPhotoEditMixins)Setting) deprecated)TrackceZdZdZdZdZdZdZdZdZ dd Z d Z d Z d Z dd ZdZdZdZdZdZdZdZddZddZdZy)LibraryaE Represents a PlexServer library. This contains all sections of media defined in your Plex server including video, shows and audio. Attributes: key (str): '/library' identifier (str): Unknown ('com.plexapp.plugins.library'). mediaTagVersion (str): Unknown (/system/bundle/media/flags/) server (:class:`~plexapi.server.PlexServer`): PlexServer this client is connected to. title1 (str): 'Plex Library' (not sure how useful this is). title2 (str): Second title (this is blank on my setup). z/libraryc.||_|jjd|_|jjd|_|jjd|_|jjd|_i|_i|_y)N identifiermediaTagVersiontitle1title2) _dataattribgetr#r$r%r& _sectionsByID_sectionsByTitleselfdatas $/opt/Tautulli/lib/plexapi/library.py _loadDatazLibrary._loadData)sk ++//,7#{{/@Akkooh/ kkooh/  "cd}i}tt}tttt d}|j j|D]}|j|jjdt|j ||}|||j<||jjjj|||_t#||_y)z, Loads and caches all the library sections. z/library/sections)movieshowartistphototype)initpathN)rlist MovieSection ShowSection MusicSection PhotoSection_serverqueryr)r(LibrarySectionkeytitlelowerstripappendr*dictr+)r-rA sectionsByIDsectionsByTitlelibclselemsections r/ _loadSectionszLibrary._loadSections2s! %d+!"!  LL&&s+ KDIfjj!8.I$,,X\gjkG(/L % GMM//1779 : A A' J K * $_ 5r1ch|jt|jjS)a Returns a list of all media sections in this library. Library sections may be any of :class:`~plexapi.library.MovieSection`, :class:`~plexapi.library.ShowSection`, :class:`~plexapi.library.MusicSection`, :class:`~plexapi.library.PhotoSection`. )rLr9r*valuesr-s r/sectionszLibrary.sectionsFs* D&&--/00r1c:|jj}|jr||jvr|j |j|}t |dkDrtjd|dS#t$rt d|dwxYw)a Returns the :class:`~plexapi.library.LibrarySection` that matches the specified title. Note: Multiple library sections with the same title is ambiguous. Use :func:`~plexapi.library.Library.sectionByID` instead for an exact match. Parameters: title (str): Title of the section to return. Raises: :exc:`~plexapi.exceptions.NotFound`: The library section title is not found on the server. zInvalid library section: NzkMultiple library sections with the same title found, use "sectionByID" instead. Returning the last section.) rCrDr+rLKeyErrorrlenwarningswarn)r-rBnormalized_titlerPs r/rKzLibrary.sectionNs!;;=..0$$(8@U@U(U     J,,-=>H x=1  MM. | J6ug>?T I Js BBc|jr||jvr|j |j|S#t$rtd|dwxYw)a8 Returns the :class:`~plexapi.library.LibrarySection` that matches the specified sectionID. Parameters: sectionID (int): ID of the section to return. Raises: :exc:`~plexapi.exceptions.NotFound`: The library section ID is not found on the server. zInvalid library sectionID: N)r*rLrTr)r- sectionIDs r/ sectionByIDzLibrary.sectionByIDhsc!!Yd6H6H%H     P%%i0 0 P8 DE4 O Ps ;ANc |r5t|ts|g}djtt||d<|r't|ts|g}dj||d<dt j |}|j|S)a Returns a list of :class:`~plexapi.library.Hub` across all library sections. Parameters: sectionID (int or str or list, optional): IDs of the sections to limit results or "playlists". identifier (str or list, optional): Names of identifiers to limit results. Available on `Hub` instances as the `hubIdentifier` attribute. Examples: 'home.continue' or 'home.ondeck' ,contentDirectoryIDr#z/hubs) isinstancer9joinmapstrrjoinArgs fetchItems)r-rZr#kwargsrAs r/hubsz Library.hubsxs i.&K +.88CY4G+HF' ( j$/(\ #&88J#7F< ennV,-.s##r1c g}|jD]*}|jdi|D]}|j|,|S)zz Returns a list of all media from all library sections. This may be a very large dataset to retrieve. )rPallrE)r-reitemsrKitems r/riz Library.allsN}} #G# -f- # T" # # r1c$|jdS)z, Returns a list of all media items on deck. z/library/onDeckrdrOs r/onDeckzLibrary.onDecks011r1c$|jdS)z3 Returns a list of all media items recently added. z/library/recentlyAddedrmrOs r/ recentlyAddedzLibrary.recentlyAddeds788r1c i}|r||d<|rtj||d<|jD] \}}|||< dtj|}|j |S)a Searching within a library section is much more powerful. It seems certain attributes on the media objects can be targeted to filter this search down a bit, but I haven't found the documentation for it. Example: "studio=Comedy%20Central" or "year=1999" "title=Kung Fu" all work. Other items such as actor= seem to work, but require you already know the id of the actor. TLDR: This is untested but seems to work. Use library section search when you can. rBr7z /library/all)r searchTyperjrcrd)r-rBlibtypereargsattrvaluerAs r/searchzLibrary.searchss !DM  ++G4DL!<<> KD%DJ U^^D123s##r1c||jjd|jjj|S)a Poster images and other metadata for items in your library are kept in "bundle" packages. When you remove items from your library, these bundles aren't immediately removed. Removing these old bundles can reduce the size of your install. By default, your server will automatically clean up old bundles once a week as part of Scheduled Tasks. z/library/clean/bundles?async=1methodr>r?_sessionputrOs r/ cleanBundleszLibrary.cleanBundless1 ;DLLDYDYD]D]^ r1cP|jD]}|j|S)zR If a library has items in the Library Trash, use this option to empty the Trash. )rP emptyTrashr-rKs r/rzLibrary.emptyTrashs(}} !G     ! r1c||jjd|jjj|S)z The Optimize option cleans up the server database from unused or fragmented data. For example, if you have deleted or added an entire library or many items in a library, you may like to optimize the database. z/library/optimize?async=1ryr{rOs r/optimizezLibrary.optimizes1 6t||?T?T?X?XY r1c<|jjd|S)z! Scan this library for new items./library/sections/all/refreshr>r?rOs r/updatezLibrary.updates :; r1cd}|jj||jjj|S)z Cancel a library update. rry)r>r?r|deleter-rAs r/ cancelUpdatezLibrary.cancelUpdates3- 3t||'<'<'C'CD r1c<|jjd|S) Forces a download of fresh media information from the internet. This can take a long time. Any locked fields are not modified. z%/library/sections/all/refresh?force=1rrOs r/refreshzLibrary.refreshs BC r1cP|jD]}|j|S)z Delete the preview thumbnails for the all sections. This cannot be undone. Recreating media preview files can take hours or even days. )rPdeleteMediaPreviewsrs r/rzLibrary.deleteMediaPreviewss*}} *G  ' ' ) * r1c t|tr|g}g} |D]?} |jj| st d| d| j d| fAdt |d|d|dt |d|d t| d  } |r8|jD cic] \} } d | d | }} } | d t|z } |jj| |jjjScc} } w)a, Simplified add for the most common options. Parameters: name (str): Name of the library agent (str): Example com.plexapp.agents.imdb type (str): movie, show, # check me location (str or list): /path/to/files, ["/path/to/files", "/path/to/morefiles"] language (str): Four letter language code (e.g. en-US) kwargs (dict): Advanced options should be passed as a dict. where the id is the key. **Photo Preferences** * **agent** (str): com.plexapp.agents.none * **enableAutoPhotoTags** (bool): Tag photos. Default value false. * **enableBIFGeneration** (bool): Enable video preview thumbnails. Default value true. * **includeInGlobal** (bool): Include in dashboard. Default value true. * **scanner** (str): Plex Photo Scanner **Movie Preferences** * **agent** (str): com.plexapp.agents.none, com.plexapp.agents.imdb, tv.plex.agents.movie, com.plexapp.agents.themoviedb * **enableBIFGeneration** (bool): Enable video preview thumbnails. Default value true. * **enableCinemaTrailers** (bool): Enable Cinema Trailers. Default value true. * **includeInGlobal** (bool): Include in dashboard. Default value true. * **scanner** (str): Plex Movie, Plex Movie Scanner, Plex Video Files Scanner, Plex Video Files **IMDB Movie Options** (com.plexapp.agents.imdb) * **title** (bool): Localized titles. Default value false. * **extras** (bool): Find trailers and extras automatically (Plex Pass required). Default value true. * **only_trailers** (bool): Skip extras which aren't trailers. Default value false. * **redband** (bool): Use red band (restricted audiences) trailers when available. Default value false. * **native_subs** (bool): Include extras with subtitles in Library language. Default value false. * **cast_list** (int): Cast List Source: Default value 1 Possible options: 0:IMDb,1:The Movie Database. * **ratings** (int): Ratings Source, Default value 0 Possible options: 0:Rotten Tomatoes, 1:IMDb, 2:The Movie Database. * **summary** (int): Plot Summary Source: Default value 1 Possible options: 0:IMDb,1:The Movie Database. * **country** (int): Default value 46 Possible options 0:Argentina, 1:Australia, 2:Austria, 3:Belgium, 4:Belize, 5:Bolivia, 6:Brazil, 7:Canada, 8:Chile, 9:Colombia, 10:Costa Rica, 11:Czech Republic, 12:Denmark, 13:Dominican Republic, 14:Ecuador, 15:El Salvador, 16:France, 17:Germany, 18:Guatemala, 19:Honduras, 20:Hong Kong SAR, 21:Ireland, 22:Italy, 23:Jamaica, 24:Korea, 25:Liechtenstein, 26:Luxembourg, 27:Mexico, 28:Netherlands, 29:New Zealand, 30:Nicaragua, 31:Panama, 32:Paraguay, 33:Peru, 34:Portugal, 35:Peoples Republic of China, 36:Puerto Rico, 37:Russia, 38:Singapore, 39:South Africa, 40:Spain, 41:Sweden, 42:Switzerland, 43:Taiwan, 44:Trinidad, 45:United Kingdom, 46:United States, 47:Uruguay, 48:Venezuela. * **collections** (bool): Use collection info from The Movie Database. Default value false. * **localart** (bool): Prefer artwork based on library language. Default value true. * **adult** (bool): Include adult content. Default value false. * **usage** (bool): Send anonymous usage data to Plex. Default value true. **TheMovieDB Movie Options** (com.plexapp.agents.themoviedb) * **collections** (bool): Use collection info from The Movie Database. Default value false. * **localart** (bool): Prefer artwork based on library language. Default value true. * **adult** (bool): Include adult content. Default value false. * **country** (int): Country (used for release date and content rating). Default value 47 Possible options 0:, 1:Argentina, 2:Australia, 3:Austria, 4:Belgium, 5:Belize, 6:Bolivia, 7:Brazil, 8:Canada, 9:Chile, 10:Colombia, 11:Costa Rica, 12:Czech Republic, 13:Denmark, 14:Dominican Republic, 15:Ecuador, 16:El Salvador, 17:France, 18:Germany, 19:Guatemala, 20:Honduras, 21:Hong Kong SAR, 22:Ireland, 23:Italy, 24:Jamaica, 25:Korea, 26:Liechtenstein, 27:Luxembourg, 28:Mexico, 29:Netherlands, 30:New Zealand, 31:Nicaragua, 32:Panama, 33:Paraguay, 34:Peru, 35:Portugal, 36:Peoples Republic of China, 37:Puerto Rico, 38:Russia, 39:Singapore, 40:South Africa, 41:Spain, 42:Sweden, 43:Switzerland, 44:Taiwan, 45:Trinidad, 46:United Kingdom, 47:United States, 48:Uruguay, 49:Venezuela. **Show Preferences** * **agent** (str): com.plexapp.agents.none, com.plexapp.agents.thetvdb, com.plexapp.agents.themoviedb, tv.plex.agents.series * **enableBIFGeneration** (bool): Enable video preview thumbnails. Default value true. * **episodeSort** (int): Episode order. Default -1 Possible options: 0:Oldest first, 1:Newest first. * **flattenSeasons** (int): Seasons. Default value 0 Possible options: 0:Show,1:Hide. * **includeInGlobal** (bool): Include in dashboard. Default value true. * **scanner** (str): Plex TV Series, Plex Series Scanner **TheTVDB Show Options** (com.plexapp.agents.thetvdb) * **extras** (bool): Find trailers and extras automatically (Plex Pass required). Default value true. * **native_subs** (bool): Include extras with subtitles in Library language. Default value false. **TheMovieDB Show Options** (com.plexapp.agents.themoviedb) * **collections** (bool): Use collection info from The Movie Database. Default value false. * **localart** (bool): Prefer artwork based on library language. Default value true. * **adult** (bool): Include adult content. Default value false. * **country** (int): Country (used for release date and content rating). Default value 47 options 0:, 1:Argentina, 2:Australia, 3:Austria, 4:Belgium, 5:Belize, 6:Bolivia, 7:Brazil, 8:Canada, 9:Chile, 10:Colombia, 11:Costa Rica, 12:Czech Republic, 13:Denmark, 14:Dominican Republic, 15:Ecuador, 16:El Salvador, 17:France, 18:Germany, 19:Guatemala, 20:Honduras, 21:Hong Kong SAR, 22:Ireland, 23:Italy, 24:Jamaica, 25:Korea, 26:Liechtenstein, 27:Luxembourg, 28:Mexico, 29:Netherlands, 30:New Zealand, 31:Nicaragua, 32:Panama, 33:Paraguay, 34:Peru, 35:Portugal, 36:Peoples Republic of China, 37:Puerto Rico, 38:Russia, 39:Singapore, 40:South Africa, 41:Spain, 42:Sweden, 43:Switzerland, 44:Taiwan, 45:Trinidad, 46:United Kingdom, 47:United States, 48:Uruguay, 49:Venezuela. **Other Video Preferences** * **agent** (str): com.plexapp.agents.none, com.plexapp.agents.imdb, com.plexapp.agents.themoviedb * **enableBIFGeneration** (bool): Enable video preview thumbnails. Default value true. * **enableCinemaTrailers** (bool): Enable Cinema Trailers. Default value true. * **includeInGlobal** (bool): Include in dashboard. Default value true. * **scanner** (str): Plex Movie Scanner, Plex Video Files Scanner **IMDB Other Video Options** (com.plexapp.agents.imdb) * **title** (bool): Localized titles. Default value false. * **extras** (bool): Find trailers and extras automatically (Plex Pass required). Default value true. * **only_trailers** (bool): Skip extras which aren't trailers. Default value false. * **redband** (bool): Use red band (restricted audiences) trailers when available. Default value false. * **native_subs** (bool): Include extras with subtitles in Library language. Default value false. * **cast_list** (int): Cast List Source: Default value 1 Possible options: 0:IMDb,1:The Movie Database. * **ratings** (int): Ratings Source Default value 0 Possible options: 0:Rotten Tomatoes,1:IMDb,2:The Movie Database. * **summary** (int): Plot Summary Source: Default value 1 Possible options: 0:IMDb,1:The Movie Database. * **country** (int): Country: Default value 46 Possible options: 0:Argentina, 1:Australia, 2:Austria, 3:Belgium, 4:Belize, 5:Bolivia, 6:Brazil, 7:Canada, 8:Chile, 9:Colombia, 10:Costa Rica, 11:Czech Republic, 12:Denmark, 13:Dominican Republic, 14:Ecuador, 15:El Salvador, 16:France, 17:Germany, 18:Guatemala, 19:Honduras, 20:Hong Kong SAR, 21:Ireland, 22:Italy, 23:Jamaica, 24:Korea, 25:Liechtenstein, 26:Luxembourg, 27:Mexico, 28:Netherlands, 29:New Zealand, 30:Nicaragua, 31:Panama, 32:Paraguay, 33:Peru, 34:Portugal, 35:Peoples Republic of China, 36:Puerto Rico, 37:Russia, 38:Singapore, 39:South Africa, 40:Spain, 41:Sweden, 42:Switzerland, 43:Taiwan, 44:Trinidad, 45:United Kingdom, 46:United States, 47:Uruguay, 48:Venezuela. * **collections** (bool): Use collection info from The Movie Database. Default value false. * **localart** (bool): Prefer artwork based on library language. Default value true. * **adult** (bool): Include adult content. Default value false. * **usage** (bool): Send anonymous usage data to Plex. Default value true. **TheMovieDB Other Video Options** (com.plexapp.agents.themoviedb) * **collections** (bool): Use collection info from The Movie Database. Default value false. * **localart** (bool): Prefer artwork based on library language. Default value true. * **adult** (bool): Include adult content. Default value false. * **country** (int): Country (used for release date and content rating). Default value 47 Possible options 0:, 1:Argentina, 2:Australia, 3:Austria, 4:Belgium, 5:Belize, 6:Bolivia, 7:Brazil, 8:Canada, 9:Chile, 10:Colombia, 11:Costa Rica, 12:Czech Republic, 13:Denmark, 14:Dominican Republic, 15:Ecuador, 16:El Salvador, 17:France, 18:Germany, 19:Guatemala, 20:Honduras, 21:Hong Kong SAR, 22:Ireland, 23:Italy, 24:Jamaica, 25:Korea, 26:Liechtenstein, 27:Luxembourg, 28:Mexico, 29:Netherlands, 30:New Zealand, 31:Nicaragua, 32:Panama, 33:Paraguay, 34:Peru, 35:Portugal, 36:Peoples Republic of China, 37:Puerto Rico, 38:Russia, 39:Singapore, 40:South Africa, 41:Spain, 42:Sweden, 43:Switzerland, 44:Taiwan, 45:Trinidad, 46:United Kingdom, 47:United States, 48:Uruguay, 49:Venezuela. Path:  does not exist.locationz/library/sections?name=z&type=z&agent=z &scanner=z &language=&Tdoseqzprefs[]ry) r_rbr> isBrowsablerrEr r rjr?r|post)r-namer7agentscannerrlanguagertre locationspathpartkv prefs_paramss r/addz Library.addsd h $ zH  1D<<++D1 6$/?!@AA   j$/ 0 1 **T*:);6$wugJw/0 8*AiPYaeFfEgi 9?HAfQCqM1,HLH a ,/01 1D||!!$t||/D/D/I/I!JJIs Dcxg}|jD]$}|j|j||&|S)z Get Play History for all library Sections for the owner. Parameters: maxresults (int): Only return the specified number of results (optional). mindate (datetime): Min datetime to return results from. ) maxresultsmindate)rPextendhistory)r-rrhistrKs r/rzLibrary.historys> }} QG KK:wO P Q r1ctj|}|jjd|}|j |S)z Returns a list of :class:`~plexapi.library.LibraryMediaTag` objects for the specified tag. Parameters: tag (str): Tag name (see :data:`~plexapi.utils.TAGTYPES`). z/library/tags?type=)rtagTyper>r? findItems)r-tagrr.s r/tagsz Library.tagss= --$||!!$7y"AB~~d##r1NN)rrrrzen-US)__name__ __module__ __qualname____doc__rAr0rLrPrKr[rfrirnrprwr~rrrrrrrrrrhr1r/r!r!sv  C#6(14P $,29$&   _KB $r1r!cteZdZdZdZedZedZedZ fdZ dZ dPdZ d Z d ZdQd Zd Zd ZdZdZdQdZdZdZdZdZdZdZdZdZdPdZdQdZdQdZdZ dZ!dZ"dRdZ#d Z$d!Z%d"Z&dQd#Z'd$Z(d%Z)d&Z*d'Z+d(Z,dQd)Z-d*Z.d+Z/dQd,Z0dQd-Z1dQd.Z2d/Z3dQd0Z4dQd1Z5d2Z6dQd3Z7d4Z8d5Z9dQd6Z:dQd7Z;d8Z dUd;Z?d<Z@dVd=ZAdTd>ZB dWd?ZCd@ZDdAZE dWdBZFdCZGdQdDZHeIdEdQdFZJeIdGdQdHZKdXdIZLdJZMdKZNdQdLZOdMZPdNZQdOZRxZSS)Yr@a~ Base class for a single library section. Attributes: agent (str): The metadata agent used for the library section (com.plexapp.agents.imdb, etc). allowSync (bool): True if you allow syncing content from the library section. art (str): Background artwork used to respresent the library section. composite (str): Composite image used to represent the library section. createdAt (datetime): Datetime the library section was created. filters (bool): True if filters are available for the library section. key (int): Key (or ID) of this library section. language (str): Language represented in this section (en, xn, etc). locations (List): List of folder paths added to the library section. refreshing (bool): True if this section is currently being refreshed. scanner (str): Internal scanner used to find media (Plex Movie Scanner, Plex Premium Music Scanner, etc.) thumb (str): Thumbnail image used to represent the library section. title (str): Name of the library section. type (str): Type of content section represents (movie, show, artist, photo). updatedAt (datetime): Datetime the library section was last updated. uuid (str): Unique id for the section (32258d7c-3e6c-4ac5-98ad-bad7a3b78c63) cV||_|jjd|_t j t |jjd|_|jjd|_|jjd|_ t j|jjd|_ t j t |jjd|_ t j t|jjd|_|jjd|_|j!|d d |_t j t |jjd |_|jjd |_|jjd|_|jjd|_|jjd|_t j|jjd|_|jjd|_d|_d|_d|_d|_d|_y)Nr allowSyncart composite createdAtfiltersrArrLocation)etag refreshingrthumbrBr7 updatedAtuuid)r'r(r)rrcastboolrrr toDatetimerrintrAr listAttrsrrrrrBr7rr _filterTypes _fieldTypes_totalViewSize_totalDuration _totalStorager,s r/r0zLibrarySection._loadDatas [[__W- D$++//+*FG;;??5)5))$++//+*FGzz$  (BC ::c4;;??5#9:  3 f:F**T4;;??<+HI{{y1 [[__W- [[__W- KKOOF+ ))$++//+*FGKKOOF+  ""!r1c&|jdS)zP Returns the total number of items in the library for the default library type. F)includeCollections) totalViewSizerOs r/ totalSizezLibrarySection.totalSizes!!U!;;r1cR|j|j|jS)zG Returns the total duration (in milliseconds) of items in the library. )r_getTotalDurationStoragerOs r/ totalDurationzLibrarySection.totalDurations(    &  ) ) +"""r1cR|j|j|jS)z? Returns the total storage (in bytes) of items in the library. )rrrOs r/ totalStoragezLibrarySection.totalStorages(    %  ) ) +!!!r1clt||}|jdr|St|rd|jvrwt |j ts tdt|j dd|s6td|j ddjjd|d|S) N_Mixinz/Must enable batchMultiEdit() to use this methodrjrzBatch multi-editing 'z' object has no attribute '') super__getattribute__ startswithcallablerr__editsrFAttributeErrorhasattr __class__r)r-rurvrs r/rzLibrarySection.__getattribute__s(. ??3  E?w%*<*<<dkk40$%VWWT[[1!4d;$+DKK,@,C,M,M,V,V+WWrswrxxyz r1c|jjd}d|jd}tt |j |d}|rqt jt|jjd|_ t jt|jjd|_ yy)z[ Queries the Plex server for the total library duration and storage and caches the values. z!/media/providers?includeStorage=1zc./MediaProvider[@identifier="com.plexapp.plugins.library"]/Feature[@type="content"]/Directory[@id="z"]N durationTotal storageTotal) r>r?rAnextiterfindallrrrr(r)rr)r-r.xpath directorys r/rz'LibrarySection._getTotalDurationStorages||!!"EF #xxj ,  dll512D9 "'**S)2B2B2F2F2W"XD !&C1A1A1E1En1U!VD  r1cbtt|ddd}|#|dk(rd|d<ntj||d<d|jdtj |}|j j|}tjt|jjd S) a Returns the total number of items in the library for a specified libtype. The number of items for the default library type will be returned if no libtype is specified. (e.g. Specify ``libtype='episode'`` for the total number of episodes or ``libtype='albums'`` for the total number of albums.) Parameters: libtype (str, optional): The type of items to return the total number for (movie, show, season, episode, artist, album, track, photoalbum). Default is the main library type. includeCollections (bool, optional): True or False to include collections in the total number. Default is True. r)rzX-Plex-Container-StartzX-Plex-Container-Sizer6rRclusterZoomLevelr7/library/sections//allr) rrrrrrArcr>r?rr(r))r-rsrrtrr.s r/rzLibrarySection.totalViewSizes#&d+=&>"?&'%&   '!+,'($//8V #DHH:T%..2F1GH||!!$'zz#t{{{;<r?rAr|rrr error)r-msgs r/rzLibrarySection.deletesu <<%%(:488*&EdllNcNcNjNj%k k -dhhZ8C Q QC IIcN   s AA 4A>c|jjj|jjj|j}|j j |j |S)z* Reload the data for the library section. )r>libraryrLr[rA__dict__r)r- newLibrarys r/reloadzLibrarySection.reloadsS **,\\))55dhh?  Z001 r1c |s |j}g}|jdrot|dtr |dg|d<|j dD]?}|j j |std|d|jd|fAt|j|z}d|jd|dt|d}|j j||j jj |S) z Edit a library. See :class:`~plexapi.library.Library` for example usage. Parameters: agent (str, optional): The library agent. kwargs (dict): Dict of settings to edit. rrrrz?agent=rTrry)rr)r_rbpopr>rrrEr9rjrAr r?r|r})r-rrerrparamsrs r/editzLibrarySection.edit$sJJE ::j !&,c2&,Z&8%9z" :. 5||//5$vdV3C%DEE  *d!34 5 flln% 1#DHH:WUG1YvUY=Z<[\ 4 (=(=(A(AB r1c|j}t|tr|g}|D]=}|jj |st d|d|j |?|j|S)aY Add a location to a library. Parameters: location (str or list): A single folder path, list of paths. Example: .. code-block:: python LibrarySection.addLocations('/path/1') LibrarySection.addLocations(['/path/1', 'path/2', '/path/3']) rrr)rr_rbr>rrrErr-rrrs r/ addLocationszLibrarySection.addLocations=suNN h $ zH #D<<++D1 6$/?!@AA   T " #yy)y,,r1c|j}t|tr|g}|D]&}||vr|j|t d|dt |dk(r t d|j |S)ad Remove a location from a library. Parameters: location (str or list): A single folder path, list of paths. Example: .. code-block:: python LibrarySection.removeLocations('/path/1') LibrarySection.removeLocations(['/path/1', 'path/2', '/path/3']) rz does not exist in the library.rz6You are unable to remove all locations from a library.r)rr_rbremoverrUrrs r/removeLocationszLibrarySection.removeLocationsTsNN h $ zH UDy   & 6(3R!STT  U y>Q UV Vyy)y,,r1c  |j|fddi|dS#t$rd|d}|r|d|z }t|dwxYw)a Returns the media item with the specified title and kwargs. Parameters: title (str): Title of the item to return. kwargs (dict): Additional search parameters. See :func:`~plexapi.library.LibrarySection.search` for more info. Raises: :exc:`~plexapi.exceptions.NotFound`: The title is not found in the library. limitrRrz Unable to find item with title 'rz and kwargs N)rw IndexErrorr)r-rBrers r/r)zLibrarySection.getnsd *4;;u8A88; ; *4UG1=CfX..3-T )  *s &AcV |jdr|j|d}|S|jdd}|j|j|j dd}|j|dj dS#t $rtd |d d wxYw) a Returns the media item with the specified external Plex, IMDB, TMDB, or TVDB ID. Note: Only available for the Plex Movie and Plex TV Series agents. Parameters: guid (str): The external guid of the item to return. Examples: Plex ``plex://show/5d9c086c46115600200aa2fe`` IMDB ``imdb://tt0944947``, TMDB ``tmdb://1399``, TVDB ``tvdb://121361``. Raises: :exc:`~plexapi.exceptions.NotFound`: The guid is not found in the library. Example: .. code-block:: python result1 = library.getGuid('plex://show/5d9c086c46115600200aa2fe') result2 = library.getGuid('imdb://tt0944947') result3 = library.getGuid('tmdb://1399') result4 = library.getGuid('tvdb://121361') # Alternatively, create your own guid lookup dictionary for faster performance guidLookup = {} for item in library.all(): guidLookup[item.guid] = item guidLookup.update({guid.id: item for guid in item.guids}) result1 = guidLookup['plex://show/5d9c086c46115600200aa2fe'] result2 = guidLookup['imdb://tt0944947'] result3 = guidLookup['tmdb://1399'] result4 = guidLookup['tvdb://121361'] zplex://)guidrrR)rz://-)rrBzGuid 'z' is not found in the libraryN)rrwmatchesrreplacerrr)r-rresultdummymatchs r/getGuidzLibrarySection.getGuidsD Sy)$/2  q 1!4 DJJdll5RU>V W{{a {6q99 SVD6)FGHd R Ss'BA#BB(c J|xs |j}|jdd|i|S)z Returns a list of all items from this library section. See description of :func:`~plexapi.library.LibrarySection.search()` for details about filtering / sorting. rsrhTYPErwr-rsres r/rizLibrarySection.alls+&TYYt{{575f55r1cNd|jd}|j|tS)z` Returns a list of available :class:`~plexapi.library.Folder` for this library section. rz/folder)rArdFolderrs r/folderszLibrarySection.folderss'#488*G4sF++r1cNd|jd}|j|tS)zd Returns a list of available :class:`~plexapi.library.ManagedHub` for this library section. /hubs/sections//manage)rArd ManagedHubrs r/ managedHubszLibrarySection.managedHubss' z1sJ//r1cd|jd}|jj||jjjy)zH Reset the managed hub customizations for this library section. rrryNrAr>r?r|rrs r/resetManagedHubszLibrarySection.resetManagedHubss= z1 3t||'<'<'C'CDr1cDd|jd}|j|S)z] Returns a list of available :class:`~plexapi.library.Hub` for this library section. rz?includeStations=1rArdrs r/rfzLibrarySection.hubss& z);<s##r1cL|jj|jS)z] Returns a list of available :class:`~plexapi.media.Agent` for this library section. )r>agentsr7rOs r/r zLibrarySection.agentss||""499--r1cd|jd}|jj|}|j|tS)z) Returns a list of all library settings. rz/prefscls)rAr>r?rrr-rAr.s r/settingszLibrarySection.settingss;"488*F3||!!#&~~d~00r1c i}i}d}|jD]=}|jdk7r|j||j<,ddd||j<?|j D]3\}} ||}||vr|||j|<%t |d||jdi|S#t $r(t |dt|jwxYw)z% Edit a library's advanced settings. prefs[{}]rFT)rrRz not found in rh) r%r7 enumValuesidrjrTrr9keysformatr) r-rer.idEnumsrAsetting settingIDrvenumss r/ editAdvancedzLibrarySection.editAdvanceds}} :G||v%&-&8&8 #*/D&9 #  : !'  @ Iu O *~.3SZZ *+%ug>?? @tyy 4   O%tGLLN7K6LMNN Os .B//1C c*i}d}|jD]k}|jdk(r2t|j||j |j <D|j||j |j <m|j di|S)z5 Edit all of library's advanced settings to default. r'rrh)r%r7rdefaultr+r)r)r-r.rAr-s r/defaultAdvancedzLibrarySection.defaultAdvanceds~}} ?G||v%/27??/CSZZ +,/6SZZ +,  ? tyy 4  r1c0|xs |j}dtj||dt|i}d|jdtj |}|j j||j jj|S)z6 Lock or unlock a field for all items in the library. r7z.lockedrrry) rrrrrrArcr>r?r|r})r-fieldrslockedrtrAs r/_lockUnlockAllFieldz"LibrarySection._lockUnlockAllFields&TYY E$$W-gW s6{ #488*D1E0FG 3t||'<'<'@'@A r1c*|j||dS)a_ Lock a field for all items in the library. Parameters: field (str): The field to lock (e.g. thumb, rating, collection). libtype (str, optional): The library type to lock (movie, show, season, episode, artist, album, track, photoalbum, photo). Default is the main library type. Trsr6r7r-r5rss r/ lockAllFieldzLibrarySection.lockAllFields''wt'LLr1c*|j||dS)ac Unlock a field for all items in the library. Parameters: field (str): The field to unlock (e.g. thumb, rating, collection). libtype (str, optional): The library type to lock (movie, show, season, episode, artist, album, track, photoalbum, photo). Default is the main library type. Fr9r:r;s r/unlockAllFieldzLibrarySection.unlockAllFields''wu'MMr1cpd|jd}|jj|}t||S)z4 Returns a timeline query for this library section. rz /timeline)rAr>r?LibraryTimeliner$s r/timelinezLibrarySection.timelines5"488*I6||!!#&tT**r1cDd|jd}|j|S)zB Returns a list of media items on deck from this library section. rz/onDeckrrs r/rnzLibrarySection.onDeck!#"488*G4s##r1cDd|jd}|j|S)zF Return a list of media items in the library's Continue Watching hub. rz/continueWatching/itemsrrs r/continueWatchingzLibrarySection.continueWatching&s$z)@As##r1cJ|xs |j}|jd||S)a{ Returns a list of media items recently added from this library section. Parameters: maxresults (int): Max number of items to return (default 50). libtype (str, optional): The library type to filter (movie, show, season, episode, artist, album, track, photoalbum, photo). Default is the main library type. addedAt:desc)sortrrsr)r-rrss r/rpzLibrarySection.recentlyAdded+s'&TYY{{:w{WWr1cPd|jd}|j|tS)Nrz/firstCharacterr")rArdFirstCharacterrs r/firstCharacterzLibrarySection.firstCharacter6s'"488*O<s77r1cd|jd}|jj||jjj|S)z Run an analysis on all of the items in this library section. See See :func:`~plexapi.base.PlexPartialObject.analyze` for more details. rz/analyzeryrAr>r?r|r}rs r/analyzezLibrarySection.analyze:sB#488*H5 3t||'<'<'@'@A r1cd|jd}|jj||jjj|S)zJ If a section has items in the Trash, use this option to empty the Trash. rz /emptyTrashryrMrs r/rzLibrarySection.emptyTrashBs@"488*K8 3t||'<'<'@'@A r1cd|jd}||dt|z }|jj||S)z Scan this section for new media. Parameters: path (str, optional): Full path to folder to scan. r/refreshz?path=)rAr r>r?)r-rrAs r/rzLibrarySection.updateHsJ #488*H5   VJt,-. .C 3 r1cd|jd}|jj||jjj|S)z( Cancel update of this Library Section. rrQryrrs r/rzLibrarySection.cancelUpdateTs@"488*H5 3t||'<'<'C'CD r1c\d|jd}|jj||S)rrz/refresh?force=1)rAr>r?rs r/rzLibrarySection.refreshZs.#488*,<= 3 r1cd|jd}|jj||jjj|S)z Delete the preview thumbnails for items in this library. This cannot be undone. Recreating media preview files can take hours or even days. rz/indexesryrrs r/rz"LibrarySection.deleteMediaPreviewsbsB#488*H5 3t||'<'<'C'CD r1c>d}|j|jd}|jj|}|j |t d|_|j |td|_|jdk7ri|j|jd}|jj|}|j j|j |t dd}|jj|j|ty ) z Retrieves and caches the list of :class:`~plexapi.library.FilteringType` and list of :class:`~plexapi.library.FilteringFieldType` for this library section. zq/library/sections/{key}/{filter}?includeMeta=1&includeAdvanced=1&X-Plex-Container-Start=0&X-Plex-Container-Size=0ri)rAfilterMeta)rtagr6 collectionszAN) r+rAr>r?r FilteringTyperFilteringFieldTyperrrrE_manuallyLoadXML)r-_keyrAr. guidFieldTypes r/ _loadFilterszLibrarySection._loadFiltersjsDkkdhhuk5||!!#& NN4VNL>>$0B>P 99 ++$((=+AC<<%%c*D    $ $T^^D-f^%U V\   5 5mEW XYr1cR|j|j|jS)z_ Returns a list of available :class:`~plexapi.library.FilteringType` for this library section. )rr_rOs r/ filterTypeszLibrarySection.filterTypess&    $       r1cxs |j tfd|jDS#t$r@|jDcgc]}|jncc}w}}t dd|dwxYw)a Returns a :class:`~plexapi.library.FilteringType` for a specified libtype. Parameters: libtype (str, optional): The library type to filter (movie, show, season, episode, artist, album, track, photoalbum, photo, collection). Raises: :exc:`~plexapi.exceptions.NotFound`: Unknown libtype for this library. c3BK|]}|jk(s|ywNr7).0frss r/ z/LibrarySection.getFilterType..sKa79JKzUnknown libtype "z(" for this library. Available libtypes: N)rrra StopIterationr7r)r-rsrgavailableLibtypess ` r/ getFilterTypezLibrarySection.getFilterTypes&TYY QK4#3#3#5KK K Q151A1A1C DA D D  D.wi822C1DFGLP Q Qs!5A>A$#A>cR|j|j|jS)zd Returns a list of available :class:`~plexapi.library.FilteringFieldType` for this library section. )rr_rOs r/ fieldTypeszLibrarySection.fieldTypess&    #    r1c tfd|jDS#t$r@|jDcgc]}|jncc}w}}t dd|dwxYw)a Returns a :class:`~plexapi.library.FilteringFieldType` for a specified fieldType. Parameters: fieldType (str): The data type for the field (tag, integer, string, boolean, date, subtitleLanguage, audioLanguage, resolution). Raises: :exc:`~plexapi.exceptions.NotFound`: Unknown fieldType for this library. c3BK|]}|jk(s|ywrdre)rfrg fieldTypes r/rhz.LibrarySection.getFieldType..sLa)8KLrizUnknown field type "z+" for this library. Available field types: N)rrnrjr7r)r-rqrgavailableFieldTypess ` r/ getFieldTypezLibrarySection.getFieldTypes~ VL4??#4LL L V37??3D"Ea166"E"E "E1)=55H4IKLQU V Vs!%A.AA.c8|j|jS)a Returns a list of available :class:`~plexapi.library.FilteringFilter` for a specified libtype. This is the list of options in the filter dropdown menu (`screenshot <../_static/images/LibrarySection.listFilters.png>`__). Parameters: libtype (str, optional): The library type to filter (movie, show, season, episode, artist, album, track, photoalbum, photo, collection). Example: .. code-block:: python availableFilters = [f.filter for f in library.listFilters()] print("Available filter fields:", availableFilters) )rlrr-rss r/ listFilterszLibrarySection.listFilterss"!!'*222r1c8|j|jS)a Returns a list of available :class:`~plexapi.library.FilteringSort` for a specified libtype. This is the list of options in the sorting dropdown menu (`screenshot <../_static/images/LibrarySection.listSorts.png>`__). Parameters: libtype (str, optional): The library type to filter (movie, show, season, episode, artist, album, track, photoalbum, photo, collection). Example: .. code-block:: python availableSorts = [f.key for f in library.listSorts()] print("Available sort fields:", availableSorts) )rlsortsrus r/ listSortszLibrarySection.listSortss"!!'*000r1c8|j|jS)a Returns a list of available :class:`~plexapi.library.FilteringFields` for a specified libtype. This is the list of options in the custom filter dropdown menu (`screenshot <../_static/images/LibrarySection.search.png>`__). Parameters: libtype (str, optional): The library type to filter (movie, show, season, episode, artist, album, track, photoalbum, photo, collection). Example: .. code-block:: python availableFields = [f.key.split('.')[-1] for f in library.listFields()] print("Available fields:", availableFields) )rlfieldsrus r/ listFieldszLibrarySection.listFieldss"!!'*111r1c8|j|jS)ap Returns a list of available :class:`~plexapi.library.FilteringOperator` for a specified fieldType. This is the list of options in the custom filter operator dropdown menu (`screenshot <../_static/images/LibrarySection.search.png>`__). Parameters: fieldType (str): The data type for the field (tag, integer, string, boolean, date, subtitleLanguage, audioLanguage, resolution). Example: .. code-block:: python field = 'genre' # Available filter field from listFields() filterField = next(f for f in library.listFields() if f.key.endswith(field)) availableOperators = [o.key for o in library.listOperators(filterField.type)] print(f"Available operators for {field}:", availableOperators) )rs operators)r-rqs r/ listOperatorszLibrarySection.listOperatorss&  +555r1c ttrqtjd}|st d|j \}|xs|xs |j } tfd|j|D|jjj}|j|t S#t$rD|j|Dcgc]}|jncc}w}}tdd|d|dwxYw)a Returns a list of available :class:`~plexapi.library.FilterChoice` for a specified :class:`~plexapi.library.FilteringFilter` or filter field. This is the list of available values for a custom filter (`screenshot <../_static/images/LibrarySection.search.png>`__). Parameters: field (str): :class:`~plexapi.library.FilteringFilter` object, or the name of the field (genre, year, contentRating, etc.). libtype (str, optional): The library type to filter (movie, show, season, episode, artist, album, track, photoalbum, photo, collection). Raises: :exc:`~plexapi.exceptions.BadRequest`: Invalid filter field. :exc:`~plexapi.exceptions.NotFound`: Unknown filter field. Example: .. code-block:: python field = 'genre' # Available filter field from listFilters() availableChoices = [f.title for f in library.listFilterChoices(field)] print(f"Available choices for {field}:", availableChoices) z(?:([a-zA-Z]*)\.)?([a-zA-Z]+)Invalid filter field: c3BK|]}|jk(s|ywrd)rVrfrgr5s r/rhz3LibrarySection.listFilterChoices..sW1QXXQVEVQWriUnknown filter field "" for libtype "z". Available filters: N)r_rbrer rgroupsrrrvrjrVrr>r?rAr FilterChoice)r-r5rsr _libtypergavailableFiltersr.s ` r/listFilterChoicesz LibrarySection.listFilterChoicess2 eS !HH=uEE #9%!ABB#llnOHe6'6TYYG SW(8(8(AWW ||!!%)),~~dL11 ! S6:6F6Fw6O#PAHH#P#P #P!7wogYW55E4F HINRS Ss #B>>D C.-D c tjd}|std|j\}}|xs|xs |j} t fd|j |D}|j|j||}|j|||} |d k(r| i} t!| d S|dd zd j#| i} t!| S#t$rt|jD]5}|j|k7st fd|jDd}|s5nD|j |D cgc]} | jncc} w} } tdd|d| dY wxYw)z Validates a filter field and values are available as a custom filter for the library. Returns the validated field and values as a URL encoded parameter string. z'(?:([a-zA-Z]*)\.)?([a-zA-Z]+)([!<>=&]*)rc3fK|](}|jjddk(s%|*yw.rSNrAsplitrs r/rhz6LibrarySection._validateFilterField..0s-dQaeekkRUFVWYFZ^cFcqd&11c3fK|](}|jjddk(s%|*ywrrrs r/rhz6LibrarySection._validateFilterField..4s-'fa TWHXY[H\`eHe'frNrrz". Available filter fields: &=TrrSr])rr rrrrr|rjreversedrar7r{rAr_validateFieldOperator_validateFieldValuer r`) r-r5rNrsr roperator filterField filterTypergavailableFieldsr rts ` r/_validateFilterFieldz#LibrarySection._validateFilterField%sCUK5eW=> >$)LLN!%2g2 Xd$//'*BddK..{HE))+vwG t 6?DT. .HSbM)388F+;rrTrstring>!==rrSNc3BK|]}|jk(s|ywrdrA)rfors r/rhz8LibrarySection._validateFieldOperator..VsEq155H3DErizUnknown operator "" for filter field "z". Available operators: r)rsr7rr~rjrrAr)r-rrrq and_operatorravailableOperatorss ` r/rz%LibrarySection._validateFieldOperatorGs %%k&6&67  { "LH >>X %(k*A OH%-bc]c%9HSbMx3N S EI//E E $t11  S151C1CKDTDT1U!VA!%%!V!V !V/z9MkooM^_33E2FHINR S SsA66&CB0/(Cc t|ttfs|g}|j|j}g} |D]}|jdk(rt t |}n|jdk(r|j|}no|jdk(r$dt|vr t|n t |}n<|jdk(r t|}n!|jdvr|j|||}|jt| |S#ttf$r*tdd|jd |jd wxYw) z Validates filter values are the correct datatype and in the available filter choices. Returns the validated list of values. booleandateintegerrr>r resolution audioLanguagesubtitleLanguagezInvalid value "rz", value should be type N)r_r9tuplersr7rr_validateFieldValueDaterbfloat_validateFieldValueTagrE ValueErrorrrrA)r-rrNrsrqresultsrvs r/rz"LibrarySection._validateFieldValue^sD&4-0XF%%k&6&67  Q +>>Y.U ,E^^v- 88?E^^y0,/3u:,=E%L3u:E^^x/JE^^'aa 77{GTEs5z* +  N+ Qug5I+//IZ[55>^^4DFGLP Q Qs CD9E ct|trt|jSt j d|rd|j dzSttj|djS)z Validates a filter date value. A filter date value can be a datetime object, a relative date (e.g. -30d), or a date in YYYY-MM-DD format. z^-?\d+(mon|[smhdwy])$rz%Y-%m-%d) r_rr timestamprr lstriprr)r-rvs r/rz&LibrarySection._validateFieldValueDate{sd eX &u() ) XX. 6c** *u''z:DDFG Gr1c\t|tr |jSt|tjt fr$t |jxs |j}n t |}|j|j|}|jtfd|D|S)a Validates a filter tag value. A filter tag value can be a :class:`~plexapi.library.FilterChoice` object, a :class:`~plexapi.media.MediaTag` object, the exact name :attr:`MediaTag.tag` (*str*), or the exact id :attr:`MediaTag.id` (*int*). c3K|]G}|jj|jjhvs:|jIywrd)rArCrB)rfrg matchValues r/rhz8LibrarySection._validateFieldValueTag..s;dqZAEEKKMSTSZSZS`S`SbCc5cQUUds ;AA) r_rrArMediaTagLibraryMediaTagrbr)rrrCr)r-rvrrs filterChoicesrs @r/rz%LibrarySection._validateFieldValueTags e\ *99  eenno> ?-EII.EJE..{H [[] dMdfkllr1ct|tr|jd}t|ttfs|g}g}|D]#}|j |j ||%dj|S)a  Validates a list of filter sort fields is available for the library. Sort fields can be a list of :class:`~plexapi.library.FilteringSort` objects, or a comma separated string. Returns the validated comma separated sort fields string. r])r_rbrr9rrE_validateSortFieldr`)r-rHrsvalidatedSorts_sorts r/_validateSortFieldsz"LibrarySection._validateSortFieldssr dC ::c?D$u .6D KE  ! !$"9"9%"I J Kxx''r1c  t|tr,|xs |jd|jd|jSt j d|j}|std||j\} }|xs|xs |j} t fd|j|D}|dz|jz gd } || vrtd |d | |r d|S S#t$rD|j|Dcgc]}|jncc}w}}td d|d|d wxYw) z Validates a filter sort field is available for the library. A sort field can be a :class:`~plexapi.library.FilteringSort` object, or a string. Returns the validated sort field string. r:z*(?:([a-zA-Z]*)\.)?([a-zA-Z]+):?([a-zA-Z]*)zInvalid filter sort: c3BK|]}|jk(s|ywrdr)rfrg sortFields r/rhz4LibrarySection._validateSortField..sWAAEEYDVaWrizUnknown sort field "rz". Available sort fields: N)rascdesc nullsLastzUnknown sort direction "z". Available sort directions: )r_ FilteringSortrrAdefaultDirectionrr rDrrrryrjr) r-rHrsr rsortDir filterSortrgavailableSortsavailableDirectionsrs @r/rz!LibrarySection._validateSortFieldsj dM **+1TXXJa8M8M7NO OF U4TF;< <',||~$)W2g2 QW)@WWJ cMJNN2 > - -5gY>\]p\qrs s+2)AgY'A A Q-1^^G-DEaeeEENE1)OG9U55C4DFGLP Q Qs#C44ED$#Ec<t|ts tdg}|jD]\}}|j dvrt |jdkDr tdt|t s td|jd|D]E}|j|j|||j|j dG|d=|jd |j|j||||S) z Validates an advanced search filter dictionary. Returns the list of validated URL encoded parameter strings for the advanced search. zFilters must be a dictionary.>orandrRz@Multiple keys in the same dictionary with and/or is not allowed.z5Value for and/or keys must be a list of dictionaries.zpush=1z=1rSzpop=1) r_rFrrjrCrUr9rEr_validateAdvancedSearchr)r-rrsvalidatedFiltersr5rNrvs r/rz&LibrarySection._validateAdvancedSearchs'4(<= =$]]_ [ME6{{} -w}}'!+$%ghh!&$/$%\]] ''1#BE$++D,H,HPW,XY$++u{{}oR,@AB%R( ''0!''(A(A%QX(YZ# [& r1c :i}g} tt|jdd|d<t|j D]E\} } | j ddt vs!| j|j| | ||| =G|>t|ttfr#| j|jd||n||d<|!| j|j||||j|||d<|tj||d<|||d<tj |j#d } | rd j%| nd } d j%| | gj'd }d |j(d |}|r||fS|S)z Returns the validated and formatted search query API key (``/library/sections//all?``). includeGuidsT__rSrBrHr7r?rrrz/all?)rrrr9rjrrrErr_rrrrrrrrcrr`rDrA)r-rBrHrsrr returnKwargsrert filter_argsr5rN joined_argsjoined_filter_argsrrAs r/_buildSearchKeyzLibrarySection._buildSearchKeys "4 >4(H#IJ^!&,,.1 "ME6{{4 $I5""4#<#rwrA)r-r? mediatypers r/ hubSearchzLibrarySection.hubSearchs&||""5)Udhh"OOr1c h|jd|||||dd| \} } |j| f|||d| S)a5 Search the library. The http requests will be batched in container_size. If you are only looking for the first results, it would be wise to set the maxresults option to that amount so the search doesn't iterate over all results on the server. Parameters: title (str, optional): General string query to search for. Partial string matches are allowed. sort (:class:`~plexapi.library.FilteringSort` or str or list, optional): A field to sort the results. See the details below for more info. maxresults (int, optional): Only return the specified number of results. libtype (str, optional): Return results of a specific type (movie, show, season, episode, artist, album, track, photoalbum, photo, collection) (e.g. ``libtype='episode'`` will only return :class:`~plexapi.video.Episode` objects) container_start (int, optional): Default 0. container_size (int, optional): Default X_PLEX_CONTAINER_SIZE in your config file. limit (int, optional): Limit the number of results from the filter. filters (dict, optional): A dictionary of advanced filters. See the details below for more info. **kwargs (dict): Additional custom filters to apply to the search results. See the details below for more info. Raises: :exc:`~plexapi.exceptions.BadRequest`: When the sort or filter is invalid. :exc:`~plexapi.exceptions.NotFound`: When applying an unknown sort or filter. **Sorting Results** The search results can be sorted by including the ``sort`` parameter. * See :func:`~plexapi.library.LibrarySection.listSorts` to get a list of available sort fields. The ``sort`` parameter can be a :class:`~plexapi.library.FilteringSort` object or a sort string in the format ``field:dir``. The sort direction ``dir`` can be ``asc``, ``desc``, or ``nullsLast``. Omitting the sort direction or using a :class:`~plexapi.library.FilteringSort` object will sort the results in the default direction of the field. Multi-sorting on multiple fields can be achieved by using a comma separated list of sort strings, or a list of :class:`~plexapi.library.FilteringSort` object or strings. Examples: .. code-block:: python library.search(sort="titleSort:desc") # Sort title in descending order library.search(sort="titleSort") # Sort title in the default order # Multi-sort by year in descending order, then by audience rating in descending order library.search(sort="year:desc,audienceRating:desc") library.search(sort=["year:desc", "audienceRating:desc"]) **Using Plex Filters** Any of the available custom filters can be applied to the search results (`screenshot <../_static/images/LibrarySection.search.png>`__). * See :func:`~plexapi.library.LibrarySection.listFields` to get a list of all available fields. * See :func:`~plexapi.library.LibrarySection.listOperators` to get a list of all available operators. * See :func:`~plexapi.library.LibrarySection.listFilterChoices` to get a list of all available filter values. The following filter fields are just some examples of the possible filters. The list is not exhaustive, and not all filters apply to all library types. * **actor** (:class:`~plexapi.media.MediaTag`): Search for the name of an actor. * **addedAt** (*datetime*): Search for items added before or after a date. See operators below. * **audioLanguage** (*str*): Search for a specific audio language (3 character code, e.g. jpn). * **collection** (:class:`~plexapi.media.MediaTag`): Search for the name of a collection. * **contentRating** (:class:`~plexapi.media.MediaTag`): Search for a specific content rating. * **country** (:class:`~plexapi.media.MediaTag`): Search for the name of a country. * **decade** (*int*): Search for a specific decade (e.g. 2000). * **director** (:class:`~plexapi.media.MediaTag`): Search for the name of a director. * **duplicate** (*bool*) Search for duplicate items. * **genre** (:class:`~plexapi.media.MediaTag`): Search for a specific genre. * **hdr** (*bool*): Search for HDR items. * **inProgress** (*bool*): Search for in progress items. * **label** (:class:`~plexapi.media.MediaTag`): Search for a specific label. * **lastViewedAt** (*datetime*): Search for items watched before or after a date. See operators below. * **mood** (:class:`~plexapi.media.MediaTag`): Search for a specific mood. * **producer** (:class:`~plexapi.media.MediaTag`): Search for the name of a producer. * **resolution** (*str*): Search for a specific resolution (e.g. 1080). * **studio** (*str*): Search for the name of a studio. * **style** (:class:`~plexapi.media.MediaTag`): Search for a specific style. * **subtitleLanguage** (*str*): Search for a specific subtitle language (3 character code, e.g. eng) * **unmatched** (*bool*): Search for unmatched items. * **unwatched** (*bool*): Search for unwatched items. * **userRating** (*int*): Search for items with a specific user rating. * **writer** (:class:`~plexapi.media.MediaTag`): Search for the name of a writer. * **year** (*int*): Search for a specific year. Tag type filter values can be a :class:`~plexapi.library.FilterChoice` object, :class:`~plexapi.media.MediaTag` object, the exact name :attr:`MediaTag.tag` (*str*), or the exact id :attr:`MediaTag.id` (*int*). Date type filter values can be a ``datetime`` object, a relative date using a one of the available date suffixes (e.g. ``30d``) (*str*), or a date in ``YYYY-MM-DD`` (*str*) format. Relative date suffixes: * ``s``: ``seconds`` * ``m``: ``minutes`` * ``h``: ``hours`` * ``d``: ``days`` * ``w``: ``weeks`` * ``mon``: ``months`` * ``y``: ``years`` Multiple values can be ``OR`` together by providing a list of values. Examples: .. code-block:: python library.search(unwatched=True, year=2020, resolution="4k") library.search(actor="Arnold Schwarzenegger", decade=1990) library.search(contentRating="TV-G", genre="animation") library.search(genre=["animation", "comedy"]) # Genre is animation OR comedy library.search(studio=["Disney", "Pixar"]) # Studio contains Disney OR Pixar **Using a** ``libtype`` **Prefix** Some filters may be prefixed by the ``libtype`` separated by a ``.`` (e.g. ``show.collection``, ``episode.title``, ``artist.style``, ``album.genre``, ``track.userRating``, etc.). This should not be confused with the ``libtype`` parameter. If no ``libtype`` prefix is provided, then the default library type is assumed. For example, in a TV show library ``viewCount`` is assumed to be ``show.viewCount``. If you want to filter using episode view count then you must specify ``episode.viewCount`` explicitly. In addition, if the filter does not exist for the default library type it will fallback to the most specific ``libtype`` available. For example, ``show.unwatched`` does not exists so it will fallback to ``episode.unwatched``. The ``libtype`` prefix cannot be included directly in the function parameters so the filters must be provided as a filters dictionary. Examples: .. code-block:: python library.search(filters={"show.collection": "Documentary", "episode.inProgress": True}) library.search(filters={"artist.genre": "pop", "album.decade": 2000}) # The following three options are identical and will return Episode objects showLibrary.search(title="Winter is Coming", libtype='episode') showLibrary.search(libtype='episode', filters={"episode.title": "Winter is Coming"}) showLibrary.searchEpisodes(title="Winter is Coming") # The following will search for the episode title but return Show objects showLibrary.search(filters={"episode.title": "Winter is Coming"}) # The following will fallback to episode.unwatched showLibrary.search(unwatched=True) **Using Plex Operators** Operators can be appended to the filter field to narrow down results with more granularity. The following is a list of possible operators depending on the data type of the filter being applied. A special ``&`` operator can also be used to ``AND`` together a list of values. Type: :class:`~plexapi.media.MediaTag` or *subtitleLanguage* or *audioLanguage* * no operator: ``is`` * ``!``: ``is not`` Type: *int* * no operator: ``is`` * ``!``: ``is not`` * ``>>``: ``is greater than`` * ``<<``: ``is less than`` Type: *str* * no operator: ``contains`` * ``!``: ``does not contain`` * ``=``: ``is`` * ``!=``: ``is not`` * ``<``: ``begins with`` * ``>``: ``ends with`` Type: *bool* * no operator: ``is true`` * ``!``: ``is false`` Type: *datetime* * ``<<``: ``is before`` * ``>>``: ``is after`` Type: *resolution* or *guid* * no operator: ``is`` Operators cannot be included directly in the function parameters so the filters must be provided as a filters dictionary. Examples: .. code-block:: python # Genre is horror AND thriller library.search(filters={"genre&": ["horror", "thriller"]}) # Director is not Steven Spielberg library.search(filters={"director!": "Steven Spielberg"}) # Title starts with Marvel and added before 2021-01-01 library.search(filters={"title<": "Marvel", "addedAt<<": "2021-01-01"}) # Added in the last 30 days using relative dates library.search(filters={"addedAt>>": "30d"}) # Collection is James Bond and user rating is greater than 8 library.search(filters={"collection": "James Bond", "userRating>>": 8}) **Using Advanced Filters** Any of the Plex filters described above can be combined into a single ``filters`` dictionary that mimics the advanced filters used in Plex Web with a tree of ``and``/``or`` branches. Each level of the tree must start with ``and`` (Match all of the following) or ``or`` (Match any of the following) as the dictionary key, and a list of dictionaries with the desired filters as the dictionary value. The following example matches `this <../_static/images/LibrarySection.search_filters.png>`__ advanced filter in Plex Web. Examples: .. code-block:: python advancedFilters = { 'and': [ # Match all of the following in this list { 'or': [ # Match any of the following in this list {'title': 'elephant'}, {'title': 'bunny'} ] }, {'year>>': 1990}, {'unwatched': True} ] } library.search(filters=advancedFilters) **Using PlexAPI Operators** For even more advanced filtering which cannot be achieved in Plex, the PlexAPI operators can be applied to any XML attribute. See :func:`plexapi.base.PlexObject.fetchItems` for a list of operators and how they are used. Note that using the Plex filters above will be faster since the filters are applied by the Plex server before the results are returned to PlexAPI. Using the PlexAPI operators requires the Plex server to return *all* results to allow PlexAPI to do the filtering. The Plex filters and the PlexAPI operators can be used in conjunction with each other. Examples: .. code-block:: python library.search(summary__icontains="Christmas") library.search(duration__gt=7200000) library.search(audienceRating__lte=6.0, audienceRatingImage__startswith="rottentomatoes://") library.search(media__videoCodec__exact="h265") library.search(genre="holiday", viewCount__gte=3) T)rBrHrsrrr)container_startcontainer_sizerrh)rrd) r-rBrHrrsrrrrrerAs r/rwzLibrarySection.search sh~+d**pdG5'`dphnp Vt r!0\frjpr rr1cB|j|jtS)zF Returns a list of :class:`~plexapi.library.Location` objects )rr'rrOs r/ _locationszLibrarySection._locationss~~djj(33r1c  ddlm} |js td|jj } | |jd} |r|n |j | _|j | _|j| _ |j| _ |jj| _ |jd |||d|} d|jdt| | _|| _|| _| j'||| S) a Add current library section as sync item for specified device. See description of :func:`~plexapi.library.LibrarySection.search` for details about filtering / sorting and :func:`~plexapi.myplex.MyPlexAccount.sync` for possible exceptions. Parameters: policy (:class:`~plexapi.sync.Policy`): policy of syncing the media (how many items to sync and process watched media or not), generated automatically when method called on specific LibrarySection object. mediaSettings (:class:`~plexapi.sync.MediaSettings`): Transcoding settings used for the media, generated automatically when method called on specific LibrarySection object. client (:class:`~plexapi.myplex.MyPlexDevice`): sync destination, see :func:`~plexapi.myplex.MyPlexAccount.sync`. clientId (str): sync destination, see :func:`~plexapi.myplex.MyPlexAccount.sync`. title (str): descriptive title for the new :class:`~plexapi.sync.SyncItem`, if empty the value would be generated from metadata of current media. sort (str): formatted as `column:dir`; column can be any of {`addedAt`, `originallyAvailableAt`, `lastViewedAt`, `titleSort`, `rating`, `mediaHeight`, `duration`}. dir can be `asc` or `desc`. libtype (str): Filter results to a specific libtype (`movie`, `show`, `episode`, `artist`, `album`, `track`). Returns: :class:`~plexapi.sync.SyncItem`: an instance of created syncItem. Raises: :exc:`~plexapi.exceptions.BadRequest`: When the library is not allowed to sync. :exc:`~plexapi.exceptions.BadRequest`: When the sort or filter is invalid. :exc:`~plexapi.exceptions.NotFound`: When applying an unknown sort or filter. Example: .. code-block:: python from plexapi import myplex from plexapi.sync import Policy, MediaSettings, VIDEO_QUALITY_3_MBPS_720p c = myplex.MyPlexAccount() target = c.device('Plex Client') sync_items_wd = c.syncItems(target.clientIdentifier) srv = c.resource('Server Name').connect() section = srv.library.section('Movies') policy = Policy('count', unwatched=True, value=1) media_settings = MediaSettings.create(VIDEO_QUALITY_3_MBPS_720p) section.sync(target, policy, media_settings, title='Next best movie', sort='rating:desc') r)SyncItemz,The requested library is not allowed to syncN)rBrHrsz library://z /directory/)clientclientId sync_itemrh) plexapi.syncrrrr> myPlexAccountrB rootTitle CONTENT_TYPE contentType METADATA_TYPE metadataTypemachineIdentifierrrr rpolicy mediaSettingssync) r-rrrrrBrHrsrermyplexrrAs r/rzLibrarySection.syncsb *~~KL L++-T\\40 #(%djj "jj  $ 1 1 !%!3!3 &*ll&D&D #"d""UT7UfU)$))K 3?PQ ! "/ {{&8y{QQr1cT|jj|||jdS)z Get Play History for this library Section for the owner. Parameters: maxresults (int): Only return the specified number of results (optional). mindate (datetime): Min datetime to return results from. rR)rrlibrarySectionID accountID)r>rrA)r-rrs r/rzLibrarySection.historyYs* ||##z7]a]e]eqr#ssr1c L|jj|f|||||||d|S)z Alias for :func:`~plexapi.server.PlexServer.createCollection` using this :class:`~plexapi.library.LibrarySection`. )rKrjsmartrrsrHr)r>createCollection) r-rBrjrrrsrHrres r/rzLibrarySection.createCollectionasA -t||,, CuE$C;AC Cr1cj |j||dS#t$rtd|ddwxYw)z Returns the collection with the specified title. Parameters: title (str): Title of the item to return. Raises: :exc:`~plexapi.exceptions.NotFound`: Unable to find collection. rB title__iexactrz&Unable to find collection with title "".N)rYrrr-rBs r/ collectionzLibrarySection.collectionjsL Y##%u#EaH H YCE7"MNTX X Y2c *|jdddi|S)z Returns a list of collections from this library section. See description of :func:`~plexapi.library.LibrarySection.search` for details about filtering / sorting. rsrrhrwr-res r/rYzLibrarySection.collectionsxst{{:<:6::r1c L|jj|f|||||||d|S)z Alias for :func:`~plexapi.server.PlexServer.createPlaylist` using this :class:`~plexapi.library.LibrarySection`. )rKrjrrrHr m3ufilepath)r>createPlaylist) r-rBrjrrrHrrres r/r zLibrarySection.createPlaylist~sA +t||** KuEwKKCIK Kr1cj |j||dS#t$rtd|ddwxYw)z Returns the playlist with the specified title. Parameters: title (str): Title of the item to return. Raises: :exc:`~plexapi.exceptions.NotFound`: Unable to find playlist. rrz$Unable to find playlist with title "rN) playlistsrrrs r/playlistzLibrarySection.playlistsI W>>U>CAF F WA%KLRV V Wrc j|jjd|j|j|d|S)z8 Returns a list of playlists from this library section. ) playlistTyperrHrh)r>r rrA)r-rHres r/r zLibrarySection.playlistss=%t||%%U**dhhTUMSU Ur1zuse "listFields" insteadc&|j|S)N)rs)r|)r- mediaTypes r/ filterFieldszLibrarySection.filterFieldssy11r1zuse "listFilterChoices" insteadc (|j||S)N)r5rs)r)r-categoryrsres r/ listChoiceszLibrarySection.listChoicess%%Hg%FFr1cd|ji}|||d<| ||d<d|d<|jjdd|i|S)aZ Returns the Plex Web URL for the library. Parameters: base (str): The base URL before the fragment (``#!``). Default is https://app.plex.tv/desktop. tab (str): The library tab (recommended, library, collections, playlists, timeline). key (str): A hub key. sourcepivotrAr9pageTypebaserh)rAr> _buildWebURL)r-rtabrArs r/ getWebURLzLibrarySection.getWebURLsWDHH% ?!F7O ?F5M!'F: (t||((=d=f==r1c2||gk(r tdt|ts|g}|dj}|D]]}|j|j k7rt|j d|j|k7sDtd|d|j|S)zK Validates the specified items are from this library and of the same type. zNo items specified.rz is not from this library.z$Cannot mix items of different type: z and )rr_r9r7rrArB)r-rjitemTyperks r/_validateItemszLibrarySection._validateItemss =ERK23 3%&GE8== dD$$0 DJJ.sV43t~~.V!r)r)r7rz/commonr") r`rrrrr7rArc fetchItemCommon)r-rjrrs r/commonzLibrarySection.commonss((V4;N;Nu;UVV$$U1X]]3 $DHH:WU^^F5K4LM~~d~//r1c t|jtr||jj||Sdj d|j |D|d<d|vr%t j|dj|d<d|jdt j|}|jj||jjj|S) z! Actually edit multiple objects. r]c3FK|]}t|jywrdr"r$s r/rhz'LibrarySection._edit..s[DNN 3[r%r)r7rrrry)r_rrFrr`rrrrr7rArcr>r?r|r})r-rjrers r/_editzLibrarySection._edits dkk4 (U] KK  v &Kxx[@S@STY@Z[[t  "--eAhmmrArnrErprKrNrrrrrr_rarlrnrsrvryr|rrrrrrrrrrrrrwrrrrrrYr r r rrrrrr(r+r-r/r2 __classcell__rs@r/r@r@s*"2<<## ""  W=42-.-4*&+SZ6, 0 E $ . 1 !0 ! MN+ $ $ X8  Z*! Q$ V"3&1&2&6*'2R #D2.: H m("B: C Y; DH<@K WU *+2,212G3G>""0  +8 r1r@cBeZdZdZdZdZdZdZdZddZ d fd Z xZ S) r:z Represents a :class:`~plexapi.library.LibrarySection` section containing movies. Attributes: TAG (str): 'Directory' TYPE (str): 'movie' Directoryr3videoc *|jdddi|S)zS Search for a movie. See :func:`~plexapi.library.LibrarySection.search` for usage. rsr3rhrrs r/ searchMovieszMovieSection.searchMoviest{{575f55r1c(|j|dS)z Returns a list of recently added movies from this library section. Parameters: maxresults (int): Max number of items to return (default 50). r3rrsrpr-rs r/recentlyAddedMoviesz MovieSection.recentlyAddedMovies! !!Z!IIr1c ddlm}m}|j||d<|j |||d<t t |di|S)a Add current Movie library section as sync item for specified device. See description of :func:`~plexapi.library.LibrarySection.search` for details about filtering / sorting and :func:`~plexapi.library.LibrarySection.sync` for details on syncing libraries and possible exceptions. Parameters: videoQuality (int): idx of quality of the video, one of VIDEO_QUALITY_* values defined in :mod:`~plexapi.sync` module. limit (int): maximum count of movies to sync, unlimited if `None`. unwatched (bool): if `True` watched videos wouldn't be synced. Returns: :class:`~plexapi.sync.SyncItem`: an instance of created syncItem. Example: .. code-block:: python from plexapi import myplex from plexapi.sync import VIDEO_QUALITY_3_MBPS_720p c = myplex.MyPlexAccount() target = c.device('Plex Client') sync_items_wd = c.syncItems(target.clientIdentifier) srv = c.resource('Server Name').connect() section = srv.library.section('Movies') section.sync(VIDEO_QUALITY_3_MBPS_720p, client=target, limit=1, unwatched=True, title='Next best movie', sort='rating:desc') rPolicy MediaSettingsrrrh)rrFrG createVideocreaterr:rr- videoQualityr unwatchedrerFrGrs r/rzMovieSection.sync)sG< 7"/";";L"I!== :x\4-777r1r3NF) rrrrTAGrrrr<rBrr6r7s@r/r:r:s3 C DML6J!8!8r1r:c^eZdZdZdZdZdZdZdZdZ dZ d d Z d d Z d d Z dfd ZxZS)r;z Represents a :class:`~plexapi.library.LibrarySection` section containing tv shows. Attributes: TAG (str): 'Directory' TYPE (str): 'show' r9r4episoder:c *|jdddi|S)zR Search for a show. See :func:`~plexapi.library.LibrarySection.search` for usage. rsr4rhrrs r/ searchShowszShowSection.searchShowsYst{{464V44r1c *|jdddi|S)zT Search for a season. See :func:`~plexapi.library.LibrarySection.search` for usage. rsseasonrhrrs r/ searchSeasonszShowSection.searchSeasons]t{{686v66r1c *|jdddi|S)zV Search for an episode. See :func:`~plexapi.library.LibrarySection.search` for usage. rsrQrhrrs r/searchEpisodeszShowSection.searchEpisodesast{{79777r1c(|j|dS)z Returns a list of recently added shows from this library section. Parameters: maxresults (int): Max number of items to return (default 50). r4r?r@rAs r/recentlyAddedShowszShowSection.recentlyAddedShowses !!Z!HHr1c(|j|dS)z Returns a list of recently added seasons from this library section. Parameters: maxresults (int): Max number of items to return (default 50). rUr?r@rAs r/recentlyAddedSeasonsz ShowSection.recentlyAddedSeasonsm !!Z!JJr1c(|j|dS)z Returns a list of recently added episodes from this library section. Parameters: maxresults (int): Max number of items to return (default 50). rQr?r@rAs r/recentlyAddedEpisodesz!ShowSection.recentlyAddedEpisodesus !!Z!KKr1c ddlm}m}|j||d<|j |||d<t t |di|S)a Add current Show library section as sync item for specified device. See description of :func:`~plexapi.library.LibrarySection.search` for details about filtering / sorting and :func:`~plexapi.library.LibrarySection.sync` for details on syncing libraries and possible exceptions. Parameters: videoQuality (int): idx of quality of the video, one of VIDEO_QUALITY_* values defined in :mod:`~plexapi.sync` module. limit (int): maximum count of episodes to sync, unlimited if `None`. unwatched (bool): if `True` watched videos wouldn't be synced. Returns: :class:`~plexapi.sync.SyncItem`: an instance of created syncItem. Example: .. code-block:: python from plexapi import myplex from plexapi.sync import VIDEO_QUALITY_3_MBPS_720p c = myplex.MyPlexAccount() target = c.device('Plex Client') sync_items_wd = c.syncItems(target.clientIdentifier) srv = c.resource('Server Name').connect() section = srv.library.section('TV-Shows') section.sync(VIDEO_QUALITY_3_MBPS_720p, client=target, limit=1, unwatched=True, title='Next unwatched episode') rrErrrh)rrFrGrHrIrr;rrJs r/rzShowSection.sync}sG< 7"/";";L"I!== :x[$,6v66r1rMrN)rrrrrOrrrrSrVrYr[r]r`rr6r7s@r/r;r;MsI C DML578IKL!7!7r1r;ceZdZdZdZdZdZdZdZdZ dZ d Z d Z dd Z dd Zdd Zdfd Z ddZxZS)r<z Represents a :class:`~plexapi.library.LibrarySection` section containing music artists. Attributes: TAG (str): 'Directory' TYPE (str): 'artist' r9r5trackaudiocDd|jd}|j|S)zJ Returns a list of :class:`~plexapi.audio.Album` objects in this section. rz/albumsrrs r/albumszMusicSection.albumsrCr1cDtd|jDdS)zQ Returns a list of :class:`~plexapi.playlist.Playlist` stations in this section. c3TK|] }|jdk(s|j"yw)zhub.music.stationsN)contextrj)rfhubs r/rhz(MusicSection.stations..s ]3H\9\SYY]s((N)rrfrOs r/stationszMusicSection.stationss]$))+]_cddr1c *|jdddi|S)zU Search for an artist. See :func:`~plexapi.library.LibrarySection.search` for usage. rsr5rhrrs r/ searchArtistszMusicSection.searchArtistsrWr1c *|jdddi|S)zT Search for an album. See :func:`~plexapi.library.LibrarySection.search` for usage. rsalbumrhrrs r/ searchAlbumszMusicSection.searchAlbumsr=r1c *|jdddi|S)zS Search for a track. See :func:`~plexapi.library.LibrarySection.search` for usage. rsrcrhrrs r/ searchTrackszMusicSection.searchTracksr=r1c(|j|dS)z Returns a list of recently added artists from this library section. Parameters: maxresults (int): Max number of items to return (default 50). r5r?r@rAs r/recentlyAddedArtistsz!MusicSection.recentlyAddedArtistsr^r1c(|j|dS)z Returns a list of recently added albums from this library section. Parameters: maxresults (int): Max number of items to return (default 50). ror?r@rAs r/recentlyAddedAlbumsz MusicSection.recentlyAddedAlbumsrCr1c(|j|dS)z Returns a list of recently added tracks from this library section. Parameters: maxresults (int): Max number of items to return (default 50). rcr?r@rAs r/recentlyAddedTracksz MusicSection.recentlyAddedTracksrCr1c ddlm}m}|j||d<|j ||d<t t |di|S)a8 Add current Music library section as sync item for specified device. See description of :func:`~plexapi.library.LibrarySection.search` for details about filtering / sorting and :func:`~plexapi.library.LibrarySection.sync` for details on syncing libraries and possible exceptions. Parameters: bitrate (int): maximum bitrate for synchronized music, better use one of MUSIC_BITRATE_* values from the module :mod:`~plexapi.sync`. limit (int): maximum count of tracks to sync, unlimited if `None`. Returns: :class:`~plexapi.sync.SyncItem`: an instance of created syncItem. Example: .. code-block:: python from plexapi import myplex from plexapi.sync import AUDIO_BITRATE_320_KBPS c = myplex.MyPlexAccount() target = c.device('Plex Client') sync_items_wd = c.syncItems(target.clientIdentifier) srv = c.resource('Server Name').connect() section = srv.library.section('Music') section.sync(AUDIO_BITRATE_320_KBPS, client=target, limit=100, sort='addedAt:desc', title='New music') rrErrrh)rrFrG createMusicrIrr<r)r-bitraterrerFrGrs r/rzMusicSection.syncsE: 7"/";";G"D!==/x\4-777r1c t|tr|n |j}t|tr|n |j}d|jd|d|}|j|fi|S)a Returns a list of tracks from this library section that are part of a sonic adventure. ID's should be of a track, other ID's will return an empty list or items itself or an error. Parameters: start (Track | int): The :class:`~plexapi.audio.Track` or ID of the first track in the sonic adventure. end (Track | int): The :class:`~plexapi.audio.Track` or ID of the last track in the sonic adventure. kwargs: Additional parameters to pass to :func:`~plexapi.base.PlexObject.fetchItems`. Returns: List[:class:`~plexapi.audio.Track`]: a list of tracks from this library section that are part of a sonic adventure. rz/computePath?startID=z&endID=)r_rr#rArd)r-startendrestartIDendIDrAs r/sonicAdventurezMusicSection.sonicAdventuresa&&eS1%u!#s+"488*,A''RWQXYts-f--r1rMrd)r} Track | intr~rrerreturnz list[Track])rrrrrOrrrrfrkrmrprrrtrvrxrrr6r7s@r/r<r<s{ C DML$ e766KJJ 8D... .  .r1r<cVeZdZdZdZdZdZdZd dZdZ dZ dZ d dZ d fd Z xZS) r=z Represents a :class:`~plexapi.library.LibrarySection` section containing photos. Attributes: TAG (str): 'Directory' TYPE (str): 'photo' r9r6c 6|xsd}|jdd|i|S)z Returns a list of all items from this library section. See description of :func:`plexapi.library.LibrarySection.search()` for details about filtering / sorting. photoalbumrsrhrrs r/rizPhotoSection.all"s')\t{{575f55r1c td)Nz2Collections are not available for a Photo library.)NotImplementedErrorrs r/rYzPhotoSection.collections)s!"VWWr1c *|jdddi|S)zY Search for a photo album. See :func:`~plexapi.library.LibrarySection.search` for usage. rsrrhrrs r/rpzPhotoSection.searchAlbums,st{{:<:6::r1c *|jdddi|S)zS Search for a photo. See :func:`~plexapi.library.LibrarySection.search` for usage. rsr6rhrrs r/ searchPhotoszPhotoSection.searchPhotos0r=r1c(|jd|S)z Returns a list of recently added photo albums from this library section. Parameters: maxresults (int): Max number of items to return (default 50). rG)rHrrrAs r/rvz PhotoSection.recentlyAddedAlbums4s{{:{FFr1c ddlm}m}|j||d<|j ||d<t t |di|S)a6 Add current Music library section as sync item for specified device. See description of :func:`~plexapi.library.LibrarySection.search` for details about filtering / sorting and :func:`~plexapi.library.LibrarySection.sync` for details on syncing libraries and possible exceptions. Parameters: resolution (str): maximum allowed resolution for synchronized photos, see PHOTO_QUALITY_* values in the module :mod:`~plexapi.sync`. limit (int): maximum count of tracks to sync, unlimited if `None`. Returns: :class:`~plexapi.sync.SyncItem`: an instance of created syncItem. Example: .. code-block:: python from plexapi import myplex from plexapi.sync import PHOTO_QUALITY_HIGH c = myplex.MyPlexAccount() target = c.device('Plex Client') sync_items_wd = c.syncItems(target.clientIdentifier) srv = c.resource('Server Name').connect() section = srv.library.section('Photos') section.sync(PHOTO_QUALITY_HIGH, client=target, limit=100, sort='addedAt:desc', title='Fresh photos') rrErrrh)rrFrG createPhotorIrr=r)r-rrrerFrGrs r/rzPhotoSection.sync=sE: 7"/";";J"G!==/x\4-777r1rdrM)rrrrrOrrrrirYrprrvrr6r7s@r/r=r=sC C DML6X;6G 8 8r1r=ceZdZdZdZdZy)r@aRepresents a LibrarySection timeline. Attributes: TAG (str): 'LibraryTimeline' size (int): Unknown allowSync (bool): Unknown art (str): Relative path to art image. content (str): "secondary" identifier (str): "com.plexapp.plugins.library" latestEntryTime (int): Epoch timestamp mediaTagPrefix (str): "/system/bundle/media/flags/" mediaTagVersion (int): Unknown thumb (str): Relative path to library thumb image. title1 (str): Name of library section. updateQueueSize (int): Number of items queued to update. viewGroup (str): "secondary" viewMode (int): Unknown cr||_tjt|jj d|_tjt|jj d|_|jj d|_ |jj d|_ |jj d|_ tjt|jj d|_ |jj d|_ tjt|jj d|_|jj d |_|jj d |_tjt|jj d |_|jj d |_tjt|jj d |_y)/ Load attribute values from Plex XML response. sizerrcontentr#latestEntryTimemediaTagPrefixr$rr%updateQueueSize viewGroupviewModeN)r'rrrr(r)rrrrrr#rrr$rr%rrrr,s r/r0zLibraryTimeline._loadDatavsW JJsDKKOOF$;< D$++//+*FG;;??5){{y1 ++//,7$zz#t{{?P/QR"kkoo.>?$zz#t{{?P/QR[[__W- kkooh/ $zz#t{{?P/QR5 3  (CD r1NrrrrrOr0rhr1r/r@r@`s$ CEr1r@ceZdZdZdZdZy)rz Represents a single library Location. Attributes: TAG (str): 'Location' id (int): Location path ID. path (str): Path used for library.. c||_tjt|jj d|_|jj d|_y)rr)rN)r'rrrr(r)r)rr,s r/r0zLocation._loadDatas< **S$++//$"78KKOOF+ r1Nrrhr1r/rrs C,r1rc,eZdZdZdZdZdZdZdZy)Huba Represents a single Hub (or category) in the PlexServer search. Attributes: TAG (str): 'Hub' context (str): The context of the hub. hubKey (str): API URL for these specific hub items. hubIdentifier (str): The identifier of the hub. items (list): List of items in the hub. key (str): API URL for the hub. more (bool): True if there are more items to load (call reload() to fetch all items). size (int): The number of items in the hub. style (str): The style of the hub. title (str): The title of the hub. type (str): The type of items in the hub. c||_|jjd|_|jjd|_|jjd|_|j ||_|jjd|_tjt|jjd|_ tjt|jjd|_|jjd|_|jjd|_|jjd |_d |_y ) rrihubKey hubIdentifierrAmorerstylerBr7N)r'r(r)rirrrrjrArrrrrrrrBr7_sectionr,s r/r0z Hub._loadDatas {{y1 kkooh/ ![[___=^^D) ;;??5)JJtT[[__V%<= JJsDKKOOF$;< [[__W- [[__W- KKOOF+  r1c|jSrd)rrOs r/__len__z Hub.__len__s yyr1c|jrO|jrB|j|j|_d|_t |j|_yyy)z0 Reloads the hub to fetch all items in the hub. FN)rrArdrjrUrrOs r/rz Hub.reloads@ 992DJDIDJJDI"9r1c|j4|jjj|j|_|jS)zS Returns the :class:`~plexapi.library.LibrarySection` this hub belongs to. )rr>rr[rrOs r/rKz Hub.sections: ==  LL00</all?). librarySectionID (int): The library section ID where the tag is found. librarySectionKey (str): API URL for the library section (/library/section/) librarySectionTitle (str): The library title where the tag is found. librarySectionType (int): The library type where the tag is found. reason (str): The reason for the search result. reasonID (int): The reason ID for the search result. reasonTitle (str): The reason title for the search result. score (float): The score for the search result. type (str): The type of search result (tag). tag (str): The title of the tag. tagKey (str): The Plex Discover ratingKey (guid) for people. tagType (int): The type ID of the tag. tagValue (int): The value of the tag. thumb (str): The URL for the thumbnail of the tag (if available). r9c||_tjt|jj d|_|jj d|_tjt|jj d|_|jj d|_ tjt|jj d|_ |jj d|_ |jj d|_ tjt|jj d|_ |jj d |_tjt|jj d |_|jj d |_tjt"|jj d |_|jj d |_|jj d|_|jj d|_tjt|jj d|_tjt|jj d|_|jj d|_y)rcountrVr)rArlibrarySectionKeylibrarySectionTitlelibrarySectionTypereasonreasonID reasonTitlescorer7rtagKeyrtagValuerN)r'rrrr(r)rrVr)rArrrrrrrrrr7rrrrrr,s r/r0zLibraryMediaTag._loadDatas ZZT[[__W%=> kkooh/ **S$++//$"78;;??5) % 3 @R0S T!%1D!E#';;??3H#I "'**S$++//BV2W"Xkkooh/  3  (CD ;;??=9ZZt{{w'?@ KKOOF+ ;;??5)kkooh/ zz#t{{y'AB  3  (CD [[__W- r1c|jstd|j|j|jS)z+ Return the list of items within this tag. z!Key is not defined for this tag: )rArrrd)r-rtres r/rjzLibraryMediaTag.itemss3xx@ KL Ltxx((r1NrrrrrOr0rjrhr1r/rrs. C.,)r1rceZdZdZdZy)Aperturezi Represents a single Aperture library media tag. Attributes: TAGTYPE (int): 202 NrrrrTAGTYPErhr1r/rr  Gr1rceZdZdZdZy)Artzd Represents a single Art library media tag. Attributes: TAGTYPE (int): 313 i9Nrrhr1r/rr rr1rceZdZdZdZy)Autotagzh Represents a single Autotag library media tag. Attributes: TAGTYPE (int): 207 Nrrhr1r/rr rr1rceZdZdZdZy)Chapterzf Represents a single Chapter library media tag. Attributes: TAGTYPE (int): 9 Nrrhr1r/rr#  Gr1rceZdZdZdZy) Collectionzi Represents a single Collection library media tag. Attributes: TAGTYPE (int): 2 Nrrhr1r/rr- rr1rceZdZdZdZy)Concertzh Represents a single Concert library media tag. Attributes: TAGTYPE (int): 306 i2Nrrhr1r/rr7 rr1rceZdZdZdZy)Countryzf Represents a single Country library media tag. Attributes: TAGTYPE (int): 8 Nrrhr1r/rrA rr1rceZdZdZdZy)Devicezg Represents a single Device library media tag. Attributes: TAGTYPE (int): 206 Nrrhr1r/rrK rr1rceZdZdZdZy)Directorzg Represents a single Director library media tag. Attributes: TAGTYPE (int): 4 Nrrhr1r/rrU rr1rceZdZdZdZy)Exposurezi Represents a single Exposure library media tag. Attributes: TAGTYPE (int): 203 Nrrhr1r/rr_ rr1rceZdZdZdZy)Formatzg Represents a single Format library media tag. Attributes: TAGTYPE (int): 302 i.Nrrhr1r/rri rr1rceZdZdZdZy)Genrezd Represents a single Genre library media tag. Attributes: TAGTYPE (int): 1 rRNrrhr1r/rrs rr1rceZdZdZdZy)Guidze Represents a single Guid library media tag. Attributes: TAGTYPE (int): 314 i:Nrrhr1r/rr} rr1rceZdZdZdZy)ISOzd Represents a single ISO library media tag. Attributes: TAGTYPE (int): 204 Nrrhr1r/rr rr1rceZdZdZdZy)Labelze Represents a single Label library media tag. Attributes: TAGTYPE (int): 11 Nrrhr1r/rr  Gr1rceZdZdZdZy)Lensze Represents a single Lens library media tag. Attributes: TAGTYPE (int): 205 Nrrhr1r/rr rr1rceZdZdZdZy)Makeze Represents a single Make library media tag. Attributes: TAGTYPE (int): 200 Nrrhr1r/rr rr1rceZdZdZdZy)Markerzf Represents a single Marker library media tag. Attributes: TAGTYPE (int): 12 Nrrhr1r/rr rr1rceZdZdZdZdZy)MediaProcessingTargetz Represents a single MediaProcessingTarget library media tag. Attributes: TAG (str): 'Tag' TAGTYPE (int): 42 Tag*N)rrrrrOrrhr1r/rr s CGr1rceZdZdZdZy)Modelzf Represents a single Model library media tag. Attributes: TAGTYPE (int): 201 Nrrhr1r/rr rr1rceZdZdZdZy)Moodze Represents a single Mood library media tag. Attributes: TAGTYPE (int): 300 i,Nrrhr1r/rr rr1rceZdZdZdZy)Networkzh Represents a single Network library media tag. Attributes: TAGTYPE (int): 319 i?Nrrhr1r/rr rr1rceZdZdZdZy)Placezf Represents a single Place library media tag. Attributes: TAGTYPE (int): 400 iNrrhr1r/rr rr1rceZdZdZdZy)Posterzg Represents a single Poster library media tag. Attributes: TAGTYPE (int): 312 i8Nrrhr1r/rr rr1rceZdZdZdZy)Producerzg Represents a single Producer library media tag. Attributes: TAGTYPE (int): 7 Nrrhr1r/rr rr1rceZdZdZdZy) RatingImagezl Represents a single RatingImage library media tag. Attributes: TAGTYPE (int): 316 i<Nrrhr1r/rr rr1rceZdZdZdZy)Reviewzf Represents a single Review library media tag. Attributes: TAGTYPE (int): 10 Nrrhr1r/rr rr1rceZdZdZdZy)Rolezc Represents a single Role library media tag. Attributes: TAGTYPE (int): 6 Nrrhr1r/rr rr1rceZdZdZdZy)Similarzh Represents a single Similar library media tag. Attributes: TAGTYPE (int): 305 i1Nrrhr1r/rr rr1rceZdZdZdZy)Studiozg Represents a single Studio library media tag. Attributes: TAGTYPE (int): 318 i>Nrrhr1r/r r ) rr1r ceZdZdZdZy)Stylezf Represents a single Style library media tag. Attributes: TAGTYPE (int): 301 i-Nrrhr1r/r r 3 rr1r ceZdZdZdZy)rzb Represents a single Tag library media tag. Attributes: TAGTYPE (int): 0 rNrrhr1r/rr= rr1rceZdZdZdZy)Themezf Represents a single Theme library media tag. Attributes: TAGTYPE (int): 317 i=Nrrhr1r/rrG rr1rceZdZdZdZy)Writerze Represents a single Writer library media tag. Attributes: TAGTYPE (int): 5 Nrrhr1r/rrQ rr1rc2eZdZdZdZdZdZdZdZdZ y) rZa} Represents a single filtering Type object for a library. Attributes: TAG (str): 'Type' active (bool): True if this filter type is currently active. fields (List<:class:`~plexapi.library.FilteringField`>): List of field objects. filters (List<:class:`~plexapi.library.FilteringFilter`>): List of filter objects. key (str): The API URL path for the libtype filter. sorts (List<:class:`~plexapi.library.FilteringSort`>): List of sort objects. title (str): The title for the libtype filter. type (str): The libtype for the filter. Typec|j|jd}ddj|jj|fDcgc]}|s| c}dScc}wNr7_clean firstAttrr`rrr-_typeps r/__repr__zFilteringType.__repr__j R DNN623388)@)@%(HN1AQNOPPQRRN A A c||_tjt|jj dd|_|j|t|_ |j|t|_ |jj d|_ |j|t|_|jj d|_|jj d|_|j#j|_|xj|j'z c_ |xj|j)z c_|xj|j+z c_ y)Nactive0rArBr7)r'rrrr(r)r"rFilteringFieldr{FilteringFilterrrArrxrBr7_parent_librarySectionID_manualFilters _manualSorts _manualFieldsr,s r/r0zFilteringType._loadDatan s jjt{{x'EF nnT>: ~~dO< ;;??5)^^D-8 [[__W- KKOOF+ !%!3!3 ++--  d''))  t))++ r1c Bg}|jdk(r|jdgn|jdk(r|jdgne|jdk(r|jdgnC|jdk(r|jdgn!|jdk(r|jdgg}|D]l\}}}d|jd|d tj|j}d |d |d |d |d }|j |j |tn|S)zm Manually add additional filters which are available but not exposed on the Plex server. rU)labelrLabelsrQr5rcrr/z?type=z)r7rr'rrrrEr\r%)r-additionalFilters manualFilters filterTagr filterTitle filterKey filterXMLs r/r(zFilteringType._manualFilters sj   99  $ $-& YY) #  $ $-& YY( "  $ $-& YY' !  $ $-& YY, &  $ $-&  2C T .Iz;,T-C-C,DAi[PVW\WgWghlhqhqWrVstI"9+.)l+!{#%'#$   !6!6y/!R S Tr1c dddd|jjdfdddg}|jd k(r|jd gne|jd k(r|jd gnC|jd k(r|jdgn!|jdk(r|jdgg}|D]:\}}}d|d|d|d|d }|j|j |t <|S)zk Manually add additional sorts which are available but not exposed on the Plex server. )rrr)r)r Rating Keyindexr Number)summaryrSummary)taglinerTagline)rr Date UpdatedrU) titleSortrTitlerc) absoluteIndexrzAbsolute Indexr6) viewUpdatedAtrzView Updated Atr)addedAtr Date Addedz)r7 capitalizerrEr\r)r-additionalSorts manualSortsrr sortTitlesortXMLs r/r)zFilteringType._manualSorts s> $ ' e 4 4 67w? @ ) ) 0   99  " "-$ YY' !  " ":$ YY' !  " "<$ YY, &  " "0$  -< N )Iw *7)4%;'!{##D*    t44WmL M Nr1cFdddd|jjdfdd|jjdfd d d g}|jd k(r|jgd n|jdk(r|jgdn|jdk(r|jgdn|jdk(r|jgdng|jdk(r|jdgnE|jdk(r|jgdn"|jdk(r|jddg|jd k(rdn|jdz}g}|D]A\}}}|dvr||}d|d|d|d }|j|j |t C|S)!zl Manually add additional fields which are available but not exposed on the Plex server. )rrr)r)rr7r8rr9 lastRatedAtrz Last Rated)rrr>)grouprzSQL Group By Statement)havingrzSQL Having Clauser3)audienceRatingrzAudience Ratingratingrz Critic Rating viewOffsetrz View Offsetr4)rN)originallyAvailableAtrzShow Release DaterPunviewedLeafCountrzEpisode Unplayed CountrU))rCrzDate Season AddedrU)yearrz Season Yearr,rrrQ)rNdurationrDurationrPrRrXr5rXrc)rYrRrX) ratingCountrz Rating Countr)rCrrDrr>rLrMz )r7rErrEr\r$)r-additionalFieldsprefix manualFieldsr5rq fieldTitlefieldXMLs r/r*zFilteringType._manualFields s % + iDII$8$8$:#;7!C D Ftyy';';'=&>k$J K 1 9 5  99   # #%  YY&  # #%  YY( "  # #%  YY) #  # #% YY( "  # #)% YY' !  # #%  YY, &  # #1)%  yyG+S ,< Q (E9j//!(5'*ug&$&" 3(     5 5h O P Qr1N) rrrrrOrr0r(r)r*rhr1r/rZrZ[ s+  CS,$)V*XJr1rZceZdZdZdZdZy)r%a Represents a single Filter object for a :class:`~plexapi.library.FilteringType`. Attributes: TAG (str): 'Filter' filter (str): The key for the filter. filterType (str): The :class:`~plexapi.library.FilteringFieldType` type (string, boolean, integer, date, etc). key (str): The API URL path for the filter. title (str): The title of the filter. type (str): 'filter' FiltercR||_|jjd|_|jjd|_|jjd|_|jjd|_|jjd|_y)NrVrrArBr7)r'r(r)rVrrArBr7r,s r/r0zFilteringFilter._loadData1 sm kkooh/ ++//,7;;??5)[[__W- KKOOF+ r1Nrrhr1r/r%r%$ s  C,r1r%ceZdZdZdZdZy)ra Represents a single Sort object for a :class:`~plexapi.library.FilteringType`. Attributes: TAG (str): 'Sort' active (bool): True if the sort is currently active. activeDirection (str): The currently active sorting direction. default (str): The currently active default sorting direction. defaultDirection (str): The default sorting direction. descKey (str): The URL key for sorting with desc. firstCharacterKey (str): API URL path for first character endpoint. key (str): The URL key for the sorting. title (str): The title of the sorting. SortcD||_tjt|jj dd|_|jj d|_|jj d|_|jj d|_ |jj d|_ |jj d|_ |jj d|_ |jj d |_ y ) rr"r#activeDirectionr2rdescKeyfirstCharacterKeyrArBN)r'rrrr(r)r"rhr2rrirjrArBr,s r/r0zFilteringSort._loadDataJ s jjt{{x'EF #{{/@A{{y1 $ 0B C{{y1 !%1D!E;;??5)[[__W- r1Nrrhr1r/rr: s  C .r1rceZdZdZdZdZy)r$a Represents a single Field object for a :class:`~plexapi.library.FilteringType`. Attributes: TAG (str): 'Field' key (str): The URL key for the filter field. title (str): The title of the filter field. type (str): The :class:`~plexapi.library.FilteringFieldType` type (string, boolean, integer, date, etc). subType (str): The subtype of the filter (decade, rating, etc). Fieldc||_|jjd|_|jjd|_|jjd|_|jjd|_y)rrArBr7subTypeN)r'r(r)rArBr7rnr,s r/r0zFilteringField._loadDatac sY ;;??5)[[__W- KKOOF+ {{y1 r1Nrrhr1r/r$r$W s C2r1r$c eZdZdZdZdZdZy)r[a. Represents a single FieldType for library filtering. Attributes: TAG (str): 'FieldType' type (str): The filtering data type (string, boolean, integer, date, etc). operators (List<:class:`~plexapi.library.FilteringOperator`>): List of operator objects. FieldTypec|j|jd}ddj|jj|fDcgc]}|s| c}dScc}wrrrs r/rzFilteringFieldType.__repr__v rr c||_|jjd|_|j |t |_y)rr7N)r'r(r)r7rFilteringOperatorr~r,s r/r0zFilteringFieldType._loadDataz s0 KKOOF+ .?@r1N)rrrrrOrr0rhr1r/r[r[l s CSAr1r[ceZdZdZdZdZy)rsz Represents an single Operator for a :class:`~plexapi.library.FilteringFieldType`. Attributes: TAG (str): 'Operator' key (str): The URL key for the operator. title (str): The title of the operator. Operatorc|jjd|_|jjd|_yrrArBNr(r)rArBr,s r/r0zFilteringOperator._loadData *;;??5)[[__W- r1Nrrhr1r/rsrs s C.r1rsc eZdZdZdZdZdZy)ra Represents a single FilterChoice object. These objects are gathered when using filters while searching for library items and is the object returned in the result set of :func:`~plexapi.library.LibrarySection.listFilterChoices`. Attributes: TAG (str): 'Directory' fastKey (str): API URL path to quickly list all items with this filter choice. (/library/sections/
/all?genre=) key (str): The id value of this filter choice. thumb (str): Thumbnail URL for the filter choice. title (str): The title of the filter choice. type (str): The filter type (genre, contentRating, etc). r9cR||_|jjd|_|jjd|_|jjd|_|jjd|_|jjd|_y)rfastKeyrArrBr7N)r'r(r)r|rArrBr7r,s r/r0zFilterChoice._loadData sm {{y1 ;;??5)[[__W- [[__W- KKOOF+ r1c8|j|jS)z1 Returns a list of items for this filter choice. )rdr|rOs r/rjzFilterChoice.items st||,,r1Nrrhr1r/rr s  C,-r1rcZeZdZdZdZdZdZddZdZddZ d Z d Z d Z d Z d ZdZy)ra Represents a Managed Hub (recommendation) inside a library. Attributes: TAG (str): 'Hub' deletable (bool): True if the Hub can be deleted (promoted collection). homeVisibility (str): Promoted home visibility (none, all, admin, or shared). identifier (str): Hub identifier for the managed hub. promotedToOwnHome (bool): Promoted to own home. promotedToRecommended (bool): Promoted to recommended. promotedToSharedHome (bool): Promoted to shared home. recommendationsVisibility (str): Promoted recommendation visibility (none or all). title (str): Title of managed hub. rcr||_tjt|jj dd|_|jj dd|_|jj d|_tjt|jj dd|_ tjt|jj dd|_ tjt|jj d d|_ |jj d d|_ |jj d |_ d|_|j}t!|t"r|j$|_y |j&|_y ) r deletableThomeVisibilitynoner#promotedToOwnHomeFpromotedToRecommendedpromotedToSharedHomerecommendationsVisibilityrBN)r'rrrr(r)rrr#rrrrrB _promotedr&r_r@rAr)r-r.parents r/r0zManagedHub._loadData s$ D$++//+t*LM"kkoo.>G++//,7!&D$++//BUW\2]!^%*ZZdkkooF]_d6e%f"$)JJtT[[__E[]b5c$d!)-9TV\)]&[[__W- .8.P V\VmVmr1cd|jd}|j||j|j}|jj |j|S)z' Reload the data for this managed hub. rr)r#)rr&rr#rr)r-rArjs r/rzManagedHub.reload sN 5 56g>nnS$..T__nM S\\* r1Nc|js tdd|jd|jd}|r|d|j}|jj ||jj jy)aq Move a managed hub to a new position in the library's Managed Recommendations. Parameters: after (obj): :class:`~plexapi.library.ManagedHub` object to move the item after in the collection. Raises: :class:`plexapi.exceptions.BadRequest`: When trying to move a Hub that is not a Managed Recommendation. z7Collection must be a Managed Recommendation to be movedr/manage/z/movez?after=ryN)rrrr#r>r?r|r})r-afterrAs r/movezManagedHub.move sx~~VW W 5 56ht>OuU E!1!1 23C 3t||'<'<'@'@Ar1cB|js td|js%t|jd|jzd|jd|j }|j j||j jjy)a Removes a managed hub from the library's Managed Recommendations. Raises: :class:`plexapi.exceptions.BadRequest`: When trying to remove a Hub that is not a Managed Recommendation or when the Hub cannot be removed. z9Collection must be a Managed Recommendation to be removedz managed hub cannot be removedrrryN) rrrrBrr#r>r?r|rrs r/rzManagedHub.remove s~~XY Y~~ |+IJTZZWX X 5 56ht>OP 3t||'<'<'C'CDr1ct|jt|jt|jd}|t||d<|t||d<|t||d<|js}|j j dd|d<d|jd }|jj||jjj| |jSd|jd |j }|jj||jjj| |jS) a Update the managed hub's visibility settings. Parameters: recommended (bool): True to make visible on your Library Recommended page. False to hide. Default None. home (bool): True to make visible on your Home page. False to hide. Default None. shared (bool): True to make visible on your Friends' Home page. False to hide. Default None. Example: .. code-block:: python managedHub.updateVisibility(recommended=True, home=True, shared=False).reload() # or using chained methods managedHub.promoteRecommended().promoteHome().demoteShared().reload() )rrrrrrrrSmetadataItemIdrr)rzrr)rrrrrr#rsplitrr>r?r|rr}r)r- recommendedhomesharedrrAs r/updateVisibilityzManagedHub.updateVisibility s>$&))C)C%D!$T%;%;!<$'(A(A$B   ".1+.>F* +  *-d)F& '  -0[F) *~~'+'='=c'B2'FF# $#D$9$9#:'BC LL  s4<<+@+@+E+Ef  U{{}$D$9$9#:(4??BSTC LL  s4<<+@+@+D+DV  T{{}r1c&|jdS)z8 Show the managed hub on your Library Recommended Page. TrrrOs r/promoteRecommendedzManagedHub.promoteRecommended s$$$66r1c&|jdS)z8 Hide the managed hub on your Library Recommended Page. FrrrOs r/demoteRecommendedzManagedHub.demoteRecommended s$$$77r1c&|jdS)z) Show the managed hub on your Home Page. TrrrOs r/ promoteHomezManagedHub.promoteHome" s$$$$//r1c&|jdS)z( Hide the manged hub on your Home Page. FrrrOs r/ demoteHomezManagedHub.demoteHome& s$$%$00r1c&|jdS)z2 Show the managed hub on your Friends' Home Page. TrrrOs r/ promoteSharedzManagedHub.promoteShared* s$$D$11r1c&|jdS)z2 Hide the managed hub on your Friends' Home Page. FrrrOs r/ demoteSharedzManagedHub.demoteShared. s$$E$22r1rdr4)rrrrrOr0rrrrrrrrrrrhr1r/rr sI  Cn B E$L780123r1rc"eZdZdZdZdZdZy)rz Represents a Folder inside a library. Attributes: key (str): Url key for folder. title (str): Title of folder. c|jjd|_|jjd|_yrwrxr,s r/r0zFolder._loadData; ryr1c|jjdr|j|jS|j|jtS)z Returns a list of available :class:`~plexapi.library.Folder` for this folder. Continue down subfolders until a mediaType is found. /library/metadata)rArrdrrOs r/ subfolderszFolder.subfolders@ s? 88  2 3??488, ,??488V4 4r1cg}|jD]r}|jjdr|j| |jD]/}|jjdr|j|1t|S)z Returns a list of all available :class:`~plexapi.library.Folder` for this folder. Only returns :class:`~plexapi.library.Folder`. r)rrArrE)r-rfolder subfolders r/ allSubfolderszFolder.allSubfoldersI soo' F::(()<=v&%+%6%6%8% (}}778KL#NN95$% r1N)rrrrr0rrrhr1r/rr3 s. 5r1rceZdZdZdZy)rJa  Represents a First Character element from a library. Attributes: key (str): Url key for character. size (str): Total amount of library items starting with this character. title (str): Character (#, !, A, B, C, ...). c||_|jjd|_|jjd|_|jjd|_y)rrArrBN)r'r(r)rArrBr,s r/r0zFirstCharacter._loadDatac sE ;;??5)KKOOF+ [[__W- r1N)rrrrr0rhr1r/rJrJZ s .r1rJc(eZdZdZdZdZddZdZy)Pathak Represents a single directory Path. Attributes: TAG (str): 'Path' home (bool): True if the path is the home directory key (str): API URL (/services/browse/) network (bool): True if path is a network location path (str): Full path to folder title (str): Folder name ctjt|jj d|_|jj d|_tjt|jj d|_|jj d|_|jj d|_ y)NrrAnetworkrrB) rrrr(r)rrArrrBr,s r/r0zPath._loadDatay s|JJtT[[__V%<= ;;??5)zz$  (BC KKOOF+ [[__W- r1c:|jj||S)z6 Alias for :func:`~plexapi.server.PlexServer.browse`. )r>browse)r- includeFiless r/rz Path.browse s||""466r1c#bK|jj|D] \}}}|||fyw)z4 Alias for :func:`~plexapi.server.PlexServer.walk`. N)r>walk)r-rpathsfiless r/rz Path.walk s8"&,,"3"3D"9 % D%u$ $ %s-/N)T)rrrrrOr0rrrhr1r/rrk s  C.7%r1rceZdZdZdZdZy)Filez Represents a single File. Attributes: TAG (str): 'File' key (str): API URL (/services/browse/) path (str): Full path to file title (str): File name c|jjd|_|jjd|_|jjd|_y)NrArrB)r(r)rArrBr,s r/r0zFile._loadData s>;;??5)KKOOF+ [[__W- r1Nrrhr1r/rr s C.r1rcFeZdZdZdZdZdZedZedZ dZ y)r'a Represents a Common element from a library. This object lists common fields between multiple objects. Attributes: TAG (str): 'Common' collections (List<:class:`~plexapi.media.Collection`>): List of collection objects. contentRating (str): Content rating of the items. countries (List<:class:`~plexapi.media.Country`>): List of countries objects. directors (List<:class:`~plexapi.media.Director`>): List of director objects. editionTitle (str): Edition title of the items. fields (List<:class:`~plexapi.media.Field`>): List of field objects. genres (List<:class:`~plexapi.media.Genre`>): List of genre objects. grandparentRatingKey (int): Grandparent rating key of the items. grandparentTitle (str): Grandparent title of the items. guid (str): Plex GUID of the items. guids (List<:class:`~plexapi.media.Guid`>): List of guid objects. index (int): Index of the items. key (str): API URL (/library/metadata/). labels (List<:class:`~plexapi.media.Label`>): List of label objects. mixedFields (List): List of mixed fields. moods (List<:class:`~plexapi.media.Mood`>): List of mood objects. originallyAvailableAt (datetime): Datetime of the release date of the items. parentRatingKey (int): Parent rating key of the items. parentTitle (str): Parent title of the items. producers (List<:class:`~plexapi.media.Producer`>): List of producer objects. ratingKey (int): Rating key of the items. ratings (List<:class:`~plexapi.media.Rating`>): List of rating objects. roles (List<:class:`~plexapi.media.Role`>): List of role objects. studio (str): Studio name of the items. styles (List<:class:`~plexapi.media.Style`>): List of style objects. summary (str): Summary of the items. tagline (str): Tagline of the items. tags (List<:class:`~plexapi.media.Tag`>): List of tag objects. title (str): Title of the items. titleSort (str): Title to use when sorting of the items. type (str): Type of the media (common). writers (List<:class:`~plexapi.media.Writer`>): List of writer objects. year (int): Year of the items. c ||_|j|tj|_|j j d|_|j|tj|_ |j|tj|_ |j j d|_ |j|tj|_|j|tj|_t#j$t&|j j d|_|j j d|_|j j d|_|j|tj.|_t#j$t&|j j d|_|j j d|_|j|tj6|_|j j dj;d |_|j|tj>|_ t#jB|j j d |_"t#j$t&|j j d |_#|j j d |_$|j|tjJ|_&t#j$t&|j j d |_'|j|tjP|_)|j|tjT|_+|j j d|_,|j|tjZ|_.|j j d|_/|j j d|_0|j|tjb|_2|j j d|_3|j j d|_4|j j d|_5|j|tjl|_7t#j$t&|j j d|_8y)N contentRating editionTitlegrandparentRatingKeygrandparentTitlerr8rA mixedFieldsr]rTparentRatingKey parentTitler#studior:r<rBr?r7rW)9r'rrrrYr(r)rr countriesr directorsrrlr{rgenresrrrrrrrguidsr8rArlabelsrrrmoodsrrTrrr producersr#Ratingratingsrrolesrr stylesr:r<rrrBr?r7rwritersrWr,s r/r0zCommon._loadData s >>$0@0@A![[___=emm<enn= KKOON;nnT5;;7 nnT5;;7 $)JJsDKKOODZ4[$\! $ 0B CKKOOF+ ^^D%**5 ZZT[[__W%=> ;;??5)nnT5;;7 ;;??=9??D^^D%**5 %*%5%5dkkooF]6^%_"$zz#t{{?P/QR;;??=9enn=C)EF~~dELL9 ^^D%**5 kkooh/ nnT5;;7 {{y1 {{y1 NN43 [[__W- 5KKOOF+ ~~dELL9 JJsDKKOOF$;< r1c d|jjd|jddjd|jDdS)Nrrr]c32K|]}t|ywrd)rb)rfrAs r/rhz"Common.__repr__.. s9#SX9sr)rr commonTyper` ratingKeysrOs r/rzCommon.__repr__ s6 NN # # OO HH99 9  r1ctt|jj}t j |ddS)z- Returns the media type of the common items. r7r)r r _initpathr?rreverseSearchType)r- parsed_querys r/rzCommon.commonType s8  8 > >? &&|F';A'>??r1ctt|jj}|ddj dDcgc]}t |j c}Scc}w)z5 Returns a list of rating keys for the common items. r)rr])r r rr?rrrD)r-rrvs r/rzCommon.ratingKeys sQ  8 > >? 0rdrrOs r/rjz Common.items s||&&t77r1N) rrrrrOr0rr5rrrjrhr1r/r'r' sK%L C"=H @@ RR 8r1r')e __future__rrtypingrrrVrYrr functoolsr urllib.parser r r r plexapir rr plexapi.baserrplexapi.exceptionsrrplexapi.mixinsrrrrrrrrrplexapi.settingsr plexapi.utilsr plexapi.audiorr!r@r:r;r<r=registerPlexObjectr@rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr r rrrrZr%rr$r[rsrrrrJrrr'rhr1r/rsw" %#%BB%%.3%$#~$j~$B rZrj+98>?98xQ7..2BDUQ7hr.>#3_or.jG8>#7G8T$Ej$E$EN,z,,"0*00f4)j4)n/oooo__O?/O??_OO?oO_/_?o_O/O_FJFR,j,,.J.:2Z2*AA* . . -:-