debian-forge/osbuild/util/path.py
Tomáš Hozza 8463394d2c util/path: add join_abs() to join potentially absolute paths
It turned out that in many cases, stages need to join two absolute
paths, the pipeline tree path and the path on a booted system. However,
the standard `os.path.join()` function can't handle such situation as
just prepending the root to the subsequent paths.

Add a new helper function, which is able to join any paths together,
regardless if any of them is absolute or not. If the root is not
absolute, the result will be made absolute to the filesystem root `/`.

Signed-off-by: Tomáš Hozza <thozza@redhat.com>
2025-01-06 11:53:46 -08:00

58 lines
1.9 KiB
Python

"""Path handling utility functions"""
import errno
import os
import os.path
from typing import Optional, Union
from .ctx import suppress_oserror
def clamp_mtime(path: str, start: int, to: int):
"""Clamp all modification times of 'path'
Set the mtime of 'path' to 'to' if it is greater or equal to 'start'.
If 'to' is None, the mtime is set to the current time.
"""
times = (to, to)
def fix_utime(path, dfd: Optional[int] = None):
sb = os.stat(path, dir_fd=dfd, follow_symlinks=False)
if sb.st_mtime < start:
return
# We might get a permission error when the immutable flag is set;
# since there is nothing much we can do, we just ignore it
with suppress_oserror(errno.EPERM):
os.utime(path, times, dir_fd=dfd, follow_symlinks=False)
fix_utime(path)
for _, dirs, files, dfd in os.fwalk(path):
for f in dirs + files:
fix_utime(f, dfd)
def in_tree(path: str, tree: str, must_exist: bool = False) -> bool:
"""Return whether the canonical location of 'path' is under 'tree'.
If 'must_exist' is True, the file must also exist for the check to succeed.
"""
path = os.path.abspath(path)
if path.startswith(tree):
return not must_exist or os.path.exists(path)
return False
def join_abs(root: Union[str, os.PathLike], *paths: Union[str, os.PathLike]) -> str:
"""
Join root and paths together, handling the case where paths are absolute paths.
In that case, paths are just appended to root as if they were relative paths.
The result is always an absolute path relative to the filesystem root '/'.
"""
final_path = root
for path in paths:
if os.path.isabs(path):
final_path = os.path.join(final_path, os.path.relpath(path, os.sep))
else:
final_path = os.path.join(final_path, path)
return os.path.normpath(os.path.join(os.sep, final_path))