G@dZAdZddlZddlZddlZddlmZddlZddlm Z ddl m Z m Z m Z ddlmZddlmZddlmZejeZGdd eZGd d eZdS) a Autosave components for the Editor plugin and the EditorStack widget The autosave system regularly checks the contents of all opened files and saves a copy in the autosave directory if the contents are different from the autosave file (if it exists) or original file (if there is no autosave file). The mapping between original files and autosave files is stored in the variable `name_mapping` and saved in the file `pidNNN.txt` in the autosave directory, where `NNN` stands for the pid. This filename is chosen so that multiple instances of Spyder can run simultaneously. File contents are compared using their hash. The variable `file_hashes` contains the hash of all files currently open in the editor and all autosave files. On startup, the contents of the autosave directory is checked and if autosave files are found, the user is asked whether to recover them; see `spyder/plugins/editor/widgets/recover.py`. N)QTimer)_ get_conf_pathrunning_under_pytest)AutosaveErrorDialog)RecoveryDialog)is_spyder_processceZdZdZdZdZedZejdZedZ e jdZ dZ d Z d Z d Z d Zd ZdS)AutosaveForPluginag Component of editor plugin implementing autosave functionality. Attributes: name_mapping (dict): map between names of opened and autosave files. file_hashes (dict): map between file names and hash of their contents. This is used for both files opened in the editor and their corresponding autosave files. i`c||_i|_i|_t|j|_|jd|jj|jd|_ |j |_ dS)z Constructor. Autosave is disabled after construction and needs to be enabled explicitly if required. Args: editor (Editor): editor plugin. TFN) editor name_mapping file_hashesrtimer setSingleShottimeoutconnect do_autosave_enabledDEFAULT_AUTOSAVE_INTERVAL _interval)selfr s Dlib/python3.11/site-packages/spyder/plugins/editor/utils/autosave.py__init__zAutosaveForPlugin.__init__>ss DK((    &&& ""4#3444 7c|jS)z Get or set whether autosave component is enabled. The setter will start or stop the autosave component if appropriate. )rrs renabledzAutosaveForPlugin.enabledQs }rc~||jkrdS|||_|dSN)rstop_autosave_timerrstart_autosave_timer)r new_enableds rrzAutosaveForPlugin.enabledZsE $, & & F   """#  !!#####rc|jS)z Interval between two autosaves, in milliseconds. The setter will perform an autosave if the interval is changed and autosave is enabled. )rrs rintervalzAutosaveForPlugin.intervalbs ~rc||jkrdS|||_|jr|dSdSr )r%r!rrr)r new_intervals rr%zAutosaveForPlugin.intervallsY 4= ( ( F   """% <           rcV|jr!|j|jdSdS)z Start a timer which calls do_autosave() after `self.interval`. The autosave timer is only started if autosave is enabled. N)rrstartr%rs rr"z&AutosaveForPlugin.start_autosave_timerus6 < , J  T] + + + + + , ,rc8|jdS)zStop the autosave timer.N)rstoprs rr!z%AutosaveForPlugin.stop_autosave_timer~s rctd|j}|j|dS)z?Instruct current editorstack to autosave files where necessary.zAutosave triggeredN)loggerdebugr get_current_editorstackautosave autosave_allr")rstacks rrzAutosaveForPlugin.do_autosavesT )*** 3355 ##%%% !!#####rc ttd}tj|tjsggfSg}g}g}g}tj|D]}t j||}tjd|}|r| |t d |t|5} | } tj| } n#t"t$f$rltd |td t)| i} YnwxYw|d| Dz }dddn #1swxYwYt-|d} t1| r/t d ||t3| z }| |t5|t5|z D]F} | d| ft d | G||fS) aI Get list of files to recover from pid files in autosave dir. This returns a tuple `(files_to_recover, pid_files)`. In this tuple, `files_to_recover` is a list of tuples containing the original file names and the corresponding autosave file names, as recorded in the pid files in the autosave directory. Any files in the autosave directory which are not listed in a pid file, are also included, with the original file name set to `None`. The second entry, `pid_files`, is a list with the names of the pid files. r0zpid([0-9]*)\.txt\ZzReading pid file: {}zError parsing pid file {}z Contents: {}cg|]\}}|Sr5).0origr0s r z:AutosaveForPlugin.get_files_to_recover..s/(@(@(@5EdH(@(@(@rNzIgnoring files in {}zAdded unmentioned file: {})rosaccessR_OKlistdirospjoinrematchappendr-r.formatopenreadast literal_eval SyntaxError ValueErrorerrorrepritemsintgroupr listset)r autosave_dirfiles_to_recoverfiles_mentioned pid_files non_pid_filesname full_namerApidfiletxt txt_as_dictpidfilenames rget_files_to_recoverz&AutosaveForPlugin.get_files_to_recovers%Z00 yrw// r6M  J|,, 0 0Dt44IH2D99E 0  +++ 3::9EEFFF)__ @!,,..C)&)&6s&;&; '4))) %@&,fY&7&7999 ^%:%:499%E%EFFF&( ) $(@(@+6+<+<+>+>(@(@(@@O @ @ @ @ @ @ @ @ @ @ @ @ @ @ @%++a..))$S))BLL!7!>!>y!I!IJJJJ$[->->-@-@(A(AA$$$$Y////M**S-A-AA H HH  # #T8$4 5 5 5 LL5<%>%@%@"( 4 6 6LDKbasenamer?rvaluesexistssplitextrC) rr\rQrxautosave_filenamecounterrootextautosave_basenames rcreate_unique_autosave_filenamez0AutosaveForStack.create_unique_autosave_filenames<))H\8<< !2!9!9!;!; ; ;:/00 <G X..ID#$(9(@(@(B(BBBj!233C1 $-$4$4T7C$H$H!$'H\;L$M$M! %(9(@(@(B(BBBj!233C ! rctd}tj}tj|d|}|jrRt|d5}|t|jddddS#1swxYwYdS tj |dS#ttf$rYdSwxYw)a/ Writes current autosave mapping to a pidNNN.txt file. This function should be called after updating `self.autosave_mapping`. The NNN in the file name is the pid of the Spyder process. If the current autosave mapping is empty, then delete the file if it exists. r0z pid{}.txtwN) rr:getpidr>r?rCrrDwriteasciirdrerf)rrQmy_pid pidfile_namerXs rsave_autosave_mappingz&AutosaveForStack.save_autosave_mappings%Z00 x k.@.@.H.HII   lC(( 8G eD$566777 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8 8  ,'''''W%    s$"(BBB%B;;CCc||jvrdS|j|} tj|n]#t$rP}t d|}t ||}|Yd}~nd}~wwxYw|j|= |j|=n#t$rYnwxYw| t d|dS)z Remove autosave file for specified file. This function also updates `self.name_mapping` and `self.file_hashes`. If there is no autosave file, then the function returns without doing anything. Nz%Error while removing autosave file {}zRemoving autosave file %s) rr:rdEnvironmentErrorrrCrexec_if_enabledrKeyErrorrr-r.)rr\r|rJactionmsgboxs rremove_autosave_filez%AutosaveForStack.remove_autosave_file's 4, , , F -h7 % I' ( ( ( ( % % %?@@v/00 (77F  " " $ $ $ $ $ $ $ $  %  h '   !233    D  ""$$$ 02CDDDDDs'/ B ABB B B+*B+c |j|}n#t$rtd}tj|s` t j|nJ#t$r=}td}t||}| Yd}~nd}~wwxYw| ||}||j|<| tdYnwxYw|S)ab Get name of autosave file for specified file name. This function uses the dict in `self.name_mapping`. If `filename` is in the mapping, then return the corresponding autosave file name. Otherwise, construct a unique file name and update the mapping. Args: filename (str): original file name r0z'Error while creating autosave directoryNzNew autosave file name)rrrr>isdirr:mkdirrrrrrrr-r.)rr\r|rQrJrrs rget_autosave_filenamez&AutosaveForStack.get_autosave_filenameFs$ 3 $ 1( ;   3 3 3(44L9\** --H\****'---HIIF0??F**,,,,,,,,-!% D Dl!,!, *;D h '  & & ( ( ( LL1 2 2 2 2 2 3! s9 -C.AC. B3BC.BAC.-C.c|jj|}|jrdS|j} |j|}n-#t $r t d|d}YnwxYw|j|}||j vrV|j |}|j|}||kr4||kr| |dS| |dSdS||kr| |dSdS)a! Autosave a file if necessary. If the file is newly created (and thus not named by the user), do nothing. If the current contents are the same as the autosave file (if it exists) or the original file (if no autosave filee exists), then do nothing. If the current contents are the same as the file on disc, but the autosave file is different, then remove the autosave file. In all other cases, autosave the file. Args: index (int): index into self.stack.data Nz#KeyError when retrieving hash of %s) r2data newly_createdr\rrr-r. compute_hashrrr0)rindexfinfo orig_filename orig_hashnew_hashr| autosave_hashs rmaybe_autosavezAutosaveForStack.maybe_autosavecs6 &    F  (7II    LL> N N NIII  :**511 D- - - $ 1- @  ,->?M=((y((--m<<<<<MM%((((( )( 9$$ e$$$$$%$s 2'AAc||j}td|j| |j|||j|}||j|<dS#t$rW}td |j|}t||}| Yd}~dSd}~wwxYw)a= Autosave a file. Save a copy in a file with name `self.get_autosave_filename()` and update the cached hash of the autosave file. An error dialog notifies the user of any errors raised when saving. Args: fileinfo (FileInfo): file that is to be autosaved. zAutosaving %s to %szError while autosaving {} to {}N) rr\r-r.r2_write_to_filerrrrrCrr)rrr|rrJrrs rr0zAutosaveForStack.autosaves!66u~FF *EN ? ? ? J33E::M2?D . / / / % % %9::ven.?@@ (77F  " " $ $ $ $ $ $ $ $ $  %s?A>> CA CCct|jD]}||dS)z*Autosave all opened files where necessary.N)ranger2get_stack_countr)rrs rr1zAutosaveForStack.autosave_allsH4:557788 ' 'E    & & & & ' 'rc0 |j|}n.#t$r!td||d}YnwxYw||||j|=||j|<|j|}||dS)z Update autosave files after a file is renamed. Args: old_name (str): name of file before it is renamed new_name (str): name of file after it is renamed z&KeyError when handling rename %s -> %sN)rrr-rJrr2 has_filenamer)rold_namenew_nameold_hashrs r file_renamedzAutosaveForStack.file_renameds '1HH    LLA!8 - - -HHH   !!(+++   *)1D X & ''11 E"""""s (;;N) rmrnrorprrrrrrr0r1rr5rrrtrts     !!!0(EEE>!!!:(%(%(%T%%%.''' #####rrt)rprFloggingr:os.pathpathr>r@ qtpy.QtCorerspyder.config.baserrr+spyder.plugins.editor.widgets.autosaveerrorr%spyder.plugins.editor.widgets.recoverrspyder.utils.programsr getLoggerrmr-objectr rtr5rrrs7,   FEEEEEEEEEKKKKKK@@@@@@333333  8 $ $n:n:n:n:n:n:n:n:b\#\#\#\#\#v\#\#\#\#\#r