superpathlib 2.0.7__tar.gz → 2.0.9__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: superpathlib
-Version: 2.0.7
+Version: 2.0.9
 Summary: Extended Pathlib
 Author-email: Quinten Roets <qdr2104@columbia.edu>
 License: MIT
@@ -27,14 +27,26 @@ Requires-Dist: xattr<2,>=0.10.1; extra == "dev"
 
 # Superpathlib
 [![PyPI version](https://badge.fury.io/py/superpathlib.svg)](https://badge.fury.io/py/superpathlib)
+![PyPI downloads](https://img.shields.io/pypi/dm/superpathlib)
 ![Python version](https://img.shields.io/badge/python-3.10+-brightgreen)
 ![Operating system](https://img.shields.io/badge/os-linux%20%7c%20macOS-brightgreen)
 ![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)
 
-Maximize your productivity using minimal code!
+Maximize your productivity with minimal code!
 
-Superpathlib enhances file operations, making them more intuitive and easy to implement.
-This library extends Python's standard library [pathlib](https://docs.python.org/3/library/pathlib.html) module, offering an expansive range of added features without compromising performance.
+Superpathlib is an enhanced version of Python's standard [pathlib](https://docs.python.org/3/library/pathlib.html), designed to make file operations more intuitive and extend functionality without compromising performance. It builds on pathlib by introducing additional properties, methods, and shortcuts that simplify common file manipulations and reduce boilerplate code.
+
+For custom operations, the package supports subclassing, which has been added to the standard library in [python3.12](https://docs.python.org/3/whatsnew/3.12.html).
+
+## Key features:
+* Read and write content in various formats such as text, bytes, YAML, JSON, and even NumPy arrays
+* Access and modify file metadata like file size, modification time, and custom tags
+* Utility methods:
+    * `rmtree` to remove directories recursively
+    * `copy_to` to copy content
+    * `tempfile` to create and use temporary files
+    * `find` for recursive search
+    * `unpack` for unpacking archives
 
 ## Usage
 
@@ -131,8 +143,7 @@ class Path(superpathlib.Path):
         return sum(1 for _ in self.iterdir())
 ```
 
-This only works if you inherit from superpathlib Path, not pathlib Path
-
+The standard pathlib library supports this for Python versions starting from [python3.12](https://docs.python.org/3/whatsnew/3.12.html).
 
 ## Installation
 
@@ -143,7 +154,9 @@ or
 ```shell
 pip install superpathlib[full]
 ```
+to include additional dependencies like PyYAML for handling YAML files
+
+or
 
-Install the packages corresponding with the properties you want to use:
-* e.g. PyYaml for yaml property
+Manually install the packages corresponding with the features you want to use:
 * Packages listed in pyproject.toml

{superpathlib-2.0.7 → superpathlib-2.0.9}/README.md

@@ -1,13 +1,25 @@
 # Superpathlib
 [![PyPI version](https://badge.fury.io/py/superpathlib.svg)](https://badge.fury.io/py/superpathlib)
+![PyPI downloads](https://img.shields.io/pypi/dm/superpathlib)
 ![Python version](https://img.shields.io/badge/python-3.10+-brightgreen)
 ![Operating system](https://img.shields.io/badge/os-linux%20%7c%20macOS-brightgreen)
 ![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)
 
-Maximize your productivity using minimal code!
+Maximize your productivity with minimal code!
 
-Superpathlib enhances file operations, making them more intuitive and easy to implement.
-This library extends Python's standard library [pathlib](https://docs.python.org/3/library/pathlib.html) module, offering an expansive range of added features without compromising performance.
+Superpathlib is an enhanced version of Python's standard [pathlib](https://docs.python.org/3/library/pathlib.html), designed to make file operations more intuitive and extend functionality without compromising performance. It builds on pathlib by introducing additional properties, methods, and shortcuts that simplify common file manipulations and reduce boilerplate code.
+
+For custom operations, the package supports subclassing, which has been added to the standard library in [python3.12](https://docs.python.org/3/whatsnew/3.12.html).
+
+## Key features:
+* Read and write content in various formats such as text, bytes, YAML, JSON, and even NumPy arrays
+* Access and modify file metadata like file size, modification time, and custom tags
+* Utility methods:
+    * `rmtree` to remove directories recursively
+    * `copy_to` to copy content
+    * `tempfile` to create and use temporary files
+    * `find` for recursive search
+    * `unpack` for unpacking archives
 
 ## Usage
 
@@ -104,8 +116,7 @@ class Path(superpathlib.Path):
         return sum(1 for _ in self.iterdir())
 ```
 
-This only works if you inherit from superpathlib Path, not pathlib Path
-
+The standard pathlib library supports this for Python versions starting from [python3.12](https://docs.python.org/3/whatsnew/3.12.html).
 
 ## Installation
 
@@ -116,7 +127,9 @@ or
 ```shell
 pip install superpathlib[full]
 ```
+to include additional dependencies like PyYAML for handling YAML files
+
+or
 
-Install the packages corresponding with the properties you want to use:
-* e.g. PyYaml for yaml property
+Manually install the packages corresponding with the features you want to use:
 * Packages listed in pyproject.toml

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

@@ -1,6 +1,6 @@
 [project]
 name = "superpathlib"
-version = "2.0.7"
+version = "2.0.9"
 description = "Extended Pathlib"
 authors = [{name = "Quinten Roets", email = "qdr2104@columbia.edu"}]
 license = {text = "MIT"}
@@ -76,9 +76,6 @@ ignore = [
     "G004",     # logging f-string
 ]
 
-[tool.ruff.lint.isort]
-known-first-party = ["src"]
-
 [tool.ruff.lint.per-file-ignores]
 "__init__.py" = [
     "F401"  # unused import

{superpathlib-2.0.7 → superpathlib-2.0.9}/src/superpathlib/base.py

@@ -15,7 +15,7 @@ class Path(pathlib.Path):  # pragma: nocover
             if os.name == "nt"
             else pathlib._posix_flavour  # type: ignore[attr-defined] # noqa: SLF001
         )
-    else:
+    elif sys.version_info < (3, 13):
         _flavour = (
             pathlib.ntpath  # type: ignore[attr-defined]
             if os.name == "nt"

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

@@ -1,5 +1,7 @@
+import abc
+import sys
 import typing
-from typing import TypeVar
+from typing import Any, TypeVar
 
 from simple_classproperty import classproperty
 
@@ -8,7 +10,28 @@ from . import base
 T = TypeVar("T", bound="Path")
 
 
-class Path(base.Path):
+def enable_classproperties(cls: type[T]) -> None:  # pragma: nocover
+    for name, method in vars(cls).items():
+        if isinstance(method, classmethod):
+            wrapped_method = method.__func__
+            if isinstance(wrapped_method, classproperty):
+                setattr(cls, name, wrapped_method)
+
+
+class PropertyMeta(abc.ABCMeta):
+    def __new__(
+        cls: type["PropertyMeta"],
+        name: str,
+        bases: tuple[type, ...],
+        attributes: dict[str, Any],
+    ) -> "PropertyMeta":
+        meta_class = super().__new__(cls, name, bases, attributes)
+        if sys.version_info >= (3, 13):
+            enable_classproperties(meta_class)  # pragma: nocover
+        return meta_class
+
+
+class Path(base.Path, metaclass=PropertyMeta):
     """Expose common folders as attributes.
 
     Use classmethod properties to ensure child classes return instance

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

@@ -261,7 +261,7 @@ class Path(cached_content.Path):
 
     def subpath(self: PathType, *parts: str) -> PathType:
         path = self
-        tokens_to_replace = self._flavour.sep, "."
+        tokens_to_replace = os.sep, "."
         for part in parts:
             for token in tokens_to_replace:
                 part = part.replace(token, "_")  # noqa: PLW2901

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

@@ -3,7 +3,7 @@ import shutil
 import typing
 from collections.abc import Callable, Generator
 from functools import wraps
-from pathlib import PurePath
+from os import PathLike
 from typing import IO, Any, TypeVar
 
 from . import encryption
@@ -80,7 +80,7 @@ class Path(encryption.Path):
                 raise
         return target_path
 
-    def replace(self: T, target: str | PurePath) -> T:
+    def replace(self: T, target: str | PathLike[str]) -> T:
         path = self.rename(target, exist_ok=True)
         return typing.cast(T, path)
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: superpathlib
-Version: 2.0.7
+Version: 2.0.9
 Summary: Extended Pathlib
 Author-email: Quinten Roets <qdr2104@columbia.edu>
 License: MIT
@@ -27,14 +27,26 @@ Requires-Dist: xattr<2,>=0.10.1; extra == "dev"
 
 # Superpathlib
 [![PyPI version](https://badge.fury.io/py/superpathlib.svg)](https://badge.fury.io/py/superpathlib)
+![PyPI downloads](https://img.shields.io/pypi/dm/superpathlib)
 ![Python version](https://img.shields.io/badge/python-3.10+-brightgreen)
 ![Operating system](https://img.shields.io/badge/os-linux%20%7c%20macOS-brightgreen)
 ![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)
 
-Maximize your productivity using minimal code!
+Maximize your productivity with minimal code!
 
-Superpathlib enhances file operations, making them more intuitive and easy to implement.
-This library extends Python's standard library [pathlib](https://docs.python.org/3/library/pathlib.html) module, offering an expansive range of added features without compromising performance.
+Superpathlib is an enhanced version of Python's standard [pathlib](https://docs.python.org/3/library/pathlib.html), designed to make file operations more intuitive and extend functionality without compromising performance. It builds on pathlib by introducing additional properties, methods, and shortcuts that simplify common file manipulations and reduce boilerplate code.
+
+For custom operations, the package supports subclassing, which has been added to the standard library in [python3.12](https://docs.python.org/3/whatsnew/3.12.html).
+
+## Key features:
+* Read and write content in various formats such as text, bytes, YAML, JSON, and even NumPy arrays
+* Access and modify file metadata like file size, modification time, and custom tags
+* Utility methods:
+    * `rmtree` to remove directories recursively
+    * `copy_to` to copy content
+    * `tempfile` to create and use temporary files
+    * `find` for recursive search
+    * `unpack` for unpacking archives
 
 ## Usage
 
@@ -131,8 +143,7 @@ class Path(superpathlib.Path):
         return sum(1 for _ in self.iterdir())
 ```
 
-This only works if you inherit from superpathlib Path, not pathlib Path
-
+The standard pathlib library supports this for Python versions starting from [python3.12](https://docs.python.org/3/whatsnew/3.12.html).
 
 ## Installation
 
@@ -143,7 +154,9 @@ or
 ```shell
 pip install superpathlib[full]
 ```
+to include additional dependencies like PyYAML for handling YAML files
+
+or
 
-Install the packages corresponding with the properties you want to use:
-* e.g. PyYaml for yaml property
+Manually install the packages corresponding with the features you want to use:
 * Packages listed in pyproject.toml

{superpathlib-2.0.7 → superpathlib-2.0.9}/src/superpathlib.egg-info/SOURCES.txt

@@ -24,4 +24,5 @@ tests/test_common_folders.py
 tests/test_content.py
 tests/test_encrypted_content.py
 tests/test_functionality.py
+tests/test_inheritance.py
 tests/test_metadata.py

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

@@ -2,9 +2,9 @@ import typing
 from typing import Any
 
 from package_utils.storage import CachedFileContent
-from superpathlib import Path
 
-from tests.content import byte_content, text_content
+from superpathlib import Path
+from tests.content import byte_content, slower_test_settings, text_content
 from tests.utils import ignore_fixture_warning
 
 
@@ -39,7 +39,7 @@ def test_content(path: Path, content: dict[str, dict[str, str]]) -> None:
     verify_storage(Storage, content)
 
 
-@ignore_fixture_warning
+@slower_test_settings
 @text_content
 def test_created_content(path: Path, content: dict[str, dict[str, str]]) -> None:
     class Storage:

{superpathlib-2.0.7 → superpathlib-2.0.9}/tests/test_common_folders.py

@@ -1,5 +1,4 @@
 from superpathlib import Path
-
 from tests.content import byte_content
 from tests.utils import ignore_fixture_warning
 

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

@@ -1,8 +1,8 @@
 from collections.abc import Callable
 
 import pytest
-from superpathlib import Path
 
+from superpathlib import Path
 from tests.content import (
     byte_content,
     dictionary_content,
@@ -65,7 +65,7 @@ def test_copy(path: Path, path2: Path, content: bytes) -> None:
     assert path2.byte_content == content
 
 
-@ignore_fixture_warning
+@slower_test_settings
 @byte_content
 def test_copy_if_newer_copies(path: Path, path2: Path, content: bytes) -> None:
     path.byte_content = content
@@ -74,7 +74,7 @@ def test_copy_if_newer_copies(path: Path, path2: Path, content: bytes) -> None:
     assert path2.byte_content == content
 
 
-@ignore_fixture_warning
+@slower_test_settings
 @byte_content
 def test_copy_if_newer_skips(path: Path, path2: Path, content: bytes) -> None:
     path.byte_content = content
@@ -83,7 +83,7 @@ def test_copy_if_newer_skips(path: Path, path2: Path, content: bytes) -> None:
     assert path2.byte_content == b""
 
 
-@ignore_fixture_warning
+@slower_test_settings
 @byte_content
 def test_move(path: Path, path2: Path, content: bytes) -> None:
     path.byte_content = content
@@ -269,6 +269,7 @@ def test_rmtree_preserve_root(directory: Path) -> None:
     directory.rmtree(remove_root=False)
 
 
+@slower_test_settings
 @dictionary_content
 def test_yaml_update(content: dict[str, str]) -> None:
     with Path.tempfile() as path:

superpathlib-2.0.9/tests/test_inheritance.py

@@ -0,0 +1,14 @@
+from simple_classproperty import classproperty
+
+import superpathlib
+from superpathlib.common_folders import T
+
+
+def test_inheritance() -> None:
+    class Path(superpathlib.Path):
+        @classmethod
+        @classproperty
+        def HOME(cls: type[T]) -> T:  # noqa: N802
+            return cls("HOME")
+
+    assert Path.docs.is_relative_to(Path.HOME)

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

@@ -4,14 +4,15 @@ import time
 
 from hypothesis import given, strategies
 from hypothesis.strategies import lists
-from superpathlib import Path
 
+from superpathlib import Path
 from tests.content import byte_content, text_strategy
 from tests.utils import ignore_fixture_warning
 
 
 @ignore_fixture_warning
-@given(mtime=strategies.floats(min_value=0, max_value=time.time()))
+# avoid small numbers
+@given(mtime=strategies.floats(min_value=0.1, max_value=time.time()))
 def test_mtime(path: Path, mtime: float) -> None:
     assert isinstance(Path.mtime, property)
     path.mtime = mtime

{superpathlib-2.0.7 → superpathlib-2.0.9}/tests/test_content.py

@@ -1,6 +1,6 @@
 import numpy as np
-from superpathlib import Path
 
+from superpathlib import Path
 from tests.content import (
     byte_content,
     dictionary_content,

{superpathlib-2.0.7 → superpathlib-2.0.9}/tests/test_encrypted_content.py

@@ -1,6 +1,6 @@
 from hypothesis import HealthCheck, settings
-from superpathlib import Path
 
+from superpathlib import Path
 from tests.content import byte_content, text_content
 
 slow_test_settings = settings(