pathlibutil 0.0.5__tar.gz → 0.1.0__tar.gz

{pathlibutil-0.0.5 → pathlibutil-0.1.0}/LICENSE

@@ -18,4 +18,4 @@ 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.
+SOFTWARE.

pathlibutil-0.1.0/PKG-INFO

@@ -0,0 +1,77 @@
+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

@@ -0,0 +1,56 @@
+# 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

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

pathlibutil-0.1.0/pathlibutil/path.py

@@ -0,0 +1,91 @@
+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

pathlibutil-0.1.0/pyproject.toml

@@ -0,0 +1,50 @@
+[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"

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)

pathlibutil-0.0.5/src/pathlibutil/hashing.py

@@ -1,222 +0,0 @@
-import re
-from typing import Dict, Generator, Iterable, List, Self, Tuple
-
-from .pathlist import PathList
-from .pathutil import Path
-
-
-class HashList:
-    def __init__(self, files: str, algorithm: str = None):
-        self.files = PathList(files)
-        self.algorithm = Path.algorithm(algorithm)
-
-    @property
-    def filedigest(self) -> Dict[Path, str]:
-        try:
-            return self._filedigest
-        except AttributeError:
-            self._filedigest = dict(zip(self.files, self.hexdigest))
-
-        return self._filedigest
-
-    @property
-    def hexdigest(self) -> List[str]:
-        try:
-            return self._hexdigest
-        except AttributeError:
-            def digest(x: Path):
-                try:
-                    return x.hexdigest(self.algorithm).upper()
-                except (FileNotFoundError, PermissionError):
-                    return None
-
-            self._hexdigest = self.files.apply(digest)
-
-        return self._hexdigest
-
-    def missing(self):
-        for file, hash in self:
-            if hash:
-                continue
-
-            yield file
-
-    def __iter__(self):
-        for item in self.filedigest.items():
-            yield item
-
-    def __getitem__(self, item: Path) -> str:
-        return self.filedigest[item]
-
-    def __len__(self):
-        return len(self.filedigest)
-
-    def __str__(self):
-        return str(self.filedigest)
-
-    def __repr__(self):
-        return f"{self.__class__.__name__}({[str(f) for f in self.files]}, algorithm='{self.algorithm}')"
-
-
-class HashSum(HashList):
-    def __init__(self, files: Iterable, hashfile: str, algorithm: str = None, comments: str = None, relative: bool = False):
-
-        self.root = Path(hashfile)
-
-        if not algorithm:
-            algorithm = self.root.suffix
-
-        super().__init__(files, algorithm)
-
-        self.comments = comments
-
-        self.save(self.root, relative=relative)
-
-    def __repr__(self):
-        files = [str(f) for f in self.files]
-        comment = str('\n').join(self.comments)
-        return f"{self.__class__.__name__}({files}, '{self.root}', algorithm='{self.algorithm}', comments='{comment}')"
-
-    @staticmethod
-    def strip_comments(comment: str) -> str:
-        return comment.lstrip('# ')
-
-    @classmethod
-    def split_comments(cls, comments: str) -> List[str]:
-        try:
-            return [cls.strip_comments(line) for line in comments.split('\n')]
-        except AttributeError:
-            return list()
-
-    @property
-    def comments(self) -> List[str]:
-        return self._comments
-
-    @comments.setter
-    def comments(self, comments: str):
-        self._comments = self.split_comments(comments)
-
-    def items(self) -> Tuple[Path, str]:
-        for file, hash in self:
-            yield file, hash
-
-    def save(self, filename: str, comments: str = None, relative: bool = False) -> None:
-        if not all(self.hexdigest):
-            raise FileNotFoundError(list(self.missing()))
-
-        self.root = Path(filename).resolve().with_suffix(
-            self.algorithm, separator=True)
-
-        if not comments:
-            comments = self.comments
-        else:
-            comments = self.split_comments(comments)
-
-        with self.root.open(mode='wt', encoding='utf-8') as f:
-
-            if comments:
-                for line in comments:
-                    f.write(f"# {line}\n")
-
-                f.write('\n')
-
-            for filename, hash in self.items():
-                filename = filename.resolve()
-
-                try:
-                    filename = filename.relative_to(
-                        self.root.parent, uptree=relative)
-                except ValueError:
-                    pass
-
-                f.write(f"{hash} *{filename}\n")
-
-
-class HashFile(HashSum):
-    regex = re.compile(
-        r'^(?P<hash>[0-9a-f]{8,}) \*(?P<file>.*?)$', re.IGNORECASE)
-
-    def __init__(self, filename: str, algorithm: str = None):
-        self._comments = list()
-
-        files = list()
-        self._hashes = list()
-
-        self.root = Path(filename).resolve()
-
-        if not algorithm:
-            algorithm = self.root.suffix
-
-        for line in self.root.iter_lines(encoding='utf-8'):
-            if not line:
-                continue
-
-            if line.startswith('#'):
-                self._comments.append(self.strip_comments(line))
-                continue
-
-            match = self.regex.match(line)
-
-            try:
-                file = Path(match.group('file'))
-                hash = match.group('hash')
-            except (AttributeError, KeyError):
-                continue
-
-            if not file.is_absolute():
-                file = self.root.parent.joinpath(file).resolve()
-
-            files.append(file)
-            self._hashes.append(hash)
-
-        super(HashSum, self).__init__(files, algorithm)
-
-    def __repr__(self):
-        return f"{self.__class__.__name__}('{self.root}', algorithm='{self.algorithm}')"
-
-    @property
-    def hashes(self) -> List[str]:
-        return self._hashes
-
-    @property
-    def filedigest(self) -> Dict[Path, Tuple[str, str]]:
-        try:
-            return self._filedigest
-        except AttributeError:
-            self._filedigest = dict(
-                zip(self.files, tuple(zip(self.hashes, self.hexdigest)))
-            )
-
-        return self._filedigest
-
-    def __getitem__(self, item: Path) -> str:
-        _, digest = self.filedigest[item]
-
-        return digest
-
-    def items(self) -> Tuple[Path, str]:
-        for file, (_, digest) in self:
-            yield file, digest
-
-    def missing(self):
-        for file, (_, digest) in self:
-            if digest:
-                continue
-
-            yield file
-
-    def match(self):
-        for file, (hash, digest) in self:
-            if not digest:
-                continue
-
-            if hash == digest:
-                yield file
-
-    def modified(self):
-        for file, (hash, digest) in self:
-            if not digest:
-                continue
-
-            if hash != digest:
-                yield file