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
|
"""Pathable paths module"""
from contextlib import contextmanager
from typing import Any
from typing import Hashable
from typing import Iterator
from typing import List
from typing import Mapping
from typing import Optional
from typing import Tuple
from typing import Type
from typing import TypeVar
from pathable.accessors import BaseAccessor
from pathable.accessors import LookupAccessor
from pathable.dataclasses import BasePathData
from pathable.parsers import SEPARATOR
from pathable.parsers import parse_args
TBasePath = TypeVar("TBasePath", bound="BasePath")
TAccessorPath = TypeVar("TAccessorPath", bound="AccessorPath")
TLookupPath = TypeVar("TLookupPath", bound="LookupPath")
class BasePath(BasePathData):
"""Base path."""
def __init__(self, *args: Any, **kwargs: Any):
separator = kwargs.pop("separator", SEPARATOR)
self.parts = parse_args(list(args))
self.separator = separator
self._cparts_cached: Optional[List[str]] = None
@classmethod
def _from_parts(
cls: Type[TBasePath], args: List[Any], separator: str = SEPARATOR
) -> TBasePath:
self = cls(separator=separator)
self.parts = parse_args(args)
return self
@classmethod
def _from_parsed_parts(
cls: Type[TBasePath], parts: List[Hashable], separator: str = SEPARATOR
) -> TBasePath:
self = cls(separator=separator)
self.parts = parts
return self
@property
def _cparts(self) -> List[Any]:
# Cached casefolded parts, for hashing and comparison
if self._cparts_cached is None:
self._cparts_cached = self._get_cparts()
return self._cparts_cached
def _get_cparts(self) -> List[str]:
return [str(p) for p in self.parts]
def _make_child(self: TBasePath, args: List[Any]) -> TBasePath:
parts = parse_args(args, self.separator)
parts_joined = self.parts + parts
return self._from_parsed_parts(parts_joined, self.separator)
def _make_child_relpath(self: TBasePath, part: Hashable) -> TBasePath:
# This is an optimization used for dir walking. `part` must be
# a single part relative to this path.
parts = self.parts + [part]
return self._from_parsed_parts(parts, self.separator)
def __str__(self) -> str:
return self.separator.join(self._cparts)
def __repr__(self) -> str:
return f"{self.__class__.__name__}({str(self)!r})"
def __hash__(self) -> int:
return hash(tuple(self._cparts))
def __truediv__(self: TBasePath, key: Any) -> TBasePath:
try:
return self._make_child(
[
key,
]
)
except TypeError:
return NotImplemented
def __rtruediv__(self: TBasePath, key: Hashable) -> TBasePath:
try:
return self._from_parts([key] + self.parts)
except TypeError:
return NotImplemented
def __eq__(self, other: Any) -> bool:
if not isinstance(other, BasePath):
return NotImplemented
return self._cparts == other._cparts
def __lt__(self, other: Any) -> bool:
if not isinstance(other, BasePath):
return NotImplemented
return self._cparts < other._cparts
def __le__(self, other: Any) -> bool:
if not isinstance(other, BasePath):
return NotImplemented
return self._cparts <= other._cparts
def __gt__(self, other: Any) -> bool:
if not isinstance(other, BasePath):
return NotImplemented
return self._cparts > other._cparts
def __ge__(self, other: Any) -> bool:
if not isinstance(other, BasePath):
return NotImplemented
return self._cparts >= other._cparts
class AccessorPath(BasePath):
"""Path for object that can be read by accessor."""
def __init__(self, accessor: BaseAccessor, *args: Any, **kwargs: Any):
separator = kwargs.pop("separator", SEPARATOR)
super().__init__(*args, separator=separator)
self.accessor = accessor
self._content_cached: Optional[Any] = None
@classmethod
def _from_parsed_parts( # type: ignore
cls: Type[TAccessorPath],
accessor: BaseAccessor,
parts: List[Hashable],
separator: str = SEPARATOR,
) -> TAccessorPath:
self = cls(accessor, separator=separator)
self.parts = parts
return self
def _make_child(self: TAccessorPath, args: List[Any]) -> TAccessorPath:
parts = parse_args(args, self.separator)
parts_joined = self.parts + parts
return self._from_parsed_parts(
self.accessor, parts_joined, self.separator
)
def _make_child_relpath(
self: TAccessorPath, part: Hashable
) -> TAccessorPath:
# This is an optimization used for dir walking. `part` must be
# a single part relative to this path.
parts = self.parts + [part]
return self._from_parsed_parts(self.accessor, parts, self.separator)
def __iter__(self: TAccessorPath) -> Iterator[TAccessorPath]:
return self.iter()
def __getitem__(self, key: Hashable) -> Any:
with self.open() as d:
return d[key]
def __contains__(self, key: Hashable) -> bool:
with self.open() as d:
return key in d
def __len__(self) -> int:
return self.accessor.len(self.parts)
def keys(self) -> Any:
return self.accessor.keys(self.parts)
def getkey(self, key: Hashable, default: Any = None) -> Any:
"""Return the value for key if key is in the path, else default."""
with self.open() as d:
try:
return d[key]
except KeyError:
return default
@contextmanager
def open(self) -> Any:
"""Open the path."""
# Cached path content
if self._content_cached is None:
with self._open() as content:
self._content_cached = content
yield self._content_cached
else:
yield self._content_cached
def _open(self) -> Any:
return self.accessor.open(self.parts)
def iter(self: TAccessorPath) -> Iterator[TAccessorPath]:
"""Iterate over all child paths."""
for idx in range(self.accessor.len(self.parts)):
yield self._make_child_relpath(idx)
def iteritems(self: TAccessorPath) -> Iterator[Tuple[Any, TAccessorPath]]:
"""Return path's items."""
return self.items()
def items(self: TAccessorPath) -> Iterator[Tuple[Any, TAccessorPath]]:
"""Return path's items."""
for key in self.accessor.keys(self.parts):
yield key, self._make_child_relpath(key)
def content(self) -> Any:
"""Return content of the path."""
with self.open() as d:
return d
def get(self, key: Hashable, default: Any = None) -> Any:
"""Return the child path for key if key is in the path, else default."""
if key in self:
return self.__truediv__(key)
return default
class LookupPath(AccessorPath):
"""Path for object that supports __getitem__ lookups."""
@classmethod
def _from_lookup(
cls: Type[TLookupPath],
lookup: Mapping[Hashable, Any],
*args: Any,
**kwargs: Any,
) -> TLookupPath:
accessor = LookupAccessor(lookup)
return cls(accessor, *args, **kwargs)
|