pathlibutil 0.1.7__tar.gz → 0.1.9__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pathlibutil
-Version: 0.1.7
+Version: 0.1.9
 Summary: inherits from pathlib.Path with methods for hashing, copying, deleting and more
 Home-page: https://d-chris.github.io
 License: MIT
@@ -51,6 +51,10 @@ Description-Content-Type: text/markdown
 - `Path.stat()` returns a `StatResult` object to get file or directory information containing
   - `TimeInt` objects for `atime`, `ctime`, `mtime` and `birthtime`
   - `ByteInt` object for `size`
+- `Path.relative_to()` to get relative path from a file or directory, `walk_up` to walk up the directory tree.
+- `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.
 
 ## Installation
 
@@ -260,3 +264,40 @@ backup = archive.move("./backup/")
 print(f"archive created: {archive.name} and moved to: {backup.parent}")
 ```
 
+## Example 6
+
+Access the current working directory with optional parameter `frozen` to determine
+different directories when script is bundled to an executable,
+e.g. with `pyinstaller`.
+> `Path.cwd()`
+
+```cmd
+>>> poetry run examples/example6.py -b
+Building frozen: K:/pathlibutil/examples/example6.exe
+Build succeeded: 0
+
+>>> poetry run examples/example6.py
+we are                          not frozen
+
+bundle dir is                   K:/pathlibutil/examples
+sys.argv[0] is                  K:/pathlibutil/examples/example6.py
+sys.executable is               K:/pathlibutil/.venv/Scripts/python.exe
+os.getcwd is                    K:/pathlibutil
+
+Path.cwd(frozen=True) is        K:/pathlibutil
+Path.cwd(frozen=False) is       K:/pathlibutil
+Path.cwd(frozen=_MEIPASS) is    K:/pathlibutil
+
+>>> examples/example6.exe
+we are                          ever so frozen
+
+bundle dir is                   C:/Users/CHRIST~1.DOE/AppData/Local/Temp/_MEI106042
+sys.argv[0] is                  examples/example6.exe
+sys.executable is               K:/pathlibutil/examples/example6.exe
+os.getcwd is                    K:/pathlibutil
+
+Path.cwd(frozen=True) is        K:/pathlibutil/examples
+Path.cwd(frozen=False) is       K:/pathlibutil
+Path.cwd(frozen=_MEIPASS) is    C:/Users/CHRIST~1.DOE/AppData/Local/Temp/_MEI106042
+```
+

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

@@ -27,6 +27,10 @@
 - `Path.stat()` returns a `StatResult` object to get file or directory information containing
   - `TimeInt` objects for `atime`, `ctime`, `mtime` and `birthtime`
   - `ByteInt` object for `size`
+- `Path.relative_to()` to get relative path from a file or directory, `walk_up` to walk up the directory tree.
+- `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.
 
 ## Installation
 
@@ -235,3 +239,40 @@ backup = archive.move("./backup/")
 
 print(f"archive created: {archive.name} and moved to: {backup.parent}")
 ```
+
+## Example 6
+
+Access the current working directory with optional parameter `frozen` to determine
+different directories when script is bundled to an executable,
+e.g. with `pyinstaller`.
+> `Path.cwd()`
+
+```cmd
+>>> poetry run examples/example6.py -b
+Building frozen: K:/pathlibutil/examples/example6.exe
+Build succeeded: 0
+
+>>> poetry run examples/example6.py
+we are                          not frozen
+
+bundle dir is                   K:/pathlibutil/examples
+sys.argv[0] is                  K:/pathlibutil/examples/example6.py
+sys.executable is               K:/pathlibutil/.venv/Scripts/python.exe
+os.getcwd is                    K:/pathlibutil
+
+Path.cwd(frozen=True) is        K:/pathlibutil
+Path.cwd(frozen=False) is       K:/pathlibutil
+Path.cwd(frozen=_MEIPASS) is    K:/pathlibutil
+
+>>> examples/example6.exe
+we are                          ever so frozen
+
+bundle dir is                   C:/Users/CHRIST~1.DOE/AppData/Local/Temp/_MEI106042
+sys.argv[0] is                  examples/example6.exe
+sys.executable is               K:/pathlibutil/examples/example6.exe
+os.getcwd is                    K:/pathlibutil
+
+Path.cwd(frozen=True) is        K:/pathlibutil/examples
+Path.cwd(frozen=False) is       K:/pathlibutil
+Path.cwd(frozen=_MEIPASS) is    C:/Users/CHRIST~1.DOE/AppData/Local/Temp/_MEI106042
+```

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

