Common filesystem operations
Get a config path to read or write some configuration.
| Parameters: | args – a list of subfolders. Those will be created when needed |
|---|
Get a config path to read or write some cached data
| Parameters: | args – a list of subfolders. Those will be created when needed |
|---|
Get a config path to read or write some persistent data
| Parameters: | args – a list of subfolders. Those will be created when needed |
|---|
Helper for get_*_path methods
Get the current user name
Recursive mkdir (do not fail if file exists)
ln (do not fail if file exists)
Write the data to out_path if the content is different
Configure a file. :param in_path: input file :parm out_path: output file
The out_path needs not to exist, missing leading directories will be created if necessary.
If copy_only is True, the contents will be copied “as is”.
If not, we will use the args and kwargs parameter as in:
in_content.format(*args, **kwargs)
Install a directory to a destination.
If filter_fun is not None, then the file will only be installed if filter_fun(relative/path/to/file) returns True.
Few notes: rewriting cp or install is a hard problem. This version will happily erase whatever is inside dest, (even it the dest is readonly, dest will be erased before being written) and it won’t complain if dest does not exist (missing directories will simply be created)
This function will preserve relative symlinks between directories, used for instance in Mac frameworks:
|__ Versions
|__ Current -> 4.0
|__ 4 -> 4.0
|__ 4.0
Return the list of files installed (with relative paths)
Copy a source to a destination but do not overwrite dest if it is more recent than src
Create any missing directories when necessary
If dest is a directory, src will be copied inside dest.
” Return True if output_path exists and is more recent than input_path
Copy a source to a destination but only copy the files under version control. Assumes that src is inside a git worktree
This one can take a file or a directory. Contrary to shutil.remove or os.remove, it:
Please avoid using shutil.rmtree ...
shutil.rmtree() on steroids.
Recursively removes a directory, even if it’s marked read-only.
shutil.rmtree() doesn’t work on Windows if any of the files or directories are read-only, which svn repositories and some .svn files are. We need to be able to force the files to be writable (i.e., deletable) as we traverse the tree.
Even with all this, Windows still sometimes fails to delete a file, citing a permission error (maybe something to do with antivirus scans or disk indexing). The best suggestion any of the user forums had was to wait a bit and try again, so we do that too. It’s hand-waving, but sometimes it works. :/
On POSIX systems, things are a little bit simpler. The modes of the files to be deleted doesn’t matter, only the modes of the directories containing them are significant. As the directory tree is traversed, each directory has its mode set appropriately before descending into it. This should result in the entire tree being removed, with the possible exception of path itself, because nothing attempts to change the mode of its parent. Doing so would be hazardous, as it’s not a directory slated for removal. In the ordinary case, this is not a problem: for our purposes, the user will never lack write permission on path‘s parent.
Move a file into a directory, but do not crash if dest/src exists
Returns a sorted list of all the files present in a diretory, relative to this directory.
For instance, with:
foo
|__ eggs
| |__ c
| |__ d
|__ empty
|__ spam
|__a
|__b
ls_r(foo) returns: [“eggs/c”, “eggs/d”, “empty/”, “spam/a”, “spam/b”]
find program in the environment PATH :return: path to program if found, None otherwise
Returns a POSIX path from a DOS path :param fix_drive: if True, will replace c: by /c/ (ala mingw)
Return a DOS path from a “windows with /” path. Useful because people sometimes use forward slash in environment variable, for instance
Return an absolute, native path from a path, :param normcase: make sure the path is all lower-case on case-insensitive filesystems
Returns True if a is inside b
>>> is_path_inside("foo/bar", "foo")
True
>>> is_path_inside("gui/bar/libfoo", "lib")
False
Check if a path is empty
This is a nice wrapper around tempfile module.
Usage:
with TempDir("foo-bar") as temp_dir:
subdir = os.path.join(temp_dir, "subdir")
do_foo(subdir)
This piece of code makes sure that:
Change the current working dir
Filter function to only install runtime components of packages
Returns True if the file is a broken symlink
Returns True if the file is binary
Returns true if the file: * is executable * is a binary (i.e not a script)