pathlibutil 0.1.0__tar.gz → 0.1.2__tar.gz

{pathlibutil-0.1.0 → pathlibutil-0.1.2}/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.2/PKG-INFO

@@ -0,0 +1,200 @@
+Metadata-Version: 2.1
+Name: pathlibutil
+Version: 0.1.2
+Summary: inherits from pathlib.Path with methods for hashing, copying, deleting and more
+Home-page: https://d-chris.github.io
+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
+Provides-Extra: 7z
+Requires-Dist: py7zr (>=0.20.2,<0.21.0) ; extra == "7z"
+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)
+[![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)
+
+
+---
+
+`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
+- `Path().make_archive()` create and `Path().unpack_archive()` an archive from a file or directory
+  
+## 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
+from pathlib import Path
+
+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
+from pathlib import Path
+
+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
+from pathlib import Path
+
+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}')
+```
+
+## Example 4
+
+Search all pycache directories and free the memory.
+> `Path().delete()` and `Path().size()`
+
+```python
+from pathlib import Path
+
+mem = 0
+i = 0
+
+for i, cache in enumerate(Path('.').rglob('*/__pycache__/'), start=1):
+      cache_size = cache.size()
+      try:
+            cache.delete(recursive=True)
+      except OSError:
+            print(f'Failed to delete {cache}')
+      else:
+            mem += cache_size
+
+print(f'{i} cache directories deleted, {mem / 2**20:.2f} MB freed.')
+```
+
+## Example 5
+
+Inherit from `pathlibutil.Path` to register new a archive format.
+Specify a `name` as keyword argument in the new subclass, which has to be the suffix of the archives.
+Implement a classmethod `_register_archive_format()` to register new archive formats.
+> `Path().make_archive()` and `Path().move()`
+
+```python
+import shutil
+import pathlibutil
+
+class RegisterRarFormat(pathlibutil.Path, name='rar'):
+      @classmethod
+      def _register_archive_format(cls):
+      """ 
+            implement new register functions for given `name`
+      """
+            try:
+                  from pyunpack import Archive
+            except ModuleNotFoundError:
+                  raise ModuleNotFoundError('pip install pyunpack')
+            else:
+                  shutil.register_archive_format(
+                        'rar', Archive, description='rar archive'
+                  )
+                  shutil.register_unpack_format(
+                        'rar', ['.rar'], Archive
+                  )
+
+file = pathlibutil.Path('README.md')
+
+print(f"available archive formats: {file.archive_formats}")
+
+archive = file.make_archive('README.rar')
+
+backup = archive.move('./backup/')
+
+print(f'rar archive created: {archive.name} and moved to: {backup.parent}')
+```
+

pathlibutil-0.1.2/README.md

@@ -0,0 +1,176 @@
+# 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)
+[![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)
+
+
+---
+
+`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
+- `Path().make_archive()` create and `Path().unpack_archive()` an archive from a file or directory
+  
+## 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
+from pathlib import Path
+
+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
+from pathlib import Path
+
+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
+from pathlib import Path
+
+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}')
+```
+
+## Example 4
+
+Search all pycache directories and free the memory.
+> `Path().delete()` and `Path().size()`
+
+```python
+from pathlib import Path
+
+mem = 0
+i = 0
+
+for i, cache in enumerate(Path('.').rglob('*/__pycache__/'), start=1):
+      cache_size = cache.size()
+      try:
+            cache.delete(recursive=True)
+      except OSError:
+            print(f'Failed to delete {cache}')
+      else:
+            mem += cache_size
+
+print(f'{i} cache directories deleted, {mem / 2**20:.2f} MB freed.')
+```
+
+## Example 5
+
+Inherit from `pathlibutil.Path` to register new a archive format.
+Specify a `name` as keyword argument in the new subclass, which has to be the suffix of the archives.
+Implement a classmethod `_register_archive_format()` to register new archive formats.
+> `Path().make_archive()` and `Path().move()`
+
+```python
+import shutil
+import pathlibutil
+
+class RegisterRarFormat(pathlibutil.Path, name='rar'):
+      @classmethod
+      def _register_archive_format(cls):
+      """ 
+            implement new register functions for given `name`
+      """
+            try:
+                  from pyunpack import Archive
+            except ModuleNotFoundError:
+                  raise ModuleNotFoundError('pip install pyunpack')
+            else:
+                  shutil.register_archive_format(
+                        'rar', Archive, description='rar archive'
+                  )
+                  shutil.register_unpack_format(
+                        'rar', ['.rar'], Archive
+                  )
+
+file = pathlibutil.Path('README.md')
+
+print(f"available archive formats: {file.archive_formats}")
+
+archive = file.make_archive('README.rar')
+
+backup = archive.move('./backup/')
+
+print(f'rar archive created: {archive.name} and moved to: {backup.parent}')
+```

pathlibutil-0.1.2/pathlibutil/__init__.py

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

pathlibutil-0.1.2/pathlibutil/path.py

@@ -0,0 +1,298 @@
+import errno
+import hashlib
+import itertools
+import os
+import pathlib
+import shutil
+import sys
+from typing import Dict, Generator, List, Set
+
+
+class Path(pathlib.Path):
+    """Path inherites from `pathlib.Path` and adds some methods to built-in python functions"""
+
+    _archive_formats: Dict[str, callable] = {}
+    """dict holding function to register shutil archive formats"""
+
+    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
+
+    def __init_subclass__(cls, name, **kwargs) -> None:
+        """register archive formats from subclasses"""
+
+        super().__init_subclass__(**kwargs)
+
+        try:
+            cls._archive_formats[name] = getattr(
+                cls, '_register_archive_format'
+            )
+        except AttributeError:
+            pass
+
+    @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)
+
+    @staticmethod
+    def _find_archive_format(filname: 'Path') -> str:
+        """
+            Searches for a file the correct archive format.
+        """
+        ext = "".join(filname.suffixes)
+
+        for name, extensions, _ in shutil.get_unpack_formats():
+            if ext in extensions:
+                return name
+
+        return "".join(ext.split('.'))
+
+    @classmethod
+    def _register_format(cls, format: str) -> None:
+        """
+            Registers a archive format from `Path._register_<format>_format`.
+        """
+        try:
+            register_format = cls._archive_formats[format]
+        except KeyError:
+            raise ValueError(f"unknown archive format: '{format}'")
+        else:
+            register_format()
+
+    def make_archive(self, archivename: str, **kwargs) -> 'Path':
+        """
+            Creates an archive file (eg. zip) and returns the path to the archive.
+        """
+        _self = self.resolve(strict=True)
+        _archive = Path(archivename).resolve()
+        _format = kwargs.pop('format', self._find_archive_format(_archive))
+
+        _ = kwargs.pop('root_dir', None)
+        _ = kwargs.pop('base_dir', None)
+
+        for _ in range(2):
+            try:
+                _archive = shutil.make_archive(
+                    base_name=_archive.parent.joinpath(_archive.stem),
+                    format=_format,
+                    root_dir=_self.parent,
+                    base_dir=_self.relative_to(_self.parent),
+                    **kwargs
+                )
+
+                return Path(_archive)
+            except ValueError:
+                self._register_format(_format)
+
+    def unpack_archive(self, extract_dir: str, **kwargs) -> 'Path':
+        """
+            Unpacks an archive file (eg. zip) and returns the path to the extracted files.
+        """
+
+        _format = kwargs.pop('format', self._find_archive_format(self))
+
+        for _ in range(2):
+            try:
+                shutil.unpack_archive(
+                    self.resolve(strict=True),
+                    extract_dir,
+                    format=_format,
+                    **kwargs
+                )
+
+                return Path(extract_dir)
+            except ValueError:
+                self._register_format(_format)
+
+    @property
+    def archive_formats(self) -> List[str]:
+        """
+            Returns a list of supported archive formats.
+        """
+        formats = itertools.chain(
+            self._archive_formats.keys(),
+            [name for name, _ in shutil.get_archive_formats()]
+        )
+
+        return list(formats)
+
+
+class Register7zFormat(Path, name='7z'):
+    """
+        Register 7z archive format using `__init_subclass__` hook.
+
+        To register a new archive format create a subclass of `Path` and implement a `_register_archive_format()` method.
+
+        Example:
+        ```python
+        class Register7zArchive(Path, name='7z'):
+            @classmethod
+            def _register_archive_format(cls):
+
+                try:
+                    from py7zr import pack_7zarchive, unpack_7zarchive
+                except ModuleNotFoundError:
+                    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
+                    )
+        ```
+    """
+
+    @classmethod
+    def _register_archive_format(cls):
+        """
+            function to register 7z archive format
+        """
+
+        try:
+            from py7zr import pack_7zarchive, unpack_7zarchive
+        except ModuleNotFoundError:
+            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
+            )

