rewritten pathlibutil with pytest

.gitignore

@@ -0,0 +1,162 @@
+.vscode
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

LICENSE

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

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](./example/example1.py)
+   > `Path().read_lines()`
+2. [Write calculated hash to file](./example/example2.py)
+   > `Path().hexdigest()`
+3. [Read hashes from file for verification](./example/example3.py)
+   > `Path().verify()` and `contextmanager`

examples/example1.py

@@ -0,0 +1,25 @@
+try:
+    import sys
+    sys.path.insert(0, '../pathlibutil')
+finally:
+    from pathlibutil import Path
+
+
+def main():
+    """Example 1: Read a file and print its content and some file information to stdout."""
+
+    readme = Path('README.md')
+
+    print(f'File size: {readme.size()} Bytes')
+    print(f'File sha1: {readme.hexdigest("sha1")}')
+
+    print('File content'.center(80, '='))
+
+    for line in readme.read_lines(encoding='utf-8'):
+        print(line, end='')
+
+    print('EOF'.center(80, '='))
+
+
+if __name__ == '__main__':
+    main()

examples/example2.py

@@ -0,0 +1,25 @@
+try:
+    import sys
+    sys.path.insert(0, '../pathlibutil')
+finally:
+    from pathlibutil import Path
+
+
+def main():
+    """Example 2: Write a file with md5 checksums of all python files in the pathlibutil-directory."""
+
+    file = Path('pathlibutil.md5')
+
+    with file.open('w') as f:
+        f.write(
+            '# MD5 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()} *{filename}\n')
+
+    print(f'\nwritten: {i:>5} {file.default_hash}-hashes to: {file}')
+
+
+if __name__ == '__main__':
+    main()

examples/example3.py

@@ -0,0 +1,44 @@
+try:
+    import sys
+    sys.path.insert(0, '../pathlibutil')
+finally:
+    from pathlibutil import Path
+
+
+def main():
+    """Example 3: Read a file with md5 checksums and verify them."""
+
+    file = Path('pathlibutil.md5')
+
+    def no_comment(line: str) -> bool:
+        return not line.startswith('#')
+
+    with file.parent as cwd:
+        miss = 0
+        ok = 0
+        fail = 0
+
+        for line in filter(no_comment, file.read_lines()):
+            try:
+                digest, filename = line.strip().split(' *')
+                verification = Path(filename).verify(digest, 'md5')
+            except ValueError as split_failed:
+                continue
+            except FileNotFoundError as verify_failed:
+                tag = 'missing'
+                miss += 1
+            else:
+                if verification:
+                    tag = 'ok'
+                    ok += 1
+                else:
+                    tag = 'fail'
+                    fail += 1
+
+            print(f'{tag.ljust(len(digest), ".")} *{filename}')
+
+        print(f'\nok: {ok:<5} fail: {fail:<5} missing: {miss}')
+
+
+if __name__ == '__main__':
+    main()

pathlibutil/__init__.py

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