auto push commit coverage

Author: alexpdev

.prospector.yml

@@ -0,0 +1,28 @@
+strictness: high
+autodetect: true
+doc-warnings: true
+test-warnings: true
+member-warnings: true
+
+pep257:
+  run: true
+  disable:
+    - D203
+    - D212
+    - D213
+    - D413
+
+pep8:
+  run: true
+
+pylint:
+  run: true
+
+bandit:
+  run: true
+
+pyroma:
+  run: true
+
+pyflakes:
+  run: true

Makefile

@@ -52,17 +52,19 @@ lint: ## check style with flake8
 	pyroma .
 	bandit pyben/*
 	pep257 pyben
+	prospector pyben
+	prospector tests
 
 test: ## run tests quickly with the default Python
 	pytest tests
-	pytest --coverage tests
-	pytest --pylint tests
+	pytest tests --cov
+	pytest tests --pylint
 
 coverage: ## check code coverage quickly with the default Python
-	coverage run -m pytest tests
+	coverage run -m pytest tests --cov --pylint
 	coverage xml -o coverage.xml
 
-push: clean lint docs coverage
+push: lint docs clean test coverage
 	git add .
 	git commit -m "auto push commit coverage"
 	git push

docs/api/index.html

@@ -257,5 +257,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.2.2
-Build Date UTC : 2021-10-10 02:34:11.330781+00:00
+Build Date UTC : 2021-10-10 03:52:47.654511+00:00
 -->

docs/index.html

@@ -72,12 +72,13 @@ def dump(obj, buffer):
     Works effectively the same as it's json equivelant except also
     accepts a path as well as an open fileIO.
 
-    Args
-    -----------------
+    Args:
+    ----
     obj : any
-    *   Data to be encoded.
+        Data to be encoded.
     buffer : `str` or `BytesIO`
-    *   File of path-like to write the data to.
+        File of path-like to write the data to.
+
     """
     encoded = benencode(obj)
 
@@ -95,14 +96,15 @@ def dumps(obj):
     Shortuct function to encoding given obj to bencode encoding.
 
     Args
-    --------
+    ----
     obj : `any`
-    *   Object to be encoded.py.
+        Object to be encoded.py.
 
     Returns
-    --------
+    -------
     `bytes` :
-    *   Encoded data.
+        Encoded data.
+
     """
     return benencode(obj)
 
@@ -112,14 +114,15 @@ def load(buffer):
     Load bencoded data from a file of path object and decodes it.
 
     Args
-    --------
+    ----
     buffer : `str` or `BytesIO`
-    *   Open and/or read data from file to be decoded.
+        Open and/or read data from file to be decoded.
 
     Returns
-    ---------
+    -------
     `any` :
-    *   (commonly `dict`), Decoded contents of file.
+        (commonly `dict`), Decoded contents of file.
+
     """
     if hasattr(buffer, "read"):
         decoded, _ = bendecode(buffer.read())
@@ -136,14 +139,15 @@ def loads(encoded):
     Shortcut function for decoding encoded data.
 
     Args
-    --------
+    ----
     encoded : `bytes`
-    *   Bencoded data.
+        Bencoded data.
 
     Returns
-    --------
+    -------
     `any` :
-    *   (commonly `dict`), Decoded data.
+        (commonly `dict`), Decoded data.
+
     """
     decoded, _ = bendecode(encoded)
     return decoded

docs/search/search_index.json

@@ -41,19 +41,20 @@ def bendecode(bits):
     Decode bencoded data.
 
     Args
-    -----------------
+    ----
     bits : `bytes`
-    >   Bencode encoded data.
+        Bencode encoded data.
 
     Raises
-    -----------------
+    ------
     `DecodeError` :
-    >   Malformed data.
+        Malformed data.
 
     Returns
-    -----------------
+    -------
     any :
-    >   Bencode decoded data.
+        Bencode decoded data.
+
     """
     if bits.startswith(b"i"):
         match, feed = bendecode_int(bits)
@@ -79,14 +80,15 @@ def bendecode_str(units):
     Bendecode string types.
 
     Args
-    ---------
+    ----
     bits : `bytes`
-    >   Bencoded string.
+        Bencoded string.
 
     Returns
-    ---------
+    -------
     `str` :
-    >   Decoded data string.
+        Decoded data string.
+
     """
     match = re.match(br"(\d+):", units)
     word_len, start = int(match.groups()[0]), match.span()[1]
@@ -107,14 +109,15 @@ def bendecode_int(bits):
     Decode digits.
 
     Args
-    -----------------
+    ----
     bits : `bytes`
-    >   Bencoded intiger bytes
+        Bencoded intiger bytes
 
     Returns
-    -----------------
+    -------
     `int` :
-    >   Decoded int value.
+        Decoded int value.
+
     """
     obj = re.match(br"i(-?\d+)e", bits)
     return int(obj.group(1)), obj.end()
@@ -125,14 +128,15 @@ def bendecode_dict(bits):
     Decode dictionary and it's contents.
 
     Args
-    ---------
+    ----
     bits : `bytes`
-    >   Bencoded dictionary.
+        Bencoded dictionary.
 
     Returns
-    ---------
+    -------
     `dict`
-    >   Decoded dictionary and contents
+        Decoded dictionary and contents
+
     """
     dic, feed = {}, 1
 
@@ -152,14 +156,15 @@ def bendecode_list(bits):
     Decode list and list contents.
 
     Args
-    -----------------
+    ----
     bits : `bytes`
-    >   Bencoded list.
+        Bencoded list.
 
     Returns
-    -----------------
+    -------
     `list` :
-    >   Bencode decoded list and contents.
+        Bencode decoded list and contents.
+
     """
     lst, feed = [], 1
 
@@ -177,19 +182,20 @@ def benencode(val):
     Encode data with bencoding.
 
     Args
-    --------
+    ----
     val : any
-    >   Data for encoding.
+        Data for encoding.
 
     Raises
-    --------
+    ------
     `EncodeError` :
-    >   Cannot interpret data.
+        Cannot interpret data.
 
     Returns
-    ---------
+    -------
     `bytes` :
-    >   Bencoded data.
+        Bencoded data.
+
     """
     if isinstance(val, str):
         return bencode_str(val)
@@ -217,14 +223,15 @@ def bencode_bytes(bits):
     Encode bytes.
 
     Args
-    --------
+    ----
     bits : `bytes`
-    >   Bytes treated as a byte-string literal.
+        Bytes treated as a byte-string literal.
 
     Returns
-    ---------
+    -------
     `bytes`:
-    >   Bencode encoded byte string literal.
+        Bencode encoded byte string literal.
+
     """
     size = str(len(bits)) + ":"
     return size.encode("utf-8") + bits
@@ -235,14 +242,15 @@ def bencode_str(txt):
     Encode string literals.
 
     Args
-    --------
+    ----
     txt : `str`
-    >   Any text string.
+        Any text string.
 
     Returns
-    ---------
+    -------
     `bytes` :
-    >   Bencoded string literal.
+        Bencoded string literal.
+
     """
     size = str(len(txt)) + ":"
     return size.encode("utf-8") + txt.encode("utf-8")
@@ -253,14 +261,15 @@ def bencode_int(i):
     Encode integer type.
 
     Args
-    --------
+    ----
     i : `int`
-    >   Number that needs encoding.
+        Number that needs encoding.
 
     Returns
-    ---------
+    -------
     `bytes` :
-    >   Bencoded Integer.
+        Bencoded Integer.
+
     """
     return ("i" + str(i) + "e").encode("utf-8")
 
@@ -270,14 +279,15 @@ def bencode_list(elems):
     Encode list and contents.
 
     Args
-    --------
+    ----
     elems : `list`
-    >   List of items for bencoding.
+        List of items for bencoding.
 
     Returns
-    ---------
+    -------
     `bytes` :
-    >   Bencoded list and contents.
+        Bencoded list and contents.
+
     """
     arr = bytearray("l", encoding="utf-8")
 
@@ -294,14 +304,15 @@ def bencode_dict(dic):
     Encode dictionary and contents.
 
     Args
-    --------
+    ----
     dic : `dict`
-    >   Any dictionary containing items that can be bencoded.
+        Any dictionary containing items that can be bencoded.
 
     Returns
-    ---------
+    -------
     `bytes` :
-    >   Bencoded key, value pairs of data.
+        Bencoded key, value pairs of data.
+
     """
     result = b"d"