c2*dZdZddlZddlZddlZddlZddlmZmZm Z m Z m Z m Z m Z ddlmZddlmZmZmZmZmZmZmZddlmZmZddlmZmZmZdd lmZdd lm Z!m"Z"dd l#m$Z$dd l%m&Z&d e'de'fdZ(dZ)de'de*fdZ+de'de'fdZ,efdZ-Gdde&Z.Gdde/Z0dZ1dZ2e$de2Z2dZ3e$de3Z3d)d e'dee'dee'fdZ4d)d edee'dee'fd!Z5e!e"dfd"e'd#e'd$ee'e'e'e'e'e'e'e'fd%ee'e'e'e'e'e'fd&e*ddf d'Z6d*d(Z7y)+a3File and file-path manipulation utilities. :group path manipulation: first_level_directory, relative_path, is_binary,get_by_ext, remove_dead_links :group file manipulation: norm_read, norm_open, lines, stream_lines, lines,write_open_mode, ensure_fs_mode, export :sort: path manipulation, file manipulation zrestructuredtext enN)isabsisdirislinksplitexistsnormpathjoin)abspath)sepmkdirremovelistdirstatchmodwalk)ST_MODES_IWRITE)OptionalListTuple) TextIOWrapper) STD_BLACKLISTIGNORED_EXTENSIONS)callable_deprecated)FileIOpathreturncXt|\}}|r|rt|\}}|r|r|r|S|S)aReturn the first level directory of a path. >>> first_level_directory('home/syt/work') 'home' >>> first_level_directory('/home/syt/work') '/' >>> first_level_directory('work') 'work' >>> :type path: str :param path: the path for which we want the first level directory :rtype: str :return: the first level directory appearing in `path` )r)rheadtails :/usr/lib/python3/dist-packages/logilab/common/fileutils.pyfirst_level_directoryr".s7"tJD$ 44[ d 4  Kcht|}t|Dcgc]}t||c}Scc}w)z*Lists path's content using absolute paths.)r rr )rfilenames r!abspath_listdirr&Hs* 4=D18 ?XDx ?? ?s/r%cr tj|djd S#t$rYywxYw)aReturn true if filename may be a binary file, according to it's extension. :type filename: str :param filename: the name of the file :rtype: bool :return: true if the file is a binary file (actually if it's mime type isn't beginning by text/) rtext) mimetypes guess_type startswithAttributeErrorr%s r! is_binaryr/Ns?''1!4??GGG s '* 66ct|ryy)zReturn the write mode that should used to open file. :type filename: str :param filename: the name of the file :rtype: str :return: the mode that should be use to open the file ('w' or 'wb') wbw)r/r.s r!write_open_moder3bs r#cRt|t}||zst|||zyy)a;Check that the given file has the given mode(s) set, else try to set it. :type filepath: str :param filepath: path of the file :type desired_mode: int :param desired_mode: ORed flags describing the desired mode. Use constants from the `stat` module for file permission's modes N)rrr)filepath desired_modemodes r!ensure_fs_moder8ps. >' "D ,  h|+, r#c<eZdZdZdededdfdZd dZd dZd d Zy) ProtectedFileaKA special file-object class that automatically does a 'chmod +w' when needed. XXX: for now, the way it is done allows 'normal file-objects' to be created during the ProtectedFile object lifetime. One way to circumvent this would be to chmod / unchmod on each write operation. One other way would be to : - catch the IOError in the __init__ - if IOError, then create a StringIO object - each write operation writes in this StringIO object - on close()/del(), write/append the StringIO content to the file and do the chmod only once r5r7rNct|t|_d|_|dvr7|jtzs$t ||jtzd|_t j|||y)NF)r2ar1abT)rr original_mode mode_changedrrr__init__)selfr5r7s r!r@zProtectedFile.__init__s_!(^G4! ) )%%0h 2 2X =>$(!h-r#cl|jr(t|j|jd|_yy)z$restores the original mode if neededFN)r?rnamer>rAs r! _restore_modezProtectedFile._restore_modes,    $))T// 0 %D  r#cN|jtj|y)zrestore mode before closingN)rErcloserDs r!rGzProtectedFile.closes  Tr#c>|js|jyyN)closedrGrDs r!__del__zProtectedFile.__del__s{{ JJLr#)rN) __name__ __module__ __qualname____doc__strr@rErGrKr#r!r:r:s0(..C.D.& r#r:ceZdZdZy)UnresolvableErrorzgException raised by relative path when it's unable to compute relative path between two paths. N)rLrMrNrOrQr#r!rSrSsr#rSct|}t|}||k(ryt|r t|s|St|r t|jt}|jt}d}g}t |dkDr]|j d}|r(t |dkDr||dk(r|j dnd}|jdt |dkDr]||z }t j|S)ajTry to get a relative path from `from_file` to `to_file` (path will be absolute if to_file is an absolute file). This function is useful to create link in `from_file` to `to_file`. This typical use case is used in this function description. If both files are relative, they're expected to be relative to the same directory. >>> relative_path( from_file='toto/index.html', to_file='index.html') '../index.html' >>> relative_path( from_file='index.html', to_file='toto/index.html') 'toto/index.html' >>> relative_path( from_file='tutu/index.html', to_file='toto/index.html') '../toto/index.html' >>> relative_path( from_file='toto/index.html', to_file='/index.html') '/index.html' >>> relative_path( from_file='/toto/index.html', to_file='/index.html') '../index.html' >>> relative_path( from_file='/toto/index.html', to_file='/toto/summary.html') 'summary.html' >>> relative_path( from_file='index.html', to_file='index.html') '' >>> relative_path( from_file='/index.html', to_file='toto/index.html') Traceback (most recent call last): File "", line 1, in ? File "", line 37, in relative_path UnresolvableError >>> relative_path( from_file='/index.html', to_file='/index.html') '' >>> :type from_file: str :param from_file: source file (where links will be inserted) :type to_file: str :param to_file: target file (on which links point) :raise UnresolvableError: if it has been unable to guess a correct path :rtype: str :return: the relative path of `to_file` from `from_file` r)rz..) rrrSrr lenpopappendr ) from_fileto_file from_partsto_partsidemresultdirnames r! relative_pathr`sV#IwGG W~YN y !!%J}}S!H D F j/A ..# CMA%'Xa[*@ LLOD MM$  j/A  hF 88F r#c6t|djS)zReturn the content of the file with normalized line feeds. :type path: str :param path: path to the file to read :rtype: str :return: the content of the file with normalized line feeds U)openreadrs r! norm_readrfs c?   !!r#zuse "open(path, 'U').read()"ct|dS)zReturn a stream for a file with content with normalized line feeds. :type path: str :param path: path to the file to open :rtype: file or StringIO :return: the opened file with normalized line feeds rb)rcres r! norm_openrh s c?r#zuse "open(path, 'U')"commentscptj|5}t||cdddS#1swYyxYw)aReturn a list of non empty lines in the file located at `path`. :type path: str :param path: path to the file :type comments: str or None :param comments: optional string which can be used to comment a line in the file (i.e. lines starting with this string won't be returned) :rtype: list :return: a list of stripped line in the file, without empty and commented lines :warning: at some point this function will probably return an iterator N)iorc stream_lines)rristreams r!linesrns0$ .&FH-...s ,5rmc |j}g}|D]:}|j}|s||j |r*|j |<|S#t$r|j}Y_wxYw)aReturn a list of non empty lines in the given `stream`. :type stream: object implementing 'xreadlines' or 'readlines' :param stream: file like object :type comments: str or None :param comments: optional string which can be used to comment a line in the file (i.e. lines starting with this string won't be returned) :rtype: list :return: a list of stripped line in the file, without empty and commented lines :warning: at some point this function will probably return an iterator ) xreadlinesr- readlinesstripr,rX)rmrirqr^lines r!rlrl.sw$%%% F  zz| X%T__X-F MM$   M %$$ %s AA.-A.from_dirto_dir blacklist ignore_extverbosec  t|t|D]\}}}|D]} |j||D]B} t || } || t |dz} t| s,t| r8t| D|D]} t|D cgc]} | j| c} r,t || } || t |dz} |rt| d| tjt| r t| tj| | y#t$rYwxYw#t$rYwxYwcc} w)aMake a mirror of `from_dir` in `to_dir`, omitting directories and files listed in the black list or ending with one of the given extensions. :type from_dir: str :param from_dir: directory to export :type to_dir: str :param to_dir: destination directory :type blacklist: list or tuple :param blacklist: list of files or directories to ignore, default to the content of `BASE_BLACKLIST` :type ignore_ext: list or tuple :param ignore_ext: list of extensions to ignore, default to the content of `IGNORED_EXTENSIONS` :type verbose: bool :param verbose: flag indicating whether information about exported files should be printed to stderr, default to False Nz->)file)r OSErrorrr ValueErrorr rVrranyendswithprintsysstderrshutilcopy2)rtrurvrwrx directorydirnames filenamesnorecursr_srcdestr%exts r!exportrLsD@  f +/x.$& 8Y! H )    Gy'*CCH 00DSzd|$K  " $HjAsH%%c*ABy(+CCH 00Dc4CJJ7d|t LLd # $$      Bs( DD+ D;  D('D(+ D87D8ct|D]M\}}}||zD]?}t||}t|st|r'|r t d|t |AOy)a"Recursively traverse directory and remove all dead links. :type directory: str :param directory: directory to cleanup :type verbose: bool :param verbose: flag indicating whether information about deleted links should be printed to stderr, default to False zremove dead linkN)rr rrrr )rrxdirpathrrr%rs r!remove_dead_linksrs`)-Y$9 9, Hw)Cc{6#;,c2s  r#rI)r)8rO __docformat__rkrrr*os.pathrrrrrrr r osr r r rrrrrrtypingrrr_iorlogilab.commonrBASE_BLACKLISTrlogilab.common.deprecationrlogilab.common.compatrrPr"r&intr/r3r8r: ExceptionrSr`rfrhrnrlrrrQr#r!rs$& GGG==="((N:(4@ ( c c +3-$,F,^  @F " B  @ A) L   ;  9 :9 E ..x}.S .,(3-4PS9B@N6H <$<$ <$S#sCc3;<<$c3S#s23 <$  <$  <$~r#