sphinx.util.osutil

module documentation

Operating system-related utility functions for Sphinx.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.

Constant	`SEP`	Undocumented
Variable	`fs_encoding`	Undocumented
Variable	`no_fn_re`	Undocumented
Variable	`Path`	Undocumented
Variable	`project_suffix_re`	Undocumented
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	`movefile`	Move a file, removing the destination if it exists.
Function	`mtimes_of_files`	Undocumented
Function	`os_path`	Undocumented
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

SEP: str =

Undocumented

Value

'/'

fs_encoding =

Undocumented

no_fn_re =

Undocumented

Path =

Undocumented

project_suffix_re =

Undocumented

def abspath(pathdir):

Undocumented

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

def canon_path(nativepath):

Return path in OS-independent form

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

@contextlib.contextmanager
def cd(target_dir):

Undocumented

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

def copyfile(source, dest):

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

Copy a file's modification times.

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

def ensuredir(path):

Ensure that a path exists.

Parameters
path:`str`	Undocumented

def make_filename(string):

Undocumented

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

def make_filename_from_project(project):

Undocumented

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

def movefile(source, dest):

Move a file, removing the destination if it exists.

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

def mtimes_of_files(dirnames, suffix):

Undocumented

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

def os_path(canonicalpath):

Undocumented

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

def relative_uri(base, to):

Return a relative URL from base to to.

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

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

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`	Undocumented
Returns
`str`	Undocumented

def rmtree(path):

Undocumented

Parameters
path:`str`	Undocumented