pathlibutil 0.0.4__tar.gz → 0.1.0__tar.gz

{pathlibutil-0.0.4 → 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.4/PKG-INFO

@@ -1,17 +0,0 @@
-Metadata-Version: 2.1
-Name: pathlibutil
-Version: 0.0.4
-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.4/README.md

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

pathlibutil-0.0.4/pyproject.toml

@@ -1,27 +0,0 @@
-[build-system]
-requires = ["setuptools>=61.0"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "pathlibutil"
-version = "0.0.4"
-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.4/setup.cfg

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

pathlibutil-0.0.4/src/pathlibutil/__init__.py

@@ -1,4 +0,0 @@
-from .pathutil import Path
-from .hashsum import hashsum, hashcheck, hashparse
-
-__all__ = ['Path', 'hashsum', 'hashcheck', 'hashparse']

pathlibutil-0.0.4/src/pathlibutil/cached.py

@@ -1,48 +0,0 @@
-from . import Path
-import functools
-from typing import Optional, Union, Callable
-import hashlib
-
-
-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):
-
-    @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)

pathlibutil-0.0.4/src/pathlibutil/hashsum.py

@@ -1,114 +0,0 @@
-from . import Path
-from typing import Iterable, Tuple, Generator, Dict, List, Union
-import os
-import re
-
-import concurrent.futures as cf
-
-
-def hashsum(
-    hashfile: str,
-    files: Iterable,
-    *,
-    header: str = None,
-    algorithm: str = None,
-    size: int = None
-) -> Path:
-    hashfile = Path(hashfile)
-
-    if algorithm is None:
-        algorithm = hashfile.suffix.lstrip('.')
-        if algorithm not in hashfile.algorithms_available:
-            raise ValueError('unknown suffix or specify algorithm')
-    else:
-        hashfile = hashfile.with_suffix(f".{algorithm}")
-
-    with hashfile.open(mode='wt', encoding='utf-8') as f:
-        if header != None:
-            f.writelines(
-                [f"# {line}\n" for line in header.split('\n') if line]
-            )
-
-            if f.seek(0, os.SEEK_END) > 0:
-                f.write('\n')
-
-        dest = hashfile.resolve().parent
-
-        kwargs = {
-            'algorithm': algorithm,
-            'size': size
-        }
-
-        def calc_hashes(file: Path, dest: Path, **kwargs) -> str:
-            file = file.resolve()
-
-            if file.is_relative_to(dest):
-                filename = file.relative_to(dest)
-            else:
-                filename = file
-
-            return f"{file.hexdigest(**kwargs)} *{filename}"
-
-        with cf.ThreadPoolExecutor() as exec:
-            results = [
-                exec.submit(calc_hashes, file, dest, **kwargs)
-                for file in files
-            ]
-
-            for result in cf.as_completed(results):
-                f.write(f"{result.result()}\n")
-
-    return hashfile
-
-
-def hashparse(
-    hashfile: str,
-) -> Generator[Tuple[str, Path], None, None]:
-
-    hashfile = Path(hashfile)
-
-    root = hashfile.resolve().parent
-
-    regex = re.compile(
-        r'^(?P<hash>[a-f0-9]{8,}) \*(?P<filename>.*?)$',
-        re.IGNORECASE
-    )
-
-    for match in map(lambda line: regex.match(line.strip()), hashfile.iter_lines(encoding='utf-8')):
-        if match is None:
-            continue
-
-        try:
-            hash, filename = match.group('hash'), Path(match.group('filename'))
-        except IndexError:
-            continue
-
-        if not filename.is_absolute():
-            filename = root.joinpath(filename)
-
-        yield (hash, filename)
-
-
-def hashcheck(
-    hashfile: str,
-    algorithm: str = None,
-    *,
-    size: int = None
-) -> Dict[Union[bool, None], List[Path]]:
-
-    kwargs = {
-        'algorithm': algorithm,
-        'size': size
-    }
-
-    result = {True: [], False: [], None: []}
-
-    for hash, file in hashparse(hashfile):
-        try:
-            key = bool(file.verify(hash, **kwargs))
-        except (FileNotFoundError, PermissionError) as e:
-            result[None].append(file)
-        else:
-            result[key].append(file)
-
-    return result