{pathlibutil-0.1.0 → pathlibutil-0.1.2}/pyproject.toml

@@ -1,50 +1,63 @@
-[tool.poetry]
-name = "pathlibutil"
-version = "0.1.0"
-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"]
-repository = "https://github.com/d-chris/pathlibutil"
-
-[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"
-
-[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 --cov=pathlibutil --cov-report=term-missing:skip-covered --color=yes"
+[tool.poetry]
+name = "pathlibutil"
+version = "v0.1.2"
+description = "inherits from pathlib.Path with methods for hashing, copying, deleting and more"
+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"]
+homepage = "https://d-chris.github.io"
+repository = "https://github.com/d-chris/pathlibutil"
+documentation = "https://d-chris.github.io/pathlibutil"
+include = ["LICENSE"]
+
+[tool.poetry.dependencies]
+python = ">=3.8,<3.13"
+py7zr = { version = "^0.20.2", optional = true }
+
+[tool.poetry.extras]
+7z = ["py7zr"]
+
+[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]
+pdoc = "^14.3.0"
+click = "^8.1.7"
+
+[[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.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.1.0/PKG-INFO

@@ -1,77 +0,0 @@
-Metadata-Version: 2.1
-Name: pathlibutil
-Version: 0.1.0
-Summary: 
-Home-page: https://github.com/d-chris/pathlibutil
-License: MIT
-Keywords: pathlib,hashlib
-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: 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)](./LICENSE)
-[![GitHub Workflow Test)](https://img.shields.io/github/actions/workflow/status/d-chris/pathlibutil/pytest.yml?logo=github&label=test)](https://github.com/d-chris/pathlibutil)
-
----
-
-`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
-
-## Installation
-
-```bash
-pip install pathlibutil
-```
-
-## Usage
-
-```python
-from pathlibutil import Path
-
-readme = Path('README.md')
-
-print(f'File size: {readme.size()} Bytes')
-print(f'File sha1: {readme.hexdigest("sha1")}')
-
-print('-- File content --')
-for line in readme.read_lines(encoding='utf-8'):
-    print(line, end='')
-print('-- EOF --')
-
-with readme.parent as cwd:
-    print(f'Current working directory: {cwd}')
-
-# Change default hash algorithm from md5 to sha1
-Path.default_hash = 'sha1'
-
-print(f'File verification: {readme.verify("add3f48fded5e0829a8e3e025e44c2891542c58e")}')
-```
-
-## Examples
-
-1. [Read file line by line to stdout](./examples/example1.py)
-   > `Path().read_lines()`
-2. [Write calculated hash to file](./examples/example2.py)
-   > `Path().hexdigest()`
-3. [Read hashes from file for verification](./examples/example3.py)
-   > `Path().verify()` and `contextmanager`
-

pathlibutil-0.1.0/README.md

@@ -1,56 +0,0 @@
-# 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)](./LICENSE)
-[![GitHub Workflow Test)](https://img.shields.io/github/actions/workflow/status/d-chris/pathlibutil/pytest.yml?logo=github&label=test)](https://github.com/d-chris/pathlibutil)
-
----
-
-`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
-
-## Installation
-
-```bash
-pip install pathlibutil
-```
-
-## Usage
-
-```python
-from pathlibutil import Path
-
-readme = Path('README.md')
-
-print(f'File size: {readme.size()} Bytes')
-print(f'File sha1: {readme.hexdigest("sha1")}')
-
-print('-- File content --')
-for line in readme.read_lines(encoding='utf-8'):
-    print(line, end='')
-print('-- EOF --')
-
-with readme.parent as cwd:
-    print(f'Current working directory: {cwd}')
-
-# Change default hash algorithm from md5 to sha1
-Path.default_hash = 'sha1'
-
-print(f'File verification: {readme.verify("add3f48fded5e0829a8e3e025e44c2891542c58e")}')
-```
-
-## Examples
-
-1. [Read file line by line to stdout](./examples/example1.py)
-   > `Path().read_lines()`
-2. [Write calculated hash to file](./examples/example2.py)
-   > `Path().hexdigest()`
-3. [Read hashes from file for verification](./examples/example3.py)
-   > `Path().verify()` and `contextmanager`

pathlibutil-0.1.0/pathlibutil/__init__.py

@@ -1 +0,0 @@
-from pathlibutil.path import Path

pathlibutil-0.1.0/pathlibutil/path.py

@@ -1,91 +0,0 @@
-import hashlib
-import os
-import pathlib
-import sys
-from typing import Generator, Set
-
-
-class Path(pathlib.Path):
-    default_hash = 'md5'
-
-    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() method.
-        """
-        return hashlib.algorithms_available
-
-    def hexdigest(self, algorithm: str = None, /, **kwargs) -> str:
-        """
-            Returns the hex digest of the file using the named algorithm (default: md5).
-        """
-        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, hashdigest: str, algorithm: str = None, *, strict: bool = True, **kwargs) -> bool:
-        """
-            Verifies the hash of the file using the named algorithm (default: md5).
-        """
-        _hash = self.hexdigest(algorithm, **kwargs)
-
-        if strict:
-            return _hash == hashdigest
-
-        if len(hashdigest) < 7:
-            raise ValueError('hashdigest must be at least 7 characters long')
-
-        for a, b in zip(_hash, hashdigest):
-            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