pathlibutil 0.1.7__tar.gz → 0.1.8__tar.gz

{pathlibutil-0.1.7 → pathlibutil-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pathlibutil
-Version: 0.1.7
+Version: 0.1.8
 Summary: inherits from pathlib.Path with methods for hashing, copying, deleting and more
 Home-page: https://d-chris.github.io
 License: MIT
@@ -51,6 +51,7 @@ Description-Content-Type: text/markdown
 - `Path.stat()` returns a `StatResult` object to get file or directory information containing
   - `TimeInt` objects for `atime`, `ctime`, `mtime` and `birthtime`
   - `ByteInt` object for `size`
+- `Path.relative_to()` to get relative path from a file or directory, `walk_up` to walk up the directory tree.
 
 ## Installation
 

{pathlibutil-0.1.7 → pathlibutil-0.1.8}/README.md

@@ -27,6 +27,7 @@
 - `Path.stat()` returns a `StatResult` object to get file or directory information containing
   - `TimeInt` objects for `atime`, `ctime`, `mtime` and `birthtime`
   - `ByteInt` object for `size`
+- `Path.relative_to()` to get relative path from a file or directory, `walk_up` to walk up the directory tree.
 
 ## Installation
 

{pathlibutil-0.1.7 → pathlibutil-0.1.8}/pathlibutil/path.py

@@ -401,15 +401,15 @@ class Path(BasePath):
         Return a new `Path` with changed suffix or remove it when its an empty
         string.
 
+        Multiple suffixes can be changed at once by passing a list of suffixes.
+        With a empty list all suffixes will be removed.
+
         >>> Path('test.a.b').with_suffix('.c')
         Path('test.a.c')
 
         >>> Path('test.a.b').with_suffix('')
         Path('test.a')
 
-        Multiple suffixes can be changed at once by passing a list of suffixes.
-        With a empty list all suffixes will be removed.
-
         >>> Path('test.a.b').with_suffix(['.c', '.d'])
         Path('test.c.d')
 
@@ -432,7 +432,48 @@ class Path(BasePath):
             end = -1 * len(self.suffixes) or None
             name = self.name.split(".")[0:end]
             stem = self.parent.joinpath("".join(name))
-            return super(Path, stem).with_suffix(suffix)
+            return super(self.__class__, stem).with_suffix(suffix)
+
+    def relative_to(
+        self, *other: Union[str, _Path], walk_up: Union[bool, int] = False
+    ) -> _Path:
+        """
+        Return the relative path to another path identified by the passed
+        arguments.  If the operation is not possible (because this is not
+        related to the other path), raise `ValueError`.
+
+        The `walk_up` parameter controls whether `..` may be used to resolve
+        the path.
+
+        If `walk_up` is a integer it specifies the maximum number of `..` to resolve, if
+        max is reached a `ValueError` is raised.
+
+        >>> Path('a/b/c/d').relative_to('a/b')
+        Path('c/d')
+
+        >>> Path('a/b/c/d').relative_to('a/b/e/f/g', walk_up=True)
+        Path('../../../c/d')
+
+        >>> Path('a/b/c/d').relative_to('a/b/e/f/g', walk_up=2)
+        ValueError: '../../../c/d' is outside of the relative deepth of '2'
+        """
+        if not walk_up:
+            return super().relative_to(*other)
+
+        try:
+            relative = super().relative_to(*other, walk_up=walk_up)
+        except TypeError:
+            relative = self.__class__(os.path.relpath(self, Path(*other)))
+
+        if type(walk_up) is not int:
+            return relative
+
+        if relative.parts.count("..") > walk_up:
+            raise ValueError(
+                f"'{relative}' is outside of the relative deepth of '{walk_up}'"
+            )
+
+        return relative
 
 
 class Register7zFormat(Path, archive="7z"):

{pathlibutil-0.1.7 → pathlibutil-0.1.8}/pathlibutil/types.py

@@ -2,7 +2,7 @@ import functools
 import os
 import re
 from datetime import datetime, tzinfo
-from typing import Set, Tuple, TypeVar
+from typing import Set, Tuple, TypeVar, Iterable
 
 _ByteInt = TypeVar("_ByteInt", bound="ByteInt")
 _stat_result = TypeVar("_stat_result", bound="os.stat_result")
@@ -332,3 +332,22 @@ class StatResult:
         Return representation of `os.stat_result` object.
         """
         return repr(self._obj)
+
+    def __dir__(self) -> Iterable[str]:
+        """
+        Return a list of attributes of `os.stat_result` object.
+        """
+        return dir(self._obj)
+
+    def __len__(self) -> int:
+        """
+        Return length of `os.stat_result` object.
+        """
+        return len(self._obj)
+
+    @property
+    def stat_result(self) -> os.stat_result:
+        """
+        Return the wrapped `os.stat_result` object.
+        """
+        return self._obj

{pathlibutil-0.1.7 → pathlibutil-0.1.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pathlibutil"
-version = "v0.1.7"
+version = "v0.1.8"
 description = "inherits from pathlib.Path with methods for hashing, copying, deleting and more"
 authors = ["Christoph Dörrer <d-chris@web.de>"]
 readme = "README.md"