1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
|
from __future__ import annotations
import errno
import os
import urllib.request as urllib
from contextlib import contextmanager
from plumbum.commands import ProcessExecutionError, shquote
from plumbum.path.base import FSUser, Path
class StatRes:
"""POSIX-like stat result"""
def __init__(self, tup):
self._tup = tuple(tup)
def __getitem__(self, index):
return self._tup[index]
st_mode = mode = property(lambda self: self[0])
st_ino = ino = property(lambda self: self[1])
st_dev = dev = property(lambda self: self[2])
st_nlink = nlink = property(lambda self: self[3])
st_uid = uid = property(lambda self: self[4])
st_gid = gid = property(lambda self: self[5])
st_size = size = property(lambda self: self[6])
st_atime = atime = property(lambda self: self[7])
st_mtime = mtime = property(lambda self: self[8])
st_ctime = ctime = property(lambda self: self[9])
class RemotePath(Path):
"""The class implementing remote-machine paths"""
def __new__(cls, remote, *parts):
if not parts:
raise TypeError("At least one path part is required (none given)")
windows = remote.uname.lower() == "windows"
normed = []
parts = tuple(
map(str, parts)
) # force the paths into string, so subscription works properly
# Simple skip if path is absolute
if parts[0] and parts[0][0] not in ("/", "\\"):
cwd = (
remote._cwd
if hasattr(remote, "_cwd")
else remote._session.run("pwd")[1].strip()
)
parts = (cwd, *parts)
for p in parts:
if windows:
plist = str(p).replace("\\", "/").split("/")
else:
plist = str(p).split("/")
if not plist[0]:
plist.pop(0)
del normed[:]
for item in plist:
if item in {"", "."}:
continue
if item == "..":
if normed:
normed.pop(-1)
else:
normed.append(item)
if windows:
self = super().__new__(cls, "\\".join(normed))
self.CASE_SENSITIVE = False # On this object only
else:
self = super().__new__(cls, "/" + "/".join(normed))
self.CASE_SENSITIVE = True
self.remote = remote
return self
def _form(self, *parts):
return RemotePath(self.remote, *parts)
@property
def _path(self):
return str(self)
@property
def name(self):
if "/" not in str(self):
return str(self)
return str(self).rsplit("/", 1)[1]
@property
def dirname(self):
if "/" not in str(self):
return str(self)
return self.__class__(self.remote, str(self).rsplit("/", 1)[0])
@property
def suffix(self):
return "." + self.name.rsplit(".", 1)[1]
@property
def suffixes(self):
name = self.name
exts = []
while "." in name:
name, ext = name.rsplit(".", 1)
exts.append("." + ext)
return list(reversed(exts))
@property
def uid(self):
uid, name = self.remote._path_getuid(self)
return FSUser(int(uid), name)
@property
def gid(self):
gid, name = self.remote._path_getgid(self)
return FSUser(int(gid), name)
def _get_info(self):
return (self.remote, self._path)
def join(self, *parts):
return RemotePath(self.remote, self, *parts)
def list(self):
if not self.is_dir():
return []
return [self.join(fn) for fn in self.remote._path_listdir(self)]
def iterdir(self):
if not self.is_dir():
return ()
return (self.join(fn) for fn in self.remote._path_listdir(self))
def is_dir(self):
res = self.remote._path_stat(self)
if not res:
return False
return res.text_mode == "directory"
def is_file(self):
res = self.remote._path_stat(self)
if not res:
return False
return res.text_mode in ("regular file", "regular empty file")
def is_symlink(self):
res = self.remote._path_stat(self)
if not res:
return False
return res.text_mode == "symbolic link"
def exists(self):
return self.remote._path_stat(self) is not None
def stat(self):
res = self.remote._path_stat(self)
if res is None:
raise OSError(errno.ENOENT, os.strerror(errno.ENOENT), "")
return res
def with_name(self, name):
return self.__class__(self.remote, self.dirname) / name
def with_suffix(self, suffix, depth=1):
if suffix and not suffix.startswith(".") or suffix == ".":
raise ValueError(f"Invalid suffix {suffix!r}")
name = self.name
depth = len(self.suffixes) if depth is None else min(depth, len(self.suffixes))
for _ in range(depth):
name, _ = name.rsplit(".", 1)
return self.__class__(self.remote, self.dirname) / (name + suffix)
def glob(self, pattern):
return self._glob(
pattern,
lambda pat: [
RemotePath(self.remote, m) for m in self.remote._path_glob(self, pat)
],
)
def delete(self):
if not self.exists():
return
self.remote._path_delete(self)
unlink = delete
def move(self, dst):
if isinstance(dst, RemotePath):
if dst.remote is not self.remote:
raise TypeError("dst points to a different remote machine")
elif not isinstance(dst, str):
raise TypeError(
f"dst must be a string or a RemotePath (to the same remote machine), got {dst!r}"
)
self.remote._path_move(self, dst)
def copy(self, dst, override=False):
if isinstance(dst, RemotePath):
if dst.remote is not self.remote:
raise TypeError("dst points to a different remote machine")
elif not isinstance(dst, str):
raise TypeError(
f"dst must be a string or a RemotePath (to the same remote machine), got {dst!r}"
)
if override:
if isinstance(dst, str):
dst = RemotePath(self.remote, dst)
dst.delete()
else:
if isinstance(dst, str):
dst = RemotePath(self.remote, dst)
if dst.exists():
raise TypeError("Override not specified and dst exists")
self.remote._path_copy(self, dst)
def mkdir(self, mode=None, parents=True, exist_ok=True):
if parents and exist_ok:
self.remote._path_mkdir(self, mode=mode, minus_p=True)
else:
if parents and len(self.parts) > 1:
self.remote._path_mkdir(self.parent, mode=mode, minus_p=True)
try:
self.remote._path_mkdir(self, mode=mode, minus_p=False)
except ProcessExecutionError as ex:
if "File exists" not in ex.stderr:
raise
if not exist_ok:
raise OSError(
errno.EEXIST, "File exists (on remote end)", str(self)
) from None
def read(self, encoding=None):
data = self.remote._path_read(self)
if encoding:
return data.decode(encoding)
return data
def write(self, data, encoding=None):
if encoding:
data = data.encode(encoding)
self.remote._path_write(self, data)
def touch(self):
self.remote._path_touch(str(self))
def chown(self, owner=None, group=None, recursive=None):
self.remote._path_chown(
self, owner, group, self.is_dir() if recursive is None else recursive
)
def chmod(self, mode):
self.remote._path_chmod(mode, self)
def access(self, mode=0):
mode = self._access_mode_to_flags(mode)
res = self.remote._path_stat(self)
if res is None:
return False
mask = res.st_mode & 0x1FF
return ((mask >> 6) & mode) or ((mask >> 3) & mode)
def link(self, dst):
if isinstance(dst, RemotePath):
if dst.remote is not self.remote:
raise TypeError("dst points to a different remote machine")
elif not isinstance(dst, str):
raise TypeError(
f"dst must be a string or a RemotePath (to the same remote machine), got {dst!r}"
)
self.remote._path_link(self, dst, False)
def symlink(self, dst):
if isinstance(dst, RemotePath):
if dst.remote is not self.remote:
raise TypeError("dst points to a different remote machine")
elif not isinstance(dst, str):
raise TypeError(
"dst must be a string or a RemotePath (to the same remote machine), got {dst!r}"
)
self.remote._path_link(self, dst, True)
def open(self, mode="r", bufsize=-1, *, encoding=None):
"""
Opens this path as a file.
Only works for ParamikoMachine-associated paths for now.
"""
if encoding is not None:
raise NotImplementedError(
"encoding not supported for ParamikoMachine paths"
)
if hasattr(self.remote, "sftp") and hasattr(self.remote.sftp, "open"):
return self.remote.sftp.open(self, mode, bufsize)
raise NotImplementedError(
"RemotePath.open only works for ParamikoMachine-associated paths for now"
)
def as_uri(self, scheme="ssh"):
suffix = urllib.pathname2url(str(self))
return f"{scheme}://{self.remote._fqhost}{suffix}"
@property
def stem(self):
return self.name.rsplit(".")[0]
@property
def root(self):
return "/"
@property
def drive(self):
return ""
class RemoteWorkdir(RemotePath):
"""Remote working directory manipulator"""
def __new__(cls, remote):
return super().__new__(cls, remote, remote._session.run("pwd")[1].strip())
def __hash__(self):
raise TypeError("unhashable type")
def chdir(self, newdir):
"""Changes the current working directory to the given one"""
self.remote._session.run(f"cd {shquote(newdir)}")
if hasattr(self.remote, "_cwd"):
del self.remote._cwd
return self.__class__(self.remote)
def getpath(self):
"""Returns the current working directory as a
`remote path <plumbum.path.remote.RemotePath>` object"""
return RemotePath(self.remote, self)
@contextmanager
def __call__(self, newdir):
"""A context manager used to ``chdir`` into a directory and then ``chdir`` back to
the previous location; much like ``pushd``/``popd``.
:param newdir: The destination director (a string or a
:class:`RemotePath <plumbum.path.remote.RemotePath>`)
"""
prev = self._path
changed_dir = self.chdir(newdir)
try:
yield changed_dir
finally:
self.chdir(prev)
|