pathlibutil 0.0.5__tar.gz → 0.1.1__tar.gz

{pathlibutil-0.0.5 → pathlibutil-0.1.1}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Christoph Dörrer
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Christoph Dörrer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pathlibutil-0.1.1/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.1
+Name: pathlibutil
+Version: 0.1.1
+Summary: 
+Home-page: https://github.com/d-chris/pathlibutil
+License: MIT
+Keywords: pathlib,hashlib,shutil
+Author: Christoph Dörrer
+Author-email: d-chris@web.de
+Requires-Python: >=3.8,<3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Project-URL: Documentation, https://d-chris.github.io/pathlibutil
+Project-URL: Repository, https://github.com/d-chris/pathlibutil
+Description-Content-Type: text/markdown
+
+# pathlibutil
+
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pathlibutil)](https://pypi.org/project/pathlibutil/)
+[![PyPI](https://img.shields.io/pypi/v/pathlibutil)](https://pypi.org/project/pathlibutil/)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/pathlibutil)](https://pypi.org/project/pathlibutil/)
+[![PyPI - License](https://img.shields.io/pypi/l/pathlibutil)](https://raw.githubusercontent.com/d-chris/pathlibutil/main/LICENSE)
+[![GitHub Workflow Test)](https://img.shields.io/github/actions/workflow/status/d-chris/pathlibutil/pytest.yml?logo=github&label=pytest)](https://github.com/d-chris/pathlibutil/actions/workflows/pytest.yml)
+
+---
+
+`pathlibutil.Path` inherits from  `pathlib.Path` with some useful built-in python functions.
+
+- `Path().hexdigest()` to calculate and `Path().verify()` for verification of hexdigest from a file
+- `Path.default_hash` to configurate default hash algorithm for `Path` class (default: *'md5'*)
+- `Path().size()` to get size in bytes of a file or directory
+- `Path().read_lines()` to yield over all lines from a file until EOF
+- `contextmanager` to change current working directory with `with` statement
+- `Path().copy()` copy a file or directory to a new path destination
+- `Path().delete()` delete a file or directory-tree
+- `Path().move()` move a file or directory to a new path destination
+  
+## Installation
+
+```bash
+pip install pathlibutil
+```
+
+## Usage
+
+```python
+from pathlibutil import Path
+
+readme = Path('README.md')
+
+print(f'File size: {readme.size()} Bytes')
+```
+
+## Example 1
+
+Read a file and print its content and some file information to stdout.
+> `Path().read_lines()`
+
+```python
+readme = Path('README.md')
+
+print('File content'.center(80, '='))
+
+for line in readme.read_lines(encoding='utf-8'):
+   print(line, end='')
+
+print('EOF'.center(80, '='))
+```
+
+## Example 2
+
+Write a file with md5 checksums of all python files in the pathlibutil-directory.
+> `Path().hexdigest()`
+
+```python
+file = Path('pathlibutil.md5')
+
+algorithm = file.suffix[1:]
+
+with file.open('w') as f:
+   f.write(
+      f'# {algorithm} checksums generated with pathlibutil (https://pypi.org/project/pathlibutil/)\n\n')
+
+   i = 0
+   for i, filename in enumerate(Path('./pathlibutil').glob('*.py'), start=1):
+      f.write(f'{filename.hexdigest(algorithm)} *{filename}\n')
+
+print(f'\nwritten: {i:>5} {algorithm}-hashes to: {file}')
+```
+
+## Example 3
+
+Read a file with md5 checksums and verify them.
+> `Path().verify()`, `Path.default_hash` and `contextmanager`
+
+```python
+file = Path('pathlibutil.md5')
+
+Path.default_hash = file.suffix[1:]
+
+def no_comment(line: str) -> bool:
+   return not line.startswith('#')
+
+with file.parent as cwd:
+
+   for line in filter(no_comment, file.read_lines()):
+      try:
+            digest, filename = line.strip().split(' *')
+            verification = Path(filename).verify(digest)
+      except ValueError as split_failed:
+            continue
+      except FileNotFoundError as verify_failed:
+            tag = 'missing'
+      else:
+            tag = 'ok' if verification else 'fail
+
+      print(f'{tag.ljust(len(digest), ".")} *{filename}')
+```
+

pathlibutil-0.1.1/README.md

@@ -0,0 +1,102 @@
+# pathlibutil
+
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pathlibutil)](https://pypi.org/project/pathlibutil/)
+[![PyPI](https://img.shields.io/pypi/v/pathlibutil)](https://pypi.org/project/pathlibutil/)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/pathlibutil)](https://pypi.org/project/pathlibutil/)
+[![PyPI - License](https://img.shields.io/pypi/l/pathlibutil)](https://raw.githubusercontent.com/d-chris/pathlibutil/main/LICENSE)
+[![GitHub Workflow Test)](https://img.shields.io/github/actions/workflow/status/d-chris/pathlibutil/pytest.yml?logo=github&label=pytest)](https://github.com/d-chris/pathlibutil/actions/workflows/pytest.yml)
+
+---
+
+`pathlibutil.Path` inherits from  `pathlib.Path` with some useful built-in python functions.
+
+- `Path().hexdigest()` to calculate and `Path().verify()` for verification of hexdigest from a file
+- `Path.default_hash` to configurate default hash algorithm for `Path` class (default: *'md5'*)
+- `Path().size()` to get size in bytes of a file or directory
+- `Path().read_lines()` to yield over all lines from a file until EOF
+- `contextmanager` to change current working directory with `with` statement
+- `Path().copy()` copy a file or directory to a new path destination
+- `Path().delete()` delete a file or directory-tree
+- `Path().move()` move a file or directory to a new path destination
+  
+## Installation
+
+```bash
+pip install pathlibutil
+```
+
+## Usage
+
+```python
+from pathlibutil import Path
+
+readme = Path('README.md')
+
+print(f'File size: {readme.size()} Bytes')
+```
+
+## Example 1
+
+Read a file and print its content and some file information to stdout.
+> `Path().read_lines()`
+
+```python
+readme = Path('README.md')
+
+print('File content'.center(80, '='))
+
+for line in readme.read_lines(encoding='utf-8'):
+   print(line, end='')
+
+print('EOF'.center(80, '='))
+```
+
+## Example 2
+
+Write a file with md5 checksums of all python files in the pathlibutil-directory.
+> `Path().hexdigest()`
+
+```python
+file = Path('pathlibutil.md5')
+
+algorithm = file.suffix[1:]
+
+with file.open('w') as f:
+   f.write(
+      f'# {algorithm} checksums generated with pathlibutil (https://pypi.org/project/pathlibutil/)\n\n')
+
+   i = 0
+   for i, filename in enumerate(Path('./pathlibutil').glob('*.py'), start=1):
+      f.write(f'{filename.hexdigest(algorithm)} *{filename}\n')
+
+print(f'\nwritten: {i:>5} {algorithm}-hashes to: {file}')
+```
+
+## Example 3
+
+Read a file with md5 checksums and verify them.
+> `Path().verify()`, `Path.default_hash` and `contextmanager`
+
+```python
+file = Path('pathlibutil.md5')
+
+Path.default_hash = file.suffix[1:]
+
+def no_comment(line: str) -> bool:
+   return not line.startswith('#')
+
+with file.parent as cwd:
+
+   for line in filter(no_comment, file.read_lines()):
+      try:
+            digest, filename = line.strip().split(' *')
+            verification = Path(filename).verify(digest)
+      except ValueError as split_failed:
+            continue
+      except FileNotFoundError as verify_failed:
+            tag = 'missing'
+      else:
+            tag = 'ok' if verification else 'fail
+
+      print(f'{tag.ljust(len(digest), ".")} *{filename}')
+```

pathlibutil-0.1.1/pathlibutil/__init__.py

@@ -0,0 +1,5 @@
+"""
+.. include:: ../README.md
+"""
+
+from pathlibutil.path import Path

pathlibutil-0.1.1/pathlibutil/path.py

@@ -0,0 +1,155 @@
+import errno
+import hashlib
+import os
+import pathlib
+import shutil
+import sys
+from typing import Generator, Set
+
+
+class Path(pathlib.Path):
+    """Path inherites from `pathlib.Path` and adds some methods to built-in python functions"""
+
+    default_hash = 'md5'
+    """default hash algorithm for the class when no algorithm is specified for `hexdigest()` and `verify()`"""
+
+    if sys.version_info < (3, 12):
+        _flavour = pathlib._windows_flavour if os.name == 'nt' else pathlib._posix_flavour
+
+    @property
+    def algorithms_available(self) -> Set[str]:
+        """
+            Set of available algorithms that can be passed to `hexdigest()` and `verify()` method.
+        """
+        return hashlib.algorithms_available
+
+    def hexdigest(self, algorithm: str = None, /, **kwargs) -> str:
+        """
+            Returns the hexdigest of the file using the named algorithm (default: `default_hash`).
+        """
+        try:
+            args = (kwargs.pop('length'),)
+        except KeyError:
+            args = ()
+
+        return hashlib.new(
+            name=algorithm or self.default_hash,
+            data=self.read_bytes(),
+        ).hexdigest(*args)
+
+    def verify(self, hexdigest: str, algorithm: str = None, *, strict: bool = True, **kwargs) -> bool:
+        """
+            Verifies the hash of the file using the named algorithm (default: `default_hash`).
+        """
+        _hash = self.hexdigest(algorithm, **kwargs)
+
+        if strict:
+            return _hash == hexdigest
+
+        if len(hexdigest) < 7:
+            raise ValueError('hashdigest must be at least 7 characters long')
+
+        for a, b in zip(_hash, hexdigest):
+            if a != b.lower():
+                return False
+
+        return True
+
+    def __enter__(self) -> 'Path':
+        """
+            Contextmanager to changes the current working directory.
+        """
+        cwd = os.getcwd()
+
+        try:
+            os.chdir(self)
+        except Exception as e:
+            raise e
+        else:
+            self.__stack = cwd
+
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb) -> None:
+        """
+            Restore previous working directory.
+        """
+        try:
+            os.chdir(self.__stack)
+        finally:
+            del self.__stack
+
+    def read_lines(self, **kwargs) -> Generator[str, None, None]:
+        """
+            Iterates over all lines of the file until EOF is reached.
+        """
+        with self.open(**kwargs) as f:
+            yield from iter(f.readline, '')
+
+    def size(self, **kwargs) -> int:
+        """
+            Returns the size in bytes of a file or directory.
+        """
+        if self.is_dir():
+            return sum([p.size(**kwargs) for p in self.iterdir()])
+
+        return self.stat(**kwargs).st_size
+
+    def copy(self, dst: str, exist_ok: bool = True, **kwargs) -> 'Path':
+        """
+            Copies the file or directory to a destination path.
+        """
+        try:
+            _path = shutil.copytree(
+                self,
+                dst,
+                dirs_exist_ok=exist_ok,
+                **kwargs
+            )
+        except NotADirectoryError:
+            dst = Path(dst, self.name)
+
+            if not exist_ok and dst.exists():
+                raise FileExistsError(f'{dst} already exists')
+
+            dst.parent.mkdir(parents=True, exist_ok=True)
+
+            _path = shutil.copy2(
+                self,
+                dst,
+                **kwargs
+            )
+
+        return Path(_path)
+
+    def delete(self, *, recursive: bool = False, missing_ok: bool = False, **kwargs) -> None:
+        """
+            Deletes the file or directory.
+        """
+        try:
+            self.rmdir()
+        except NotADirectoryError:
+            self.unlink(missing_ok)
+        except FileNotFoundError as e:
+            if not missing_ok:
+                raise e
+        except OSError as e:
+            if not recursive or e.errno != errno.ENOTEMPTY:
+                raise e
+
+            shutil.rmtree(self, **kwargs)
+
+    def move(self, dst: str) -> 'Path':
+        """
+            Moves the file or directory to a destination path.
+        """
+        src = self.resolve(strict=True)
+        dst = Path(dst).resolve()
+        dst.mkdir(parents=True, exist_ok=True)
+
+        try:
+            _path = shutil.move(str(src), str(dst))
+        except shutil.Error as e:
+            raise OSError(e)
+
+        return Path(_path)

pathlibutil-0.1.1/pyproject.toml

@@ -0,0 +1,73 @@
+[tool.poetry]
+name = "pathlibutil"
+version = "v0.1.1"
+description = ""
+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",
+]
+keywords = ["pathlib", "hashlib", "shutil"]
+repository = "https://github.com/d-chris/pathlibutil"
+documentation = "https://d-chris.github.io/pathlibutil"
+include = ["LICENSE"]
+
+[tool.poetry.dependencies]
+python = ">=3.8,<3.13"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.4.3"
+tox = "^4.11.4"
+pytest-random-order = "^1.1.0"
+pytest-cov = "^4.1.0"
+pytest-mock = "^3.12.0"
+
+
+[tool.poetry.group.doc.dependencies]
+jinja2 = "^3.1.2"
+pdoc = "^14.3.0"
+
+[[tool.poetry.source]]
+name = "PyPI"
+priority = "primary"
+
+[[tool.poetry.source]]
+name = "testpypi"
+url = "https://test.pypi.org/legacy/"
+priority = "explicit"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+envlist = py38,py39,py310,py311,py312
+
+[testenv]
+deps =
+    pytest
+    pytest-random-order
+    pytest-mock
+    pytest-cov
+commands = pytest --random-order
+"""
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+testpaths = "tests"
+addopts = [
+    "--random-order",
+    "--color=yes",
+    "--cov=pathlibutil",
+    "--cov-report=term-missing:skip-covered",
+    "--cov-append",
+    # "--cov-report=html",
+]

pathlibutil-0.0.5/PKG-INFO

@@ -1,17 +0,0 @@
-Metadata-Version: 2.1
-Name: pathlibutil
-Version: 0.0.5
-Summary: extend pathlib with some handy features
-Author: Christoph Dörrer
-Project-URL: Homepage, https://github.com/d-chris/pathutil
-Project-URL: Bug Tracker, https://github.com/d-chris/pathutil/issues
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-# readme
-
-> [MIT License](LICENSE)

pathlibutil-0.0.5/README.md

@@ -1,3 +0,0 @@
-# readme
-
-> [MIT License](LICENSE)

pathlibutil-0.0.5/pyproject.toml

@@ -1,27 +0,0 @@
-[build-system]
-requires = ["setuptools>=61.0"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "pathlibutil"
-version = "0.0.5"
-authors = [{ name = "Christoph Dörrer" }]
-description = "extend pathlib with some handy features"
-readme = "README.md"
-requires-python = ">=3.11"
-classifiers = [
-    "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: MIT License",
-    "Operating System :: OS Independent",
-]
-
-[project.urls]
-"Homepage" = "https://github.com/d-chris/pathutil"
-"Bug Tracker" = "https://github.com/d-chris/pathutil/issues"
-
-[tool.pytest.ini_options]
-minversion = "6.0"
-pythonpath = "src"
-testpaths = "test"
-addopts = "--random-order -v -s"
-# addopts = "--cov=src --cov-report=html:test/report"

pathlibutil-0.0.5/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

pathlibutil-0.0.5/src/pathlibutil/__init__.py

@@ -1,2 +0,0 @@
-from .pathlist import PathList
-from .pathutil import Path

pathlibutil-0.0.5/src/pathlibutil/cached.py

@@ -1,69 +0,0 @@
-import functools
-import hashlib
-
-from .pathlist import PathList as _PathList
-from .pathutil import Path as _Path
-
-
-def cache(func):
-    @functools.wraps(func)
-    def cached(self, *args, **kwargs):
-        try:
-            lock = (self.mtime, self)
-        except AttributeError:
-            lock = self
-
-        try:
-            func_cache = self.__cache__[lock]
-        except (AttributeError, KeyError):
-            func_cache = dict()
-            self.__cache__ = {lock: func_cache}
-
-        try:
-            args_cache = func_cache[func.__name__]
-        except KeyError:
-            args_cache = dict()
-            self.__cache__[lock][func.__name__] = args_cache
-
-        # key = args + tuple(sorted(kwargs.items()))
-        key = args
-        try:
-            value = args_cache[key]
-        except KeyError:
-            value = func(self, *args, **kwargs)
-            args_cache[key] = value
-
-        return value
-
-    return cached
-
-
-class Path(_Path):
-
-    def cached(self, func: str = None) -> dict:
-        try:
-            cache, *_ = self.__cache__.values()
-
-            if func:
-                return cache[func]
-            else:
-                return cache
-        except (AttributeError, KeyError) as e:
-            return dict()
-
-    @cache
-    def _count(self, substr: str, /, *, size: int) -> int:
-        return super()._count(substr, size=size)
-
-    @cache
-    def _file_digest(self, algorithm: str, /, *, _bufsize: int) -> 'hashlib._Hash':
-        return super()._file_digest(algorithm, _bufsize=_bufsize)
-
-
-class PathList(_PathList):
-    @staticmethod
-    def Path(item):
-        if isinstance(item, Path):
-            return item
-
-        return Path(item)