pathlibutil-0.0.4/src/pathlibutil/pathutil.py

@@ -1,192 +0,0 @@
-import pathlib
-import hashlib
-import os
-import shutil
-import distutils.file_util as dfutil
-from typing import Tuple, Union, Callable, Optional, Any
-
-
-class Path(pathlib.Path):
-    _flavour = pathlib._windows_flavour if os.name == 'nt' else pathlib._posix_flavour
-
-    _digest_length = {
-        'shake_128': 128,
-        'shake_256': 256
-    }
-
-    _digest_default = 'md5'
-
-    _digest_chunk = 2**20
-
-    @property
-    def default_digest(self) -> str:
-        return self._digest_default
-
-    def iter_lines(self, encoding: str = None) -> str:
-        ''' read the content of a file line by line without the line-ending char '''
-        with super().open(mode='rt', encoding=encoding) as f:
-            while True:
-                line = f.readline()
-
-                if line:
-                    yield line.rstrip('\n')
-                else:
-                    break
-
-    def iter_bytes(self, size: int = None) -> bytes:
-        ''' return a chunk of bytes '''
-        if not size:
-            size = self._digest_chunk
-
-        with super().open(mode='rb') as f:
-            while True:
-                chunk = f.read(size)
-
-                if chunk:
-                    yield chunk
-                else:
-                    break
-
-    def hexdigest(self, algorithm: str = None, *, size: int = None, length: int = None) -> str:
-        ''' calculate a hashsum using an algorithm '''
-        h = self.digest(algorithm, size=size)
-
-        if h.digest_size != 0:
-            kwargs = dict()
-        else:
-            if length:
-                kwargs = {'length': length}
-            else:
-                try:
-                    key = self.algorithm(algorithm)
-                    kwargs = {'length': self._digest_length[key]}
-                except KeyError:
-                    raise TypeError(
-                        "hexdigest() missing required argument 'length'")
-
-            if kwargs['length'] < 0:
-                raise ValueError(
-                    "hexdigest() required argument 'length' to be a positive integer")
-
-        return h.hexdigest(**kwargs)
-
-    def digest(self, algorithm: str = None, *, size: int = None) -> 'hashlib._Hash':
-        ''' digest of the binary file-content '''
-        if not size or size < 0:
-            size = self._digest_chunk
-
-        if not algorithm:
-            algorithm = self._digest_default
-
-        return self._file_digest(self.algorithm(algorithm), _bufsize=size)
-
-    def _file_digest(self, algorithm: str, /, *, _bufsize: int) -> 'hashlib._Hash':
-        digest = (lambda: hashlib.new(algorithm))
-
-        with self.open(mode='rb') as f:
-            h = hashlib.file_digest(f, digest, _bufsize=_bufsize)
-
-        return h
-
-    @property
-    def algorithms_available(self) -> set[str]:
-        ''' names of available hash algorithms '''
-        return hashlib.algorithms_available
-
-    def algorithm(self, value: Union[str, Any]) -> Union[str, Any]:
-        ''' converts file suffix into a valid algorithm string '''
-        try:
-            return value.strip().lstrip('.').lower()
-        except AttributeError:
-            return self._digest_default
-
-    def eol_count(self, eol: str = None, size: int = None) -> int:
-        ''' return the number of end-of-line characters'''
-        try:
-            substr = eol.encode()
-        except AttributeError as e:
-            substr = '\n'.encode()
-
-        if not size:
-            size = self._digest_chunk
-
-        return self._count(substr, size=size)
-
-    def _count(self, substr: str, /, *, size: int) -> int:
-        return sum(chunk.count(substr) for chunk in self.iter_bytes(size))
-
-    def copy(self, dst: Union[str, 'Path'], *, parents: bool = True, **kwargs) -> Tuple['Path', int]:
-        ''' copies self into a new destination, check distutils.file_util::copy_file for kwargs '''
-
-        if parents is True:
-            Path(dst).mkdir(parents=True, exist_ok=True)
-
-        destination, result = dfutil.copy_file(self, dst, **kwargs)
-
-        return (Path(destination), result)
-
-    def move(self, dst: Union[str, 'Path'], *, parents: bool = True, prune: bool = True, **kwargs) -> Tuple['Path', int]:
-        ''' moves self into a new destination '''
-
-        destination, result = self.copy(dst, parents=parents, **kwargs)
-
-        if result:
-            prune = False if not prune else 'try'
-            self.unlink(missing_ok=True, prune=prune)
-
-        return (Path(destination), result)
-
-    def rmdir(self, *, recursive=False, **kwargs):
-        ''' deletes a directory with all files, check shutil::rmtree for kwargs '''
-
-        if not recursive:
-            super().rmdir()
-        else:
-            shutil.rmtree(self, **kwargs)
-
-    def unlink(self, missing_ok: bool = False, *, prune: Union[bool, str] = False):
-        ''' deletes a file and prune an empty directory '''
-        super().unlink(missing_ok)
-
-        if prune:
-            try:
-                self.parent.rmdir(recursive=False)
-            except OSError as e:
-                if str(prune).casefold() != 'try':
-                    raise
-
-    def touch(self, mode=0o666, exist_ok=True, *, parents: bool = False):
-        ''' creates a file and parent directories '''
-        if parents is True:
-            self.parent.mkdir(parents=True, exist_ok=True)
-
-        super().touch(mode=mode, exist_ok=exist_ok)
-
-    @property
-    def mtime(self) -> int:
-        ''' time of the last modification in nanoseconds '''
-        return self.stat().st_mtime_ns
-
-    def verify(self, hexdigest: str, algorithm: Optional[str] = None, *, size: Optional[int] = None) -> Union[str, None]:
-        ''' verify if file has the correct hash '''
-        hexdigest = hexdigest.strip().lower()
-        digest_size = int(len(hexdigest) / 2)
-
-        if algorithm:
-            result = self.hexdigest(algorithm, length=digest_size, size=size)
-            return algorithm if result == hexdigest else None
-
-        for algorithm in self.algorithms_available:
-            h = hashlib.new(algorithm)
-
-            if h.digest_size not in (digest_size, 0):
-                continue
-
-            result = self.hexdigest(algorithm, length=digest_size, size=size)
-
-            if result == hexdigest:
-                break
-        else:
-            return None
-
-        return algorithm