@@ -2,8 +2,11 @@ import errno
 import hashlib
 import itertools
 import os
+import re
 import shutil
-from typing import Callable, Dict, Generator, List, Set, Union
+import subprocess
+import sys
+from typing import Callable, Dict, Generator, List, Literal, Set, Union
 
 from pathlibutil.base import BasePath, _Path
 from pathlibutil.types import ByteInt, StatResult, _stat_result, byteint
@@ -401,15 +404,15 @@ class Path(BasePath):
         Return a new `Path` with changed suffix or remove it when its an empty
         string.
 
+        Multiple suffixes can be changed at once by passing a list of suffixes.
+        With a empty list all suffixes will be removed.
+
         >>> Path('test.a.b').with_suffix('.c')
         Path('test.a.c')
 
         >>> Path('test.a.b').with_suffix('')
         Path('test.a')
 
-        Multiple suffixes can be changed at once by passing a list of suffixes.
-        With a empty list all suffixes will be removed.
-
         >>> Path('test.a.b').with_suffix(['.c', '.d'])
         Path('test.c.d')
 
@@ -432,7 +435,137 @@ class Path(BasePath):
             end = -1 * len(self.suffixes) or None
             name = self.name.split(".")[0:end]
             stem = self.parent.joinpath("".join(name))
