pathlibutil 0.2.0__tar.gz → 0.2.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pathlibutil
-Version: 0.2.0
+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

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.2.0 → pathlibutil-0.2.1}/pathlibutil/path.py

@@ -611,7 +611,8 @@ class Path(BasePath):
         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.
+        When recursing, folders can be excluded by passing a callable for
+        `exclude_dirs`, e.g.
 
         ```python
         def exclude_version_control(dirpath: _Path) -> bool:
@@ -622,7 +623,7 @@ class Path(BasePath):
             if exclude_dirs and not callable(exclude_dirs):
                 raise TypeError("exclude_dirs must be a callable")
 
-            depth = recursive if type(recursive) == int else None
+            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:

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

@@ -7,7 +7,7 @@ requires = [
 
 [tool.poetry]
 name = "pathlibutil"
-version = "v0.2.0"
+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>" ]
 readme = "README.md"

pathlibutil-0.2.0/pathlibutil/json.py

@@ -1,25 +0,0 @@
-import functools
-import importlib
-import pathlib
-
-json = importlib.import_module("json")
-
-from json import load, loads
-
-
-class PathEncoder(json.JSONEncoder):
-    def default(self, obj):
-        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)