pathlib2#
- class pathlib_mate.pathlib2.PurePath(*args: Type[PurePath])[source]#
PurePath represents a filesystem path and offers operations which don’t imply any actual filesystem I/O. Depending on your system, instantiating a PurePath will return either a PurePosixPath or a PureWindowsPath object. You can also instantiate either of these classes directly, regardless of your system.
- property drive#
The drive prefix (letter or UNC path), if any.
- property root#
The root of the path, if any.
- property anchor#
The concatenation of the drive and root, or ‘’.
- property name#
The final path component, if any.
- property suffix#
The final component’s last suffix, if any.
- property suffixes#
A list of the final component’s suffixes, if any.
- property stem#
The final path component, minus its last suffix.
- with_suffix(suffix)[source]#
Return a new path with the file suffix changed. If the path has no suffix, add given suffix. If the given suffix is an empty string, remove the suffix from the path.
- Return type:
- relative_to(*other)[source]#
Return the relative path to another path identified by the passed arguments. If the operation is not possible (because this is not a subpath of the other path), raise ValueError.
- Return type:
- property parts#
An object providing sequence-like access to the components in the filesystem path.
- joinpath(*args)[source]#
Combine this path with one or several arguments, and return a new path representing either a subpath (if all arguments are relative paths) or a totally different path (if one of the arguments is anchored).
- Return type:
- is_absolute()[source]#
True if the path is absolute (has both a root and, if applicable, a drive).
- Return type:
- class pathlib_mate.pathlib2.PureWindowsPath(*args: Type[PurePath])[source]#
PurePath subclass for Windows systems.
On a Windows system, instantiating a PurePath should return this object. However, you can also instantiate it directly on any system.
- class pathlib_mate.pathlib2.Path(*args: Type[Path], **kwargs: Union[str, PurePath, PathlibPath])[source]#
PurePath subclass that can make system calls.
Path represents a filesystem path but unlike PurePath, also offers methods to do system calls on path objects. Depending on your system, instantiating a Path will return either a PosixPath or a WindowsPath object. You can also instantiate a PosixPath or WindowsPath directly, but cannot instantiate a WindowsPath on a POSIX system or vice versa.
- classmethod cwd()[source]#
Return a new path pointing to the current working directory (as returned by os.getcwd())
- Return type:
- classmethod home()[source]#
Return a new path pointing to the user’s home directory (as returned by os.path.expanduser(‘~’)).
- Return type:
- samefile(other_path)[source]#
Return whether other_path is the same or not as this file (as returned by os.path.samefile()).
- Return type:
- iterdir()[source]#
Iterate over the files in this directory. Does not yield any result for the special paths ‘.’ and ‘..’.
- Return type:
Iterable[Path]
- glob(pattern)[source]#
Iterate over this subtree and yield all existing files (of any kind, including directories) matching the given relative pattern.
- Return type:
Iterable[Path]
- rglob(pattern)[source]#
Recursively yield all existing files (of any kind, including directories) matching the given relative pattern, anywhere in this subtree.
- Return type:
Iterable[Path]
- absolute()[source]#
Return an absolute version of this path. This function works even if the path doesn’t point to anything.
No normalization is done, i.e. all ‘.’ and ‘..’ will be kept along. Use resolve() to get the canonical path to a file.
- Return type:
- resolve(strict=False)[source]#
Make the path absolute, resolving all symlinks on the way and also normalizing it (for example turning slashes into backslashes under Windows).
- Return type:
- open(mode='r', buffering=-1, encoding=None, errors=None, newline=None)[source]#
Open the file pointed by this path and return a file object, as the built-in open() function does.
- read_text(encoding=None, errors=None)[source]#
Open the file in text mode, read it, and close the file.
- Return type:
- write_text(data, encoding=None, errors=None, newline=None)[source]#
Open the file in text mode, write to it, and close the file.
- touch(mode=438, exist_ok=True)[source]#
Create this file with the given access mode, if it doesn’t exist.
- lchmod(mode)[source]#
Like chmod(), except if the path points to a symlink, the symlink’s permissions are changed, rather than its target’s.
- lstat()[source]#
Like stat(), except if the path points to a symlink, the symlink’s status information is returned, rather than its target’s.
- replace(target)[source]#
Rename this path to the given path, clobbering the existing destination if it exists.
- symlink_to(target, target_is_directory=False)[source]#
Make this path a symlink pointing to the given path. Note the order of arguments (self, target) is the reverse of os.symlink’s.
- class pathlib_mate.pathlib2.PosixPath(*args: Type[Path], **kwargs: Union[str, PurePath, PathlibPath])[source]#
Path subclass for non-Windows systems.
On a POSIX system, instantiating a Path should return this object.