pathlibutil-0.0.4/src/pathlibutil.egg-info/PKG-INFO

@@ -1,17 +0,0 @@
-Metadata-Version: 2.1
-Name: pathlibutil
-Version: 0.0.4
-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.4/src/pathlibutil.egg-info/SOURCES.txt

@@ -1,13 +0,0 @@
-LICENSE
-README.md
-pyproject.toml
-src/pathlibutil/__init__.py
-src/pathlibutil/cached.py
-src/pathlibutil/hashsum.py
-src/pathlibutil/pathutil.py
-src/pathlibutil.egg-info/PKG-INFO
-src/pathlibutil.egg-info/SOURCES.txt
-src/pathlibutil.egg-info/dependency_links.txt
-src/pathlibutil.egg-info/top_level.txt
-test/test_hashsum.py
-test/test_pathutil.py

pathlibutil-0.0.4/src/pathlibutil.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

pathlibutil-0.0.4/src/pathlibutil.egg-info/top_level.txt

@@ -1 +0,0 @@
-pathlibutil

pathlibutil-0.0.4/test/test_hashsum.py

@@ -1,15 +0,0 @@
-import pytest
-
-from pathlibutil import *
-
-
-def test_hashsum():
-    pass
-
-
-def test_hashcheck():
-    pass
-
-
-def test_hashparse():
-    pass

pathlibutil-0.0.4/test/test_pathutil.py

