3
T'íc ã @ sî d Z ddlZddlZddlZddlZddlZddlZddlZddlm Z ddlm
Z
ddl m Z m
Z
mZmZmZmZ ddlmZ yddlm
Z W n ek
r¨ dZY nX dZeedd d
Zeed d d
ZeeedddZeddddZ ee eee dddZ eeddddZ eeddddZ eeddd d Z!ej"d Z#ej"d Z$eed d!d"Z%eed#d$d%Z&ej'feeed&d'd(Z(e(Z)ej* p ej+ Z,eed)d*d+Z-ej.ee
d3 d,d-d.Z/G d/d0 d0Z0eddd1d2Z1dS )4z6Operating system-related utility functions for Sphinx.é N)ÚStringIO)Úpath)ÚAnyÚ GeneratorÚIteratorÚListÚOptionalÚType)ÚRemovedInSphinx50Warningú/)Ú
canonicalpathÚreturnc C s | j ttjS )N)ÚreplaceÚSEPr Úsep)r © r ú4/tmp/pip-build-gk9425m9/sphinx/sphinx/util/osutil.pyÚos_path s r )Ú
nativepathr
c C s | j tjtS )z"Return path in OS-independent form)r r r r )r r r r Ú
canon_path# s r )ÚbaseÚtor
c C sÄ |j tr|S | jdd jt}|jdd jt}xDt|dd
|dd
D ]&\}}||krdP |jd |jd qRW ||krdS t|dkr¦|dgkr¦dt S dt t|d tj| S )
z.Return a relative URL from ``base`` to ``to``.ú#r Né Ú Ú.z..éÿÿÿÿr )Ú
startswithr ÚsplitÚzipÚpopÚlenÚjoin)r r Zb2Út2ÚxÚyr r r Ú relative_uri( s
$
r& )r r
c C s t j| dd dS )zEnsure that a path exists.T)Úexist_okN)ÚosÚmakedirs)r r r r Ú ensuredir? s r* )ÚdirnamesÚsuffixr
c c sr xl| D ]d}x^t j|D ]P\}}}xD|D ]<}|j|r&ytjtj||V W q& tk
r` Y q&X q&W qW qW d S )N)r( ÚwalkÚendswithr Úgetmtimer" ÚOSError)r+ r, ÚdirnameÚrootZ_dirsÚfilesÚsfiler r r Úmtimes_of_filesD s
r5 )ÚsourceÚdestr
c C sP t jdtdd tjj|r@ytj| W n tk
r> Y nX tj| | dS )z3Move a file, removing the destination if it exists.zYsphinx.util.osutil.movefile() is deprecated for removal. Please use os.replace() instead.é )Ú
stacklevelN) ÚwarningsÚwarnr
r( r ÚexistsÚunlinkr0 Úrename)r6 r7 r r r ÚmovefileO s
r? c C s, t j| }tt dr(t j||j|jf dS )z!Copy a file's modification times.ÚutimeN)r( ÚstatÚhasattrr@ Úst_atimeÚst_mtime)r6 r7 Ústr r r Ú copytimes\ s
rF c C sN t j| stj| | rJtj| | yt| | W n tk
rH Y nX dS )z{Copy a file and its modification times, if possible.
Note: ``copyfile`` skips copying if the file has not been changedN)r r< ÚfilecmpÚcmpÚshutilÚcopyfilerF r0 )r6 r7 r r r rJ c s rJ z[^a-zA-Z0-9_-]z Documentation$)Ústringr
c C s t jd| pdS )Nr Zsphinx)Úno_fn_reÚsub)rK r r r Ú
make_filenamet s rN )Úprojectr
c C s t tjd| j S )Nr )rN Úproject_suffix_rerM Úlower)rO r r r Úmake_filename_from_projectx s rR )r Ústartr
c C s( yt jj| |S tk
r" | S X dS )a Return a relative filepath to *path* either from the current directory or
from an optional *start* directory.
This is an alternative of ``os.path.relpath()``. This returns original path
if *path* and *start* are on different drives (for Windows platform).
N)r( r ÚrelpathÚ
ValueError)r rS r r r rT | s rT )Úpathdirr
c C sv t d k rt| t r| j S tj| } t| trny| jt} W n0 tk
rl } ztdt |W Y d d }~X nX | S d S )NzAmultibyte filename not supported on this filesystem encoding (%r))ÚPathÚ
isinstanceÚabspathr ÚbytesÚdecodeÚ fs_encodingÚUnicodeDecodeError)rV Úexcr r r rY s
rY )Ú
target_dirr
c c s. t j }zt j| d V W d t j| X d S )N)r( ÚgetcwdÚchdir)r_ Úcwdr r r Úcd s
rc c @ st e Zd ZdZeddddZeddddZdd d
d Zd d d d
Ze e
e
e e dddZ
ee dddZdS )ÚFileAvoidWritea¸ File-like object that buffers output and only writes if content changed.
Use this class like when writing to a file to avoid touching the original
file if the content hasn't changed. This is useful in scenarios where file
mtime is used to invalidate caches or trigger new behavior.
When writing to this file handle, all writes are buffered until the object
is closed.
Objects can be used as context managers.
N)r r
c C s || _ d | _d S )N)Ú_pathÚ_io)Úselfr r r r Ú__init__² s zFileAvoidWrite.__init__)Údatar
c C s | j st | _ | j j| d S )N)rf r Úwrite)rg ri r r r rj ¶ s zFileAvoidWrite.write)r
c C s | j std| j }| j j y2t| jdd}|j }||krFdS W dQ R X W n tk
rf Y nX t| jddd}|j| W dQ R X dS )z0Stop accepting writes and write file, if needed.z,FileAvoidWrite does not support empty files.zutf-8)ÚencodingNÚw) rf Ú ExceptionÚgetvalueÚcloseÚopenre Úreadr0 rj )rg ÚbufZold_fZ old_contentÚfr r r ro » s
zFileAvoidWrite.closec C s | S )Nr )rg r r r Ú __enter__Î s zFileAvoidWrite.__enter__)Úexc_typeÚ exc_valueÚ tracebackr
c C s | j dS )NT)ro )rg ru rv rw r r r Ú__exit__Ñ s zFileAvoidWrite.__exit__)Únamer
c C s | j stdt| j |S )Nz=Must write to FileAvoidWrite before other methods can be used)rf rm Úgetattr)rg ry r r r Ú __getattr__Õ s zFileAvoidWrite.__getattr__)Ú__name__Ú
__module__Ú __qualname__Ú__doc__Ústrrh rj ro rt r rm r Úboolrx r{ r r r r rd ¦ s rd c C s& t jj| rtj| n
t j| d S )N)r( r ÚisdirrI ÚrmtreeÚremove)r r r r r Þ s r )NNN)2r Ú
contextlibrG r( ÚrerI Úsysr: Úior r Útypingr r r r r r Zsphinx.deprecationr
Zsphinx.testing.pathrW Ú ImportErrorr r r r r& r* Úfloatr5 r? rF rJ ÚcompilerL rP rN rR ÚcurdirrT Z safe_relpathÚgetfilesystemencodingÚgetdefaultencodingr\ rY Úcontextmanagerrc rd r r r r r Ú<module> sH
8