Merge pull request #15 from alexpdev/newbranch

alexpdev · web-flow · commit 2f4671b2d716 · 2022-06-04T19:23:09.000-07:00
Newbranch
diff --git a/Makefile b/Makefile
@@ -29,23 +29,22 @@ help:
 clean: clean-build ## remove all build, test, coverage and Python artifacts
 
 clean-build: ## remove build artifacts
-	rm -fr build/
-	rm -fr dist/
-	rm -fr .eggs/
-	rm -fr **/.pytest_cache
-	rm -fr *.egg-info
-	rm -fr *.egg
-	rm -f **.pyc
-	rm -f **.pyo
-	rm -f **~
-	rm -fr **/__pycache__
-	rm -fr .tox/
-	rm -f .coverage
-	rm -fr htmlcov/
-	rm -fr .pytest_cache
-	rm -f corbertura.xml
-	rm -f coverage.xml
-	rm -fr .codacy-coverage
+	rm -fvr build/
+	rm -fvr dist/
+	rm -fvr .eggs/
+	rm -fvr **/.pytest_cache
+	rm -fvr *.egg-info
+	rm -fvr *.egg
+	rm -fv **.pyc
+	rm -fv **.pyo
+	rm -fv **~
+	rm -fvr **/__pycache__
+	rm -fvr .tox/
+	rm -fv .coverage
+	rm -fvr htmlcov/
+	rm -fvr .pytest_cache
+	rm -fv corbertura.xml
+	rm -fv coverage.xml
 
 lint: ## check style with flake8
 	black pyben
@@ -57,15 +56,16 @@ lint: ## check style with flake8
 
 test: ## run tests quickly with the default Python
 	pytest tests --cov=tests --cov=pyben --pylint
+	coverage xml -o coverage.xml
+
+coverage: ## run and get coverage report
+	coverage xml -o coverage.xml
+	coverage run --source pyben -m pytest tests
 
-push: lint docs clean test
+push: clean lint docs test coverage
 	git add .
 	git commit -m "$m"
 	git push
-	coverage run --source pyben -m pytest tests
-	coverage xml -o coverage.xml
-	bash codacy.sh report -r coverage.xml
-	rm coverage.xml
 
 docs: ## generate Sphinx HTML documentation, including API docs
 	rm -rf docs
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Pyben v0.3.0
+# Pyben v0.3.2
 
 Small library for encoding/decoding bencode data.
 Supports Unicode pathnames as of PyBen 3.0.
@@ -8,7 +8,7 @@ Pyben Enables fast and easy encoding and decoding of bencoded data.
 
 ---------
 
