+0rdZddlmZddlmZddlmZddlZddlZddlZddlZddl Z ddl m Z ddl m Z ddl mZdd l mZdd lmZdd lmZdd lmZddlZd ZGdde j.ZGddeZdZdZdZej8dZGddeZdZ GddeZ!GddeZ"y)z/Utilities for gcloud help document differences.)absolute_import)division)unicode_literalsN) exceptions)log) console_io)progress_tracker)files)parallel)text ceZdZdZy)ErrorzErrors for this module.N__name__ __module__ __qualname____doc__0lib/googlecloudsdk/command_lib/meta/help_util.pyrr*srrceZdZdZy)HelpUpdateErrorzUpdate errors.Nrrrrrr.srrcFtjj|dk(S)z-Return True if path refers to an OWNERS file.OWNERS)ospathbasename)rs r IsOwnersFiler2s   $ 8 ++rc tj|}d}||fS#t$rtj|}d}Y||fSwxYw)zReturns the file contents and whether or not the file contains binary data. Args: file: A file path. Returns: A tuple of the file contents and whether or not the file contains binary contents. FT) file_utilsReadFileContents UnicodeErrorReadBinaryFileContents)filecontents is_binarys rGetFileContentsr(7sZ**40HI 9  006HI 9 s AAc,t}tjtj|D]^\}}}|D]S}tj j ||}tj j||}|j|U`|S)zGenerates the set of all files in directory and its children recursively. Args: directory: The directory path name. Returns: A set of all files in directory and its children recursively, relative to the directory. ) setrwalksix text_typerjoinrelpathadd) directorydirfilesdirpath_r namer% relative_files rGetDirFilesRecursiver7JssU(773==#;<gq% WW\\'4 (dggoodI6mll=!= /rc# Ktj|d5tj}dtj|z }tjj dj ||dddy#1swYyxYww)z:Context manager to track progress and time blocks of code.T)autotickNz{} took {} seconds)r ProgressTrackertimerstatusPrintformat)messagestart elapsed_times rTimeItrB^sb''$? IIKE 99;&LJJ)00,GH @??sBAB9 BB Bc0eZdZdZdZdZddZdZdZy) DiffAccumulatorz0A module for accumulating DirDiff() differences.cd|_y)Nr_changesselfs r__init__zDiffAccumulator.__init__ks DMrcy)Checks if relative_file should be ignored by DirDiff(). Args: relative_file: A relative file path name to be checked. Returns: True if path is to be ignored in the directory differences. Fr)rIr6s rIgnorezDiffAccumulator.Ignoreos rNc.|xjdz c_y)aCalled for each file difference. AddChange() can construct the {'add', 'delete', 'edit'} file operations that convert old_dir to match new_dir. Directory differences are ignored. This base implementation counts the number of changes. Args: op: The change operation string; 'add'; relative_file is not in old_dir. 'delete'; relative_file is not in new_dir. 'edit'; relative_file is different in new_dir. relative_file: The old_dir and new_dir relative path name of a file that changed. old_contents: The old file contents. new_contents: The new file contents. Returns: A prune value. If non-zero then DirDiff() returns immediately with that value. NrFrIopr6 old_contents new_contentss r AddChangezDiffAccumulator.AddChange{s, MMQM rc|jS)z Returns the accumulated changes.rFrHs r GetChangeszDiffAccumulator.GetChangess ==rcy)zCalled for each file for content validation. Args: relative_file: The old_dir and new_dir relative path name of an existing file. contents: The file contents string. Nr)rIr6r&s rValidatezDiffAccumulator.Validates rNN) rrrrrJrMrTrVrXrrrrDrDhs8 2 rrDctd5t}dddtd5tdddfd}tjd5}g}D]8}j |r|j ||f}|j |:|D]?} | j}|s|\} }} } j| || | } | s4| ccdddS dddD]1}j |r|vsjd|} | s/| cSy#1swY xYw#1swYxYw#1swYYxYw)aCalls diff.AddChange(op, file) on files that changed from old_dir new_dir. diff.AddChange() can construct the {'add', 'delete', 'edit'} file operations that convert old_dir to match new_dir. Directory differences are ignored. Args: old_dir: The old directory path name. new_dir: The new directory path name. diff: A DiffAccumulator instance. Returns: The return value of the first diff.AddChange() call that returns non-zero or None if all diff.AddChange() calls returned zero. zGetDirFilesRecursive new filesNzGetDirFilesRecursive old filescttjj|\}}|sj |||vr=ttjj|\}}||k(r||k(ryd|||fSd|d|fS)z$Diffs a file in new_dir and old_dir.Neditr0)r(rrr.rX) r%rS new_binaryrR old_binarydiffnew_dirold_dir old_filess r _FileDiffzDirDiff.._FileDiffs.rww||GT/JKL*  mmD,' y!0gt1L!MlJ z !ll&B T< 55 D$ ,,rdelete) rBr7r GetPoolrM ApplyAsyncappendGetrT)rar`r_ new_filesrcpoolresultsr%result result_futurerQrRrSprunerbs``` @rDirDiffrps6./$W-I0 ./$W-I0 -tG T y4'2f nnV  !   "f /5,D, r4|D ,! d {{4 9nnXt,e   U0///"s5 D$ D1 AD=8D=D=#D=$D.1D:=Ec2eZdZdZdfd ZdZddZxZS)HelpAccumulatorzAccumulates help document directory differences. Attributes: _changes: The list of DirDiff() (op, path) difference tuples. _restrict: The set of file path prefixes that the accumulator should be restricted to. ctt| g|_|rE|Dchc]3}tj j |jddd5c}|_yi|_ycc}w)N.rO) superrrrJrGrsepr.split _restrict)rIrestrictr __class__s rrJzHelpAccumulator.__init__s\ /4)+DM!?GGhrvv{{1773<#34hGDN') NGs8A*ct|ry|jsy|jD]+}||k(s#|j|tjzs+yy)rLTF)rrx startswithrrv)rIr6items rrMzHelpAccumulator.IgnoresLM"  >>  $ -":":4"&&="I rc>|jj||fy)agAdds an DirDiff() difference tuple to the list of changes. Args: op: The difference operation, one of {'add', 'delete', 'edit'}. relative_file: The relative path of a file that has changed. old_contents: The old file contents. new_contents: The new file contents. Returns: None which signals DirDiff() to continue. N)rGrhrPs rrTzHelpAccumulator.AddChanges MM"m,- rNrY)rrrrrJrMrT __classcell__)r{s@rrrrrs+ $ rrrc.eZdZdZddZdZddZddZy) HelpUpdatera2Updates the document directory to match the current CLI. Attributes: _cli: The Current CLI. _directory: The help document directory. _generator: The document generator. _hidden: Boolean indicating whether to update hidden commands. _test: Show but do not apply operations if True. ctjj|std|z||_||_||_||_||_y)a}Constructor. Args: cli: The Current CLI. directory: The help document directory. generator: An uninstantiated walker_util document generator. test: Show but do not apply operations if True. hidden: Boolean indicating whether the hidden commands should be used. Raises: HelpUpdateError: If the destination directory does not exist. z,Destination directory [%s] must be absolute.N) rrisabsr_cli _directory _generator_hidden_test)rIclir1 generatortesthiddens rrJzHelpUpdater.__init__sN 77== #  89 D FFDIDODODLDJrc tj5}tjd}t d5|j |j ||j|}dddtj}|jjd|jtj|z }tjdj|t|}t d 5t!|j"||dddt%j&t(}d } t d 5t+|j-D]b\} } | d z } |j.r | t0kr/tj2j5d j| | || j7| d ddd|j.rx| rk| t0k\rtj2j5dtj2j5dj| t9j:| d| cdddSt d5dD]} || D]} t<j>jA|j"| } | dvrr| dk(r6t<j>jC| } | rtjD| t<j>jA|| }tGjH|| | dk(s t=jJ|  ddd| cdddS#1swYxYw#1swY6xYw#1swYxYw#tL$rY wxYw#1swYKxYw#1swYyxYw)zEUpdate() helper method. Returns the number of changed help doc files.zGenerating Help Document Files)labelzCreating walkerryNTrz.Generating Help Document Files took {} secondsDiffingrz Getting diffsrOz{0} {1}z...z{0} help text {1} changedr%zUpdating destination files)r0r\re)r0r\r0re)'r!TemporaryDirectoryr ProgressBarrBrr SetProgressr;StartWalkFinishrinfor>rrrpr collections defaultdictlistsortedrVrTEST_CHANGES_DISPLAY_MAXr<r=rhr Pluralizerrr.dirnameMakeDirshutilcopyfileremoveOSError)rIrytemp_dirpbwalkerr@rAr_opschangesrQr dest_pathsubdir temp_paths r_UpdatezHelpUpdater._Update1s  & & (H  ! !(H Ib # $ IIx(!D %iikehhj kkkiikYY[5(l hh : A A, Oh /d ) 40   # #D )cg / "t01HB Q,'w)AA JJ  Y--b$7 8 b'..  2 #   0 0 JJ  U # **  6==t~~gv68 9G ) (J . /+B"gd T__d;I_$u3$$V,'',,x6iooi3x )$, 0"m ) ( % $   # ": 0 /K ) (s"N*M!B NM .NA?MBN NB3M7M'(M7- NM N M NM$ N' M4 0M73M4 4M77N <NN Nc"tjj|jst d|jz |j |S#t ttf$r&}t dtj|zd}~wwxYw)aUpdates the help document directory to match the current CLI. Args: restrict: Restricts the walk to the command/group dotted paths in this list. For example, restrict=['gcloud.alpha.test', 'gcloud.topic'] restricts the walk to the 'gcloud topic' and 'gcloud alpha test' commands/groups. Raises: HelpUpdateError: If the destination directory does not exist. Returns: The number of changed help document files. z8Destination directory [%s] must exist and be searchable.zUpdate failed: %sN) rrisdirrrrIOErrorr SystemErrorr,r-)rIryes rUpdatezHelpUpdater.Updateks| 77== )  D //  D \\( ## Wk *D /#--2BB CCDsAB(!B  Bc0tj5}|j|j|d|}|j dt |}t |j||t|jcdddS#1swYyxYw)zFPrint a list of help text files that are distinct from source, if any.NrTr) r!rrrrrrrprrrV)rIryrrr_s r GetDiffFileszHelpUpdater.GetDiffFilesss  & & (H ))Xth8f kkk h /d doox. DOO% & ) ( (s A-B  B)FFr)rrrrrJrrrrrrrrs,8tD0'rr)#r __future__rrrr contextlibrrr;googlecloudsdk.corerrgooglecloudsdk.core.consolerr googlecloudsdk.core.utilr r!r r r,rrrrr(r7contextmanagerrBobjectrDrprrrrrrrs 6&' *#288-)  J   e, &( II8 f8 v9x.o.b{'&{'r