pathlibutil 0.3.6__tar.gz → 0.3.8__tar.gz

{pathlibutil-0.3.6 → pathlibutil-0.3.8}/PKG-INFO

@@ -1,25 +1,25 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.1
 Name: pathlibutil
-Version: 0.3.6
+Version: 0.3.8
 Summary: inherits from pathlib.Path with methods for hashing, copying, deleting and more
 License: MIT
-License-File: LICENSE
-Keywords: pathlib,hashlib,shutil,urllib.parse,json,urlpath
+Keywords: hashlib,json,pathlib,shutil,urllib.parse,urlpath
 Author: Christoph Dörrer
 Author-email: d-chris@web.de
-Requires-Python: >=3.8.1,<4.0.0
+Requires-Python: >=3.8,<4.0
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Classifier: Programming Language :: Python :: 3.8
 Provides-Extra: 7z
 Requires-Dist: py7zr (>=0.20.2) ; extra == "7z"
+Requires-Dist: typing-extensions (>=4.13.2)
 Project-URL: documentation, https://d-chris.github.io/pathlibutil
 Project-URL: repository, https://github.com/d-chris/pathlibutil
 Description-Content-Type: text/markdown
@@ -66,6 +66,7 @@ filename: ./README.md
 - `Path.iterdir()` with `recursive` all files from the directory tree will be yielded and `exclude_dirs` via callable.
 - `Path.is_expired()` to check if a file is expired by a given `datetime.timedelta`
 - `Path.expand()` yields file paths for multiple file patterns if they exsits.
+- `Path.with_anchor()` to change the anchor of a path object, e.g. for UNC paths on Windows.
 
 JSON serialization of `Path` objects is supported in `pathlibutil.json`.
 

{pathlibutil-0.3.6 → pathlibutil-0.3.8}/README.md

@@ -40,6 +40,7 @@ filename: ./README.md
 - `Path.iterdir()` with `recursive` all files from the directory tree will be yielded and `exclude_dirs` via callable.
 - `Path.is_expired()` to check if a file is expired by a given `datetime.timedelta`
 - `Path.expand()` yields file paths for multiple file patterns if they exsits.
+- `Path.with_anchor()` to change the anchor of a path object, e.g. for UNC paths on Windows.
 
 JSON serialization of `Path` objects is supported in `pathlibutil.json`.
 

{pathlibutil-0.3.6 → pathlibutil-0.3.8}/pathlibutil/base.py

@@ -1,7 +1,12 @@
+from __future__ import annotations
+
 import os
 import pathlib
 import sys
-from typing import Generator
+import typing as t
+
+if t.TYPE_CHECKING:
+    from typing_extensions import Self
 
 
 class BasePath(pathlib.Path):
@@ -17,7 +22,7 @@ class BasePath(pathlib.Path):
         )
 
     @classmethod
-    def expand(cls, file: str) -> Generator["BasePath", None, None]:
+    def expand(cls, file: str) -> t.Generator[Self, None, None]:
         """
         yields only Path object of file names that exists. Supports glob patterns in
         filename as wildcards.
@@ -31,7 +36,7 @@ class BasePath(pathlib.Path):
         BasePath('pathlibutil/__init__.py')]
         """
 
-        file = cls(file)
+        file = cls(file)  # type: Self
         try:
             file.resolve(True)
         except (OSError, FileNotFoundError):

{pathlibutil-0.3.6 → pathlibutil-0.3.8}/pathlibutil/path.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import errno
 import hashlib
 import itertools
@@ -6,11 +8,16 @@ import re
 import shutil
 import subprocess
 import sys
+import typing as t
 from datetime import datetime, timedelta
-from typing import Callable, Dict, Generator, List, Literal, Set, Tuple, Union
 
 from pathlibutil.base import BasePath
-from pathlibutil.types import ByteInt, StatResult, TimeInt, _stat_result, byteint
+from pathlibutil.types import ByteInt, StatResult, TimeInt, byteint
+
+if t.TYPE_CHECKING:
+    from typing_extensions import Self
+
+    from pathlibutil.types import _stat_result
 
 
 class Path(BasePath):
