superpathlib 2.0.9__tar.gz → 2.0.10__tar.gz

{superpathlib-2.0.9/src/superpathlib.egg-info → superpathlib-2.0.10}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: superpathlib
-Version: 2.0.9
+Version: 2.0.10
 Summary: Extended Pathlib
 Author-email: Quinten Roets <qdr2104@columbia.edu>
-License: MIT
+License-Expression: MIT
 Project-URL: Source Code, https://github.com/quintenroets/superpathlib
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
@@ -17,13 +17,14 @@ Requires-Dist: PyYaml<7,>=6.0.1; extra == "full"
 Requires-Dist: xattr<2,>=0.10.1; extra == "full"
 Provides-Extra: dev
 Requires-Dist: hypothesis<7,>=6.97.1; extra == "dev"
-Requires-Dist: package-dev-tools<1,>=0.5.12; extra == "dev"
+Requires-Dist: package-dev-tools<1,>=0.7.1; extra == "dev"
 Requires-Dist: types-PyYaml<7,>=6.0.12.12; extra == "dev"
 Requires-Dist: dirhash<1,>=0.2.1; extra == "dev"
 Requires-Dist: numpy<3,>=1.26.4; extra == "dev"
 Requires-Dist: package-utils<1,>=0.6.1; extra == "dev"
 Requires-Dist: PyYaml<7,>=6.0.1; extra == "dev"
 Requires-Dist: xattr<2,>=0.10.1; extra == "dev"
