o @sjdZddlmZddlmZddlmZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlZddlZddlZddlmZddlmZddlmZdd lmZddlZdd lmZd ZzeWn eywdZYnwGd d d eZGdddeZ ddZ!d|ddZ"ddZ#gdZ$ddZ%ddfddZ&dd Z'd!d"Z(d#d$Z)d%d&Z*d'd(Z+d)d*Z,d+d,Z-d}d-d.Z.d/d0Z/d1d2Z0  d~d3d4Z1d5d6Z2d7d8Z3Gd9d:d:e4Z5Gd;d<dd>e4Z7Gd?d@d@eZ8GdAdBdBe8Z9GdCdDdDeZ:GdEdFdFe4Z;GdGdHdHe4ZdKdLZ?dMdNZ@dOdPZA ddQdRZBd}dSdTZC    ddUdVZDdWdXZEdYdZZF [  [  dd\d]ZG [  [ dd^d_ZHd`daZIdbdcZJdddeZK     ddfdgZLGdhdidiejMZNdeNjOddfdjdkZP     ddldmZQdndoZRdpdqZSdrdsZTdtduZUddvdwZVdxdyZWdzd{ZXdS)zCSome general file utilities used that can be used by the Cloud SDK.)absolute_import)division)unicode_literalsN) exceptionsencoding) platforms)retry)range c@eZdZdZdS)Errorz)Base exception for the file_utils module.N__name__ __module__ __qualname____doc__rr;/tmp/google-cloud-sdk/lib/googlecloudsdk/core/util/files.pyr 6r c@r )MissingFileErrorz%Error for when a file does not exist.Nrrrrrr;rrc Cst|g}t|D]`}t|}tj||}tj||}ztj|r.t||nt ||Wq t j yP}z| |j dWYd}~q d}~wtyl}z|||t|fWYd}~q d}~ww|rtt |dS)auCopies a directory recursively, without copying file stat info. More specifically, behaves like `cp -R` rather than `cp -Rp`, which means that the destination directory and its contents will be *writable* and *deletable*. (Yes, an omnipotent being can shutil.copytree a directory so read-only that they cannot delete it. But they cannot do that with this function.) Adapted from shutil.copytree. Args: src: str, the path to the source directory dst: str, the path to the destination directory. Must not already exist and be writable. Raises: shutil.Error: if copying failed for any reason. rN)osmakedirslistdir encoding_utilDecodepathjoinisdirCopyTreeshutilcopy2r extendargsEnvironmentErrorappendsix text_type)srcdsterrorsnamesrcnamedstnameerrwhyrrrr@s*     " rFc Cs|rtjtjjkrt|}z tj||dWdSty`}z:d|}|j t j kr4tj |r4n!|j t j krFtj |rFt|d|j t jkrTt|ddWYd}~dSd}~ww)aCreates the given directory and its parents and does not fail if it exists. Args: path: str, The path of the directory to create. mode: int, The permissions to give the created directories. 0777 is the default mode for os.makedirs(), allowing reading, writing, and listing by all users on the machine. convert_invalid_windows_characters: bool, Convert invalid Windows path characters with an 'unsupported' symbol rather than trigger an OSError on Windows (e.g. "file|.txt" -> "file$.txt"). Raises: Error: if the operation fails and we can provide extra information. OSError: if the operation fails. modez"Could not create directory [{0}]: z!A file exists at that location. zPermission denied. zIPlease verify that you have permissions to write to the parent directory.N)rOperatingSystemCurrentWINDOWSMakePathWindowsCompatiblerrOSErrorformaterrnoEEXISTrrisfiler EACCES)rr2"convert_invalid_windows_charactersexbase_msgrrrMakeDiris*    r@cCs*ddt|}td|t|dS)zSleeps for a period of time based on the retry count. Args: retries_left: int, The number of retries remaining. Should be in the range of NUM_RETRIES - 1 to 0. g?zWaiting for retry: [%s]N) NUM_RETRIESloggingdebugtimesleep) retries_left time_to_waitrrr _WaitForRetrys rI) cCsB|tjks|tjks|tjksdStsdS|d}t|ddtvS)aZMatches specific error types that should be retried. This will retry the following errors: WindowsError(5, 'Access is denied'), When trying to delete a readonly file WindowsError(32, 'The process cannot access the file because it is being ' 'used by another process'), When a file is in use. WindowsError(145, 'The directory is not empty'), When a directory cannot be deleted. Args: func: function, The function that failed. exc_info: sys.exc_info(), The current exception state. Returns: True if the error can be retried or false if we should just fail. FwinerrorN)rremovermdirunlink WindowsErrorgetattrRETRY_ERROR_CODES)funcexc_infoerrr_ShouldRetryOperations rXcCdSNTr)rUrVrrrr[cCsnt}|dkr5|||r5td|||||d8}z t|||WdSt}Y|dkr5|||s dS)aAttempts to retry the failed file operation. Args: exc_info: sys.exc_info(), The current exception state. func: function, The function that failed. args: (str, ...), The tuple of args that should be passed to func when retrying. retry_test_function: The function to call to determine if a retry should be attempted. Takes the function that is being retried as well as the current exc_info. Returns: True if the operation eventually succeeded or False if it continued to fail for all retries. rz;Retrying file system operation: %s, %s, %s, retries_left=%srMTF)rBrCrDrIsysrV)rVrUr#retry_test_functionrGrrr_RetryOperations  r_cCstd|||t|tst|||jf}tr/t|dtr/t|ddddkr/t |t j t |||ftsDtj|d|dddSdS) zA function to pass as the onerror arg to rmdir for handling errors. Args: func: function, The function that failed. failed_path: str, The path of the file the error occurred on. exc_info: sys.exc_info(), The current exception state. z&Handling file system error: %s, %s, %srrMrNNrJrA)tb)rCrD isinstancetupletype __traceback__rR issubclassrSrchmodstatS_IWUSRr_rXrreraise)rU failed_pathrVrrr_HandleRemoveErrors rkcCst|}tjdddkrtj|tdntj|tdt}tj |rC|dkrGt d||d8}t |tj |rE|dks)dSdSdSdS) zCalls shutil.rmtree() with error handling to fix Windows problems. It also ensures that the top level directory deletion is actually reflected in the file system before this returns. Args: path: str, The path to remove. NrA) )onerror)onexcrz&Waiting for directory to disappear: %srM)r&r'r] version_infor rmtreerkrBrrrrCrDrI)rrGrrrRmTrees  $rrcCsVtj|}tj|}|tjjs|tjj7}|tjjs&|tjj7}||SN)rrabspathendswithsep startswith)r(r)rrr _DestInSrcs     rxc Cstj|s td|tj|rtd|t||r'td||z)td||z t ||WWdSt yPt t tj ||fsLYWdSwt yu}ztd|tj||ddt|WYd}~dSd}~ww) aRecursively moves a directory to another location. This code is mostly copied from shutil.move(), but has been scoped down to specifically handle only directories. The src must be a directory, and the dst must not exist. It uses functions from this module to be resilient against spurious file system errors in Windows. It will try to do an os.rename() of the directory. If that fails, the tree will be copied to the new location and then deleted from the old location. Args: src: str, The directory path to move. dst: str, The path to move the directory to. Raises: Error: If the src or dst directories are not valid. z%Source path '{0}' must be a directoryz%Destination path '{0}' already existsz0Cannot move a directory '{0}' into itself '{1}'.z)Attempting to move directory [%s] to [%s]z4Directory rename failed. Falling back to copy. [%s]T)symlinksN)rrrr r8existsrxrCrDrenamer7r_r]rVr copytreerr)r(r)rWrrrMoveDirs.     r}cCs\d}ttj|}||kr,tj||}tj|r|S|}tj|\}}||ksdS)aSearches directories upwards until it finds one with the given contents. This can be used to find the directory above you that contains the given entry. It is useful for things like finding the workspace root you are under that contains a configuration directory. Args: starting_dir_path: str, The path of the directory to start searching upwards from. directory_entry_name: str, The name of the directory that must be present in order to return the current directory. Returns: str, The full path to the directory above the starting dir that contains the given entry, or None if the root of the file system was hit without finding it. N)rrrrrealpathrrsplit)starting_dir_pathdirectory_entry_name prev_pathr search_dir_rrrFindDirectoryContaining@s rcCstj|s td|ttj|}ttj|}z tj||}Wn ty2YdSw| dtjj  o@|dkS)aReturns whether ancestor_directory is an ancestor of path. Args: ancestor_directory: str, path to the directory that is the potential ancestor of path path: str, path to the file/directory that is a potential descendant of ancestor_directory Returns: bool, whether path has ancestor_directory as an ancestor. Raises: ValueError: if the given ancestor_directory is not, in fact, a directory. z[{0}] is not a directory.Fz..) rrr ValueErrorr8rrr~relpathrwrv)ancestor_directoryrrelrrrIsDirAncestorOf]s   rcCsttjdS)z5Returns properly encoded system PATH variable string.PATH)rGetEncodedValuerenvironrrrr_GetSystemPath|rcCsT|s t}|s gS|tj}g}|D]}tj||}tj|r'||q|S)aTries to find all 'executable' in the directories listed in the PATH. This is mostly copied from distutils.spawn.find_executable() but with a few differences. It does not check the current directory for the executable. We only want to find things that are actually on the path, not based on what the CWD is. It also returns a list of all matching executables. If there are multiple versions of an executable on the path it will return all of them at once. Args: executable: The name of the executable to find path: A path to search. If none, the system PATH will be used. Returns: A list of full paths to matching executables or an empty list if none are found. )rrrpathseprrr;r%) executablerpathsmatchingpfrrrSearchForExecutableOnPaths   rcCst|tjr td||D]0}|tjD]'}|d}tj tj |||}tj |r>t |tjr>|SqqdS)a}Internal function to a find an executable. Args: executable: The name of the executable to find. path: A list of directories to search separated by 'os.pathsep'. pathext: An iterable of file name extensions to use. Returns: str, the path to a file on `path` with name `executable` + `p` for `p` in `pathext`. Raises: ValueError: invalid input. zr_FindExecutableOnPath(..., pathext='{0}') failed because pathext must be an iterable of strings, but got a string."N)rar& string_typesrr8rrrstriprnormpathrr;accessX_OK)rrpathextext directoryfullrrr_FindExecutableOnPaths   rcCs|tjjkrdSdS)N)z.exez.cmdz.batz.comz.ps1)z.sh)rr3r5)platformrrr_PlatformExecutableExtensionss rcCs|stj|drtd|tj|rtd||dur,t}|dur+dSn|}|dur4|nttj }t |||S)a$Searches for `executable` in the directories listed in `path` or $PATH. Executable must not contain a directory or an extension. Args: executable: The name of the executable to find. path: A list of directories to search separated by 'os.pathsep'. If None then the system PATH is used. pathext: An iterable of file name extensions to use. If None then platform specific extensions are used. allow_extensions: A boolean flag indicating whether extensions in the executable are allowed. Returns: The path of 'executable' (possibly with a platform-specific extension) if found and executable, None if not found. Raises: ValueError: if executable has a path or an extension, and extensions are not allowed, or if there's an internal error. rMzWFindExecutableOnPath({0},...) failed because first argument must not have an extension.zQFindExecutableOnPath({0},...) failed because first argument must not have a path.N) rrsplitextrr8dirnamerrrr3r4r)rrrallow_extensionseffective_patheffective_pathextrrrFindExecutableOnPaths,  rc CsTtj|stdj|dtj|d}t|tjr#t|tjs%dStj|djt d}t dD]q}zt |tj tj Bd}t|Wn,tyv}z |jtjkr`WYd }~dS|jtjtjfvrqtdj|dd }~wwz t|Wd Sty}z|jtjkrWYd }~dS|jtjkrWYd }~q6d }~wwdS) a7Determines if the current user is able to modify the contents of the dir. Args: directory: str, The full path of the directory to check. Raises: ValueError: If the given directory path is not a valid directory. Returns: True if the current user has missing write and execute permissions. z+The given path [{path}] is not a directory.r.Fz.HasWriteAccessInDir{pid})pidr iNT)rrrrr8rrrW_OKgetpidr openO_RDWRO_CREATcloser7r9r<ENOTDIRENOENTrO)rrrfdrWrrrHasWriteAccessInDirsH          rcCsttS)z%Returns os.getcwd() properly decoded.)rrrgetcwdrrrrGetCWD8rrc@s>eZdZdZdddZeddZddZd d Zd d Z d S)TemporaryDirectoryzA class to easily create and dispose of temporary directories. Securely creates a directory for temporary use. This class can be used with a context manager (the with statement) to ensure cleanup in exceptional situations. FcCs0t|_d|_|rt|_t|jdSdSrs)tempfilemkdtemp_TemporaryDirectory__temp_dir_curdirrrchdir)self change_torrr__init__Es zTemporaryDirectory.__init__cC|jSrs)rrrrrrLszTemporaryDirectory.pathcCrrsrrrrr __enter__PszTemporaryDirectory.__enter__cCs6z|WdStj|||gtRYdS)NF)CloserRaiseWithContextr]rV)r prev_exc_type prev_exc_valprev_exc_tracerrr__exit__Ss  zTemporaryDirectory.__exit__cCs4|jdur t|j|jrt|jd|_dSdS)NTF)rrrrrrrrrrrr\s   zTemporaryDirectory.CloseNF) rrrrrpropertyrrrrrrrrr=s   rc@sjeZdZdZejfddZddZddZdd Z d d Z d d Z e ejfddZ e ejfddZdS)Checksumz@Consistently handles calculating checksums across the Cloud SDK.cCs||_t|_dS)zCreates a new Checksum.N)_Checksum__hashset_Checksum__files)r algorithmrrrris zChecksum.__init__cCs|jt||S)zAdds the given contents to the checksum. Args: contents: str or bytes, The contents to add. Returns: self, For method chaining. )rupdater& ensure_binary)rcontentsrrr AddContentsns zChecksum.AddContentscCsNt|} |d}|sn|j|qWd|S1s wY|S)zAdds the contents of the given file to the checksum. Args: file_path: str, The file path of the contents to add. Returns: self, For method chaining. TiN)BinaryFileReaderreadrr)r file_pathfpchunkrrrAddFileContentszs    zChecksum.AddFileContentsc Cst|}t|D]s\}}}|jtjjd|jtjjd|D])}tj||}tj|rJtj ||}|j || || t |q!|D]/}tj||}tj ||}|j || |tj|rw| t |qM||qMq |S)aAdds all files under the given directory to the checksum. This adds both the contents of the files as well as their names and locations to the checksum. If the checksums of two directories are equal this means they have exactly the same files, and contents. Args: dir_path: str, The directory path to add all files from. Returns: self, For method chaining. )key)r&r'rwalksortrnormcaserislinkrraddrreadlinkr) rdir_pathrootdirsfilesdrrrrrr AddDirectorys,         zChecksum.AddDirectorycCs |jS)z~Gets the hex digest for all content added to this checksum. Returns: str, The checksum digest as a hex string. )r hexdigestrrrr HexDigests zChecksum.HexDigestcCr)zGets the list of all files that were discovered when adding a directory. Returns: {str}, The relative paths of all files that were found when traversing the directory tree. )rrrrrFilesszChecksum.FilescCst|d|S)zCreates a Checksum containing one file. Args: input_path: str, The file path of the contents to add. algorithm: a hashing algorithm method, a la hashlib.algorithms Returns: Checksum, The checksum containing the file. r)rr input_pathrrrrFromSingleFiles zChecksum.FromSingleFilecCstj||dS)aGets the hex digest of a single file. Args: input_path: str, The file path of the contents to add. algorithm: a hashing algorithm method, ala hashlib.algorithms Returns: str, The checksum digest of the file as a hex string. r)rrrrrrrHashSingleFiles zChecksum.HashSingleFileN)rrrrhashlibsha256rrrrrr staticmethodrrrrrrrfs )  rc@s(eZdZdZddZddZddZdS) ChDirzNDo some things from a certain directory, and reset the directory afterward. cCs ||_dSrs) _ChDir__dir)rrrrrrs zChDir.__init__cCst|_t|j|jSrs)r_ChDir__original_dirrrrrrrrrs zChDir.__enter__cCst|jdSrs)rrr)rtypvaluer`rrrrszChDir.__exit__N)rrrrrrrrrrrrs  rc@ eZdZdS)FileLockLockingErrorNrrrrrrrrrc@r )FileLockTimeoutErrorzA case of FileLockLockingError.Nrrrrrrrrc@r)FileLockUnlockingErrorNrrrrrrrrc@s:eZdZdZd ddZddZddZd d Zd d ZdS)FileLockzA file lock for interprocess (not interthread) mutual exclusion. At most one FileLock instance may be locked at a time for a given local file path. FileLock instances may be used as context objects. NcCsB||_||_d|_d|_tjtjjkrt|_ dSt |_ dS)a)Constructs the FileLock. Args: path: str, the path to the file to lock. The directory containing the file must already exist when Lock() is called. timeout_secs: int, seconds Lock() may wait for the lock to become available. If None, Lock() may block forever. NF) _path _timeout_secs_file_lockedrr3r4r5_WindowsLocking_impl _PosixLocking)rr timeout_secsrrrrs   zFileLock.__init__c Cs|jrdSzt|j|_Wnty}zt|d}~wwd}|jdur*d|j}tj|d}z|j |j j |j gddWntj y]}z|jd|_td|jd}~wwd|_dS)aTOpens and locks the file. A no-op if this FileLock is already locked. The lock file is created if it does not already exist. Raises: FileLockLockingError: if the file could not be opened (or created when necessary). FileLockTimeoutError: if the file could not be locked before the timeout elapsed. Ni) max_wait_msd)r#sleep_msz#Timed-out waiting to lock file: {0}T)r FileWriterrrr rrr RetryerRetryOnExceptionrTryLockfilenoRetryExceptionrrr8)rrWr rrrrLocks2        z FileLock.Lockc Csx|jsdSz*z |j|jWnty!}zt|d}~wwW|jd|_d|_dS|jd|_d|_w)zUnlocks and closes the file. A no-op if this object is not locked. Raises: FileLockUnlockingError: if a problem was encountered when unlocking the file. There is no need to retry. NF)rrUnlockrrIOErrorrr)rrWrrrr8s    zFileLock.UnlockcCs ||S)z'Locks and returns this FileLock object.)rrrrrrMszFileLock.__enter__c CsFz|WdSty"}ztd|j|WYd}~dSd}~ww)z(Unlocks, logging any errors encountered.z'Encountered error unlocking file %s: %sNF)rr rCrDr)rexc_typeexc_valexc_tbrWrrrrRs zFileLock.__exit__rs) rrrrrrrrrrrrrrs " rc@ eZdZdZddZddZdS)rz6Exclusive, non-blocking file locking on POSIX systems.cCs ddl}|||j|jBdS)Raises IOError on failure.rN)fcntlflockLOCK_EXLOCK_NBrrrrrrrasz_PosixLocking.TryLockcCsddl}|||jdS)Nr)rrLOCK_UNrrrrrhsz_PosixLocking.UnlockNrrrrrrrrrrr^ rc@r)rz0Exclusive, non-blocking file locking on Windows.cCsddl}|||jddS)rrNrM)msvcrtlockingLK_NBLCKrrr#rrrrqsz_WindowsLocking.TryLockcCsddl}|||jddS)NrrM)r#r$LK_UNLCKr&rrrrxsz_WindowsLocking.UnlockNr!rrrrrnr"rc csz|}WnttjfydVYdSwtjr "file$.txt"). Raises: ValueError: file_name or contents is empty. TypeError: contents is not a valid string. Nz&Empty file_name [{}] or contents [{}].zInvalid contents [{}].T)privater=wF)r2dirdelete)rr8rar&r TypeErrorrrrrerrorrr3r+WriteFileContentsrNamedTemporaryFiler2r3r{r+) file_namerr=r temp_filerrrWriteFileAtomicallys6      "rCcCsfd}|dur dd}tt|D]}|dD]}tj|d|}||r/|tj|7}qq|S)zEReturns sum of sizes of not-ignored files under given path, in bytes.rNcSrYrZrxrrrr[r\z"GetTreeSizeBytes..rA)rrr&r'rrgetsize)r predicateresultrrArrrrGetTreeSizeBytess rIc cs|st}|dur dd}|durdd}ttt|D](\}}}|||r2|D]}|Vq,||D]} tj|| } || rF| Vq6qdS)a6Yields a generator that list all the files in a directory tree. Walks directory tree from path and yeilds all files that it finds. Will expand paths relative to home dir e.g. those that start with '~'. Args: path: string, base of file tree to walk. include_dirs: bool, if true will yield directory names in addition to files. file_predicate: function, boolean function to determine which files should be included in the output. Default is all files. dir_sort_func: function, function that will determine order directories are processed. Default is lexical ordering. file_sort_func: function, function that will determine order directories are processed. Default is lexical ordering. Yields: Generator: yields all files and directory paths matching supplied criteria. NcSrYrZrrDrrrr[#r\z)GetDirectoryTreeListing..cSs|Srs)rrDrrrr[%s)sortedrr ExpandHomeDirr&r'rr) r include_dirsfile_predicate dir_sort_funcfile_sort_funcrrrrrArrrrGetDirectoryTreeListing s& rPc Cbzt| }|WdWS1swYWdSty0}ztd||d}~ww)zReads the text contents from the given path. Args: path: str, The file path to read. Raises: Error: If the file cannot be read. Returns: str, The text string read from the file. NUnable to read file [{0}]: {1}) FileReaderrr$r r8rrrWrrrReadFileContents2 (rUc CrQ)zReads the binary contents from the given path. Args: path: str, The file path to read. Raises: Error: If the file cannot be read. Returns: bytes, The byte string read from the file. NrR)rrr$r r8rTrrrReadBinaryFileContentsGrVrWTc Csz+t||t|||||d}|t|WdWdS1s$wYWdSty?}ztd||d}~ww)aWrites the given text contents to a file at the given path. Args: path: str, The file path to write to. contents: str, The text string to write. overwrite: bool, False to error out if the file already exists. private: bool, True to make the file have 0o600 permissions. create_path: bool, True to create intermediate directories, if needed. newline: str, The line ending style to use, or None to use platform default. convert_invalid_windows_characters: bool, Convert invalid Windows path characters with an 'unsupported' symbol rather than trigger an OSError on Windows (e.g. "file|.txt" -> "file$.txt"). Raises: Error: If the file cannot be written. )r9 create_pathnewliner=NUnable to write file [{0}]: {1})_CheckOverwriter r2rrr$r r8) rr overwriter9rXrYr=rrWrrrr?\s  & r?c Csxz't||t||||d}||WdWdS1s wYWdSty;}ztd||d}~ww)avWrites the given binary contents to a file at the given path. Args: path: str, The file path to write to. contents: str, The byte string to write. overwrite: bool, False to error out if the file already exists. private: bool, True to make the file have 0o600 permissions. create_path: bool, True to create intermediate directories, if needed. convert_invalid_windows_characters: bool, Convert invalid Windows path characters with an 'unsupported' symbol rather than trigger an OSError on Windows (e.g. "file|.txt" -> "file$7.txt"). Raises: Error: If the file cannot be written. r9rXr=NrZ)r[BinaryFileWriterr2r$r r8)rrr\r9rXr=rrWrrrWriteBinaryFileContentss  &r_cCs&|stj|rtd|dSdS)Nz3File [{0}] already exists and cannot be overwritten)rrrzr r8)rr\rrrr[s r[cCst|ddddS)zOpens the given file for text read for use in a 'with' statement. Args: path: str, The file path to read from. Returns: A file-like object opened for read in text mode. rtrutf-8r _FileOpenerrrrrrSs rScCsttj|ddddS)zOpens the given file for binary read for use in a 'with' statement. Args: path: str, The file path to read from. Returns: A file-like object opened for read in binary mode. rarrbr)rcrEncoderrrrrs rc Cs$|rdnd}t||dd||||dS)aOpens the given file for text write for use in a 'with' statement. Args: path: str, The file path to write to. private: bool, True to create or update the file permission to be 0o600. append: bool, True to append to an existing file. create_path: bool, True to create intermediate directories, if needed. newline: str, The line ending style to use, or None to use plaform default. convert_invalid_windows_characters: bool, Convert invalid Windows path characters with an 'unsupported' symbol rather than trigger an OSError on Windows (e.g. "file|.txt" -> "file$7.txt"). Returns: A file-like object opened for write in text mode. atwtr2ra)rr9rXrYr=rb)rr9r%rXrYr=r2rrrr s r c@seZdZdZdZdZdS)BinaryFileWriterModeabzr+bwbN)rrrAPPENDMODIFYTRUNCATErrrrrhsrhcCst||jd|||dS)apOpens the given file for binary write for use in a 'with' statement. Args: path: str, The file path to write to. private: bool, True to create or update the file permission to be 0o600. mode: BinaryFileWriterMode, Determines how to open file for writing. create_path: bool, True to create intermediate directories, if needed. convert_invalid_windows_characters: bool, Convert invalid Windows path characters with an 'unsupported' symbol rather than trigger an OSError on Windows (e.g. "file|.txt" -> "file$7.txt"). Returns: A file-like object opened for write in binary mode. r2r])rcr)rr9r2rXr=rrrr^sr^c Cs|rtjtjjkrt|}|rt||rt|z tj||||dWSt yJ}zt } t |t r=|j t jkr=t} | d|||d}~ww)z6Opens a file in various modes and does error handling.)rrYzUnable to {0} file [{1}]: {2}N)rr3r4r5r6 PrivatizeFile_MakePathToFiler)rr$r rarr9rrr8) rr2verbrr9rXrYr=rWrrrrrc s   rccCstdS)z-Returns the current user HOME directory path.~)rKrrrr GetHomeDir(srrcCsttj|S)z:Returns path with leading ~ or ~ expanded.)rrrr expanduserrrrrrK-srKcCsttjt|S)zExpands ~ and ENV_VARS in path.)rrrr expandvarsrKrrrrExpandHomeAndVars2srucCs$tjjjj}tjtj||S)z7Converts url to path string and normalizes path string.) r&movesurllibrequest url2pathnamerrrr)urlryrrrNormalizePathFromURL7s r{cCs.tj|\}}tjt|}t||dSrs)rrrr~rKr@)rr2parent_dir_pathrfull_parent_dir_pathrrrro=sroc Csz7tj|rt|dWdSt|ddtjtjBtjB}ttdr)|tj O}t ||d}t |WdSt yK}zt d||d}~ww)aMakes an existing file private or creates a new, empty private file. In theory it would be better to return the open file descriptor so that it could be used directly. The issue that we would need to pass an encoding to os.fdopen() and on Python 2. This is not supported. Instead we just create the empty file and then we will just open it normally later to do the write. Args: path: str, The path of the file to create or privatize. iir1 O_NOINHERITz(Unable to create private file [{0}]: {1}N)rrrzrfrorrO_TRUNChasattrr~rrr$r r8)rflagsrrWrrrrnCs    rnccsJt|}|D] }||r|VqWddS1swYdS)z/Read all lines from a text file matching regex.N)rSmatch)rregexrlinerrrFilteredFileReader`s  "r)r0Frs)NNFr)FNNN)TFTNF)TFTF)FFFNF)NFFNF)r0)Yr __future__rrr contextlibenumr9rr)rCrr rgr]rrEgooglecloudsdk.corergooglecloudsdk.core.utilrrrr r& six.movesr rBrR NameError Exceptionr rrr@rIrTrXr_rkrrrxr}rrrrrrrrrobjectrrrrrrrrrcontextmanagerr0r6r8rCrIrPrUrWr?r_r[rSrr Enumrhrmr^rcrrrKrur{rornrrrrrs          )$  !  % !! .@)za & : ( . $   !