-            return super(Path, stem).with_suffix(suffix)
+            return super(self.__class__, stem).with_suffix(suffix)
+
+    def relative_to(
+        self, *other: Union[str, _Path], walk_up: Union[bool, int] = False
+    ) -> _Path:
+        """
+        Return the relative path to another path identified by the passed
+        arguments.  If the operation is not possible (because this is not
+        related to the other path), raise `ValueError`.
+
+        The `walk_up` parameter controls whether `..` may be used to resolve
+        the path.
+
+        If `walk_up` is a integer it specifies the maximum number of `..` to resolve, if
+        max is reached a `ValueError` is raised.
+
+        >>> Path('a/b/c/d').relative_to('a/b')
+        Path('c/d')
+
+        >>> Path('a/b/c/d').relative_to('a/b/e/f/g', walk_up=True)
+        Path('../../../c/d')
+
+        >>> Path('a/b/c/d').relative_to('a/b/e/f/g', walk_up=2)
+        ValueError: '../../../c/d' is outside of the relative deepth of '2'
+        """
+        if not walk_up:
+            return super().relative_to(*other)
+
+        try:
+            relative = super().relative_to(*other, walk_up=walk_up)
+        except TypeError:
+            relative = self.__class__(os.path.relpath(self, Path(*other)))
+
+        if type(walk_up) is not int:
+            return relative
+
+        if relative.parts.count("..") > walk_up:
+            raise ValueError(
+                f"'{relative}' is outside of the relative deepth of '{walk_up}'"
+            )
+
+        return relative
+
+    @classmethod
+    def cwd(cls, *, frozen: Literal[True, False, "_MEIPASS"] = False) -> _Path:
+        """
+        Return a `Path` object representing the current working directory.
+
+        The `frozen` parameter takes only effect when the script is bundled to a
+        executable, e.g. with `pyinstaller`.
+
+        - `False`: Returns the current working directory, this is the default.
+        - `True`: Returns the directory of the executable.
+        - `"_MEIPASS"`: Returns the directory of the bundled resources.
+        """
+        if getattr(sys, "frozen", False):
+            if frozen is True:
+                return cls(sys.executable).parent
+            elif isinstance(frozen, str):
+                return cls(getattr(sys, frozen))
+
+        return super().cwd()
+
+    @classmethod
+    def _net_use(cls) -> Dict[str, str]:
+        """
+        Return a dictionary of mapped network drives. Keys are UNC paths and values
+        are drive letters.
+        """
+
+        def run(cmd: str) -> str:
+            """execute `command` and return stdout with cp850 encoding."""
+            result = subprocess.run(
+                cmd,
+                capture_output=True,
+                shell=True,
+                encoding="cp850",
+            )
+
+            return result.stdout
+
+        try:
+            mapped_drives = re.finditer(
+                r"^OK\s+(?P<drive>[A-Z]):\s+(?P<unc>\S+)",
+                run("net use"),
+                re.IGNORECASE | re.MULTILINE,
+            )
+            return {
+                match.group("unc") + "\\": match.group("drive") + ":\\"
+                for match in mapped_drives
+            }
+        except Exception:
+            return {}
+
+    def _resolve_unc(self) -> _Path:
+        """
+        Resolve UNC paths to mapped network drives.
+        """
+        if not hasattr(self.__class__, "_netuse"):
+            self.__class__._netuse = self._net_use()
+
+        try:
+            drive = self._netuse[self.anchor]
+            return self.__class__(drive).joinpath(self.relative_to(self.anchor))
+        except KeyError:
+            return self
+
+    def resolve(self, strict: bool = False, unc: bool = True) -> _Path:
+        """
+        Make the path absolute, resolving all symlinks on the way and also normalizing
+        it.
+
+        If `strict` is `True`, a `FileNotFoundError` will be raised if the path does
+        not exist.
+
+        On Windows if `unc` is `False`, UNC paths will be resolved to mapped network
+        drives.
+
+        >>> Path("T:/file.txt").resolve()
+        Path("\\\\server\\temp\\file.txt")
+
+        >>> Path("//server/temp/file.txt").resolve(unc=False)
+        Path("T:\\file.txt")
+        """
+
+        p = super().resolve(strict)
+
+        if unc is True or os.name != "nt":
+            return p
+
+        return p._resolve_unc()
 
 
 class Register7zFormat(Path, archive="7z"):

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

@@ -2,7 +2,7 @@ import functools
 import os
 import re
 from datetime import datetime, tzinfo
-from typing import Set, Tuple, TypeVar
+from typing import Set, Tuple, TypeVar, Iterable
 
 _ByteInt = TypeVar("_ByteInt", bound="ByteInt")
 _stat_result = TypeVar("_stat_result", bound="os.stat_result")
@@ -332,3 +332,22 @@ class StatResult:
         Return representation of `os.stat_result` object.
         """
         return repr(self._obj)
+
+    def __dir__(self) -> Iterable[str]:
+        """
+        Return a list of attributes of `os.stat_result` object.
+        """
+        return dir(self._obj)
+
+    def __len__(self) -> int:
+        """
+        Return length of `os.stat_result` object.
+        """
+        return len(self._obj)
+
+    @property
+    def stat_result(self) -> os.stat_result:
+        """
+        Return the wrapped `os.stat_result` object.
+        """
+        return self._obj

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pathlibutil"
-version = "v0.1.7"
+version = "v0.1.9"
 description = "inherits from pathlib.Path with methods for hashing, copying, deleting and more"
 authors = ["Christoph Dörrer <d-chris@web.de>"]
 readme = "README.md"
@@ -44,6 +44,7 @@ docformatter = "^1.7.5"
 jinja2-pdoc = "^0.2.0"
 pdoc = "^14.3.0"
 click = "^8.1.7"
+pyinstaller = "^6.5.0"
 
 [[tool.poetry.source]]
 name = "PyPI"