a mb8l@sjdZddlZddlZddlZddlmZddlmZddlmZddlm Z ddlm Z ddl m Z dd lmZdd lmZdd lmZdd lmZdd lmZddlmZddlmZddlmZddlmZddlmZddlmZddlm Z ddlmZddlmZddlm Z ddlm!Z!ddl"m#Z#ddl$m%Z%e&dZ'GdddeZ(Gdd d e(Z)dS)!z#A base class for contents managers.Nfnmatch) import_item)sign)validate)ValidationError) new_notebook) HTTPError)RequestHandler)Any)Bool)default)Dict)Instance)List) TraitError)Type)Unicode)LoggingConfigurable) FilesHandler)AsyncCheckpoints) Checkpoints)_i18n) ensure_asyncz \-Copy\d*\.c@seZdZdZedddZeddddZee j Z dd Z e egd dd dZeed dd dZeddddZeddddZedddddZedddZddZeeddZeeddZeddZedddZedddZ ee!e"ddd d!Z#edd"dZ$d#d$Z%d%d&Z&d'd(Z'd\d*d+Z(d,d-Z)d]d.d/Z*d0d1Z+d2d3Z,d4d5Z-d6d7Z.d8d9Z/d:d;Z0dd?Z2d_d@dAZ3dBdCZ4d`dDdEZ5dadFdGZ6dbdHdIZ7dJdKZ8dLdMZ9dcdNdOZ:dddPdQZ;dRdSZdXdYZ?dZd[Z@dS)eContentsManageraBase class for serving files and directories. This serves any text or binary file, as well as directories, with special handling for JSON notebook documents. Most APIs take a path argument, which is always an API-style unicode path, and always refers to a directory. - unicode, not url-escaped - '/'-separated - leading and trailing '/' will be stripped - if unspecified, path defaults to '', indicating the root path. /TconfigFzAllow access to hidden files)rhelpcCs tj|dS)N)parent)rNotebookNotaryselfr%Glib/python3.9/site-packages/jupyter_server/services/contents/manager.py_notary_default?szContentsManager._notary_default) __pycache__z*.pycz*.pyoz .DS_Storez*.soz*.dylibz*~zC Glob patterns to hide in file and directory listings. ZUntitledz4The base name used when creating untitled notebooks.untitledz0The base name used when creating untitled files.zUntitled Folderz6The base name used when creating untitled directories.NauPython callable or importstring thereof To be called on a contents model prior to save. This can be used to process the structure, such as removing notebook outputs or other side effects that should not be saved. It will be called as (all arguments passed by keyword):: hook(path=path, model=model, contents_manager=self) - model: the model to be saved. Includes file contents. Modifying this dict will affect the file that is stored. - path: the API path of the save destination - contents_manager: this ContentsManager instance )r allow_noner pre_save_hookcCs0|d}t|trt|j}t|s,td|S)Nvaluezpre_save_hook must be callable) isinstancestrrr+callabler)r$Zproposalr,r%r%r&_validate_pre_save_hookxs   z'ContentsManager._validate_pre_save_hookcKsl|jrhz*|jd||jf|||d|Wn6tyDYn$tyf|jjd|ddYn0dS)z0Run the pre-save hook if defined, and log errorszRunning pre-save hook on %s)modelpathZcontents_managerzPre-save hook failed on %sT)exc_infoN)r+logdebugr Exceptionerror)r$r1r2kwargsr%r%r&run_pre_save_hooks  z!ContentsManager.run_pre_save_hook checkpointscCs|jfi|jSNcheckpoints_classcheckpoints_kwargsr#r%r%r&_default_checkpointssz$ContentsManager._default_checkpointsr>cCst||jdSN)r!r4dictr4r#r%r%r&_default_checkpoints_kwargssz+ContentsManager._default_checkpoints_kwargsavhandler class to use when serving raw file requests. Default is a fallback that talks to the ContentsManager API, which may be inefficient, especially for large files. Local files-based ContentsManagers can use a StaticFileHandler subclass, which will be much more efficient. Access to these files should be Authenticated. )klassr*rr zExtra parameters to pass to files_handler_class. For example, StaticFileHandlers generally expect a `path` argument specifying the root directory from which to serve files. cCs"g}|jr|d|j|jf|S)z[Return additional handlers Default: self.files_handler_class on /files/.* z /files/(.*))files_handler_classappendfiles_handler_params)r$handlersr%r%r&get_extra_handlerssz"ContentsManager.get_extra_handlerscCstdSa=Does a directory exist at the given path? Like os.path.isdir Override this method in subclasses. Parameters ---------- path : string The path to check Returns ------- exists : bool Whether the path does indeed exist. NNotImplementedErrorr$r2r%r%r& dir_existsszContentsManager.dir_existscCstdSa/Is path a hidden directory or file? Parameters ---------- path : string The path to check. This is an API path (`/` separated, relative to root dir). Returns ------- hidden : bool Whether the path is hidden. NrKrMr%r%r& is_hiddenszContentsManager.is_hiddencCs tddSaADoes a file exist at the given path? Like os.path.isfile Override this method in subclasses. Parameters ---------- path : string The API path of a file to check for. Returns ------- exists : bool Whether the file exists. !must be implemented in a subclassNrKrMr%r%r& file_existsszContentsManager.file_existscCs||p||S)0Does a file or directory exist at the given path? Like os.path.exists Parameters ---------- path : string The API path of a file or directory to check for. Returns ------- exists : bool Whether the target exists. )rTrNrMr%r%r&existsszContentsManager.existscCs tddSzGet a file or directory model.rSNrKr$r2contenttypeformatr%r%r&getszContentsManager.getcCs tddSz Save a file or directory model to path. Should return the saved model with no content. Save implementations should call self.run_pre_save_hook(model=model, path=path) prior to writing any data. rSNrKr$r1r2r%r%r&saveszContentsManager.savecCs tddSz%Delete the file or directory at path.rSNrKrMr%r%r& delete_fileszContentsManager.delete_filecCs tddSzRename a file or directory.rSNrKr$Zold_pathnew_pathr%r%r& rename_file szContentsManager.rename_filecCs2|d}|stdd|||j|dSz7Delete a file/directory and any associated checkpoints.rzCan't delete rootNstripr rar:Zdelete_all_checkpointsrMr%r%r&delete's    zContentsManager.deletecCs||||j||dSzr%)objr%r%r&|z9ContentsManager.validate_notebook_model..)indentr messageN) validate_nbrr[rjsondumpsinstance)r$r1er%r%r&validate_notebook_modelusz'ContentsManager.validate_notebook_modelcCs|d}||s"tdd|i}|r2||d<|dkrH|ddn |ddd}|dd krp|j}d }n>|ddkr|j}d}n&|ddkr|j}ntd d |d|j||||d }d||}| ||S)Create a new untitled file or directory in path path must be a directory File extension can be specified. Use `new` to create files with a fully specified path (including filename). rNo such directory: %srZ.ipynbnotebookfilerQ directory rgUnexpected model type: %rr|{0}/{1}) rirNr setdefaultuntitled_directoryuntitled_notebook untitled_filerr[new)r$r2rZrr1r|r)rr%r%r& new_untitleds,       zContentsManager.new_untitledcCs|d}|duri}|dr.|ddn |ddd|vr|ddkr|ddkrnt|d<d |d <nd |d<d|d<d |d <|||}|S zCreate a new file or directory and return its model with no content. To create a new untitled entity in a directory, use `new_untitled`. rNrrZrrrYrrr[rQtextriendswithrrr_r^r%r%r&rs       zContentsManager.newc Cs|d}|dur|d}d|vr6|dd\}}nd}|}||}|dd|dd|ddkrvtd d |dur|}||rtd |}|j||d d }d ||}| ||}|SaCopy an existing file and return its new model. If to_path not specified, it will be the parent directory of from_path. If to_path is a directory, filename will increment `from_path-Copy#.ext`. Considering multi-part extensions, the Copy# part will be placed before the first dot for all the extensions except `ipynb`. For easier manual searching in case of notebooks, the Copy# part will be placed before the last dot. from_path must be a full path to a file. rNrrQr2rrZrrgzCan't copy directoriesrvz-Copyrr) rirsplitr\popr rNcopy_patsubrr[r_ r$Z from_pathZto_pathr2Zfrom_dir from_namer1rZto_namer%r%r&copys(           zContentsManager.copycCs|j|dSr;)r4inforsr#r%r%r&log_infoszContentsManager.log_infocCs>||}|d}|jd||j|d|||dS)Explicitly trust a notebook Parameters ---------- path : string The path of a notebook rYTrusting notebook %sTNr\r4warningnotary mark_cellscheck_and_signr$r2r1nbr%r%r&trust_notebooks  zContentsManager.trust_notebookcCs,|j|r|j|n|jd|dS)aCheck for trusted cells, and sign the notebook. Called as a part of saving notebooks. Parameters ---------- nb : dict The notebook dict path : string The notebook's path (for logging) Notebook %s is not trustedN)rZ check_cellsrr4r)r$rr2r%r%r&rs zContentsManager.check_and_signcCs0|j|}|s|jd||j||dS)a$Mark cells as trusted if the notebook signature matches. Called as a part of loading notebooks. Parameters ---------- nb : dict The notebook object (in current nbformat) path : string The notebook's path (for logging) rN)rZcheck_signaturer4rr)r$rr2Ztrustedr%r%r&mark_trusted_cellss z"ContentsManager.mark_trusted_cellscstfdd|jD S)z:Should this file/directory name be displayed in a listing?c3s|]}t|VqdSr;r).0globrr%r& rz.ContentsManager.should_list..)any hide_globs)r$rr%rr& should_listszContentsManager.should_listcCs|j||S)Create a checkpoint.r:create_checkpointrMr%r%r&rsz!ContentsManager.create_checkpointcCs|j|||dSz' Restore a checkpoint. Nr:restore_checkpointr$Z checkpoint_idr2r%r%r&r!sz"ContentsManager.restore_checkpointcCs |j|Sr;r:list_checkpointsrMr%r%r&r'sz ContentsManager.list_checkpointscCs|j||Sr;r:delete_checkpointrr%r%r&r*sz!ContentsManager.delete_checkpoint)rQ)TNN)N)rQrQ)rQrQrQ)NrQ)N)rQ)rQ)A__name__ __module__ __qualname____doc__rroot_dirr Z allow_hiddenrrr"rr'rrrrrrr r+rr0r9rrr=r:rr>r r?rCrr rErGrIrNrPrTrVr\r_rarerjrmrrrsrtrrrrrrrrrrrrrrr%r%r%r&r&s                 % &  $  rc@seZdZdZeeddZeeddZe ddZ e dddZ e ddd Z d d Zd d Zd4ddZddZd5ddZddZddZddZddZddZd d!Zd6d"d#Zd7d$d%Zd8d&d'Zd9d(d)Zd*d+Zd,d-Zd.d/Zd0d1Z d2d3Z!dS):AsyncContentsManagerzcCst||jdSr@rAr#r%r%r&rC9sz0AsyncContentsManager._default_checkpoints_kwargscstdSrJrKrMr%r%r&rNCszAsyncContentsManager.dir_existscstdSrOrKrMr%r%r&rPVszAsyncContentsManager.is_hiddenrQcs tddSrRrKrMr%r%r&rTgsz AsyncContentsManager.file_existscs(t||IdHp&t||IdHS)rUN)rrTrNrMr%r%r&rVzszAsyncContentsManager.existsNcs tddSrWrKrXr%r%r&r\szAsyncContentsManager.getcs tddSr]rKr^r%r%r&r_szAsyncContentsManager.savecs tddSr`rKrMr%r%r&rasz AsyncContentsManager.delete_filecs tddSrbrKrcr%r%r&resz AsyncContentsManager.rename_filecs>|d}|stdd||IdH|j|IdHdSrfrhrMr%r%r&rjs   zAsyncContentsManager.deletecs*|||IdH|j||IdHdSrkrlrcr%r%r&rmszAsyncContentsManager.renamecsN|d}|d|d}||kr6|||IdH|j|ddIdH}|S)rnrr2NFrorprqr%r%r&rrs  zAsyncContentsManager.updatec s|d}|d\}}}|dkr2|d\}}}||}tD]N}|rXd||} nd} dj|| |d} t|d|| Id H} | sBqqB| S) rurrvrwrxrQryrzr~N)rirrrrr[rrV) r$rr2r|r{rrr}rrrrTr%r%r&rs   z'AsyncContentsManager.increment_filenamec s|d}t||IdH}|s0tdd|i}|r@||d<|dkrV|ddn |ddd }|dd kr~|j}d }n>|ddkr|j}d}n&|ddkr|j}ntd d |d|j||||dIdH}d ||}| ||IdHS)rrNrrrZrrrrQrrrgrrr) rirrNr rrrrrr[r) r$r2rZrrNr1r|r)rr%r%r&rs.      z!AsyncContentsManager.new_untitledcs|d}|duri}|dr.|ddn |ddd|vr|ddkr|ddkrnt|d<d |d <nd |d<d|d<d |d <|||IdH}|Srrr^r%r%r&rs      zAsyncContentsManager.newc s|d}|dur|d}d|vr6|dd\}}nd}|}||IdH}|dd|dd|ddkr|td d |dur|}t||IdHrtd |}|j ||d d IdH}d ||}| ||IdH}|Sr) rirr\rr rrNrrrr[r_rr%r%r&r)s(        zAsyncContentsManager.copycsD||IdH}|d}|jd||j|d|||dS)rNrYrTrrr%r%r&rLs z#AsyncContentsManager.trust_notebookcs|j||IdHS)rNrrMr%r%r&r[sz&AsyncContentsManager.create_checkpointcs|j|||IdHdSrrrr%r%r&r_sz'AsyncContentsManager.restore_checkpointcs|j|IdHSr;rrMr%r%r&resz%AsyncContentsManager.list_checkpointscs|j||IdHSr;rrr%r%r&rhsz&AsyncContentsManager.delete_checkpoint)rQ)TNN)rQrQ)rQrQrQ)NrQ)N)"rrrrrrr=rr:rr>r r?rCrNrPrTrVr\r_rarerjrmrrrrrrrrrrrr%r%r%r&r.s8          & '  #r)*rrrrerZipython_genutils.importstringrZnbformatrrrrZ nbformat.v4rZ tornado.webr r Z traitletsr r r rrrrrrZtraitlets.config.configurablerZfiles.handlersrr:rrZjupyter_server.transutilsrZjupyter_server.utilsrcompilerrrr%r%r%r&sD