Source code for ase2sprkkr.common.file_utils

import contextlib
import tempfile
import os
from io import IOBase

_RAISE = object()


[docs] class FilePath(os.PathLike): """A path displayed relative to its base directory but resolved absolutely. ``str(path)`` is intended for concise user-facing output, while filesystem consumers such as ``open(path)``, ``Path(path)`` and ``os.path`` receive the absolute path through :meth:`__fspath__`. """
[docs] def __init__(self, path, base_directory=None): absolute = os.fsdecode(os.fspath(path)) if base_directory is None: if isinstance(path, FilePath): base_directory = path.base_directory elif os.path.isabs(absolute): base_directory = os.path.dirname(absolute) else: base_directory = os.getcwd() self.base_directory = os.path.realpath(os.fsdecode(os.fspath(base_directory))) if os.path.isabs(absolute): self.relative_path = os.path.relpath(absolute, self.base_directory) else: self.relative_path = os.path.normpath(absolute) self.absolute_path = os.path.abspath(os.path.join(self.base_directory, self.relative_path))
def __str__(self): return self.relative_path def __repr__(self): return f"FilePath({self.relative_path!r}, base_directory={self.base_directory!r})" def __fspath__(self): return self.absolute_path def __eq__(self, other): if not isinstance(other, FilePath): return NotImplemented return self.absolute_path == other.absolute_path def __hash__(self): return hash(self.absolute_path)
[docs] def filename_from_file(file, default=_RAISE, realpath=False): """Return a filesystem name for a path or a file backed by one. If the object has no filename, return ``default`` or raise ``TypeError`` when no default was supplied. """ if isinstance(file, IOBase): file = getattr(file, "name", file) try: out = os.fspath(file) except TypeError: if default is _RAISE: raise return default if realpath: out = os.path.realpath(out) return out
[docs] class Directory:
[docs] @staticmethod def new(dir, default="."): if isinstance(dir, Directory): return dir return Directory(dir, default)
[docs] def __init__(self, dir, default="."): if dir is None: dir = default if dir is None: raise ValueError("No directory has been specified") self.enters = 0 self.dir = dir self.path = dir if self.dir == ".": self.chdir = contextlib.suppress
def __fspath__(self): return self.path def __str__(self): return str(self.path) if self.path is not False else "<tempdir>" def __repr__(self): return f"<Directory {str(self)}>" def __enter__(self): self.enters += 1 if self.enters == 1: if self.dir is False: self.handler = tempfile.TemporaryDirectory() self.path = self.handler.name else: self.handler = None if self.handler: self.handler.__enter__() return self def __exit__(self, type, value, traceback): self.enters -= 1 if self.enters == 0 and self.handler: self.handler.__exit__(type, value, traceback) self.path = self.dir
[docs] @contextlib.contextmanager def chdir(self): cwd = os.getcwd() if self.path: os.chdir(self.path) try: yield self.path finally: os.chdir(cwd) else: yield cwd