@@ -28,7 +35,7 @@ class Path(BasePath):
     ```
     """
 
-    _archive_formats: Dict[str, Callable] = {}
+    _archive_formats: t.Dict[str, t.Callable] = {}
     """
     Dict holding function to register shutil archive formats.
     """
@@ -57,7 +64,7 @@ class Path(BasePath):
             pass
 
     @property
-    def algorithms_available(self) -> Set[str]:
+    def algorithms_available(self) -> t.Set[str]:
         """
         Set of `hashlib.algorithms_available` that can be passed to `hexdigest()`,
         `verify()` method as `algorithm` parameter or to set the `default_hash`
@@ -72,7 +79,12 @@ class Path(BasePath):
         """
         return hashlib.algorithms_available
 
-    def hexdigest(self, algorithm: str = None, /, **kwargs) -> str:
+    def hexdigest(
+        self,
+        algorithm: t.Optional[str] = None,
+        /,
+        **kwargs,
+    ) -> str:
         """
         Returns the hexdigest of the file using the named algorithm (default:
         `default_hash`).
@@ -101,7 +113,12 @@ class Path(BasePath):
         return hash.hexdigest(length)
 
     def verify(
-        self, digest: str, algorithm: str = None, *, strict: bool = True, **kwargs
+        self,
+        digest: str,
+        algorithm: t.Optional[str] = None,
+        *,
+        strict: bool = True,
+        **kwargs,
     ) -> bool:
         """
         Verifies the hash of the file using the named algorithm (default:
@@ -130,7 +147,7 @@ class Path(BasePath):
 
         return True
 
-    def __enter__(self) -> "Path":
+    def __enter__(self) -> Self:
         """
         Contextmanager to changes the current working directory.
         """
@@ -154,7 +171,7 @@ class Path(BasePath):
         finally:
             del self.__stack
 
-    def read_lines(self, **kwargs) -> Generator[str, None, None]:
+    def read_lines(self, **kwargs) -> t.Generator[str, None, None]:
         """
         Iterates over all lines of the file until EOF is reached.
 
@@ -175,7 +192,12 @@ class Path(BasePath):
 
         return super().stat(**kwargs).st_size
 
-    def copy(self, dst: str, exist_ok: bool = True, **kwargs) -> "Path":
+    def copy(
+        self,
+        dst: str,
+        exist_ok: bool = True,
+        **kwargs,
+    ) -> Self:
         """
         Copies the file or directory to a destination directory, if it is missing it
         will be created.
@@ -200,7 +222,11 @@ class Path(BasePath):
         return self.__class__(_path)
 
     def delete(
-        self, *, recursive: bool = False, missing_ok: bool = False, **kwargs
+        self,
+        *,
+        recursive: bool = False,
+        missing_ok: bool = False,
+        **kwargs,
     ) -> None:
         """
         Deletes the file or directory.
@@ -227,7 +253,7 @@ class Path(BasePath):
 
             shutil.rmtree(self, **kwargs)
 
-    def move(self, dst: str) -> "Path":
+    def move(self, dst: str) -> Self:
         """
         Moves the file or directory into the destination directory.
 
@@ -247,7 +273,7 @@ class Path(BasePath):
         return self.__class__(_path)
 
     @staticmethod
-    def _find_archive_format(filename: "Path") -> str:
+    def _find_archive_format(filename: Path) -> str:
         """
         Searches for a file the correct archive format.
         """
@@ -272,8 +298,12 @@ class Path(BasePath):
             register_format()
 
     def make_archive(
-        self, archivename: str, *, exists_ok: bool = False, **kwargs
-    ) -> "Path":
+        self,
+        archivename: str,
+        *,
+        exists_ok: bool = False,
+        **kwargs,
+    ) -> Self:
         """
         Creates an archive file (eg. zip) and returns the path to the archive.
 
@@ -296,7 +326,10 @@ class Path(BasePath):
         Path('test.zpy')
         """
 
-        def _archive_exists(file: str, exists_ok: bool) -> "Path":
+        def _archive_exists(
+            file: str,
+            exists_ok: bool,
+        ) -> Self:
             """
             Returns a `Path` object of the archive file or raises a `FileExistsError`
             If `exists_ok` is `True` the file will be deleted.
@@ -311,7 +344,10 @@ class Path(BasePath):
 
             return file
 
-        def _archive_filename(expect: Path, real: str) -> "Path":
+        def _archive_filename(
+            expect: Path,
+            real: str,
+        ) -> Self:
             """
             Check if the expected archive filename matches the real filename.
             If not try to rename the real filename.
@@ -346,7 +382,7 @@ class Path(BasePath):
 
         return _archive_filename(_filename, _archive)
 
-    def unpack_archive(self, extract_dir: str, **kwargs) -> "Path":
+    def unpack_archive(self, extract_dir: str, **kwargs) -> Self:
         """
         Unpacks an archive file (eg. zip) into a directory and returns the path to the
         extracted files.
@@ -376,7 +412,7 @@ class Path(BasePath):
                 self._register_format(_format)
 
     @property
-    def archive_formats(self) -> Set[str]:
+    def archive_formats(self) -> t.Set[str]:
         """
         Returns a set with names of the supported archive formats.
 
@@ -405,7 +441,7 @@ class Path(BasePath):
         """
         return StatResult(super().stat(**kwargs))
 
-    def with_suffix(self, suffix: Union[str, List[str]]) -> "Path":
+    def with_suffix(self, suffix: t.Union[str, t.List[str]]) -> Self:
         """
         Return a new `Path` with changed suffix or remove it when its an empty
         string.
@@ -444,8 +480,10 @@ class Path(BasePath):
             return super(self.__class__, stem).with_suffix(suffix)
 
     def relative_to(
-        self, *other: Union[str, "Path"], walk_up: Union[bool, int] = False
-    ) -> "Path":
+        self,
+        *other: t.Union[str, Path],
+        walk_up: t.Union[bool, int] = False,
+    ) -> Self:
         """
         Return the relative path to another path identified by the passed
         arguments.  If the operation is not possible (because this is not
@@ -485,7 +523,11 @@ class Path(BasePath):
         return relative
 
     @classmethod
-    def cwd(cls, *, frozen: Literal[True, False, "_MEIPASS"] = False) -> "Path":
+    def cwd(
+        cls,
+        *,
+        frozen: t.Literal[True, False, "_MEIPASS"] = False,
+    ) -> Self:
         """
         Return a `Path` object representing the current working directory.
 
@@ -505,7 +547,7 @@ class Path(BasePath):
         return super().cwd()
 
     @classmethod
-    def _net_use(cls) -> Dict[str, str]:
+    def _net_use(cls) -> t.Dict[str, str]:
         """
         Return a dictionary of mapped network drives. Keys are UNC paths and values
         are drive letters.
@@ -536,7 +578,7 @@ class Path(BasePath):
         except Exception:
             return {}
 
-    def _resolve_unc(self) -> "Path":
+    def _resolve_unc(self) -> Self:
         """
         Resolve UNC paths to mapped network drives.
         """
@@ -549,7 +591,11 @@ class Path(BasePath):
         except KeyError:
             return self
 
-    def resolve(self, strict: bool = False, unc: bool = True) -> "Path":
+    def resolve(
+        self,
+        strict: bool = False,
+        unc: bool = True,
+    ) -> Self:
         """
         Make the path absolute, resolving all symlinks on the way and also normalizing
         it.
@@ -577,9 +623,9 @@ class Path(BasePath):
     def walk(
         self,
         top_down: bool = True,
-        on_error: Callable[[OSError], object] = None,
+        on_error: t.Callable[[OSError], object] = None,
         follow_symlinks: bool = False,
-    ) -> Generator[Tuple["Path", List[str], List[str]], None, None]:
+    ) -> t.Generator[t.Tuple[Self, t.List[str], t.List[str]], None, None]:
         """
         Walks the directory tree and yields a 3-tuple of (dirpath, dirnames, filenames).
         """
@@ -601,10 +647,10 @@ class Path(BasePath):
     def iterdir(
         self,
         *,
-        recursive: Union[bool, int] = False,
-        exclude_dirs: Callable[["Path"], bool] = None,
+        recursive: t.Union[bool, int] = False,
+        exclude_dirs: t.Callable[[Path], bool] = None,
         **kwargs,
-    ) -> Generator["Path", None, None]:
+    ) -> t.Generator[Self, None, None]:
         """
         Iterates over the files in the directory.
 
@@ -636,7 +682,12 @@ class Path(BasePath):
         else:
             yield from super().iterdir()
 
-    def is_expired(self, *, stat="st_mtime", **kwargs) -> bool:
+    def is_expired(
+        self,
+        *,
+        stat: str = "st_mtime",
+        **kwargs,
+    ) -> bool:
         """
         Returns `True` if the time of the file is greater than a given threshold.
 
@@ -660,7 +711,7 @@ class Path(BasePath):
         cls,
         *files: str,
         duplicates: bool = True,
-    ) -> Generator["Path", None, None]:
+    ) -> t.Generator[Self, None, None]:
         """
         Yields only Path object of file names that exists. Supports glob patterns in
         filename as wildcards.
@@ -682,6 +733,17 @@ class Path(BasePath):
                         seen.add(item)
                         yield item
 
+    def with_anchor(self, anchor: t.Union[str, os.PathLike]) -> Self:
+        """
+        Returns a new `Path` object with the given anchor.
+
+        >>> Path("README.md").with_anchor("C:\\")
+        Path('C:/README.md')
+        """
+        relpath = self.relative_to(self.anchor)
+
+        return self.__class__(anchor).joinpath(relpath)
+
 
 class Register7zFormat(Path, archive="7z"):
     """

{pathlibutil-0.3.6 → pathlibutil-0.3.8}/pathlibutil/types.py

@@ -1,11 +1,16 @@
+from __future__ import annotations
+
 import functools
 import os
 import re
+import typing as t
 from datetime import datetime, tzinfo
-from typing import Iterable, Set, Tuple, TypeVar
 
-_ByteInt = TypeVar("_ByteInt", bound="ByteInt")
-_stat_result = TypeVar("_stat_result", bound="os.stat_result")
+if t.TYPE_CHECKING:
+    from typing_extensions import Self
+
+_ByteInt = t.TypeVar("_ByteInt", bound="ByteInt")
+_stat_result = t.TypeVar("_stat_result", bound="os.stat_result")
 
 
 class ByteInt(int):
@@ -49,7 +54,7 @@ class ByteInt(int):
     }
 
     @property
-    def units(self) -> Set[str]:
+    def units(self) -> t.Set[str]:
         """
         `decimal` and `binary` units for measuring storage data.
 
@@ -73,7 +78,7 @@ class ByteInt(int):
     def __str__(self) -> str:
         return self.string()
 
-    def string(self, decimal=True) -> str:
+    def string(self, decimal: bool = True) -> str:
         """
         Return a string representation of `self` in the most appropriate unit.
 
@@ -101,7 +106,7 @@ class ByteInt(int):
         return f"{int(self)} b"
 
     @classmethod
-    def info(cls, unit: str) -> Tuple[int, str]:
+    def info(cls, unit: str) -> t.Tuple[int, str]:
         """
         Return a tuple containing `bytes` and `name` for a given `unit`
 
@@ -137,61 +142,61 @@ class ByteInt(int):
 
             return value.__format__(self.__regex.sub("f", __format_spec, 1))
 
-    def __add__(self, other: int) -> _ByteInt:
+    def __add__(self, other: int) -> Self:
         """
         b + 1
         """
         return self.__class__(super().__add__(other))
 
-    def __iadd__(self, other: int) -> _ByteInt:
+    def __iadd__(self, other: int) -> Self:
         """
         b += 1
         """
         return self.__add__(other)
 
-    def __sub__(self, other: int) -> _ByteInt:
+    def __sub__(self, other: int) -> Self:
         """
         b - 1
         """
         return self.__class__(super().__sub__(other))
 
-    def __isub__(self, other: int) -> _ByteInt:
+    def __isub__(self, other: int) -> Self:
         """
         b -=1
         """
         return self.__sub__(other)
 
-    def __mul__(self, other: int) -> _ByteInt:
+    def __mul__(self, other: int) -> Self:
         """
         b * 1
         """
         return self.__class__(super().__mul__(other))
 
-    def __imul__(self, other: int) -> _ByteInt:
+    def __imul__(self, other: int) -> Self:
         """
         b *= 1
         """
         return self.__mul__(other)
 
-    def __floordiv__(self, other: int) -> _ByteInt:
+    def __floordiv__(self, other: int) -> Self:
         """
         b // 1
         """
         return self.__class__(super().__floordiv__(other))
 
-    def __ifloordiv__(self, other: int) -> _ByteInt:
+    def __ifloordiv__(self, other: int) -> Self:
         """
         b //= 1
         """
         return self.__floordiv__(other)
 
-    def __mod__(self, other: int) -> _ByteInt:
+    def __mod__(self, other: int) -> Self:
         """
         b % 1
         """
         return self.__class__(super().__mod__(other))
 
-    def __imod__(self, other: int) -> _ByteInt:
+    def __imod__(self, other: int) -> Self:
         """
         b %= 1
         """
@@ -247,19 +252,27 @@ class TimeInt(float):
     '1970-01-01 00:00:00'
     """
 
-    format = "%Y-%m-%d %H:%M:%S"
+    format: str = "%Y-%m-%d %H:%M:%S"
     """
     Format string to which is uesed to convert `self` to a string. Default: 'isoformat'.
     For more information see `datetime.datetime.strftime`.
     """
 
-    def __new__(cls, value: int, tz: tzinfo = None) -> float:
+    def __new__(
+        cls,
+        value: int,
+        tz: t.Optional[tzinfo] = None,
+    ) -> float:
         """
         Create a new instance from baseclass `int`.
         """
         return super().__new__(cls, value)
 
-    def __init__(self, value: int, tz: tzinfo = None) -> None:
+    def __init__(
+        self,
+        value: int,
+        tz: t.Optional[tzinfo] = None,
+    ) -> None:
         """
         Create a new instance from baseclass `int` with optional `timezone` info.
         """
@@ -283,7 +296,7 @@ class TimeInt(float):
         """
         return self.string()
 
-    def string(self, format_string: str = None) -> str:
+    def string(self, format_string: t.Optional[str] = None) -> str:
         """
         Return a string representation of `datetime` using the `format_string`.
 
@@ -301,13 +314,13 @@ class StatResult:
     to prevent subclassing.
     """
 
-    def __init__(self, stat):
+    def __init__(self, stat: os.stat_result) -> None:
         """
         Wrapper for `os.stat_result`.
         """
         self._obj = stat
 
-    def __getattr__(self, name):
+    def __getattr__(self, name: str) -> t.Any:
         """
         Forward all unknown attributes to `self._obj`.
         """
@@ -334,7 +347,7 @@ class StatResult:
         """
         return repr(self._obj)
 
-    def __dir__(self) -> Iterable[str]:
+    def __dir__(self) -> t.Iterator[str]:
         """
         Return a list of attributes of `os.stat_result` object.
         """

{pathlibutil-0.3.6 → pathlibutil-0.3.8}/pyproject.toml

@@ -1,16 +1,18 @@
 [build-system]
 build-backend = "poetry.core.masonry.api"
-
 requires = [ "poetry-core" ]
 
 [tool.poetry]
 name = "pathlibutil"
-version = "v0.3.6"
+version = "v0.3.8"
 description = "inherits from pathlib.Path with methods for hashing, copying, deleting and more"
+license = "MIT"
 authors = [ "Christoph Dörrer <d-chris@web.de>" ]
 readme = "README.md"
-license = "MIT"
+keywords = [ "hashlib", "json", "pathlib", "shutil", "urllib.parse", "urlpath" ]
 classifiers = [
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
   "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
@@ -18,36 +20,26 @@ classifiers = [
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: 3.14",
-  "License :: OSI Approved :: MIT License",
-  "Operating System :: OS Independent",
 ]
-keywords = [ "pathlib", "hashlib", "shutil", "urllib.parse", "json", "urlpath" ]
-
-[tool.poetry.urls]
-repository = "https://github.com/d-chris/pathlibutil"
-documentation = "https://d-chris.github.io/pathlibutil"
 
 [tool.poetry.dependencies]
-python = "^3.8.1"
+python = "^3.8"
 py7zr = { version = ">=0.20.2", optional = true }
+typing-extensions = ">=4.13.2"
 
 [tool.poetry.extras]
 7z = [ "py7zr" ]
 
-[tool.poetry.group.dev.dependencies]
-tox = ">=4.11.4"
-pyinstaller = { version = ">=6.10.0", python = "<3.15" }
+[tool.poetry.group.docs.dependencies]
+jinja2-pdoc = { version = "^1.3.0", python = ">=3.8.1" }
+pyperclip = "^1.9.0"
 
 [tool.poetry.group.test.dependencies]
+exrex = ">=0.12.0"
 pytest = ">=8.3.3"
-pytest-random-order = ">=1.1.0"
 pytest-cov = ">=4.1.0"
 pytest-mock = ">=3.12.0"
-exrex = ">=0.12.0"
-
-[tool.poetry.group.docs.dependencies]
-jinja2-pdoc = ">=1.1.0"
-pyperclip = ">=1.9.0"
+pytest-random-order = ">=1.1.0"
 
 [[tool.poetry.source]]
 name = "PyPI"
@@ -58,13 +50,21 @@ name = "testpypi"
 url = "https://test.pypi.org/legacy/"
 priority = "explicit"
 
+[tool.poetry.urls]
+documentation = "https://d-chris.github.io/pathlibutil"
+repository = "https://github.com/d-chris/pathlibutil"
+
 [tool.isort]
 profile = "black"
 
-[tool.pytest.ini_options]
-minversion = "6.0"
-testpaths = "tests"
-addopts = [
+[tool.pyproject-fmt]
+tool_format = "short"
+expand_tables = [ "tool.poetry" ]
+
+[tool.pytest]
+ini_options.minversion = "6.0"
+ini_options.testpaths = "tests"
+ini_options.addopts = [
   "--random-order",
   "--color=yes",
   "-s",
@@ -73,14 +73,12 @@ addopts = [
   "--cov-report=xml",
 ]
 
-[tool.coverage.report]
-exclude_lines = [
-  "^def normalize_url",
-]
-
-[tool.coverage.run]
-omit = [
-  "*/tests/*",
+[tool.coverage]
+run.omit = [
   "*/docs/*",
   "*/examples/*",
+  "*/tests/*",
+]
+report.exclude_lines = [
+  "^def normalize_url",
 ]