pathlibutil 0.1.9__tar.gz → 0.2.1__tar.gz

{pathlibutil-0.1.9 → pathlibutil-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pathlibutil
-Version: 0.1.9
+Version: 0.2.1
 Summary: inherits from pathlib.Path with methods for hashing, copying, deleting and more
 Home-page: https://d-chris.github.io
 License: MIT
@@ -32,6 +32,7 @@ Description-Content-Type: text/markdown
 [![Website](https://img.shields.io/website?url=https%3A%2F%2Fd-chris.github.io%2Fpathlibutil&up_message=pdoc&logo=github&label=documentation)](https://d-chris.github.io/pathlibutil)
 [![GitHub tag (with filter)](https://img.shields.io/github/v/tag/d-chris/pathlibutil?logo=github&label=github)](https://github.com/d-chris/pathlibutil)
 [![Coverage](https://img.shields.io/website?url=https%3A%2F%2Fd-chris.github.io%2Fpathlibutil%2Fhtmlcov&up_message=available&down_message=missing&logo=codecov&label=coverage)](https://d-chris.github.io/pathlibutil/htmlcov)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 
 ---
 
@@ -55,6 +56,12 @@ Description-Content-Type: text/markdown
 - `Path.with_suffix()` to change the multiple suffixes of a file
 - `Path.cwd()` to get the current working directory or executable path when script is bundled, e.g. with `pyinstaller`
 - `Path.resolve()` to resolve a unc path to a mapped windows drive.
+- `Path.walk()` to walk over a directory tree like `os.walk()`
+- `Path.iterdir()` with `recursive` all files from the directory tree will be yielded and `exclude_dirs` via callable.
+
+JSON serialization of `Path` objects is supported in `pathlibutil.json`.
+
+- `pathlibutil.json.dumps()` and `pathlibutil.json.dump()` to serialize `Path` objects as posix paths.
 
 ## Installation
 
@@ -176,7 +183,7 @@ deleted directories and the amount of memory freed in MB.
 > `Path.delete()`, `Path.size()` and `ByteInt`
 
 ```python
-from pathlibutil import Path, ByteInt
+from pathlibutil import ByteInt, Path
 
 mem = ByteInt(0)
 i = 0
@@ -203,9 +210,10 @@ to register new archive formats.
 > Path.make_archive(), Path.archive_formats and Path.move()
 
 ```python
-import pathlibutil
 import shutil
 
+import pathlibutil
+
 
 class RegisterFooBarFormat(pathlibutil.Path, archive="foobar"):
   @classmethod

{pathlibutil-0.1.9 → pathlibutil-0.2.1}/README.md

@@ -8,6 +8,7 @@
 [![Website](https://img.shields.io/website?url=https%3A%2F%2Fd-chris.github.io%2Fpathlibutil&up_message=pdoc&logo=github&label=documentation)](https://d-chris.github.io/pathlibutil)
 [![GitHub tag (with filter)](https://img.shields.io/github/v/tag/d-chris/pathlibutil?logo=github&label=github)](https://github.com/d-chris/pathlibutil)
 [![Coverage](https://img.shields.io/website?url=https%3A%2F%2Fd-chris.github.io%2Fpathlibutil%2Fhtmlcov&up_message=available&down_message=missing&logo=codecov&label=coverage)](https://d-chris.github.io/pathlibutil/htmlcov)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 
 ---
 
@@ -31,6 +32,12 @@
 - `Path.with_suffix()` to change the multiple suffixes of a file
 - `Path.cwd()` to get the current working directory or executable path when script is bundled, e.g. with `pyinstaller`
 - `Path.resolve()` to resolve a unc path to a mapped windows drive.
+- `Path.walk()` to walk over a directory tree like `os.walk()`
+- `Path.iterdir()` with `recursive` all files from the directory tree will be yielded and `exclude_dirs` via callable.
+
+JSON serialization of `Path` objects is supported in `pathlibutil.json`.
+
+- `pathlibutil.json.dumps()` and `pathlibutil.json.dump()` to serialize `Path` objects as posix paths.
 
 ## Installation
 
@@ -152,7 +159,7 @@ deleted directories and the amount of memory freed in MB.
 > `Path.delete()`, `Path.size()` and `ByteInt`
 
 ```python
-from pathlibutil import Path, ByteInt
+from pathlibutil import ByteInt, Path
 
 mem = ByteInt(0)
 i = 0
@@ -179,9 +186,10 @@ to register new archive formats.
 > Path.make_archive(), Path.archive_formats and Path.move()
 
 ```python
-import pathlibutil
 import shutil
 
+import pathlibutil
+
 
 class RegisterFooBarFormat(pathlibutil.Path, archive="foobar"):
   @classmethod

{pathlibutil-0.1.9 → pathlibutil-0.2.1}/pathlibutil/__init__.py

@@ -3,6 +3,6 @@
 """
 
 from pathlibutil.path import Path, Register7zFormat
-from pathlibutil.types import ByteInt, TimeInt, byteint, StatResult
+from pathlibutil.types import ByteInt, StatResult, TimeInt, byteint
 
 __all__ = ["Path", "Register7zFormat", "ByteInt", "byteint", "TimeInt", "StatResult"]

pathlibutil-0.2.1/pathlibutil/json.py

@@ -0,0 +1,48 @@
+"""
+Wrapper around the `json` module that provides a custom JSON encoder for `pathlib.Path`
+objects. This allows `pathlib.Path` objects to be serialized to JSON without having to
+convert them to strings first.
+
+```python
+from pathlib import Path
+from pathlibutil.json import dump
+
+data = {"file": Path(__file__)}
+
+with open("data.json", "w") as f:
+    dump(data, f)
+```
+"""
+
+import functools
+import json
+import pathlib
+from json import load, loads
+
+
+class PathEncoder(json.JSONEncoder):
+    """
+    JSON encoder that converts `pathlib.Path` objects to their string representation.
+    """
+
+    def default(self, obj):
+        """
+        Convert `pathlib.Path` objects to a string using `pathlib.Path.as_posix()`.
+        """
+        if isinstance(obj, pathlib.Path):
+            return obj.as_posix()
+
+        return super().default(obj)
+
+
+@functools.wraps(json.dump)
+def dump(obj, fp, *, cls=PathEncoder, **kwargs):
+    return json.dump(obj, fp, cls=cls, **kwargs)
+
+
+@functools.wraps(json.dumps)
+def dumps(obj, *, cls=PathEncoder, **kwargs):
+    return json.dumps(obj, cls=cls, **kwargs)
+
+
+__all__ = ["load", "loads", "dump", "dumps", "PathEncoder"]

{pathlibutil-0.1.9 → pathlibutil-0.2.1}/pathlibutil/path.py

@@ -6,7 +6,7 @@ import re
 import shutil
 import subprocess
 import sys
-from typing import Callable, Dict, Generator, List, Literal, Set, Union
+from typing import Callable, Dict, Generator, List, Literal, Set, Tuple, Union
 
 from pathlibutil.base import BasePath, _Path
 from pathlibutil.types import ByteInt, StatResult, _stat_result, byteint
@@ -22,8 +22,8 @@ class Path(BasePath):
 
     - Contextmanger lets you change the current working directory.
     ```python
-    with Path('path/to/directory') as cwd:
-        print(f'current working directory: {cwd}')
+    with Path("path/to/directory") as cwd:
+        print(f"current working directory: {cwd}")
     ```
     """
 
@@ -84,15 +84,20 @@ class Path(BasePath):
         if not self.is_file():
             raise FileNotFoundError(f"'{self}' is not an existing file")
 
-        try:
-            args = (kwargs.pop("length"),)
-        except KeyError:
-            args = ()
-
-        return hashlib.new(
+        hash = hashlib.new(
             name=algorithm or self.default_hash,
             data=self.read_bytes(),
-        ).hexdigest(*args)
+        )
+
+        try:
+            return hash.hexdigest()
+        except TypeError as e:
+            try:
+                length = kwargs["length"]
+            except KeyError:
+                raise e
+
+        return hash.hexdigest(length)
 
     def verify(
         self, digest: str, algorithm: str = None, *, strict: bool = True, **kwargs
@@ -512,6 +517,7 @@ class Path(BasePath):
                 capture_output=True,
                 shell=True,
                 encoding="cp850",
+                check=True,
             )
 
             return result.stdout
@@ -523,7 +529,7 @@ class Path(BasePath):
                 re.IGNORECASE | re.MULTILINE,
             )
             return {
-                match.group("unc") + "\\": match.group("drive") + ":\\"
+                match.group("unc") + "\\": cls(match.group("drive") + ":\\")
                 for match in mapped_drives
             }
         except Exception:
@@ -538,7 +544,7 @@ class Path(BasePath):
 
         try:
             drive = self._netuse[self.anchor]
-            return self.__class__(drive).joinpath(self.relative_to(self.anchor))
+            return drive.joinpath(self.relative_to(self.anchor))
         except KeyError:
             return self
 
@@ -567,6 +573,68 @@ class Path(BasePath):
 
         return p._resolve_unc()
 
+    def walk(
+        self,
+        top_down: bool = True,
+        on_error: Callable[[OSError], object] = None,
+        follow_symlinks: bool = False,
+    ) -> Generator[Tuple[_Path, List[str], List[str]], None, None]:
+        """
+        Walks the directory tree and yields a 3-tuple of (dirpath, dirnames, filenames).
+        """
+        try:
+            yield from super().walk(
+                top_down,
+                on_error,
+                follow_symlinks,
+            )
+        except AttributeError:
+            for dirpath, dirnames, filenames in os.walk(
+                self,
+                top_down,
+                on_error,
+                follow_symlinks,
+            ):
+                yield self.__class__(dirpath), dirnames, filenames
+
+    def iterdir(
+        self,
+        *,
+        recursive: Union[bool, int] = False,
+        exclude_dirs: Callable[[_Path], bool] = None,
+        **kwargs,
+    ) -> Generator[_Path, None, None]:
+        """
+        Iterates over the files in the directory.
+
+        If `recursive` is `True` all files from the directory tree will
+        be yielded if it is an `integer` files are yielded to this max. directory depth
+        optional` **kwargs` are passed to `Path.walk()`.
+
+        When recursing, folders can be excluded by passing a callable for
+        `exclude_dirs`, e.g.
+
+        ```python
+        def exclude_version_control(dirpath: _Path) -> bool:
+            return dirpath.name in (".git", ".svn", ".hg", ".bzr", "CVS")
+        ```
+        """
+        if recursive is not False:
+            if exclude_dirs and not callable(exclude_dirs):
+                raise TypeError("exclude_dirs must be a callable")
+
+            depth = recursive if type(recursive) is int else None
+
+            for root, dirs, files in self.walk(**kwargs):
+                if depth is not None and len(root.relative_to(self).parts) >= depth:
+                    dirs[:] = []
+                elif exclude_dirs:
+                    dirs[:] = [d for d in dirs if not exclude_dirs(root.joinpath(d))]
+
+                yield from (root.joinpath(file) for file in files)
+        else:
+            yield from super().iterdir()
+
 
 class Register7zFormat(Path, archive="7z"):
     """
@@ -583,20 +651,18 @@ class Register7zFormat(Path, archive="7z"):
 
     Example:
     ```python
-    class Register7zArchive(pathlibutil.Path, archive='7z'):
+    class Register7zArchive(pathlibutil.Path, archive="7z"):
         @classmethod
         def _register_archive_format(cls):
             try:
                 from py7zr import pack_7zarchive, unpack_7zarchive
             except ModuleNotFoundError:
-                raise ModuleNotFoundError('pip install pathlibutil[7z]')
+                raise ModuleNotFoundError("pip install pathlibutil[7z]")
             else:
                 shutil.register_archive_format(
-                    '7z', pack_7zarchive, description='7zip archive'
-                )
-                shutil.register_unpack_format(
-                    '7z', ['.7z'], unpack_7zarchive
+                    "7z", pack_7zarchive, description="7zip archive"
                 )
+                shutil.register_unpack_format("7z", [".7z"], unpack_7zarchive)
     ```
     """
 

{pathlibutil-0.1.9 → pathlibutil-0.2.1}/pathlibutil/types.py

@@ -2,7 +2,7 @@ import functools
 import os
 import re
 from datetime import datetime, tzinfo
-from typing import Set, Tuple, TypeVar, Iterable
+from typing import Iterable, Set, Tuple, TypeVar
 
 _ByteInt = TypeVar("_ByteInt", bound="ByteInt")
 _stat_result = TypeVar("_stat_result", bound="os.stat_result")
@@ -206,6 +206,7 @@ def byteint(func):
     ```python
     randbyte = byteint(random.randint)
 
+
     @byteint
     def randhexbyte():
         return hex(random.randint(0, 2**32))

{pathlibutil-0.1.9 → pathlibutil-0.2.1}/pyproject.toml

@@ -1,31 +1,38 @@
+[build-system]
+build-backend = "poetry.core.masonry.api"
+
+requires = [
+  "poetry-core",
+]
+
 [tool.poetry]
 name = "pathlibutil"
-version = "v0.1.9"
+version = "v0.2.1"
 description = "inherits from pathlib.Path with methods for hashing, copying, deleting and more"
-authors = ["Christoph Dörrer <d-chris@web.de>"]
+authors = [ "Christoph Dörrer <d-chris@web.de>" ]
 readme = "README.md"
 license = "MIT"
 classifiers = [
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
-    "License :: OSI Approved :: MIT License",
-    "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
 ]
-keywords = ["pathlib", "hashlib", "shutil"]
+keywords = [ "pathlib", "hashlib", "shutil" ]
 homepage = "https://d-chris.github.io"
 repository = "https://github.com/d-chris/pathlibutil"
 documentation = "https://d-chris.github.io/pathlibutil"
-include = ["LICENSE"]
+include = [ "LICENSE" ]
 
 [tool.poetry.dependencies]
 python = ">=3.8.1,<3.13"
 py7zr = { version = "^0.20.2", optional = true }
 
 [tool.poetry.extras]
-7z = ["py7zr"]
+7z = [ "py7zr" ]
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.4.3"
@@ -55,19 +62,15 @@ name = "testpypi"
 url = "https://test.pypi.org/legacy/"
 priority = "explicit"
 
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
-
 [tool.pytest.ini_options]
 minversion = "6.0"
 testpaths = "tests"
 addopts = [
-    "--random-order",
-    "--color=yes",
-    "-s",
-    # "--cov=pathlibutil",
-    # "--cov-report=term-missing:skip-covered",
-    # "--cov-append",
-    # "--cov-report=html",
+  "--random-order",
+  "--color=yes",
+  "-s",
+  # "--cov=pathlibutil",
+  # "--cov-report=term-missing:skip-covered",
+  # "--cov-append",
+  # "--cov-report=html",
 ]