@@ -1,275 +0,0 @@
-import pytest
-import hashlib
-import inspect
-import pathlib
-import subprocess
-import time
-
-from pathlibutil import Path
-
-CONTENT = 'foo\nbar!\n'
-SEC = 0.02
-
-
-@pytest.fixture()
-def tmp_file(tmp_path: pathlib.Path) -> str:
-    ''' returns a filename to a temporary testfile'''
-    txt = tmp_path / 'test_file.txt'
-
-    txt.write_text(CONTENT, encoding='utf-8', newline='')
-    return str(txt)
-
-
-@pytest.fixture()
-def dst_path(tmp_path: pathlib.Path) -> str:
-    dest = tmp_path / 'destination'
-
-    return str(dest)
-
-
-def test_eol_count(tmp_file):
-    p = Path(tmp_file)
-    assert p.eol_count() == 2
-    assert p.eol_count(eol='\n') == 2
-    assert p.eol_count(eol='\r') == 0
-
-
-def test_verify(tmp_file):
-    p = Path(tmp_file)
-
-    my_bytes = pathlib.Path(tmp_file).read_bytes()
-    shake_128 = hashlib.new('shake_128', my_bytes).hexdigest(128)
-    sha256 = hashlib.new('sha256', my_bytes).hexdigest()
-
-    assert p.verify(sha256) == 'sha256'
-    assert p.verify(sha256, algorithm='sha256') != None
-    assert p.verify(sha256[:14]) == None
-    assert p.verify(sha256[:14], algorithm='sha256') == None
-    assert p.verify(sha256, algorithm='sha1') == None
-    assert p.verify(sha256, algorithm=None, size=10) == 'sha256'
-
-    assert p.verify(shake_128) != None
-    assert p.verify(shake_128, algorithm='shake_128') == 'shake_128'
-    assert p.verify(shake_128[:32]) != None
-    assert p.verify(shake_128[:32], algorithm='shake_128') == 'shake_128'
-
-
-def test_hexdigest(tmp_file):
-    p = Path(tmp_file)
-
-    my_bytes = pathlib.Path(tmp_file).read_bytes()
-    md5 = hashlib.new('md5', my_bytes).hexdigest()
-    sha1 = hashlib.new('sha1', my_bytes).hexdigest()
-
-    assert p.hexdigest() == md5
-    assert p.hexdigest(p.default_digest) == md5
-    assert p.hexdigest(algorithm='md5', size=4) == md5
-    assert p.hexdigest(algorithm='sha1') == sha1
-
-    with pytest.raises(ValueError):
-        p.hexdigest(algorithm='fubar')
-
-    with pytest.raises(TypeError):
-        p.hexdigest(size='fubar')
-
-    # test on a directory
-    with pytest.raises(PermissionError):
-        p.parent.hexdigest()
-
-    # test none existing file
-    p.unlink()
-    with pytest.raises(FileNotFoundError):
-        p.hexdigest()
-
-
-def test_shake(tmp_file):
-    p = Path(tmp_file)
-
-    assert len(p.hexdigest('shake_128')) == 128*2
-
-    length = 10
-
-    assert len(p.hexdigest('shake_128', length=length)) == length * 2
-
-    with pytest.raises(TypeError):
-        p.hexdigest('shake_128', length)
-
-    with pytest.raises(ValueError):
-        p.hexdigest('shake_256', length=-1)
-
-
-def test_digest(tmp_file):
-    p = Path(tmp_file)
-
-    my_bytes = pathlib.Path(tmp_file).read_bytes()
-    md5 = hashlib.new('md5', my_bytes)
-
-    assert p.digest('md5').digest() == md5.digest()
-
-
-def test_available_algorithm():
-    p = Path()
-
-    assert isinstance(p.algorithms_available, set)
-
-    for a in p.algorithms_available:
-        assert a in hashlib.algorithms_available
-
-
-def test_iter_lines(tmp_file):
-    with pytest.raises(FileNotFoundError):
-        for line in Path('file_not_available.txt').iter_lines():
-            pass
-
-    my_generator = Path(tmp_file).iter_lines()
-
-    assert inspect.isgenerator(my_generator)
-    assert list(my_generator) == str(CONTENT).splitlines()
-
-
-def test_iter_bytes(tmp_file):
-    with pytest.raises(FileNotFoundError):
-        for chunk in Path('file_not_available.txt').iter_bytes():
-            pass
-
-    my_generator = Path(tmp_file).iter_bytes()
-
-    assert inspect.isgenerator(my_generator)
-    assert list(my_generator)[0] == str(CONTENT).encode()
-
-
-def test_copy(tmp_file, dst_path):
-    src = Path(tmp_file)
-
-    result = src.copy(dst_path, parents=True)
-
-    assert isinstance(result, tuple)
-
-    dst, copied = result
-
-    assert copied == True
-    assert pathlib.Path(src).is_file() == True
-    assert dst == pathlib.Path(dst_path).joinpath(pathlib.Path(tmp_file).name)
-
-
-def test_move(tmp_file, dst_path):
-    src = Path(tmp_file)
-
-    result = src.move(dst_path)
-
-    assert isinstance(result, tuple)
-
-    _, moved = result
-
-    assert moved == True
-    assert pathlib.Path(src).is_file() == False
-
-
-def test_unlink_prune(tmp_file):
-    src = Path(tmp_file)
-
-    src.unlink(prune=True)
-    assert src.is_file() == False
-    assert src.parent.exists() == False
-
-
-def test_unlink(tmp_file):
-    src = Path(tmp_file)
-
-    src.unlink()
-    assert src.is_file() == False
-    assert src.parent.exists() == True
-
-
-def test_unlink_missing(tmp_path):
-    src = Path(tmp_path) / 'subdir' / 'file_not_found.txt'
-
-    with pytest.raises(FileNotFoundError):
-        src.unlink()
-
-    src.parent.mkdir()
-
-    src.unlink(missing_ok=True)
-    assert src.parent.is_dir() == True
-
-    src2 = Path(tmp_path) / 'subdir' / 'not_empty.txt'
-    src2.touch()
-
-    with pytest.raises(OSError):
-        src.unlink(missing_ok=True, prune=True)
-    assert src.parent.is_dir() == True
-
-    src.unlink(missing_ok=True, prune='try')
-    assert src.parent.is_dir() == True
-
-    src2.unlink()
-    src.unlink(missing_ok=True, prune=True)
-    assert src.parent.is_dir() == False
-
-
-def test_rmdir_isfile(tmp_file):
-    src = Path(tmp_file)
-
-    with pytest.raises(NotADirectoryError):
-        src.rmdir()
-
-    with pytest.raises(NotADirectoryError):
-        src.rmdir(recursive=True)
-
-    assert src.exists() == True
-
-
-def test_rmdir_isdir(dst_path):
-    dst = Path(dst_path)
-    dst.mkdir()
-    file = dst.joinpath('tmp.txt')
-    file.touch()
-
-    assert dst.is_dir() == True
-    assert file.is_file() == True
-    dst.rmdir(recursive=True)
-    assert file.exists() == False
-    assert dst.exists() == False
-
-
-def test_touch(tmp_path):
-    src = Path(tmp_path) / 'file_not_found.txt'
-
-    src.touch()
-    assert src.is_file() == True
-
-    src2 = Path(tmp_path) / 'subdir' / 'file_not_found.txt'
-
-    with pytest.raises(FileNotFoundError):
-        src2.touch()
-
-    assert src2.exists() == False
-
-    src2.touch(parents=True)
-    assert src2.parent.is_dir() == True
-    assert src2.is_file() == True
-
-
-def test_mtime(tmp_file, tmp_path):
-    src = Path(tmp_file)
-
-    start = src.mtime
-
-    assert isinstance(start, int)
-
-    with src.open(mode='at') as f:
-        f.write('hallo welt')
-        time.sleep(SEC)
-
-    end = src.mtime
-    assert (end - start) >= (SEC * 1e9)
-
-    assert (src.mtime - end) == 0
-
-    src2 = Path(tmp_path) / 'subdir_not_exists'
-
-    with pytest.raises(FileNotFoundError):
-        _ = src2.mtime
-
-    src2.mkdir()
-    assert src2.mtime > 0