xotl.tools.fs.path – Path utilities

Extensions to os.path

Functions inside this module must not have side-effects on the file-system. This module re-exports (without change) several functions from the os.path standard module.

xotl.tools.fs.path.join(base, *extras)

Join two or more pathname components, inserting ‘/’ as needed.

If any component is an absolute path, all previous path components will be discarded.

Normalize path (after join parts), eliminating double slashes, etc.

xotl.tools.fs.path.fix_encoding(name, encoding=None)

Fix encoding of a file system resource name.

encoding is ignored if name is already a str.

xotl.tools.fs.path.normalize_path(base, *extras)

Normalize path by:

• expanding ‘~’ and ‘~user’ constructions.
• eliminating double slashes
• converting to absolute.

xotl.tools.fs.path.shorten_module_filename(filename)

A filename, normally a module o package name, is shortened looking his head in all python path.

xotl.tools.fs.path.shorten_user(filename)

A filename is shortened looking for the (expantion) $HOME in his head and replacing it by ‘~’.

xotl.tools.fs.path.rtrim(path, n=1)

Trims the last n components of the pathname path.

This basically applies n times the function os.path.dirname to path.

path is normalized before proceeding (but not tested to exists).

Changed in version 1.5.5: n defaults to 1. In this case rtrim is identical to os.path.dirname().

Example:

>>> rtrim('/tmp/a/b/c/d', 3)
'/tmp/a'

# It does not matter if `/` is at the end
>>> rtrim('/tmp/a/b/c/d/', 3)
'/tmp/a'