g>hddlZddlmZddlmZddlmZddlZddlm Z m Z m Z m Z m Z ddlmZddlmZddlmZdd lmZdd lmZdd lmZmZmZdd lmZmZmZmZdd l m!Z!m"Z"ddl#m$Z$ddl%m&Z&ddl'm(Z(ddl)m*Z*ddl+m,Z-ddlm.Z/ddlm0Z1ddlm2Z3ddlm4Z5ddlm6Z7ddlm8Z9GddeZ:GddeZ;GddeZGd!d"eZ?Gd#d$eZ@Gd%d&eZAGd'd(eZBejzGd)d*eZCGd+d,eZDy)-N)cached_property) urlencode) ElementTree) BASE_HEADERSCONFIGTIMEOUTlog logfilter)utils) AlertListener) PlexObject) PlexClient) Collection) BadRequestNotFound Unauthorized)HubLibraryPathFile) Conversion Optimized)Playlist) PlayQueue)Settings) deprecated)_codes)audio) collection)media)photo)playlist)videoceZdZdZdZdAfd ZdZdZdZe dZ e dZ d Z d Z d Zd Zed ZdBdZdCdZdDdZdZdZdZdZdZdZdEdZdBdZdZdZdZ dFdZ dGdZ!dZ"dHdZ#dHd Z$d!Z%d"Z&e'd#dId$Z(dId%Z)d&Z*d'Z+d(Z,dJd)Z-dAd*Z.d+Z/dBd,Z0e'd-d.Z1dBd/Z2d0Z3dAd1Z4dKd2Z5d3Z6d4Z7d5Z8dDd6Z9 dLd7Z:dBd8Z;d9ZdMd<Z?dBd=Z@d>ZAdDd?ZBdDd@ZCxZDS)N PlexServera This is the main entry point to interacting with a Plex server. It allows you to list connected clients, browse your library sections and perform actions such as emptying trash. If you do not know the auth token required to access your Plex server, or simply want to access your server with your username and password, you can also create an PlexServer instance from :class:`~plexapi.myplex.MyPlexAccount`. Parameters: baseurl (str): Base url for to access the Plex Media Server (default: 'http://localhost:32400'). token (str): Required Plex authentication token to access the server. session (requests.Session, optional): Use your own session object if you want to cache the http responses from the server. timeout (int, optional): Timeout in seconds on initial connection to the server (default config.TIMEOUT). Attributes: allowCameraUpload (bool): True if server allows camera upload. allowChannelAccess (bool): True if server allows channel access (iTunes?). allowMediaDeletion (bool): True is server allows media to be deleted. allowSharing (bool): True is server allows sharing. allowSync (bool): True is server allows sync. backgroundProcessing (bool): Unknown certificate (bool): True if server has an HTTPS certificate. companionProxy (bool): Unknown diagnostics (bool): Unknown eventStream (bool): Unknown friendlyName (str): Human friendly name for this server. hubSearch (bool): True if `Hub Search `_ is enabled. I believe this is enabled for everyone machineIdentifier (str): Unique ID for this server (looks like an md5). multiuser (bool): True if `multiusers `_ are enabled. myPlex (bool): Unknown (True if logged into myPlex?). myPlexMappingState (str): Unknown (ex: mapped). myPlexSigninState (str): Unknown (ex: ok). myPlexSubscription (bool): True if you have a myPlex subscription. myPlexUsername (str): Email address if signed into myPlex (user@example.com) ownerFeatures (list): List of features allowed by the server owner. This may be based on your PlexPass subscription. Features include: camera_upload, cloudsync, content_filter, dvr, hardware_transcoding, home, lyrics, music_videos, pass, photo_autotags, premium_music_metadata, session_bandwidth_restrictions, sync, trailers, webhooks (and maybe more). photoAutoTag (bool): True if photo `auto-tagging `_ is enabled. platform (str): Platform the server is hosted on (ex: Linux) platformVersion (str): Platform version (ex: '6.1 (Build 7601)', '4.4.0-59-generic'). pluginHost (bool): Unknown readOnlyLibraries (bool): Unknown requestParametersInCookie (bool): Unknown streamingBrainVersion (bool): Current `Streaming Brain `_ version. sync (bool): True if `syncing to a device `_ is enabled. transcoderActiveVideoSessions (int): Number of active video transcoding sessions. transcoderAudio (bool): True if audio transcoding audio is available. transcoderLyrics (bool): True if audio transcoding lyrics is available. transcoderPhoto (bool): True if audio transcoding photos is available. transcoderSubtitles (bool): True if audio transcoding subtitles is available. transcoderVideo (bool): True if audio transcoding video is available. transcoderVideoBitrates (bool): List of video bitrates. transcoderVideoQualities (bool): List of video qualities. transcoderVideoResolutions (bool): List of video resolutions. updatedAt (int): Datetime the server was updated. updater (bool): Unknown version (str): Current Plex version (ex: 1.3.2.3112-1751929) voiceSearch (bool): True if voice search is enabled. (is this Google Voice search?) _baseurl (str): HTTP address of the client. _token (str): Token used to access this client. _session (obj): Requests session object used to access this client. /cL|xstjdd|_|jjd|_t j |xstjd|_tjddjdk(|_|xstj|_ |xst|_ d|_d|_d|_|j#|j$|j}t&t(|W|||j$y) Nzauth.server_baseurlzhttp://localhost:32400r&zauth.server_tokenzlog.show_secretstrue)timeout)rget_baseurlrstripr add_secret_tokenlower _showSecretsrequestsSession_sessionr_timeout_myPlexAccount_systemAccounts_systemDevicesquerykeysuperr%__init__)selfbaseurltokensessionr*data __class__s #/opt/Tautulli/lib/plexapi/server.pyr<zPlexServer.__init__js^6::.CE]#^  ,,S1 **5+SFJJ?R4ST "JJ'92>DDF&P58#3#3#5 *7 "#"zz$((DMMz: j$(tTXX>c||_tjt|jj d|_tjt|jj d|_tjt|jj d|_tjt|jj d|_ tjt|jj d|_ tjt|jj d|_ tjt|jj d|_ tjt|jj d|_ tj|jj d |_tjt|jj d |_|jj d |_tjt|jj d |_|jj d |_tjt|jj d|_tjt|jj d|_|jj d|_|jj d|_tjt|jj d|_|jj d|_tj|jj d|_tjt|jj d|_|jj d|_|jj d|_tjt|jj d|_tjt>|jj d|_ tjt|jj d|_!|jj d|_"tjt|jj d|_#t?|jj dd|_$tjt|jj d|_%tjt|jj d |_&tjt|jj d!|_'tjt|jj d"|_(tjt|jj d#|_)tj|jj d$|_*tj|jj d%|_+tj|jj d&|_,tjZ|jj d'|_.tjt|jj d(|_/|jj d)|_0tjt|jj d*|_1y+),z/ Load attribute values from Plex XML response. allowCameraUploadallowChannelAccessallowMediaDeletion allowSharing allowSyncbackgroundProcessing certificatecompanionProxy diagnostics eventStream friendlyName hubSearchmachineIdentifier multiusermyPlexmyPlexMappingStatemyPlexSigninStatemyPlexSubscriptionmyPlexUsername ownerFeatures photoAutoTagplatformplatformVersion pluginHostreadOnlyLibrariesrequestParametersInCookiestreamingBrainVersionsynctranscoderActiveVideoSessionsrtranscoderAudiotranscoderLyricstranscoderPhototranscoderSubtitlestranscoderVideotranscoderVideoBitratestranscoderVideoQualitiestranscoderVideoResolutions updatedAtupdaterversion voiceSearchN)2_datar castboolattribr+rFrGrHrIrJrKrLrMtoListrNrOrPrQrRrSrTrUrVrWrXrYrZr[r\r]intr^r_r`rarbrcrdrerfrgrhrirj toDatetimerkrlrmrnr=rAs rC _loadDatazPlexServer._loadDataws !&D$++//BU2V!W"'**T4;;??CW3X"Y"'**T4;;??CW3X"Y!JJtT[[__^-LMD$++//+*FG$)JJtT[[__E[5\$]! ::dDKKOOM,JK#jjt{{?O/PQ <<  (FG ::dDKKOOM,JK KKOON;D$++//+*FG!%1D!ED$++//+*FGjjt{{x'@A "&++//2F"G!%1D!E"'**T4;;??CW3X"Y"kkoo.>?"\\$++///*JK!JJtT[[__^-LM  3 #{{/@A**T4;;??<+HI!&CAT1U!V).D$++//Je:f)g&%)[[__5L%M"JJtT[[__V%<= -0A`bc1d-e*$zz$ @Q0RS % 4AS1T U$zz$ @Q0RS#(::dDKKOODY4Z#[ $zz$ @Q0RS',||DKKOOD]4^'_$(- T[[__E_5`(a%*/,,t{{Gc7d*e'))$++//+*FGzz$  (BC {{y1  ::dDKKOOM,JKrDc tj}|jr|j|d<|j||S)zF Returns dict containing base headers for all requests to the server. z X-Plex-Token)rcopyr/update)r=kwargsheaderss rC_headerszPlexServer._headerss6##% ;;&*kkGN #vrDc"d|jdS)Nz server:///com.plexapp.plugins.library)rRr=s rC_uriRootzPlexServer._uriRoots41122NOOrDc |jtj}t||S#t$r|jd}Y(wxYw)z) Library to browse or search your media. z/library/sections/)r9rr:rrvs rClibraryzPlexServer.librarysJ 4::gkk*D tT""  4::23D 4s-A  A cX|jtj}t||S)z( Returns a list of all server settings. )r9rr:rvs rCsettingszPlexServer.settingss#zz(,,'d##rDc<|jd}t||S)z# Returns the Plex server identity. z /identity)r9Identityrvs rCidentityzPlexServer.identityszz+&d##rDcX|jtj}t||S)zM Returns the :class:`~plexapi.server.Account` object this server belongs to. )r9Accountr:rvs rCaccountzPlexServer.accounts!zz'++&tT""rDcd}d|ji}|j||jj|}t ||S)a> Claim the Plex server using a :class:`~plexapi.myplex.MyPlexAccount`. This will only work with an unclaimed server on localhost or the same subnet. Parameters: account (:class:`~plexapi.myplex.MyPlexAccount`): The account used to claim the server. z /myplex/claimr?)methodparams) claimTokenr9r4postr)r=rr:rrAs rCclaimzPlexServer.claimsG7--/0zz#dmm&8&8zHtT""rDc|jtj|jj}t||S)z| Unclaim the Plex server. This will remove the server from your :class:`~plexapi.myplex.MyPlexAccount`. r)r9rr:r4deletervs rCunclaimzPlexServer.unclaims1zz'++dmm.B.BzCtT""rDcg}|jtjD]}|jt|||S)z#Returns all current PMS activities.)r9Activityr:append)r= activitieselems rCrzPlexServer.activitiess@ JJx||, 4D   htT2 3 4rDcbd}|r|dtj|z }|j|S)zT Returns a list of :class:`~plexapi.media.Agent` objects this server has available. z/system/agentsz ?mediaType=)r searchType fetchItems)r= mediaTyper:s rCagentszPlexServer.agentss6  [!1!1)!< => >Cs##rDc|jsy|jd|d|}|jjdS)z, Create a temp access token for the server. Nz/security/token?type=z&scope=r?)r/r9rrr+)r=typescopeqs rC createTokenzPlexServer.createTokens;{{ JJ.tfGE7C Dxx||G$$rDcddlm}t||r|n|jj |}|j |j }| |j}| |j}t|j|||S)a Returns a new :class:`~plexapi.server.PlexServer` object logged in as the given username. Note: Only the admin account can switch to other users. Parameters: user (:class:`~plexapi.myplex.MyPlexUser` or str): `MyPlexUser` object, username, email, or user id of the user to log in to the server. session (requests.Session, optional): Use your own session object if you want to cache the http responses from the server. This will default to the same session as the admin account if no new session is provided. timeout (int, optional): Timeout in seconds on initial connection to the server. This will default to the same timeout as the admin account if no new timeout is provided. Example: .. code-block:: python from plexapi.server import PlexServer # Login to the Plex server using the admin token plex = PlexServer('http://plexserver:32400', token='2ffLuB84dqLswk9skLos') # Login to the same Plex server using a different account userPlex = plex.switchUser("Username") r) MyPlexUser)r?r@r*) plexapi.myplexr isinstance myPlexAccountuser get_tokenrRr4r5r%r,)r=rr@r*r userTokens rC switchUserzPlexServer.switchUsersr2 .!$ 3t9K9K9M9R9RSW9XNN4#9#9: ?mmG ?mmG$--y'SZ[[rDcl|jd}|j|t|_|jS)zX Returns a list of :class:`~plexapi.server.SystemAccount` objects this server contains. z /accounts)r7r SystemAccountr=r:s rCsystemAccountszPlexServer.systemAccountss2    'C#'??3 #FD ###rDc tfd|jDS#t$rtddwxYw)z Returns the :class:`~plexapi.server.SystemAccount` object for the specified account ID. Parameters: accountID (int): The :class:`~plexapi.server.SystemAccount` ID. c3BK|]}|jk(s|ywNid).0r accountIDs rC z+PlexServer.systemAccount..%s`G V_H_`zUnknown account with accountID=N)nextr StopIterationr)r=rs `rC systemAccountzPlexServer.systemAccountsI  T`t/B/B/D`` ` Tcl|jd}|j|t|_|jS)zW Returns a list of :class:`~plexapi.server.SystemDevice` objects this server contains. z/devices)r8r SystemDevicers rC systemDeviceszPlexServer.systemDevices)s2    &C"&//#|"DD """rDc tfd|jDS#t$rtddwxYw)z Returns the :class:`~plexapi.server.SystemDevice` object for the specified device ID. Parameters: deviceID (int): The :class:`~plexapi.server.SystemDevice` ID. c3BK|]}|jk(s|ywrr)rdevicedeviceIDs rCrz*PlexServer.systemDevice..7s[6VYYRZEZ[rzUnknown device with deviceID=N)rrrr)r=rs `rC systemDevicezPlexServer.systemDevice0sI  Q[T-?-?-A[[ [ Q:8*EFD P Qrc|j)ddlm}||j|j|_|jS)z Returns a :class:`~plexapi.myplex.MyPlexAccount` object using the same token to access this server. If you are not the owner of this PlexServer you're likely to receive an authentication error calling this. r) MyPlexAccount)r?r@)r6rrr/r4)r=rs rCrzPlexServer.myPlexAccount;s6    & 4"/dkk4=="YD """rDcR i}|j}|jD]R}|jsd|jdddvs%|jdjdd||j<T|S#t $r"}t jd|cYd}~Sd}~wwxYw)a1 Sometimes the PlexServer does not properly advertise port numbers required to connect. This attempts to look up device port number from plex.tv. See issue #126: Make PlexServer.clients() more user friendly. https://github.com/pkkid/python-plexapi/issues/126 :rNz,Unable to fetch client ports from myPlex: %s)rdevices connectionssplitclientIdentifier Exceptionr warning)r=portsrrerrs rC_myPlexClientPortszPlexServer._myPlexClientPortsEs E((*G!//+ Z%%#1C1CA1Fqr1J*J5;5G5G5J5P5PQT5UVX5YE&112 ZL  KKF LL s(1A;A; 1A;; B&B!B&!B&ct|tr |j}n|tj|}d|}nd}|dt |z }|j |S)a Browse the system file path using the Plex API. Returns list of :class:`~plexapi.library.Path` and :class:`~plexapi.library.File` objects. Parameters: path (:class:`~plexapi.library.Path` or str, optional): Full path to browse. includeFiles (bool): True to include files when browsing (Default). False to only return folders. z/services/browse/z/services/browsez?includeFiles=)rrr:r base64strrtr)r=path includeFilesr: base64paths rCbrowsezPlexServer.browseVsb dD !((C  .J%j\2C$C L 1233s##rDc#fKg}g}|j|D]F}t|tr|j|%t|ts6|j|Ht|tr |j }|xsd||f|D]#}|j |D] \}}}|||f%yw)a Walk the system file tree using the Plex API similar to `os.walk`. Yields a 3-tuple `(path, paths, files)` where `path` is a string of the directory path, `paths` is a list of :class:`~plexapi.library.Path` objects, and `files` is a list of :class:`~plexapi.library.File` objects. Parameters: path (:class:`~plexapi.library.Path` or str, optional): Full path to walk. r(N)rrrrrrwalk)r=rpathsfilesitem_paths rCrzPlexServer.walkisKK% #D$% T"D$' T"  # dD !99Djb%&& )E&*ii&6 )"eUE5(( ) )s A B1A#B1ct|tr |j}|jtjj |dDcgc]}|j}}||vScc}w)z Returns True if the Plex server can browse the given path. Parameters: path (:class:`~plexapi.library.Path` or str): Full path to browse. F)r)rrrrosdirname)r=rprs rC isBrowsablezPlexServer.isBrowsablesY dD !99D!%RWW__T-BQV!WXAXXu}YsA(c g}d}|jdD]}|jjd}|smtjd|jjd||j n|}|j|jjd}d|jdd |}|j t|||j|d |S) zV Returns list of all :class:`~plexapi.client.PlexClient` objects connected to server. Nz/clientsportz.%s did not advertise a port, checking plex.tv.namerRzhttp://hostrF)r>serverr?rAconnect) r9rrr+r rrrrr/)r=itemsrrrr>s rCclientszPlexServer.clientssJJz* RD;;??6*D Ldkkoo^dNef5:]//1yy1D!EF F 34AdV>": "4w", "genre": "comedy"} ) )rsmartlimitlibtypesortfilters)rcreate) r=rsectionrrrrrrr{s rCcreateCollectionzPlexServer.createCollections>h  %C(-U%$C;AC CrDc Btj||f|||||||| d| S)a" Creates and returns a new :class:`~plexapi.playlist.Playlist`. Parameters: title (str): Title of the playlist. section (:class:`~plexapi.library.LibrarySection`, str): Smart playlists and m3u import only, the library section to create the playlist in. items (List): Regular playlists only, list of :class:`~plexapi.audio.Audio`, :class:`~plexapi.video.Video`, or :class:`~plexapi.photo.Photo` objects to be added to the playlist. smart (bool): True to create a smart playlist. Default False. limit (int): Smart playlists only, limit the number of items in the playlist. libtype (str): Smart playlists only, the specific type of content to filter (movie, show, season, episode, artist, album, track, photoalbum, photo). sort (str or list, optional): Smart playlists only, a string of comma separated sort fields or a list of sort fields in the format ``column:dir``. See :func:`~plexapi.library.LibrarySection.search` for more info. filters (dict): Smart playlists only, a dictionary of advanced filters. See :func:`~plexapi.library.LibrarySection.search` for more info. m3ufilepath (str): Music playlists only, the full file path to an m3u file to import. Note: This will overwrite any playlist previously created from the same m3u file. **kwargs (dict): Smart playlists only, additional custom filters to apply to the search results. See :func:`~plexapi.library.LibrarySection.search` for more info. Raises: :class:`plexapi.exceptions.BadRequest`: When no items are included to create the playlist. :class:`plexapi.exceptions.BadRequest`: When mixing media types in the playlist. :class:`plexapi.exceptions.BadRequest`: When attempting to import m3u file into non-music library. :class:`plexapi.exceptions.BadRequest`: When failed to import m3u file. Returns: :class:`~plexapi.playlist.Playlist`: A new instance of the created Playlist. Example: .. code-block:: python # Create a regular playlist episodes = plex.library.section("TV Shows").get("Game of Thrones").episodes() playlist = plex.createPlaylist( title="GoT Episodes", items=episodes ) # Create a smart playlist playlist = plex.createPlaylist( title="Top 10 Unwatched Movies", section="Movies", smart=True, limit=10, sort="audienceRating:desc", filters={"audienceRating>>": 8.0, "unwatched": True} ) # Create a music playlist from an m3u file playlist = plex.createPlaylist( title="Favorite Tracks", section="Music", m3ufilepath="/path/to/playlist.m3u" ) )rrrrrrr m3ufilepath)rr) r=rrrrrrrrrr{s rCcreatePlaylistzPlexServer.createPlaylists>| %\!(U%$[\TZ\ \rDc 0tj||fi|S)z Creates and returns a new :class:`~plexapi.playqueue.PlayQueue`. Parameters: item (Media or Playlist): Media or playlist to add to PlayQueue. kwargs (dict): See `~plexapi.playqueue.PlayQueue.create`. )rr)r=rr{s rCcreatePlayQueuezPlexServer.createPlayQueue)sd5f55rDc |jd}tj||jd||j||}|S)z Download databases. Parameters: savepath (str): Defaults to current working dir. unpack (bool): Unpack the zip file. showstatus(bool): Display a progressbar. z/diagnostics/databasesNunpack showstatusurlr downloadr/r4r=savepathrrrfilepaths rCdownloadDatabaseszPlexServer.downloadDatabases2s<hh/0>>#t{{D(DMMZ`mwxrDc |jd}tj||jd||j||}|S)z Download server logs. Parameters: savepath (str): Defaults to current working dir. unpack (bool): Unpack the zip file. showstatus(bool): Display a progressbar. z/diagnostics/logsNrrrs rC downloadLogszPlexServer.downloadLogs>s<hh*+>>#t{{D(DMMZ`mwxrDc$|jdS)z= Return a list of :class:`~plexapi.base.ButlerTask` objects. z/butlerrrs rC butlerTaskszPlexServer.butlerTasksJsy))rDc|jDcgc]}|j}}||vrtd|d||jd||jj |Scc}w)a Manually run a butler task immediately instead of waiting for the scheduled task to run. Note: The butler task is run asynchronously. Check Plex Web to monitor activity. Parameters: task (str): The name of the task to run. (e.g. 'BackupDatabase') Example: .. code-block:: python availableTasks = [task.name for task in plex.butlerTasks()] print("Available butler tasks:", availableTasks) zInvalid butler task: z. Available tasks are: z/butler/r)rrrr9r4r)r=task_task validTaskss rC runButlerTaskzPlexServer.runButlerTaskNsx/3.>.>.@AUejjA A z !'v-DZLQ  XdV$T]]-?-? @ BsA)zuse "checkForUpdate" insteadc(|j||S)NforcercheckForUpdate)r=rrs rCcheck_for_updatezPlexServer.check_for_updatees"""BBrDcd|rdnd}|r'|j||jj|jd}t |r|dSy)a> Returns a :class:`~plexapi.server.Release` object containing release info if an update is available or None if no update is available. Parameters: force (bool): Force server to check for new releases download (bool): Download if a update is available. z/updater/check?download=rr/updater/statusN)r9r4putrlen)r=rrpartreleasess rCrzPlexServer.checkForUpdateisW*x!Q)?@  JJtDMM$5$5J 6??#45 x=A;  rDc.|jd}|duS)zK Returns True if the installed version of Plex Media Server is the latest. T)rNrr=releases rCisLatestzPlexServer.isLatestxs%%D%1$rDcv|jd}tjt|j dS)z Returns True if the newest version of Plex Media Server can be installed automatically. (e.g. Windows and Mac can install updates automatically, but Docker and NAS devices cannot.) r canInstall)r9r rprqr+r#s rCcanInstallUpdatezPlexServer.canInstallUpdate}s-**./zz$ L 9::rDcd}|jdd}|rA|j|jk7r'|j||jjSyy)z@ Automatically install the newest version of Plex Media Server. z/updater/applyTrrN)rrmr9r4r)r=r r$s rC installUpdatezPlexServer.installUpdatesT %%D4%@ w$,,6::d4==+<+<:= =77rDcddi}|r||d<|r||d<|r||d<|rt|j|d<dtj|}|j ||S) a Returns a list of media items from watched history. If there are many results, they will be fetched from the server in batches of X_PLEX_CONTAINER_SIZE amounts. If you're only looking for the first results, it would be wise to set the maxresults option to that amount so this functions doesn't iterate over all results on the server. Parameters: maxresults (int): Only return the specified number of results (optional). mindate (datetime): Min datetime to return results from. This really helps speed up the result listing. For example: datetime.now() - timedelta(days=7) ratingKey (int/str) Request history for a specific ratingKey item. accountID (int/str) Request history for a specific account ID. librarySectionID (int/str) Request history for a specific library section ID. rz viewedAt:descmetadataItemIDrlibrarySectionIDz viewedAt>z/status/sessions/history/all) maxresults)rt timestampr joinArgsr)r=r.mindate ratingKeyrr-argsr:s rChistoryzPlexServer.historys{( %.D! "  )D  '7D# $  #G$5$5$7 8D ,U^^D-A,BCsz::rDc i}|||d<|||d<|||d<|||d<dtj|}|j|fi|S)aO Returns a list of all :class:`~plexapi.playlist.Playlist` objects on the server. Parameters: playlistType (str, optional): The type of playlists to return (audio, video, photo). Default returns all playlists. sectionId (int, optional): The section ID (key) of the library to search within. title (str, optional): General string query to search for. Partial string matches are allowed. sort (str or list, optional): A string of comma separated sort fields in the format ``column:dir``. playlistType sectionIDrrz /playlists)r r0r)r=r6 sectionIdrrr{r3r:s rC playlistszPlexServer.playlistsss  ##/D  )D   !DM  DL5>>$/01ts-f--rDcj |j||dS#t$rtd|ddwxYw)a Returns the :class:`~plexapi.client.Playlist` that matches the specified title. Parameters: title (str): Title of the playlist to return. Raises: :exc:`~plexapi.exceptions.NotFound`: Unable to find playlist. )r title__iexactrz$Unable to find playlist with title "z".N)r9 IndexErrorr)r=rs rCr"zPlexServer.playlistsI W>>U>CAF F WA%KLRV V Ws2c|dur4d}|j||jjjy|j d}|j |j dtS)zT Returns list of all :class:`~plexapi.media.Optimized` objects connected to server. Tz/playlists/generators?type=42r/playlists?type=42/itemsclsN)r9_serverr4r fetchItemrr:r)r= removeAllr:rKs rCoptimizedItemszPlexServer.optimizedItemssa  1C JJs4<<#8#8#?#?J @#'>>2F#G ??&:&>&>%?v#FI?V VrDz-use "plexapi.media.Optimized.items()" insteadcf|jd}|j|jd|dS)z Returns single queued optimized item :class:`~plexapi.media.Video` object. Allows for using optimized item ID to connect back to source item. r>z/items/r?)rCr:)r= optimizedIDrKs rC optimizedItemzPlexServer.optimizedItems8 $~~.BC~~!5!9!9 :'+fUVVrDc|dur2|jd|jjjy|dur2|jd|jjjy|j dt S) zU Returns list of all :class:`~plexapi.media.Conversion` objects connected to server. Tz$/:/prefs?BackgroundQueueIdlePaused=1rFz$/:/prefs?BackgroundQueueIdlePaused=0z /playQueues/1r@N)r9rBr4rrr)r=pauses rC conversionszPlexServer.conversionsse D= JJ=dllF[F[F_F_J ` e^ JJ=dllF[F[F_F_J `??? ?C CrDc$|jdS)z_ Returns list of all :class:`~plexapi.media.TranscodeJob` objects running or paused on server. z/status/sessions/backgroundrrs rCcurrentBackgroundProcessz#PlexServer.currentBackgroundProcesss<==rDc |j|}|xs|jj}|xs |j}t j d|j j||jdi|xsi}||f|||d|}|jdvrtj|jd} |jjdd} d|jd| d |jd| } |jd k(r t| |jd k(r t| t| t!j"|jj%d } | j'rt)j*| Sd S)z Main method used to handle HTTPS requests to the Plex server. This method helps by encoding the response to utf-8 and parsing the returned XML into and ElementTree object. Returns None if no data exists in the response. z%s %s)r|rr*)r  (z) z; iiutf8N)rr4r+r5r debug__name__upperr} status_codecodestextreplacerrrr cleanXMLStringencodestripr fromstring) r=r:rr|rr*r{rresponsecodenameerrtextmessagerAs rCr9zPlexServer.querys` hhsm,4==,,*T]] '6??002C8$--0'-R0#YwvwYRXY    6yy!5!56q9Hmm++D#6G(../r(2hll^1WIVG##s*"7++%%,w'' ))##HMM299&A/3zz|{%%d+EErDcg}|ddd}|r||d<|r||d<dt|}|j|tD]1}|r|j|k(s|jcS||jz }3|S)uq Returns a list of media items or filter categories from the resulting `Hub Search `_ against all items in your Plex library. This searches genres, actors, directors, playlists, as well as all the obvious media titles. It performs spell-checking against your search terms (because KUROSAWA is hard to spell). It also provides contextual search results. So for example, if you search for 'Pernice', it’ll return 'Pernice Brothers' as the artist result, but we’ll also go ahead and return your most-listened to albums and tracks from the artist. If you type 'Arnold' you’ll get a result for the actor, but also the most recently added movies he’s in. Parameters: query (str): Query to use when searching your library. mediatype (str, optional): Limit your search to the specified media type. actor, album, artist, autotag, collection, director, episode, game, genre, movie, photo, photoalbum, place, playlist, shared, show, tag, track limit (int, optional): Limit to the specified number of results per Hub. sectionId (int, optional): The section ID (key) of the library to search within. r)r9includeCollectionsincludeExternalMediarr8z /hubs/search?)rrrrr) r=r9 mediatyperr8resultsrr:hubs rCsearchzPlexServer.searchs("#$%' #F7O "+F; i/01??3, %C88y(99$399$  % rDc$|jdS)z: Return a list of all items in the Continue Watching hub. z/hubs/continueWatching/itemsrrs rCcontinueWatchingzPlexServer.continueWatching,s=>>rDc$|jdS)zI Returns a list of all active session (currently playing) media objects. z/status/sessionsrrs rCsessionszPlexServer.sessions0s122rDc$|jdS)zP Returns a list of all active :class:`~plexapi.media.TranscodeSession` objects. z/transcode/sessionsrrs rCtranscodeSessionszPlexServer.transcodeSessions4s455rDc@t|||}|j|S)a Creates a websocket connection to the Plex Server to optionally receive notifications. These often include messages from Plex about media scans as well as updates to currently running Transcode Sessions. Returns a new :class:`~plexapi.alert.AlertListener` object. Note: ``websocket-client`` must be installed in order to use this feature. .. code-block:: python >> pip install websocket-client Parameters: callback (func): Callback function to call on received messages. callbackError (func): Callback function to call on errors. Raises: :exc:`~plexapi.exception.Unsupported`: Websocket-client not installed. )r start)r=callback callbackErrornotifiers rCstartAlertListenerzPlexServer.startAlertListener8s!(!x?rDc |||tt| tt| d} ||| d<||| d<||| d<|t|jd| d<|t|jd| d<| | j | d<d t j | } |j| d S) a Returns the URL for a transcoded image. Parameters: imageUrl (str): The URL to the image (eg. returned by :func:`~plexapi.mixins.PosterUrlMixin.thumbUrl` or :func:`~plexapi.mixins.ArtUrlMixin.artUrl`). The URL can be an online image. height (int): Height to transcode the image to. width (int): Width to transcode the image to. opacity (int, optional): Change the opacity of the image (0 to 100) saturation (int, optional): Change the saturation of the image (0 to 100). blur (int, optional): The blur to apply to the image in pixels (e.g. 3). background (str, optional): The background hex colour to apply behind the opacity (e.g. '000000'). blendColor (str, optional): The hex colour to blend the image with (e.g. '000000'). minSize (bool, optional): Maintain smallest dimension. Default True. upscale (bool, optional): Upscale the image if required. Default True. imageFormat (str, optional): 'jpeg' (default) or 'png'. )rheightwidthminSizeupscaleopacity saturationblur# background blendColorformatz/photo/:/transcodeT) includeToken)rtrqstrr`r0r r0r)r=imageUrlrzr{r~rrrrr|r} imageFormatrr:s rCtranscodeImagezPlexServer.transcodeImagePs,4=)4=)     'F9   !#-F<  !F6N  !#&z?#8#8#=F<  !#&z?#8#8#=F<  "*002F8 "5>> ":;xx$x//rDc|jr5|s |jr'd|vrdnd}|j||d|jS|j|S)z Build a URL string with proper token argument. Token will be appended to the URL if either includeToken is True or CONFIG.log.show_secrets is 'true'. ?&z X-Plex-Token=)r/r1r,)r=r:rdelims rCrzPlexServer.url|sV ;;LD,=,=#:C3Emm_SE% dkk]K K--&&rDcN|jd|jjS)z2 Force PMS to download new SyncList from Plex.tv. z/sync/refreshSynclistsr9r4rrs rCrefreshSynclistzPlexServer.refreshSynclistszz2DMM4E4EFFrDcN|jd|jjS)z3 Force PMS to refresh content for known SyncLists. z/sync/refreshContentrrs rCrefreshContentzPlexServer.refreshContentszz0$--2C2CDDrDcD|j|jy)z Calls :func:`~plexapi.server.PlexServer.refreshSynclist` and :func:`~plexapi.server.PlexServer.refreshContent`, just like the Plex Web UI does when you click 'refresh'. N)rrrs rC refreshSynczPlexServer.refreshSyncs  rDc|jr|durtjdnv|jr$|dur tjdtd|j|durtjdn tjdtd|durdnd}|j d ||j j S) z Toggle allowMediaDeletion. Parameters: toggle (bool): True enables Media Deletion False or None disable Media Deletion (Default) Fz8Plex is currently allowed to delete media. Toggling off.TzHPlex is currently allowed to delete media. Toggle set to allow, exiting.zCPlex is currently not allowed to delete media. Toggle set to allow.zPPlex is currently not allowed to delete media. Toggle set to not allow, exiting.rrz/:/prefs?allowMediaDeletion=)rHr rWrr9r4r)r=togglevalues rC_allowMediaDeletionzPlexServer._allowMediaDeletions  " "v IIP Q  $ $4 II` agh h  $ $ ,4 II[ \ IIh iop pt^zz8@$--BSBSTTrDc i}|d|d<ndddddd} |||d<hd }|j D]\}}||vrtd |d ||j dr* t jt|j}nU|j ds|dk(rt jt|}n$|dk(r||jjk(rd}|||<dt|}|j|tS#t$r/td|d d j|jwxYw#t$rtd|d |wxYw)a8 Returns a list of :class:`~plexapi.server.StatisticsBandwidth` objects with the Plex server dashboard bandwidth data. Parameters: timespan (str, optional): The timespan to bin the bandwidth data. Default is seconds. Available timespans: seconds, hours, days, weeks, months. **kwargs (dict, optional): Any of the available filters that can be applied to the bandwidth data. The time frame (at) and bytes can also be filtered using less than or greater than (see examples below). * accountID (int): The :class:`~plexapi.server.SystemAccount` ID to filter. * at (datetime): The time frame to filter (inclusive). The time frame can be either: 1. An exact time frame (e.g. Only December 1st 2020 `at=datetime(2020, 12, 1)`). 2. Before a specific time (e.g. Before and including December 2020 `at<=datetime(2020, 12, 1)`). 3. After a specific time (e.g. After and including January 2021 `at>=datetime(2021, 1, 1)`). * bytes (int): The amount of bytes to filter (inclusive). The bytes can be either: 1. An exact number of bytes (not very useful) (e.g. `bytes=1024**3`). 2. Less than or equal number of bytes (e.g. `bytes<=1024**3`). 3. Greater than or equal number of bytes (e.g. `bytes>=1024**3`). * deviceID (int): The :class:`~plexapi.server.SystemDevice` ID to filter. * lan (bool): True to only retrieve local bandwidth, False to only retrieve remote bandwidth. Default returns all local and remote bandwidth. Raises: :exc:`~plexapi.exceptions.BadRequest`: When applying an invalid timespan or unknown filter. Example: .. code-block:: python from plexapi.server import PlexServer plex = PlexServer('http://localhost:32400', token='xxxxxxxxxxxxxxxxxxxx') # Filter bandwidth data for December 2020 and later, and more than 1 GB used. filters = { 'at>': datetime(2020, 12, 1), 'bytes>': 1024**3 } # Retrieve bandwidth data in one day timespans. bandwidthData = plex.bandwidth(timespan='days', **filters) # Print out bandwidth usage for each account and device combination. for bandwidth in sorted(bandwidthData, key=lambda x: x.at): account = bandwidth.account() device = bandwidth.device() gigabytes = round(bandwidth.bytes / 1024**3, 3) local = 'local' if bandwidth.lan else 'remote' date = bandwidth.at.strftime('%Y-%m-%d') print(f'{account.name} used {gigabytes} GB of {local} bandwidth on {date} from {device.name}') rtimespanr)secondshoursdaysweeksmonthszInvalid timespan specified: z. Available timespans: z, > at<at>bytes<bytes>atlanbytesrrzUnknown filter: =rz-Time frame filter must be a datetime object: rrrz/statistics/bandwidth?)KeyErrorrjoinkeysr startswithr rprtr/AttributeErrorrrrrStatisticsBandwidth)r=rr{r timespansrr:rs rC bandwidthzPlexServer.bandwidthsh  !"F:  I X%.x%8z" d ,,. JC'! #3C5%!ABB~~d#d!JJsEOO,=>E(C5L 3. #D..0333EF3K 'y'8&9:s$788- X #?zJ99=9>>CS9T8U"WXX X&d$'TUXTYYZ[`Za%bccdsD(E8D>Ec2d}|j|tS)z Returns a list of :class:`~plexapi.server.StatisticsResources` objects with the Plex server dashboard resources data. z /statistics/resources?timespan=6)rStatisticsResourcesrs rC resourceszPlexServer.resourcess1s$788rDc |d}|r)|d|jd|tj|S|d|jdtj|S)a Build the Plex Web URL for the object. Parameters: base (str): The base URL before the fragment (``#!``). Default is https://app.plex.tv/desktop. endpoint (str): The Plex Web URL endpoint. None for server, 'playlist' for playlists, 'details' for all other media types. **kwargs (dict): Dictionary of URL parameters. zhttps://app.plex.tv/desktop/z #!/server/r&z #!/media/r)rRr r0)r=baseendpointr{s rC _buildWebURLzPlexServer._buildWebURLsk <1D V:d&<&<%=QxjX^I_H`a aV9T%;%;$<6CpRVJN@\D6  *../C0C  ;>;6.0 WW?@WAWD>F0$L?362^b?C*0X'GEU&X9t9 r$ 6rDr%ceZdZdZdZdZy)ra4 Contains the locally cached MyPlex account information. The properties provided don't match the :class:`~plexapi.myplex.MyPlexAccount` object very well. I believe this exists because access to myplex is not required to get basic plex information. I can't imagine object is terribly useful except unless you were needed this information while offline. Parameters: server (:class:`~plexapi.server.PlexServer`): PlexServer this account is connected to (optional) data (ElementTree): Response from PlexServer used to build this object (optional). Attributes: authToken (str): Plex authentication token to access the server. mappingError (str): Unknown mappingErrorMessage (str): Unknown mappingState (str): Unknown privateAddress (str): Local IP address of the Plex server. privatePort (str): Local port of the Plex server. publicAddress (str): Public IP address of the Plex server. publicPort (str): Public port of the Plex server. signInState (str): Signin state for this account (ex: ok). subscriptionActive (str): True if the account subscription is active. subscriptionFeatures (str): List of features allowed by the server for this account. This may be based on your PlexPass subscription. Features include: camera_upload, cloudsync, content_filter, dvr, hardware_transcoding, home, lyrics, music_videos, pass, photo_autotags, premium_music_metadata, session_bandwidth_restrictions, sync, trailers, webhooks' (and maybe more). subscriptionState (str): 'Active' if this subscription is active. username (str): Plex account username (user@example.com). z/myplex/accountc||_|jjd|_|jjd|_|jjd|_|jjd|_|jjd|_|jjd|_|jjd|_ |jjd|_ |jjd |_ |jjd |_ tj|jjd |_tj t"|jjd |_|jjd |_y)N authTokenusername mappingState mappingErrormappingErrorMessage signInState publicAddress publicPortprivateAddress privatePortsubscriptionFeaturessubscriptionActivesubscriptionState)rorrr+rrrrrrrrrrr rsrrprqrrrvs rCrwzAccount._loadDataGs0 5  3  KKOON; KKOON;#';;??3H#I ;;??=9![[___=++//,7"kkoo.>?;;??=9$)LLAW1X$Y!"'**T4;;??CW3X"Y!%1D!ErDNrXrrrr:rwrVrDrCrr(s8 CFrDrceZdZdZdZdZy)rz/A currently running activity on the PlexServer.z /activitiesc||_tjt|jj d|_tjt|jj d|_|jj d|_ |jj d|_ |jj d|_ |jj d|_ y)N cancellableprogressrsubtitleruuid) ror rprqrrr+rrtrrrrrrvs rCrwzActivity._loadData\s  ::dDKKOOM,JK 3  (CD [[__W-   3 KKOOF+ KKOOF+ rDNrrVrDrCrrXs9 C,rDrceZdZdZdZdZy)Releaserc|jjd|_|jjd|_|jjd|_|jjd|_|jjd|_|jjd|_y)Nr:rmaddedfixed downloadURLstate)rrr+ download_keyrmrrrrrvs rCrwzRelease._loadDataks| KKOOE2{{y1 [[__W- [[__W- ;;??=9[[__W- rDN)rXrrTAGr:rwrVrDrCrrfs C C.rDrceZdZdZdZdZy)ra Represents a single system account. Attributes: TAG (str): 'Account' autoSelectAudio (bool): True or False if the account has automatic audio language enabled. defaultAudioLanguage (str): The default audio language code for the account. defaultSubtitleLanguage (str): The default subtitle language code for the account. id (int): The Plex account ID. key (str): API URL (/accounts/) name (str): The username of the account. subtitleMode (bool): The subtitle mode for the account. thumb (str): URL for the account thumbnail. rc||_tjt|jj d|_|jj d|_|jj d|_tjt|jj d|_ |jj d|_ |jj d|_ tjt|jj d|_ |jj d|_|j|_|j|_y) NautoSelectAudiodefaultAudioLanguagedefaultSubtitleLanguagerr:r subtitleModethumb)ror rprqrrr+rrrrtrr:rrrr accountKeyrvs rCrwzSystemAccount._loadDatas $zz$ @Q0RS$(KKOO4J$K!'+{{7P'Q$**S$++//$"78;;??5)KKOOF+ !JJsDKKOON,KL[[__W- ((rDNrXrrrrrwrVrDrCrrts  C #rDrceZdZdZdZdZy)ra Represents a single system device. Attributes: TAG (str): 'Device' clientIdentifier (str): The unique identifier for the device. createdAt (datetime): Datetime the device was created. id (int): The ID of the device (not the same as :class:`~plexapi.myplex.MyPlexDevice` ID). key (str): API URL (/devices/) name (str): The name of the device. platform (str): OS the device is running (Linux, Windows, Chrome, etc.) Devicec||_|jjd|_t j |jjd|_t jt|jjd|_ d|j|_ |jjd|_ |jjd|_ y)Nr createdAtrz /devices/rr[) rorrr+rr rurrprtrr:rr[rvs rCrwzSystemDevice._loadDatas $ 0B C))$++//+*FG**S$++//$"78twwi(KKOOF+   3 rDNrrVrDrCrrs  C4rDrc,eZdZdZdZdZdZdZdZy)ra Represents a single statistics bandwidth data. Attributes: TAG (str): 'StatisticsBandwidth' accountID (int): The associated :class:`~plexapi.server.SystemAccount` ID. at (datetime): Datetime of the bandwidth data. bytes (int): The total number of bytes for the specified time span. deviceID (int): The associated :class:`~plexapi.server.SystemDevice` ID. lan (bool): True or False whether the bandwidth is local or remote. timespan (int): The time span for the bandwidth data. 1: months, 2: weeks, 3: days, 4: hours, 6: seconds. c||_tjt|jj d|_tj|jj d|_tjt|jj d|_ tjt|jj d|_ tjt|jj d|_ tjt|jj d|_ y)Nrrrrrr)ror rprtrrr+rrurrrrqrrrvs rCrwzStatisticsBandwidth._loadDatas C)EF""4;;??4#89ZZT[[__W%=>  3  (CD ::dDKKOOE$:; 3  (CD rDc `djdj|jj|j |j |j |j |j t|jjfDcgc]}|r|c}Scc}w)Nz<{}>r) rrrBrX_cleanrrrtrr/r=rs rC__repr__zStatisticsBandwidth.__repr__s}} HH'' DNN+ DMM* C 1 1 345 "A     s B+ cL|jj|jS)zX Returns the :class:`~plexapi.server.SystemAccount` associated with the bandwidth data. )rBrrrs rCrzStatisticsBandwidth.accounts||))$..99rDcL|jj|jS)zW Returns the :class:`~plexapi.server.SystemDevice` associated with the bandwidth data. )rBrrrs rCrzStatisticsBandwidth.devices||((77rDN) rXrrrrrwrrrrVrDrCrrs#  CE :8rDrc eZdZdZdZdZdZy)ra  Represents a single statistics resources data. Attributes: TAG (str): 'StatisticsResources' at (datetime): Datetime of the resource data. hostCpuUtilization (float): The system CPU usage %. hostMemoryUtilization (float): The Plex Media Server CPU usage %. processCpuUtilization (float): The system RAM usage %. processMemoryUtilization (float): The Plex Media Server RAM usage %. timespan (int): The time span for the resource data (6: seconds). c||_tj|jj d|_tj t|jj d|_tj t|jj d|_ tj t|jj d|_ tj t|jj d|_ tj t|jj d|_ y)NrhostCpuUtilizationhostMemoryUtilizationprocessCpuUtilizationprocessMemoryUtilizationr)ror rurrr+rrpfloatrrrrrtrrvs rCrwzStatisticsResources._loadDatas ""4;;??4#89"'**UDKKOODX4Y"Z%*ZZt{{G^7_%`"%*ZZt{{G^7_%`"(- 5$++//Jd:e(f% 3  (CD rDc ddj|jj|jt |j j fDcgc]}|s| c}dScc}wN)rrBrXrrtrr/rs rCrzStatisticsResources.__repr__sZ388)@)@$++cRVRYRYRcRcReNfBg(hn1lmQnoppqrrns A- A- N)rXrrrrrwrrVrDrCrrs  CEsrDrceZdZdZdZdZy) ButlerTaska Represents a single scheduled butler task. Attributes: TAG (str): 'ButlerTask' description (str): The description of the task. enabled (bool): Whether the task is enabled. interval (int): The interval the task is run in days. name (str): The name of the task. scheduleRandomized (bool): Whether the task schedule is randomized. title (str): The title of the task. c"||_|jjd|_t j t |jjd|_t j t|jjd|_ |jjd|_ t j t |jjd|_ |jjd|_ y)N descriptionenabledintervalrscheduleRandomizedr) rorrr+r r rprqr rtr rr rrvs rCrwzButlerTask._loadDatas ;;??=9zz$  (BC  3  (CD KKOOF+ "'**T4;;??CW3X"Y[[__W- rDNrrVrDrCrrs  C.rDrceZdZdZdZdZy)rz Represents a server identity. Attributes: claimed (bool): True or False if the server is claimed. machineIdentifier (str): The Plex server machine identifier. version (str): The Plex server version. cPd|jjd|jdSr)rBrXrRrs rCrzIdentity.__repr__s)4>>**+1T-C-C,DAFFrDc||_tjt|jj d|_|jj d|_|jj d|_y)NclaimedrRrm) ror rprqrrr+rrRrmrvs rCrwzIdentity._loadDatasR zz$  (BC !%1D!E{{y1 rDN)rXrrrrrwrVrDrCrr sG2rDr)Er functoolsr urllib.parser xml.etreerr2plexapirrrr r r plexapi.alertr plexapi.baser plexapi.clientrplexapi.collectionrplexapi.exceptionsrrrplexapi.libraryrrrr plexapi.mediarrplexapi.playlistrplexapi.playqueuerplexapi.settingsr plexapi.utilsrrequests.status_codesrr[r_audior _collectionr _mediar!_photor" _playlistr#_videor%rrregisterPlexObjectrrrrrrrrVrDrCr(s %"!AA'#%)AA44/%'%$1$-##)#D6D6N -Fj-F` ,z , .j . .#J#>4:40)8*)8Xs*s6...02z2rD