+Dynamic: license-file
 
 # Superpathlib
 [![PyPI version](https://badge.fury.io/py/superpathlib.svg)](https://badge.fury.io/py/superpathlib)

{superpathlib-2.0.9 → superpathlib-2.0.10}/pyproject.toml

@@ -1,9 +1,9 @@
 [project]
 name = "superpathlib"
-version = "2.0.9"
+version = "2.0.10"
 description = "Extended Pathlib"
 authors = [{name = "Quinten Roets", email = "qdr2104@columbia.edu"}]
-license = {text = "MIT"}
+license = "MIT"
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
@@ -20,7 +20,7 @@ full = [
 ]
 dev = [
     "hypothesis >=6.97.1, <7",
-    "package-dev-tools >=0.5.12, <1",
+    "package-dev-tools >=0.7.1, <1",
 
     # types
     "types-PyYaml >=6.0.12.12, <7",
@@ -69,8 +69,6 @@ fix = true
 [tool.ruff.lint]
 select = ["ALL"]
 ignore = [
-    "ANN101",   # annotate self
-    "ANN102",   # annotate cls
     "ANN401",   # annotated with Any
     "D",        # docstrings
     "G004",     # logging f-string

{superpathlib-2.0.9 → superpathlib-2.0.10}/src/superpathlib/cached_content.py

@@ -14,7 +14,7 @@ T = TypeVar("T")
 
 class Path(metadata_properties.Path):
     """
-    Properties to for cached file content.
+    Properties for cached file content.
     """
 
     @cached_property

{superpathlib-2.0.9 → superpathlib-2.0.10}/src/superpathlib/common_folders.py

@@ -4,6 +4,7 @@ import typing
 from typing import Any, TypeVar
 
 from simple_classproperty import classproperty
+from typing_extensions import Self
 
 from . import base
 
@@ -27,7 +28,9 @@ class PropertyMeta(abc.ABCMeta):
     ) -> "PropertyMeta":
         meta_class = super().__new__(cls, name, bases, attributes)
         if sys.version_info >= (3, 13):
-            enable_classproperties(meta_class)  # pragma: nocover
+            enable_classproperties(
+                meta_class,  # type: ignore[arg-type]
+            )  # pragma: nocover
         return meta_class
 
 
@@ -42,37 +45,37 @@ class Path(base.Path, metaclass=PropertyMeta):
 
     @classmethod
     @classproperty
-    def HOME(cls: type[T]) -> T:  # noqa: N802
+    def HOME(cls) -> Self:  # noqa: N802
         return cls.home()
 
     @classmethod
     @classproperty
-    def docs(cls: type[T]) -> T:
+    def docs(cls) -> Self:
         path = cls.HOME / "Documents"
-        return typing.cast(T, path)
+        return typing.cast("Self", path)
 
     @classmethod
     @classproperty
-    def scripts(cls: type[T]) -> T:
+    def scripts(cls) -> Self:
         path = cls.docs / "Scripts"
-        return typing.cast(T, path)
+        return typing.cast("Self", path)
 
     @classmethod
     @classproperty
-    def script_assets(cls: type[T]) -> T:
+    def script_assets(cls) -> Self:
         path = cls.scripts / "assets"
-        return typing.cast(T, path)
+        return typing.cast("Self", path)
 
     @classmethod
     @classproperty
-    def assets(cls: type[T]) -> T:
+    def assets(cls) -> Self:
         """
         Often overwritten by child classes for specific project.
         """
-        return typing.cast(T, cls.script_assets)
+        return typing.cast("Self", cls.script_assets)
 
     @classmethod
     @classproperty
-    def draft(cls: type[T]) -> T:
+    def draft(cls) -> Self:
         path = cls.docs / "draft.txt"
-        return typing.cast(T, path)
+        return typing.cast("Self", path)

{superpathlib-2.0.9 → superpathlib-2.0.10}/src/superpathlib/content_properties.py

@@ -53,12 +53,12 @@ class Path(base.Path):
     @content_lines.setter
     def content_lines(self, lines: Iterable[Any]) -> None:
         lines = (line for line in lines if line)
-        self.lines = typing.cast(list[str], lines)
+        self.lines = typing.cast("list[str]", lines)
 
     @property
     def json(self) -> dict[str, Any] | list[Any]:
         value = json.loads(self.text or "{}")
-        return typing.cast(dict[str, Any] | list[Any], value)
+        return typing.cast("dict[str, Any] | list[Any]", value)
 
     @json.setter
     def json(self, content: dict[Any, Any] | list[Any]) -> None:

{superpathlib-2.0.9 → superpathlib-2.0.10}/src/superpathlib/encryption.py

@@ -62,6 +62,7 @@ class EncryptedPath(Path):
         self,
         encoding: str | None = None,  # noqa: ARG002
         errors: str | None = None,  # noqa: ARG002
+        newline: str | None = None,  # noqa: ARG002
     ) -> str:
         return self.read_bytes().decode()
 

{superpathlib-2.0.9 → superpathlib-2.0.10}/src/superpathlib/extra_functionality.py

@@ -5,43 +5,44 @@ import tempfile
 import time
 import typing
 import urllib.parse
+from collections import deque
 from collections.abc import Callable, Iterator
 from functools import cached_property
 from types import TracebackType
-from typing import Any, TypeVar, cast
+from typing import Any, cast
+
+from typing_extensions import Self
 
 from . import cached_content
 from .utils import find_first_match
 
-PathType = TypeVar("PathType", bound="Path")
-
 
 class Path(cached_content.Path):
     """
     Additional functionality.
     """
 
-    def create_parent(self: PathType) -> PathType:
+    def create_parent(self) -> Self:
         self.parent.mkdir(parents=True, exist_ok=True)
         return self.parent
 
-    def with_nonexistent_name(self: PathType) -> PathType:
+    def with_nonexistent_name(self) -> Self:
         path = self
         if path.exists():
             stem = path.stem
 
-            def with_number(i: int) -> PathType:
+            def with_number(i: int) -> "Path":
                 return path.with_stem(f"{stem} ({i})")
 
             def nonexistent(i: int) -> bool:
                 return not with_number(i).exists()
 
             first_free_number = find_first_match(nonexistent)
-            path = with_number(first_free_number)
+            path = cast("Self", with_number(first_free_number))
 
         return path
 
-    def with_timestamp(self: PathType) -> PathType:
+    def with_timestamp(self) -> Self:
         from datetime import datetime, timezone
 
         timestamp = int(time.time())  # precision up to second
@@ -50,7 +51,7 @@ class Path(cached_content.Path):
 
     def copy_to(
         self,
-        dest: PathType,
+        dest: Self,
         *,
         include_properties: bool = True,
         only_if_newer: bool = False,
@@ -60,7 +61,7 @@ class Path(cached_content.Path):
             if include_properties:
                 self.copy_properties_to(dest)
 
-    def copy_properties_to(self, dest: PathType) -> None:
+    def copy_properties_to(self, dest: Self) -> None:
         for path in dest.find():
             path.tag = self.tag
             path.mtime = self.mtime
@@ -70,20 +71,20 @@ class Path(cached_content.Path):
         # noinspection PyProtectedMember
         path_str = str(self)
         format_ = shutil._find_unpack_format(path_str)  # type: ignore[attr-defined] # noqa: SLF001
-        return typing.cast(str, format_)
+        return typing.cast("str", format_)
 
     def unpack_if_archive(
         self,
         *,
-        extraction_directory: PathType | None = None,
+        extraction_directory: Self | None = None,
         recursive: bool = True,
     ) -> None:
         if self.archive_format is not None:
             self.unpack(extraction_directory, recursive=recursive)
 
     def unpack(  # noqa: PLR0913
-        self: PathType,
-        extraction_directory: PathType | None = None,
+        self,
+        extraction_directory: Self | None = None,
         *,
         remove_existing: bool = True,
         preserve_properties: bool = True,
@@ -91,7 +92,7 @@ class Path(cached_content.Path):
         archive_format: str | None = None,
         recursive: bool = True,
     ) -> None:
-        def cleanup(cleanup_path: PathType) -> None:
+        def cleanup(cleanup_path: Self) -> None:
             (cleanup_path / "__MACOSX").rmtree(missing_ok=True)
             subfolder = cleanup_path / cleanup_path.name
             if subfolder.exists() and cleanup_path.number_of_children == 1:
@@ -129,7 +130,7 @@ class Path(cached_content.Path):
             for path in extraction_directory.find():
                 path.unpack_if_archive()
 
-    def create_extraction_directory(self: PathType, archive_format: str) -> PathType:
+    def create_extraction_directory(self, archive_format: str) -> Self:
         extract_name = self.name
         # noinspection PyProtectedMember
         unpack_formats = shutil._UNPACK_FORMATS  # type: ignore[attr-defined] # noqa: SLF001
@@ -180,7 +181,7 @@ class Path(cached_content.Path):
     def update(self, value: dict[Any, Any]) -> dict[Any, Any]:
         # only read and write if value to add not empty
         if value:
-            current_content = cast(dict[Any, Any], self.yaml)
+            current_content = cast("dict[Any, Any]", self.yaml)
             updated_content = current_content | value
             self.yaml = updated_content
         else:
@@ -188,20 +189,20 @@ class Path(cached_content.Path):
         return updated_content
 
     def find(
-        self: PathType,
-        condition: Callable[[PathType], bool] | None = None,
-        exclude: Callable[[PathType], bool] = lambda _: False,
+        self,
+        condition: Callable[[Self], bool] | None = None,
+        exclude: Callable[[Self], bool] = lambda _: False,
         *,
         recurse_on_match: bool = False,
         follow_symlinks: bool = False,
         only_folders: bool = False,
-    ) -> Iterator[PathType]:
+    ) -> Iterator[Self]:
         """Find all subpaths under path that match condition.
 
         only_folders option can be used for efficiency reasons
         """
 
-        def extract_children_to_recurse_on(path: PathType) -> Iterator[PathType]:
+        def extract_children_to_recurse_on(path: Self) -> Iterator[Self]:
             # skip folders that do not allow listing
             with contextlib.suppress(PermissionError):
                 for child in path.iterdir():
@@ -213,12 +214,12 @@ class Path(cached_content.Path):
         if condition is None:
             recurse_on_match = True
 
-            def condition(_: PathType) -> bool:
+            def condition(_: Self) -> bool:
                 return True
 
-        to_traverse = [self] if self.exists() else []
+        to_traverse = deque([self] if self.exists() else [])
         while to_traverse:
-            path = to_traverse.pop(0)
+            path = to_traverse.popleft()
             if not exclude(path):
                 match = condition(path)
                 if match:
@@ -226,7 +227,7 @@ class Path(cached_content.Path):
                 should_recurse = recurse_on_match or not match
                 should_recurse_folder = only_folders or path.is_dir()
                 if should_recurse and should_recurse_folder:
-                    to_traverse += list(extract_children_to_recurse_on(path))
+                    to_traverse.extend(extract_children_to_recurse_on(path))
 
     def rmtree(
         self,
@@ -248,18 +249,18 @@ class Path(cached_content.Path):
     @classmethod
     def _on_error(
         cls,
-        _: bool,  # noqa: FBT001
+        func: Callable[[str], Any],
         path_str: str,
         exc_info: tuple[type[Exception], Exception, TracebackType],
     ) -> None:
         if exc_info[0] is PermissionError and os.name == "nt":  # pragma: nocover
             path = Path(path_str)
             path.chmod(0o777)
-            path.unlink()
+            func(path_str)
         else:
             raise exc_info[0]
 
-    def subpath(self: PathType, *parts: str) -> PathType:
+    def subpath(self, *parts: str) -> Self:
         path = self
         tokens_to_replace = os.sep, "."
         for part in parts:
@@ -269,18 +270,18 @@ class Path(cached_content.Path):
         return path
 
     @classmethod
-    def from_uri(cls: type[PathType], uri: str) -> PathType:
+    def from_uri(cls, uri: str) -> Self:
         path_str = urllib.parse.urlparse(uri).path
         return cls(path_str)
 
     @classmethod
     def tempfile(
-        cls: type[PathType],
+        cls,
         *,
         in_memory: bool = True,
         create: bool = True,
         **kwargs: Any,
-    ) -> PathType:
+    ) -> Self:
         """Usage:
 
         with Path.tempfile() as tmp:     run_command(log_file=tmp)     logs = tmp.text
@@ -298,12 +299,12 @@ class Path(cached_content.Path):
         return path
 
     @classmethod
-    def tempdir(cls: type[PathType], *, in_memory: bool = True) -> PathType:
+    def tempdir(cls, *, in_memory: bool = True) -> Self:
         path = cls.tempfile(in_memory=in_memory, create=False)
         path.mkdir()
         return path
 
-    def __enter__(self: PathType) -> PathType:
+    def __enter__(self) -> Self:
         return self
 
     def __exit__(

{superpathlib-2.0.9 → superpathlib-2.0.10}/src/superpathlib/metadata_properties.py

@@ -1,8 +1,6 @@
-import contextlib
 import hashlib
 import mimetypes
 import os
-import subprocess
 import warnings
 from collections.abc import Callable
 from functools import wraps
@@ -44,12 +42,6 @@ class Path(content_properties.Path):
     def mtime(self, time: float) -> None:
         os.utime(self, (time, time))  # set create time as well
 
-        command = "touch", "-d", f"@{time}", self
-        with contextlib.suppress(
-            subprocess.CalledProcessError,
-        ):  # Doesn't work on Windows
-            subprocess.run(command, check=False)  # noqa: S603
-
     @property
     def tags(self) -> list[str]:
         from .tags import XDGTags  # , autoimport
@@ -119,7 +111,7 @@ class Path(content_properties.Path):
 
         # use default algorithm used in cloud provider checksums
         # can be efficient because not used for cryptographic security
-        return cast(str, dirhash.dirhash(self, "md5")) if self.has_children else None
+        return cast("str", dirhash.dirhash(self, "md5")) if self.has_children else None
 
     @property
     def file_content_hash(self) -> str:

{superpathlib-2.0.9 → superpathlib-2.0.10}/src/superpathlib/override.py

@@ -6,6 +6,8 @@ from functools import wraps
 from os import PathLike
 from typing import IO, Any, TypeVar
 
+from typing_extensions import Self
+
 from . import encryption
 from .metadata_properties import catch_missing
 
@@ -47,12 +49,12 @@ class Path(encryption.Path):
     def rmdir(self) -> None:
         return super().rmdir()
 
-    def iterdir(self: T, *, missing_ok: bool = True) -> Generator[T, None, None]:
+    def iterdir(self, *, missing_ok: bool = True) -> Generator[Self, None, None]:
         if self.exists() or not missing_ok:
             yield from super().iterdir()
 
     @create_parent_on_missing
-    def rename(self: T, target: str | T, *, exist_ok: bool = False) -> T:
+    def rename(self, target: str | Self, *, exist_ok: bool = False) -> Self:
         target_path = self.__class__(target)
         rename = super().replace if exist_ok else super().rename
         try:
@@ -71,7 +73,7 @@ class Path(encryption.Path):
                         else:
                             target_path.unlink()  # pragma: nocover
                     else:
-                        message = f"Target already exists: {target_path }"
+                        message = f"Target already exists: {target_path}"
                         raise RuntimeError(message) from exception
                 else:
                     target_path.create_parent()
@@ -80,9 +82,9 @@ class Path(encryption.Path):
                 raise
         return target_path
 
-    def replace(self: T, target: str | PathLike[str]) -> T:
+    def replace(self, target: str | PathLike[str]) -> Self:
         path = self.rename(target, exist_ok=True)
-        return typing.cast(T, path)
+        return typing.cast("Self", path)
 
     def open(self, mode: str = "r", **kwargs: Any) -> IO[Any]:  # type: ignore[override]
         try:

{superpathlib-2.0.9 → superpathlib-2.0.10}/src/superpathlib/utils.py

@@ -4,8 +4,8 @@ from collections.abc import Callable
 def find_first_match(condition: Callable[..., bool]) -> int:
     """
     :param condition: Condition that number needs to match.
-                      The condition is assumed to be valid for all integers staring
-                      from an initial value.
+                     The condition is assumed to be valid for all integers starting
+                     from an initial value.
     :return: First integer for which condition is valid.
     """
 

{superpathlib-2.0.9 → superpathlib-2.0.10/src/superpathlib.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: superpathlib
-Version: 2.0.9
+Version: 2.0.10
 Summary: Extended Pathlib
 Author-email: Quinten Roets <qdr2104@columbia.edu>
-License: MIT
+License-Expression: MIT
 Project-URL: Source Code, https://github.com/quintenroets/superpathlib
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
@@ -17,13 +17,14 @@ Requires-Dist: PyYaml<7,>=6.0.1; extra == "full"
 Requires-Dist: xattr<2,>=0.10.1; extra == "full"
 Provides-Extra: dev
 Requires-Dist: hypothesis<7,>=6.97.1; extra == "dev"
-Requires-Dist: package-dev-tools<1,>=0.5.12; extra == "dev"
+Requires-Dist: package-dev-tools<1,>=0.7.1; extra == "dev"
 Requires-Dist: types-PyYaml<7,>=6.0.12.12; extra == "dev"
 Requires-Dist: dirhash<1,>=0.2.1; extra == "dev"
 Requires-Dist: numpy<3,>=1.26.4; extra == "dev"
 Requires-Dist: package-utils<1,>=0.6.1; extra == "dev"
 Requires-Dist: PyYaml<7,>=6.0.1; extra == "dev"
 Requires-Dist: xattr<2,>=0.10.1; extra == "dev"
+Dynamic: license-file
 
 # Superpathlib
 [![PyPI version](https://badge.fury.io/py/superpathlib.svg)](https://badge.fury.io/py/superpathlib)

{superpathlib-2.0.9 → superpathlib-2.0.10}/src/superpathlib.egg-info/requires.txt

@@ -2,7 +2,7 @@ simple-classproperty<5,>=4.0.2
 
 [dev]
 hypothesis<7,>=6.97.1
-package-dev-tools<1,>=0.5.12
+package-dev-tools<1,>=0.7.1
 types-PyYaml<7,>=6.0.12.12
 dirhash<1,>=0.2.1
 numpy<3,>=1.26.4

{superpathlib-2.0.9 → superpathlib-2.0.10}/tests/test_cached_content.py

@@ -32,7 +32,7 @@ def test_text(content: str) -> None:
 def test_content(path: Path, content: dict[str, dict[str, str]]) -> None:
     class Storage:
         content: CachedFileContent[dict[str, dict[str, str]]] = typing.cast(
-            CachedFileContent[dict[str, dict[str, str]]],
+            "CachedFileContent[dict[str, dict[str, str]]]",
             path.cached_content,
         )
 
@@ -44,7 +44,7 @@ def test_content(path: Path, content: dict[str, dict[str, str]]) -> None:
 def test_created_content(path: Path, content: dict[str, dict[str, str]]) -> None:
     class Storage:
         content: CachedFileContent[dict[str, dict[str, str]]] = typing.cast(
-            CachedFileContent[dict[str, dict[str, str]]],
+            "CachedFileContent[dict[str, dict[str, str]]]",
             path.create_cached_content({}),
         )
 

{superpathlib-2.0.9 → superpathlib-2.0.10}/tests/test_functionality.py

@@ -11,6 +11,8 @@ from tests.content import (
 )
 from tests.utils import ignore_fixture_warning
 
+MTIME_TOLERANCE = 0.01
+
 
 def test_tempfile() -> None:
     with Path.tempfile() as path:
@@ -297,3 +299,5 @@ def test_rmdir(directory: Path) -> None:
 
 def test_touch(path: Path) -> None:
     path.touch(mtime=1)
+    assert path.exists()
+    assert abs(path.mtime - 1) < MTIME_TOLERANCE

{superpathlib-2.0.9 → superpathlib-2.0.10}/tests/test_metadata.py

@@ -6,7 +6,7 @@ from hypothesis import given, strategies
 from hypothesis.strategies import lists
 
 from superpathlib import Path
-from tests.content import byte_content, text_strategy
+from tests.content import byte_content, slower_test_settings, text_strategy
 from tests.utils import ignore_fixture_warning
 
 
@@ -44,7 +44,7 @@ def test_tag(path: Path, content: str) -> None:
     assert path.tag == content
 
 
-@ignore_fixture_warning
+@slower_test_settings
 @byte_content
 def test_size(path: Path, content: bytes) -> None:
     assert isinstance(Path.size, property)