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 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
|
from __future__ import annotations
import sys
from collections.abc import Iterator
from collections.abc import Mapping
from collections.abc import Sequence
from typing import IO
from typing import TYPE_CHECKING
from typing import Any
from typing import BinaryIO
from typing import Callable
from typing import Literal
from typing import TextIO
from typing import TypeVar
from typing import overload
from urllib.parse import SplitResult
from fsspec import AbstractFileSystem
from pathlib_abc import vfspath
from upath._chain import Chain
from upath._chain import ChainSegment
from upath.core import UnsupportedOperation
from upath.core import UPath
from upath.types import UNSET_DEFAULT
from upath.types import JoinablePathLike
from upath.types import OnNameCollisionFunc
from upath.types import PathInfo
from upath.types import ReadablePath
from upath.types import ReadablePathLike
from upath.types import StatResultType
from upath.types import SupportsPathLike
from upath.types import UPathParser
from upath.types import WritablePathLike
if TYPE_CHECKING:
if sys.version_info > (3, 11):
from typing import Self
else:
from typing_extensions import Self
from pydantic import GetCoreSchemaHandler
from pydantic_core.core_schema import CoreSchema
__all__ = [
"ProxyUPath",
]
T = TypeVar("T")
class classmethod_or_method(classmethod):
"""A decorator that can be used as a classmethod or an instance method.
When called on the class, it behaves like a classmethod.
When called on an instance, it behaves like an instance method.
"""
def __get__(
self,
instance: T | None,
owner: type[T] | None = None,
/,
) -> Callable[..., T]:
if instance is None:
return self.__func__.__get__(owner)
else:
return self.__func__.__get__(instance)
class ProxyUPath:
"""ProxyUPath base class
ProxyUPath should be used when you want to extend the UPath class
interface with additional methods, but still want to support
all supported upath implementations.
"""
__slots__ = ("__wrapped__",)
# TODO: think about if and how to handle these
# _transform_init_args
# _parse_storage_options
# _fs_factory
# _protocol_dispatch
# === non-public methods / attributes =============================
@classmethod
def _from_upath(cls, upath: UPath, /) -> Self:
if isinstance(upath, cls):
return upath # type: ignore[unreachable]
else:
obj = object.__new__(cls)
obj.__wrapped__ = upath
return obj
@property
def _chain(self):
try:
return self.__wrapped__._chain
except AttributeError:
return Chain(
ChainSegment(
path=self.__wrapped__.path,
protocol=self.__wrapped__.protocol,
storage_options=dict(self.__wrapped__.storage_options),
),
)
# === wrapped interface ===========================================
def __init__(
self,
*args: JoinablePathLike,
protocol: str | None = None,
**storage_options: Any,
) -> None:
self.__wrapped__ = UPath(*args, protocol=protocol, **storage_options)
@property
def parser(self) -> UPathParser:
return self.__wrapped__.parser
def with_segments(self, *pathsegments: JoinablePathLike) -> Self:
return self._from_upath(self.__wrapped__.with_segments(*pathsegments))
def __str__(self) -> str:
return self.__wrapped__.__str__()
def __vfspath__(self) -> str:
return self.__wrapped__.__vfspath__()
def __repr__(self) -> str:
return (
f"{type(self).__name__}"
f"({self.__wrapped__.path!r}, protocol={self.protocol!r})"
)
@property
def parts(self) -> Sequence[str]:
return self.__wrapped__.parts
def with_name(self, name: str) -> Self:
return self._from_upath(self.__wrapped__.with_name(name))
@property
def info(self) -> PathInfo:
return self.__wrapped__.info
def iterdir(self) -> Iterator[Self]:
for pth in self.__wrapped__.iterdir():
yield self._from_upath(pth)
def __open_reader__(self) -> BinaryIO:
return self.__wrapped__.__open_reader__()
def readlink(self) -> Self:
return self._from_upath(self.__wrapped__.readlink())
def symlink_to(
self,
target: ReadablePathLike,
target_is_directory: bool = False,
) -> None:
if not isinstance(target, str):
target = vfspath(target)
self.__wrapped__.symlink_to(target, target_is_directory=target_is_directory)
def mkdir(
self,
mode: int = 0o777,
parents: bool = False,
exist_ok: bool = False,
) -> None:
self.__wrapped__.mkdir(mode=mode, parents=parents, exist_ok=exist_ok)
def __open_writer__(self, mode: Literal["a", "w", "x"]) -> BinaryIO:
return self.__wrapped__.__open_writer__(mode)
@overload
def open(
self,
mode: Literal["r", "w", "a"] = "r",
buffering: int = ...,
encoding: str = ...,
errors: str = ...,
newline: str = ...,
**fsspec_kwargs: Any,
) -> TextIO: ...
@overload
def open(
self,
mode: Literal["rb", "wb", "ab"],
buffering: int = ...,
encoding: str = ...,
errors: str = ...,
newline: str = ...,
**fsspec_kwargs: Any,
) -> BinaryIO: ...
@overload
def open(
self,
mode: str,
*args: Any,
**fsspec_kwargs: Any,
) -> IO[Any]: ...
def open(
self,
mode: str = "r",
buffering: int = UNSET_DEFAULT,
encoding: str | None = UNSET_DEFAULT,
errors: str | None = UNSET_DEFAULT,
newline: str | None = UNSET_DEFAULT,
**fsspec_kwargs: Any,
) -> IO[Any]:
return self.__wrapped__.open(
mode,
buffering,
encoding,
errors,
newline,
**fsspec_kwargs,
)
def stat(
self,
*,
follow_symlinks=True,
) -> StatResultType:
return self.__wrapped__.stat(follow_symlinks=follow_symlinks)
def lstat(self) -> StatResultType:
return self.__wrapped__.stat(follow_symlinks=False)
def chmod(self, mode: int, *, follow_symlinks: bool = True) -> None:
self.__wrapped__.chmod(mode=mode, follow_symlinks=follow_symlinks)
def exists(self, *, follow_symlinks=True) -> bool:
return self.__wrapped__.exists(follow_symlinks=follow_symlinks)
def is_dir(self) -> bool:
return self.__wrapped__.is_dir()
def is_file(self) -> bool:
return self.__wrapped__.is_file()
def is_mount(self) -> bool:
return self.__wrapped__.is_mount()
def is_symlink(self) -> bool:
return self.__wrapped__.is_symlink()
def is_junction(self) -> bool:
return self.__wrapped__.is_junction()
def is_block_device(self) -> bool:
return self.__wrapped__.is_block_device()
def is_char_device(self) -> bool:
return self.__wrapped__.is_char_device()
def is_fifo(self) -> bool:
return self.__wrapped__.is_fifo()
def is_socket(self) -> bool:
return self.__wrapped__.is_socket()
def is_reserved(self) -> bool:
return self.__wrapped__.is_reserved()
def expanduser(self) -> Self:
return self._from_upath(self.__wrapped__.expanduser())
def glob(
self,
pattern: str,
*,
case_sensitive: bool | None = None,
recurse_symlinks: bool = False,
) -> Iterator[Self]:
for p in self.__wrapped__.glob(
pattern, case_sensitive=case_sensitive, recurse_symlinks=recurse_symlinks
):
yield self._from_upath(p)
def rglob(
self,
pattern: str,
*,
case_sensitive: bool | None = None,
recurse_symlinks: bool = False,
) -> Iterator[Self]:
for p in self.__wrapped__.rglob(
pattern, case_sensitive=case_sensitive, recurse_symlinks=recurse_symlinks
):
yield self._from_upath(p)
def owner(self) -> str:
return self.__wrapped__.owner()
def group(self) -> str:
return self.__wrapped__.group()
def absolute(self) -> Self:
return self._from_upath(self.__wrapped__.absolute())
def is_absolute(self) -> bool:
return self.__wrapped__.is_absolute()
def __eq__(self, other: object) -> bool:
if not isinstance(other, type(self)):
return NotImplemented
return self.__wrapped__.__eq__(other.__wrapped__)
def __hash__(self) -> int:
return self.__wrapped__.__hash__()
def __ne__(self, other: object) -> bool:
if not isinstance(other, type(self)):
return NotImplemented
return self.__wrapped__.__ne__(other.__wrapped__)
def __lt__(self, other: object) -> bool:
if not isinstance(other, type(self)):
return NotImplemented
return self.__wrapped__.__lt__(other.__wrapped__)
def __le__(self, other: object) -> bool:
if not isinstance(other, type(self)):
return NotImplemented
return self.__wrapped__.__le__(other.__wrapped__)
def __gt__(self, other: object) -> bool:
if not isinstance(other, type(self)):
return NotImplemented
return self.__wrapped__.__gt__(other.__wrapped__)
def __ge__(self, other: object) -> bool:
if not isinstance(other, type(self)):
return NotImplemented
return self.__wrapped__.__ge__(other.__wrapped__)
def resolve(self, strict: bool = False) -> Self:
return self._from_upath(self.__wrapped__.resolve(strict=strict))
def touch(self, mode=0o666, exist_ok=True) -> None:
self.__wrapped__.touch(mode=mode, exist_ok=exist_ok)
def lchmod(self, mode: int) -> None:
self.__wrapped__.lchmod(mode=mode)
def unlink(self, missing_ok: bool = False) -> None:
self.__wrapped__.unlink(missing_ok=missing_ok)
def rmdir(self, recursive: bool = UNSET_DEFAULT) -> None: # fixme: non-standard
kwargs: dict[str, Any] = {}
if recursive is not UNSET_DEFAULT:
kwargs["recursive"] = recursive
self.__wrapped__.rmdir(**kwargs)
def rename(
self,
target: WritablePathLike,
*, # note: non-standard compared to pathlib
recursive: bool = UNSET_DEFAULT,
maxdepth: int | None = UNSET_DEFAULT,
**kwargs: Any,
) -> Self:
if recursive is not UNSET_DEFAULT:
kwargs["recursive"] = recursive
if maxdepth is not UNSET_DEFAULT:
kwargs["maxdepth"] = maxdepth
return self._from_upath(
self.__wrapped__.rename(
target.__wrapped__ if isinstance(target, ProxyUPath) else target,
**kwargs,
)
)
def replace(self, target: WritablePathLike) -> Self:
return self._from_upath(self.__wrapped__.replace(target))
@property
def drive(self) -> str:
return self.__wrapped__.drive
@property
def root(self) -> str:
return self.__wrapped__.root
def __reduce__(self):
return type(self)._from_upath, (self.__wrapped__,)
@classmethod
def from_uri(cls, uri: str, **storage_options: Any) -> Self:
return cls(uri, **storage_options)
def as_uri(self) -> str:
return self.__wrapped__.as_uri()
def as_posix(self) -> str:
return self.__wrapped__.as_posix()
def samefile(self, other_path) -> bool:
return self.__wrapped__.samefile(other_path)
@classmethod_or_method
def cwd(cls_or_self) -> Self: # noqa: B902
if isinstance(cls_or_self, type):
raise UnsupportedOperation(".cwd() not supported")
else:
return cls_or_self._from_upath(cls_or_self.__wrapped__.cwd())
@classmethod
def home(cls) -> Self:
raise UnsupportedOperation(".home() not supported")
def relative_to( # type: ignore[override]
self,
other,
/,
*_deprecated,
walk_up=False,
) -> Self:
if isinstance(other, ProxyUPath):
other = other.__wrapped__
return self._from_upath(
self.__wrapped__.relative_to(other, *_deprecated, walk_up=walk_up)
)
def is_relative_to(self, other, /, *_deprecated) -> bool: # type: ignore[override]
if not isinstance(other, str):
other = vfspath(other)
return self.__wrapped__.is_relative_to(other, *_deprecated)
def hardlink_to(self, target: ReadablePathLike) -> None:
if not isinstance(target, str):
target = vfspath(target)
return self.__wrapped__.hardlink_to(target)
def match(self, pattern: str, *, case_sensitive: bool | None = None) -> bool:
return self.__wrapped__.match(pattern)
@property
def protocol(self) -> str:
return self.__wrapped__.protocol
@property
def storage_options(self) -> Mapping[str, Any]:
return self.__wrapped__.storage_options
@property
def fs(self) -> AbstractFileSystem:
return self.__wrapped__.fs
@property
def path(self) -> str:
return self.__wrapped__.path
def joinuri(self, uri: JoinablePathLike) -> Self:
return self._from_upath(self.__wrapped__.joinuri(uri))
@property
def _url(self) -> SplitResult:
return self.__wrapped__._url
def read_bytes(self) -> bytes:
return self.__wrapped__.read_bytes()
def read_text(
self,
encoding: str | None = None,
errors: str | None = None,
newline: str | None = None,
) -> str:
return self.__wrapped__.read_text(
encoding=encoding, errors=errors, newline=newline
)
def walk(
self,
top_down: bool = True,
on_error: Callable[[Exception], Any] | None = None,
follow_symlinks: bool = False,
) -> Iterator[tuple[Self, list[str], list[str]]]:
for pth, dirnames, filenames in self.__wrapped__.walk(
top_down=top_down, on_error=on_error, follow_symlinks=follow_symlinks
):
yield self._from_upath(pth), dirnames, filenames
def copy(self, target: WritablePathLike, **kwargs: Any) -> Self: # type: ignore[override] # noqa: E501
return self._from_upath(self.__wrapped__.copy(target, **kwargs))
def copy_into(self, target_dir: WritablePathLike, **kwargs: Any) -> Self: # type: ignore[override] # noqa: E501
return self._from_upath(self.__wrapped__.copy_into(target_dir, **kwargs))
def move(self, target: WritablePathLike, **kwargs: Any) -> Self: # type: ignore[override] # noqa: E501
return self._from_upath(self.__wrapped__.move(target, **kwargs))
def move_into(self, target_dir: WritablePathLike, **kwargs: Any) -> Self: # type: ignore[override] # noqa: E501
return self._from_upath(self.__wrapped__.move_into(target_dir, **kwargs))
def write_bytes(self, data: bytes) -> int:
return self.__wrapped__.write_bytes(data)
def write_text(
self,
data: str,
encoding: str | None = None,
errors: str | None = None,
newline: str | None = None,
) -> int:
return self.__wrapped__.write_text(
data, encoding=encoding, errors=errors, newline=newline
)
def _copy_from(
self,
source: ReadablePath | Self,
follow_symlinks: bool = True,
on_name_collision: OnNameCollisionFunc | None = None,
**kwargs: Any,
) -> None:
self.__wrapped__._copy_from(source, follow_symlinks=follow_symlinks, on_name_collision=on_name_collision, **kwargs) # type: ignore # noqa: E501
@property
def anchor(self) -> str:
return self.__wrapped__.anchor
@property
def name(self) -> str:
return self.__wrapped__.name
@property
def suffix(self) -> str:
return self.__wrapped__.suffix
@property
def suffixes(self) -> list[str]:
return self.__wrapped__.suffixes
@property
def stem(self) -> str:
return self.__wrapped__.stem
def with_stem(self, stem: str) -> Self:
return self._from_upath(self.__wrapped__.with_stem(stem))
def with_suffix(self, suffix: str) -> Self:
return self._from_upath(self.__wrapped__.with_suffix(suffix))
def joinpath(self, *pathsegments: JoinablePathLike) -> Self:
return self._from_upath(self.__wrapped__.joinpath(*pathsegments))
def __truediv__(self, other: str | Self) -> Self:
return self._from_upath(
self.__wrapped__.__truediv__(other) # type: ignore[operator]
)
def __rtruediv__(self, other: str | Self) -> Self:
return self._from_upath(
self.__wrapped__.__rtruediv__(other) # type: ignore[operator]
)
@property
def parent(self) -> Self:
return self._from_upath(self.__wrapped__.parent)
@property
def parents(self) -> Sequence[Self]:
return tuple(self._from_upath(p) for p in self.__wrapped__.parents)
def full_match(
self,
pattern: str | SupportsPathLike,
*,
case_sensitive: bool | None = None,
) -> bool:
return self.__wrapped__.full_match(pattern, case_sensitive=case_sensitive)
@classmethod
def __get_pydantic_core_schema__(
cls, source_type: Any, handler: GetCoreSchemaHandler
) -> CoreSchema:
cs = UPath.__get_pydantic_core_schema__.__func__ # type: ignore[attr-defined]
return cs(cls, source_type, handler)
UPath.register(ProxyUPath)
|