-![GitHub repo size](https://img.shields.io/github/repo-size/alexpdev/pyben&style=flat-square)
+![GitHub repo size](https://img.shields.io/github/repo-size/alexpdev/pyben?style=flat-square)
 ![GitHub contributors](https://img.shields.io/github/license/alexpdev/pyben)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/pyben?color=%23CC3919&label=PyPi%20Downloads&logo=PyPi&logoColor=cyan&style=flat-square)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/af86338dcf0a4a899228df470d20e894)](https://www.codacy.com/gh/alexpdev/pyben/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=alexpdev/pyben&amp;utm_campaign=Badge_Grade)
@@ -49,7 +49,7 @@ The API is intentionally designed to mimic Python's json and pickle modules.
     ... True
 
 One key difference is that the 'load' and 'dump' methods accept as arguments,
-string paths or path objects as well as open iobuffer.
+string paths or path-like objects as well as an open BytesIO object.
 
 For Example this:
 
@@ -76,4 +76,4 @@ See docs for more full API.
 
 ## License
 
-This project uses the following license: GNU LGPL v3
+This project uses the following license: Apache 2.0
diff --git a/docs/404.html b/docs/404.html
@@ -113,7 +113,7 @@ <h3>Quick search</h3>
 
   <!--
   MkDocs version      : 1.2.3
-  Docs Build Date UTC : 2022-04-24 00:10:52.551087+00:00
+  Docs Build Date UTC : 2022-06-05 02:20:38.561236+00:00
   -->
 </body>
 </html>
diff --git a/docs/LICENSE/index.html b/docs/LICENSE/index.html
@@ -314,7 +314,7 @@ <h3>Quick search</h3>
 
   <!--
   MkDocs version      : 1.2.3
-  Docs Build Date UTC : 2022-04-24 00:10:52.573093+00:00
+  Docs Build Date UTC : 2022-06-05 02:20:38.580484+00:00
   -->
 </body>
 </html>
diff --git a/docs/api/index.html b/docs/api/index.html
diff --git a/docs/examples/index.html b/docs/examples/index.html
@@ -215,7 +215,7 @@ <h3>Quick search</h3>
 
   <!--
   MkDocs version      : 1.2.3
-  Docs Build Date UTC : 2022-04-24 00:10:52.738852+00:00
+  Docs Build Date UTC : 2022-06-05 02:20:38.674028+00:00
   -->
 </body>
 </html>
diff --git a/docs/img/favicon.ico b/docs/img/favicon.ico
diff --git a/docs/index.html b/docs/index.html
@@ -44,7 +44,7 @@
             <h1 id="pyben">Pyben</h1>
 <p>Small library for encoding/decoding bencode data.
 Pyben Enables fast and easy encoding and decoding of bencoded data.</p>
-<p><img alt="PyBen" src="./assets/pyben.png" /></p>
+<p><img alt="PyBen" src="img/pyben.png" /></p>
 <hr />
 <p><img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/alexpdev/pyben&amp;style=flat-square" />
 <img alt="GitHub contributors" src="https://img.shields.io/github/license/alexpdev/pyben" />
@@ -98,7 +98,7 @@ <h2 id="using-pyben">Using PyBen</h2>
 <p>The full API includes many other functions and classes as well.
 See docs for more full API.</p>
 <h2 id="license">License</h2>
-<p>This project uses the following license: GNU LGPL v3</p>
+<p>This project uses the following license: Apache 2.0</p>
             
               <h2>Navigation</h2>
 
@@ -182,7 +182,7 @@ <h3>Quick search</h3>
 
   <!--
   MkDocs version      : 1.2.3
-  Docs Build Date UTC : 2022-04-24 00:10:52.569695+00:00
+  Docs Build Date UTC : 2022-06-05 02:20:38.577413+00:00
   -->
 </body>
 </html>
diff --git a/docs/search/search_index.json b/docs/search/search_index.json
diff --git a/docs/sitemap.xml b/docs/sitemap.xml
@@ -2,22 +2,22 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://alexpdev.github.io/pyben/</loc>
-         <lastmod>2022-04-24</lastmod>
+         <lastmod>2022-06-05</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://alexpdev.github.io/pyben/LICENSE/</loc>
-         <lastmod>2022-04-24</lastmod>
+         <lastmod>2022-06-05</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://alexpdev.github.io/pyben/api/</loc>
-         <lastmod>2022-04-24</lastmod>
+         <lastmod>2022-06-05</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://alexpdev.github.io/pyben/examples/</loc>
-         <lastmod>2022-04-24</lastmod>
+         <lastmod>2022-06-05</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -11,8 +11,6 @@ nav:
   - API: api.md
 
 theme: alabaster
-logo: img/pyben.png
-favicon: img/favicon.png
 
 plugins:
   - search
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pyben",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Small library for encoding/decoding bencode data. Pyben Enables fast and easy encoding and decoding of bencoded data.",
   "directories": {
     "doc": "docs",
diff --git a/pyben/__init__.py b/pyben/__init__.py
@@ -42,6 +42,7 @@
 from pyben.api import dump, dumps, load, loadinto, loads, show
 from pyben.bencode import bendecode, benencode
 from pyben.classes import Bendecoder, Benencoder
+from pyben.exceptions import DecodeError, EncodeError, FilePathError
 from pyben.version import version
 
 __version__ = version
@@ -61,4 +62,7 @@
     "loads",
     "show",
     "loadinto",
+    "DecodeError",
+    "FilePathError",
+    "EncodeError",
 ]
diff --git a/pyben/api.py b/pyben/api.py
@@ -24,6 +24,8 @@
 * loads
 * tojson
 
+Examples
+--------
 ## Usage Examples
 
 ### Encode inline code:
@@ -60,7 +62,6 @@
     ... {'item1': ['item2', 3, [4], {5: 'item6'}]}
     >>> decoded_file == data
     ... True
-
 """
 
 from pyben.bencode import bendecode, benencode
@@ -78,9 +79,8 @@ def dump(obj, buffer):
     ----------
     obj : any
         Data to be encoded.
-    buffer : `str` or `BytesIO`
+    buffer : str or BytesIO
         File of path-like to write the data to.
-
     """
     encoded = benencode(obj)
 
@@ -101,14 +101,13 @@ def dumps(obj):
 
     Parameters
     ----------
-    obj : `any`
+    obj : any
         Object to be encoded.py.
 
     Returns
     -------
-    `bytes` :
+    bytes :
         Encoded data.
-
     """
     return bytes(benencode(obj))
 
@@ -126,9 +125,8 @@ def load(buffer, to_json=False):
 
     Returns
     -------
-    any :
+    dict :
         (commonly `dict`), Decoded contents of file.
-
     """
     if buffer in [None, ""]:
         raise FilePathError(buffer)
@@ -143,8 +141,8 @@ def load(buffer, to_json=False):
         try:
             with open(path, "rb") as _fd:
                 decoded, _ = bendecode(_fd.read())
-        except FileNotFoundError as e:
-            raise FilePathError(buffer) from e
+        except (FileNotFoundError, IsADirectoryError, PermissionError) as err:
+            raise FilePathError(buffer) from err
     if to_json:
         decoded = _to_json(decoded)
     return decoded
@@ -156,16 +154,15 @@ def loads(encoded, to_json=False):
 
     Parameters
     ----------
-    encoded : `bytes`
+    encoded : bytes
         Bencoded data.
-    to_json : `bool`
+    to_json : bool
         Convert to json serializable if true otherwise leave it alone.
 
     Returns
     -------
-    any :
+    dict :
         (any), Decoded data.
-
     """
     decoded, _ = bendecode(encoded)
     if to_json:
@@ -179,12 +176,12 @@ def _to_json(decoded):
 
     Parameters
     ----------
-    decoded : `any`
+    decoded : any
         decoded input data with unknown data type.
 
     Returns
     -------
-    `dict` :
+    dict :
         json serializable dictionary.
     """
     if isinstance(decoded, (bytes, bytearray)):
@@ -257,6 +254,10 @@ def loadinto(buffer, lst):
     list :
         the list containing the output.
     """
-    output = load(buffer)
-    lst.append(output)
+    try:
+        output = load(buffer)
+        lst.append(output)
+    except FilePathError as err:
+        lst.append(False)
+        raise FilePathError from err
     return lst
diff --git a/pyben/classes.py b/pyben/classes.py
@@ -300,8 +300,8 @@ def dumps(cls, data):
 
         Returns
         -------
-        `bytes`: Encoded data.
-
+        bytes:
+            Encoded data.
         """
         return cls(data).encode()
 
diff --git a/pyben/exceptions.py b/pyben/exceptions.py
@@ -24,9 +24,8 @@ class DecodeError(Exception):
 
     Parameters
     ----------
-    val : any
+    val : None
         Value that cause the exception
-
     """
 
     def __init__(self, val=None):
@@ -45,9 +44,8 @@ class EncodeError(Exception):
 
     Parameters
     ----------
-    val : any
+    val : None
         Value that cause the exception
-
     """
 
     def __init__(self, val=None):
@@ -64,9 +62,8 @@ class FilePathError(Exception):
 
     Parameters
     ----------
-    val : any
+    obj : None
         Value that cause the exception
-
     """
 
     def __init__(self, obj=None):
diff --git a/pyben/version.py b/pyben/version.py
@@ -13,4 +13,4 @@
 #####################################################################
 """Module containing the current version."""
 
-version = "0.3.1"
+version = "0.3.2"
diff --git a/site/img/favicon.ico b/site/img/favicon.ico
diff --git a/site/index.md b/site/index.md
@@ -3,7 +3,7 @@
 Small library for encoding/decoding bencode data.
 Pyben Enables fast and easy encoding and decoding of bencoded data.
 
-![PyBen](./assets/pyben.png)
+![PyBen](./img/pyben.png)
 
 ---------
 
@@ -75,4 +75,4 @@ See docs for more full API.
 
 ## License
 
-This project uses the following license: GNU LGPL v3
+This project uses the following license: Apache 2.0
diff --git a/tests/test_api.py b/tests/test_api.py
