sphinx.util.osutil

module documentation

(source)

Operating system-related utility functions for Sphinx.

Class	`FileAvoidWrite`	File-like object that buffers output and only writes if content changed.
Function	`abspath`	Undocumented
Function	`canon_path`	Return path in OS-independent form
Function	`cd`	Undocumented
Function	`copyfile`	Copy a file and its modification times, if possible.
Function	`copytimes`	Copy a file's modification times.
Function	`ensuredir`	Ensure that a path exists.
Function	`make_filename`	Undocumented
Function	`make_filename_from_project`	Undocumented
Function	`mtimes_of_files`	Undocumented
Function	`os_path`	Undocumented
Function	`path_stabilize`	Normalize path separator and unicode string
Function	`relative_uri`	Return a relative URL from ``base`` to ``to``.
Function	`relpath`	Return a relative filepath to path either from the current directory or from an optional start directory.
Function	`rmtree`	Undocumented
Constant	`SEP`	Undocumented
Variable	`fs_encoding`	Undocumented
Variable	`no_fn_re`	Undocumented
Variable	`project_suffix_re`	Undocumented

def abspath(pathdir): (source) ¶

Undocumented

Parameters
pathdir:`str`	Undocumented
Returns
`str`	Undocumented

def canon_path(nativepath): (source) ¶

Return path in OS-independent form

Parameters
nativepath:`str`	Undocumented
Returns
`str`	Undocumented

@contextlib.contextmanager
def cd(target_dir): (source) ¶

Undocumented

Parameters
target_dir:`str`	Undocumented
Returns
`Generator[None, None, None]`	Undocumented

def copyfile(source, dest): (source) ¶

Copy a file and its modification times, if possible. Note: ``copyfile`` skips copying if the file has not been changed

Parameters
source:`str`	Undocumented
dest:`str`	Undocumented

def copytimes(source, dest): (source) ¶

Copy a file's modification times.

Parameters
source:`str`	Undocumented
dest:`str`	Undocumented

def ensuredir(path): (source) ¶

Ensure that a path exists.

Parameters
path:`str`	Undocumented

def make_filename(string): (source) ¶

Undocumented

Parameters
string:`str`	Undocumented
Returns
`str`	Undocumented

def make_filename_from_project(project): (source) ¶

Undocumented

Parameters
project:`str`	Undocumented
Returns
`str`	Undocumented

def mtimes_of_files(dirnames, suffix): (source) ¶

Undocumented

Parameters
dirnames:`list[str]`	Undocumented
suffix:`str`	Undocumented
Returns
`Iterator[float]`	Undocumented

def os_path(canonicalpath): (source) ¶

Undocumented

Parameters
canonicalpath:`str`	Undocumented
Returns
`str`	Undocumented

def path_stabilize(filepath): (source) ¶

Normalize path separator and unicode string

Parameters
filepath:`str`	Undocumented
Returns
`str`	Undocumented

def relative_uri(base, to): (source) ¶

Return a relative URL from ``base`` to ``to``.

Parameters
base:`str`	Undocumented
to:`str`	Undocumented
Returns
`str`	Undocumented

def relpath(path, start=os.curdir): (source) ¶

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).

Parameters
path:`str`	Undocumented
start:`str\|None`	Undocumented
Returns
`str`	Undocumented

def rmtree(path): (source) ¶

Undocumented

Parameters
path:`str`	Undocumented

SEP: str = (source) ¶

Undocumented

Value

'/'

fs_encoding = (source) ¶

Undocumented

no_fn_re = (source) ¶

Undocumented

project_suffix_re = (source) ¶

Undocumented