Source code for plumbum.path.base

import itertools
import operator
import os
import warnings
from abc import ABC, abstractmethod
from functools import reduce

FLAGS = {"f": os.F_OK, "w": os.W_OK, "r": os.R_OK, "x": os.X_OK}


[docs]class FSUser(int): """A special object that represents a file-system user. It derives from ``int``, so it behaves just like a number (``uid``/``gid``), but also have a ``.name`` attribute that holds the string-name of the user, if given (otherwise ``None``) """
[docs] def __new__(cls, val, name=None): self = int.__new__(cls, val) self.name = name return self
[docs]class Path(str, ABC): """An abstraction over file system paths. This class is abstract, and the two implementations are :class:`LocalPath <plumbum.machines.local.LocalPath>` and :class:`RemotePath <plumbum.path.remote.RemotePath>`. """ CASE_SENSITIVE = True
[docs] def __repr__(self): return f"<{self.__class__.__name__} {self}>"
[docs] def __truediv__(self, other): """Joins two paths""" return self.join(other)
[docs] def __getitem__(self, key): if type(key) == str or isinstance(key, Path): return self / key return str(self)[key]
[docs] def __floordiv__(self, expr): """Returns a (possibly empty) list of paths that matched the glob-pattern under this path""" return self.glob(expr)
[docs] def __iter__(self): """Iterate over the files in this directory""" return iter(self.list())
[docs] def __eq__(self, other): if isinstance(other, Path): return self._get_info() == other._get_info() if isinstance(other, str): if self.CASE_SENSITIVE: return str(self) == other return str(self).lower() == other.lower() return NotImplemented
[docs] def __ne__(self, other): return not self == other
[docs] def __gt__(self, other): return str(self) > str(other)
[docs] def __ge__(self, other): return str(self) >= str(other)
[docs] def __lt__(self, other): return str(self) < str(other)
[docs] def __le__(self, other): return str(self) <= str(other)
[docs] def __hash__(self): return hash(str(self)) if self.CASE_SENSITIVE else hash(str(self).lower())
def __bool__(self): return bool(str(self))
[docs] def __fspath__(self): """Added for Python 3.6 support""" return str(self)
[docs] def __contains__(self, item): """Paths should support checking to see if an file or folder is in them.""" try: return (self / item.name).exists() except AttributeError: return (self / item).exists()
@abstractmethod def _form(self, *parts): pass
[docs] def up(self, count=1): """Go up in ``count`` directories (the default is 1)""" return self.join("../" * count)
[docs] def walk( self, filter=lambda p: True, # pylint: disable=redefined-builtin dir_filter=lambda p: True, ): """traverse all (recursive) sub-elements under this directory, that match the given filter. By default, the filter accepts everything; you can provide a custom filter function that takes a path as an argument and returns a boolean :param filter: the filter (predicate function) for matching results. Only paths matching this predicate are returned. Defaults to everything. :param dir_filter: the filter (predicate function) for matching directories. Only directories matching this predicate are recursed into. Defaults to everything. """ for p in self.list(): if filter(p): yield p if p.is_dir() and dir_filter(p): yield from p.walk(filter, dir_filter)
@property @abstractmethod def name(self): """The basename component of this path""" @property def basename(self): """Included for compatibility with older Plumbum code""" warnings.warn("Use .name instead", FutureWarning) return self.name @property @abstractmethod def stem(self): """The name without an extension, or the last component of the path""" @property @abstractmethod def dirname(self): """The dirname component of this path""" @property @abstractmethod def root(self): """The root of the file tree (`/` on Unix)""" @property @abstractmethod def drive(self): """The drive letter (on Windows)""" @property @abstractmethod def suffix(self): """The suffix of this file""" @property @abstractmethod def suffixes(self): """This is a list of all suffixes""" @property @abstractmethod def uid(self): """The user that owns this path. The returned value is a :class:`FSUser <plumbum.path.FSUser>` object which behaves like an ``int`` (as expected from ``uid``), but it also has a ``.name`` attribute that holds the string-name of the user""" @property @abstractmethod def gid(self): """The group that owns this path. The returned value is a :class:`FSUser <plumbum.path.FSUser>` object which behaves like an ``int`` (as expected from ``gid``), but it also has a ``.name`` attribute that holds the string-name of the group"""
[docs] @abstractmethod def as_uri(self, scheme=None): """Returns a universal resource identifier. Use ``scheme`` to force a scheme."""
@abstractmethod def _get_info(self): pass
[docs] @abstractmethod def join(self, *parts): """Joins this path with any number of paths"""
[docs] @abstractmethod def list(self): """Returns the files in this directory"""
[docs] @abstractmethod def iterdir(self): """Returns an iterator over the directory. Might be slightly faster on Python 3.5 than .list()"""
[docs] @abstractmethod def is_dir(self): """Returns ``True`` if this path is a directory, ``False`` otherwise"""
[docs] def isdir(self): """Included for compatibility with older Plumbum code""" warnings.warn("Use .is_dir() instead", FutureWarning) return self.is_dir()
[docs] @abstractmethod def is_file(self): """Returns ``True`` if this path is a regular file, ``False`` otherwise"""
[docs] def isfile(self): """Included for compatibility with older Plumbum code""" warnings.warn("Use .is_file() instead", FutureWarning) return self.is_file()
[docs] @abstractmethod def exists(self): """Returns ``True`` if this path exists, ``False`` otherwise"""
[docs] @abstractmethod def stat(self): """Returns the os.stats for a file"""
[docs] @abstractmethod def with_name(self, name): """Returns a path with the name replaced"""
[docs] @abstractmethod def with_suffix(self, suffix, depth=1): """Returns a path with the suffix replaced. Up to last ``depth`` suffixes will be replaced. None will replace all suffixes. If there are less than ``depth`` suffixes, this will replace all suffixes. ``.tar.gz`` is an example where ``depth=2`` or ``depth=None`` is useful"""
[docs] def preferred_suffix(self, suffix): """Adds a suffix if one does not currently exist (otherwise, no change). Useful for loading files with a default suffix""" return self if len(self.suffixes) > 0 else self.with_suffix(suffix)
[docs] @abstractmethod def glob(self, pattern): """Returns a (possibly empty) list of paths that matched the glob-pattern under this path"""
[docs] @abstractmethod def delete(self): """Deletes this path (recursively, if a directory)"""
[docs] @abstractmethod def move(self, dst): """Moves this path to a different location"""
[docs] def rename(self, newname): """Renames this path to the ``new name`` (only the basename is changed)""" return self.move(self.up() / newname)
[docs] @abstractmethod def copy(self, dst, override=None): """Copies this path (recursively, if a directory) to the destination path "dst". Raises TypeError if dst exists and override is False. Will overwrite if override is True. Will silently fail to copy if override is None (the default)."""
[docs] @abstractmethod def mkdir(self, mode=0o777, parents=True, exist_ok=True): """ Creates a directory at this path. :param mode: **Currently only implemented for local paths!** Numeric mode to use for directory creation, which may be ignored on some systems. The current implementation reproduces the behavior of ``os.mkdir`` (i.e., the current umask is first masked out), but this may change for remote paths. As with ``os.mkdir``, it is recommended to call :func:`chmod` explicitly if you need to be sure. :param parents: If this is true (the default), the directory's parents will also be created if necessary. :param exist_ok: If this is true (the default), no exception will be raised if the directory already exists (otherwise ``OSError``). Note that the defaults for ``parents`` and ``exist_ok`` are the opposite of what they are in Python's own ``pathlib`` - this is to maintain backwards-compatibility with Plumbum's behaviour from before they were implemented. """
[docs] @abstractmethod def open(self, mode="r", *, encoding=None): """opens this path as a file"""
[docs] @abstractmethod def read(self, encoding=None): """returns the contents of this file as a ``str``. By default the data is read as text, but you can specify the encoding, e.g., ``'latin1'`` or ``'utf8'``"""
[docs] @abstractmethod def write(self, data, encoding=None): """writes the given data to this file. By default the data is written as-is (either text or binary), but you can specify the encoding, e.g., ``'latin1'`` or ``'utf8'``"""
[docs] @abstractmethod def touch(self): """Update the access time. Creates an empty file if none exists."""
[docs] @abstractmethod def chown(self, owner=None, group=None, recursive=None): """Change ownership of this path. :param owner: The owner to set (either ``uid`` or ``username``), optional :param group: The group to set (either ``gid`` or ``groupname``), optional :param recursive: whether to change ownership of all contained files and subdirectories. Only meaningful when ``self`` is a directory. If ``None``, the value will default to ``True`` if ``self`` is a directory, ``False`` otherwise. """
[docs] @abstractmethod def chmod(self, mode): """Change the mode of path to the numeric mode. :param mode: file mode as for os.chmod """
@staticmethod def _access_mode_to_flags(mode, flags=None): if flags is None: flags = FLAGS if isinstance(mode, str): mode = reduce(operator.or_, [flags[m] for m in mode.lower()], 0) return mode
[docs] @abstractmethod def access(self, mode=0): """Test file existence or permission bits :param mode: a bitwise-or of access bits, or a string-representation thereof: ``'f'``, ``'x'``, ``'r'``, ``'w'`` for ``os.F_OK``, ``os.X_OK``, ``os.R_OK``, ``os.W_OK`` """
[docs] def split(self, *_args, **_kargs): """Splits the path on directory separators, yielding a list of directories, e.g, ``"/var/log/messages"`` will yield ``['var', 'log', 'messages']``. """ parts = [] path = self while path != path.dirname: parts.append(path.name) path = path.dirname return parts[::-1]
@property def parts(self): """Splits the directory into parts, including the base directory, returns a tuple""" return tuple([self.drive + self.root] + self.split())
[docs] def relative_to(self, source): """Computes the "relative path" require to get from ``source`` to ``self``. They satisfy the invariant ``source_path + (target_path - source_path) == target_path``. For example:: /var/log/messages - /var/log/messages = [] /var/log/messages - /var = [log, messages] /var/log/messages - / = [var, log, messages] /var/log/messages - /var/tmp = [.., log, messages] /var/log/messages - /opt = [.., var, log, messages] /var/log/messages - /opt/lib = [.., .., var, log, messages] """ if isinstance(source, str): source = self._form(source) parts = self.split() baseparts = source.split() ancestors = len( list(itertools.takewhile(lambda p: p[0] == p[1], zip(parts, baseparts))) ) return RelativePath([".."] * (len(baseparts) - ancestors) + parts[ancestors:])
[docs] def __sub__(self, other): """Same as ``self.relative_to(other)``""" return self.relative_to(other)
@staticmethod def _glob(pattern, fn): """Applies a glob string or list/tuple/iterable to the current path, using ``fn``""" if isinstance(pattern, str): return fn(pattern) results = [] for single_pattern in pattern: results.extend(fn(single_pattern)) return sorted(list(set(results)))
[docs] def resolve(self, strict=False): # pylint:disable=unused-argument """Added to allow pathlib like syntax. Does nothing since Plumbum paths are always absolute. Does not (currently) resolve symlinks.""" # TODO: Resolve symlinks here return self
@property def parents(self): """Pathlib like sequence of ancestors""" as_list = ( reduce(lambda x, y: self._form(x) / y, self.parts[:i], self.parts[0]) for i in range(len(self.parts) - 1, 0, -1) ) return tuple(as_list) @property def parent(self): """Pathlib like parent of the path.""" return self.parents[0]
[docs]class RelativePath: """ Relative paths are the "delta" required to get from one path to another. Note that relative path do not point at anything, and thus are not paths. Therefore they are system agnostic (but closed under addition) Paths are always absolute and point at "something", whether existent or not. Relative paths are created by subtracting paths (``Path.relative_to``) """
[docs] def __init__(self, parts): self.parts = parts
[docs] def __str__(self): return "/".join(self.parts)
def __iter__(self): return iter(self.parts) def __len__(self): return len(self.parts) def __getitem__(self, index): return self.parts[index]
[docs] def __repr__(self): return f"RelativePath({self.parts!r})"
[docs] def __eq__(self, other): return str(self) == str(other)
[docs] def __ne__(self, other): return not self == other
[docs] def __gt__(self, other): return str(self) > str(other)
[docs] def __ge__(self, other): return str(self) >= str(other)
[docs] def __lt__(self, other): return str(self) < str(other)
[docs] def __le__(self, other): return str(self) <= str(other)
[docs] def __hash__(self): return hash(str(self))
def __bool__(self): return bool(str(self)) def up(self, count=1): return RelativePath(self.parts[:-count]) def __radd__(self, path): return path.join(*self.parts)