a mb+@s&dZddlZzddlmZWney:ddlmZYn0ddlmZddlm Z ddlm Z ddlm Z dd l m Z dd l mZdd l mZd d ZGddde ZGddde ZGddde ZGddde ZGddde ZdZde efde efefde efde efdefgZdS)zTornado handlers for the contents web service. Preliminary documentation at https://github.com/ipython/ipython/wiki/IPEP-27%3A-Contents-Service N) json_default) date_default)web) APIHandler)JupyterHandler) path_regex) ensure_async) url_escape) url_path_joincshd}|t}|r0tddj|dddg}|rhfdd|D}|rtdd j|d n*fd d |D}|rtdd j|d dS)z Validate a model returned by a ContentsManager method. If expect_content is True, then we expect non-null entries for 'content' and 'format'. > ZmimetypewritableformattypeZcreatedname last_modifiedcontentpathizMissing Model Keys: {missing})missingrr csg|]}|dur|qSN.0keymodelrHlib/python3.9/site-packages/jupyter_server/services/contents/handlers.py 2z"validate_model..zKeys unexpectedly None: {keys})keyscs"i|]}|dur||qSrrrrrr 9rz"validate_model..z"Keys unexpectedly not None: {keys}N)setrr HTTPErrorr )rexpect_content required_keysrZmaybe_none_keyserrorsrrrvalidate_models*    r$c@seZdZddZdddZejdddZejdd d Zdd d Z ddZ dddZ ddZ ejdddZ ejd ddZejd!ddZd S)"ContentsHandlercCst|jddt|S)zReturn the full URL location of a file. Parameters ---------- path : unicode The API path of the file, such as "foo/bar.txt". Zapicontents)r base_urlr selfrrrr location_urlBszContentsHandler.location_urlTcCsR|r||d}|d||d|d|dd|tj|tddS) zBFinish a JSON request with a model, setting relevant headers, etc.rLocationz Last-Modifiedrz Content-Typezapplication/jsondefaultN)r* set_headerfinishjsondumpsr)r)rlocationrrr _finish_modelLs   zContentsHandler._finish_modelcs|pd}|jddd}|dvr.tdd||jddd}|d vrTtdd ||jd d d}|d vrztdd|t|}t|jj||||dIdH}t||d|j|dddS)zReturn a model for a file or directory. A directory model contains a list of models (without content) of the files and directories it contains. r4r Nr,>NZnotebookfileZ directoryzType %r is invalidr >Ntextbase64zFormat %r is invalidr1>0r9zContent %r is invalid)rr r rr!F)r2) Zget_query_argumentrr intrcontents_managergetr$r3)r)rr r rrrrrr>Us*  zContentsHandler.getcsR|j}|}|dur"tddt|||IdH}t|dd||dS)z?PATCH renames a file or directory without re-uploading content.Nr6zJSON body missingFr;)r= get_json_bodyrr rupdater$r3)r)rcmrrrrpatchts  zContentsHandler.patchNcsV|jdj||pddt|j||IdH}|dt|dd||dS)z6Copy a file, optionally specifying a target directory.z Copying {copy_from} to {copy_to}r4) copy_fromcopy_toNFr;) loginfor rr=copy set_statusr$r3)r)rCrDrrrr_copys  zContentsHandler._copycsJ|jd|t|j||IdH}|dt|dd||dS)z#Handle upload of a new file to pathzUploading file to %sNrEFr;)rFrGrr=newrIr$r3)r)rrrrr_uploads   zContentsHandler._uploadcsT|jd|pd|t|jj|||dIdH}|dt|dd||dS)z#Create a new, empty untitled entityzCreating new %s in %sr5)rr extNrEFr;)rFrGrr=Z new_untitledrIr$r3)r)rr rMrrrr _new_untitleds   zContentsHandler._new_untitledcsX|dd}|r|dkr&|jd|t|j||IdH}t|dd||dS)zSave an existing file.chunkNzSaving file at %sFr;)r>rFrGrr=Zsaver$r3)r)rrrOrrr_saves    zContentsHandler._savec s|j}t||IdH}|r*tddt||IdH}|sRtdd||}|dur|d}|dd}|d d}|r|||IdHq|j |||d IdHn| |IdHdS) aZCreate a new file in the specified path. POST creates new files. The server always decides on the name. POST /api/contents/path New untitled, empty file or directory. POST /api/contents/path with body {"copy_from" : "/path/to/OtherNotebook.ipynb"} New copy of OtherNotebook in path Nr6z&Cannot POST to files, use PUT instead.izNo such directory: %srCrMr4r )r rM) r=r file_existsrr dir_existsr?r>rJrN) r)rrArRrSrrCrMr rrrposts     zContentsHandler.postcsx|}|rd|dr"tddt|j|IdH}|rP|||IdHqt|||IdHn| |IdHdS)aSaves the file in the location specified by name and path. PUT is very similar to POST, but the requester specifies the name, whereas with POST, the server picks the name. PUT /api/contents/path/Name.ipynb Save notebook at ``path/Name.ipynb``. Notebook structure is specified in `content` key of JSON request body. If content is not specified, create a new empty notebook. rCr6zCannot copy with PUT, only POSTN) r?r>rr rr=rRrQrLrN)r)rrexistsrrrputs   zContentsHandler.putcs>|j}|jd|t||IdH|d|dS)zdelete a file in the given pathz delete %sN)r=rFwarningrdeleterIr/r)rrArrrrYs  zContentsHandler.delete)T)r4)r4)N)r4r4)r4)r4)r4)__name__ __module__ __qualname__r*r3r authenticatedr>rBrJrLrNrQrTrVrYrrrrr%As       # r%c@s,eZdZejdddZejdddZdS) CheckpointsHandlerr4cs6|j}t||IdH}tj|td}||dS)z get lists checkpoints for a fileNr,)r=rZlist_checkpointsr0r1rr/)r)rrA checkpointsdatarrrr>szCheckpointsHandler.getcsj|j}t||IdH}tj|td}t|jdt|dt|d}| d|| d| |dS)zpost creates a new checkpointNr, api/contentsr`idr+rE) r=rZcreate_checkpointr0r1rr r'r r.rIr/)r)rrAZ checkpointrar2rrrrTs   zCheckpointsHandler.postN)r4)r4)r[r\r]rr^r>rTrrrrr_s r_c@s(eZdZejddZejddZdS)ModifyCheckpointsHandlercs2|j}t|||IdH|d|dS)z&post restores a file from a checkpointNrW)r=rZrestore_checkpointrIr/r)rZ checkpoint_idrArrrrT s zModifyCheckpointsHandler.postcs2|j}t|||IdH|d|dS)z+delete clears a checkpoint for a given fileNrW)r=rZdelete_checkpointrIr/rerrrrYs zModifyCheckpointsHandler.deleteN)r[r\r]rr^rTrYrrrrrds rdc@s,eZdZdZdZddZeZZZZ dS)NotebooksRedirectHandlerz(Redirect /api/notebooks to /api/contents)ZGETZPUTZPATCHZPOSTZDELETEcCs(|jd|t|jdt|dS)Nz//api/notebooks is deprecated, use /api/contentsrb)rFrXZredirectr r'r r(rrrr>s zNotebooksRedirectHandler.getN) r[r\r]__doc__ZSUPPORTED_METHODSr>rVrBrTrYrrrrrfsrfc@s eZdZdZejdddZdS)TrustNotebooksHandlerz$ Handles trust/signing of notebooks r4cs0|j}t||IdH|d|dS)NrE)r=rZtrust_notebookrIr/rZrrrrT)s zTrustNotebooksHandler.postN)r4)r[r\r]rgrr^rTrrrrrh&srhz(?P[\w-]+)z/api/contents%s/checkpointsz/api/contents%s/checkpoints/%sz/api/contents%s/trustz/api/contents%sz/api/notebooks/?(.*))rgr0Zjupyter_client.jsonutilr ImportErrorrZtornadorZjupyter_server.base.handlersrrrZjupyter_server.utilsrr r r$r%r_rdrfrhZ_checkpoint_id_regexZdefault_handlersrrrrs8        *-