Merge pull request #11 from alexpdev/update

alexpdev · web-flow · commit b1726ed411bd · 2022-03-17T13:07:31.000-07:00
Update
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,7 @@ __pycache__/
 *$py.class
 # Prerequisites
 *.d
+coverage.xml
 
 # Compiled Object files
 *.slo
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # Pyben v0.2.4
 
 Small library for encoding/decoding bencode data.
+Supports Unicode pathnames as of PyBen 3.0.
 Pyben Enables fast and easy encoding and decoding of bencoded data.
 
 ![PyBen](./assets/pyben.png)
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 : 2021-12-31 01:38:23.853201+00:00
+  Docs Build Date UTC : 2022-03-17 20:02:24.369003+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 : 2021-12-31 01:38:23.876200+00:00
+  Docs Build Date UTC : 2022-03-17 20:02:24.394001+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 : 2021-12-31 01:38:23.971199+00:00
+  Docs Build Date UTC : 2022-03-17 20:02:24.484002+00:00
   -->
 </body>
 </html>
diff --git a/docs/index.html b/docs/index.html
@@ -182,7 +182,7 @@ <h3>Quick search</h3>
 
   <!--
   MkDocs version      : 1.2.3
-  Docs Build Date UTC : 2021-12-31 01:38:23.872200+00:00
+  Docs Build Date UTC : 2022-03-17 20:02:24.390003+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>2021-12-31</lastmod>
+         <lastmod>2022-03-17</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://alexpdev.github.io/pyben/LICENSE/</loc>
-         <lastmod>2021-12-31</lastmod>
+         <lastmod>2022-03-17</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://alexpdev.github.io/pyben/api/</loc>
-         <lastmod>2021-12-31</lastmod>
+         <lastmod>2022-03-17</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://alexpdev.github.io/pyben/examples/</loc>
-         <lastmod>2021-12-31</lastmod>
+         <lastmod>2022-03-17</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pyben",
-  "version": "0.2.7",
+  "version": "0.3.0",
   "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/api.py b/pyben/api.py
@@ -63,8 +63,8 @@
 
 """
 
-from .bencode import bendecode, benencode
-from .exceptions import FilePathError
+from pyben.bencode import bendecode, benencode
+from pyben.exceptions import FilePathError
 
 
 def dump(obj, buffer):
@@ -85,7 +85,11 @@ def dump(obj, buffer):
     encoded = benencode(obj)
 
     if not hasattr(buffer, "write"):
-        with open(buffer, "wb") as _fd:
+        if hasattr(buffer, "decode"):  # pragma: nocover
+            txt = buffer.decode("utf-8")
+        else:
+            txt = buffer
+        with open(txt, "wb") as _fd:
             _fd.write(encoded)
     else:
         buffer.write(encoded)
@@ -132,12 +136,15 @@ def load(buffer, to_json=False):
     if hasattr(buffer, "read"):
         decoded, _ = bendecode(buffer.read())
     else:
+        if hasattr(buffer, "decode"):  # pragma: nocover
+            path = buffer.decode("utf-8")
+        else:
+            path = buffer
         try:
-            with open(buffer, "rb") as _fd:
+            with open(path, "rb") as _fd:
                 decoded, _ = bendecode(_fd.read())
-        except FileNotFoundError as excp:
-            raise FilePathError(buffer) from excp
-
+        except FileNotFoundError as e:
+            raise FilePathError(buffer) from e
     if to_json:
         decoded = _to_json(decoded)
     return decoded
diff --git a/pyben/bencode.py b/pyben/bencode.py
@@ -89,7 +89,7 @@ def bendecode_str(units):
         Decoded data string.
 
     """
-    match = re.match(br"(\d+):", units)
+    match = re.match(rb"(\d+):", units)
     word_len, start = int(match.groups()[0]), match.span()[1]
     end = start + word_len
     text = units[start:end]
@@ -118,7 +118,7 @@ def bendecode_int(bits):
         Decoded int value.
 
     """
-    obj = re.match(br"i(-?\d+)e", bits)
+    obj = re.match(rb"i(-?\d+)e", bits)
     return int(obj.group(1)), obj.end()
 
 
@@ -251,8 +251,9 @@ def bencode_str(txt):
         Bencoded string literal.
 
     """
-    size = str(len(txt)) + ":"
-    return size.encode("utf-8") + txt.encode("utf-8")
+    text = txt.encode("utf-8")
+    size = str(len(text)) + ":"
+    return size.encode("utf-8") + text
 
 
 def bencode_int(i):
diff --git a/pyben/classes.py b/pyben/classes.py
@@ -213,7 +213,7 @@ def _decode_str(bits):
             Decoded string.
 
         """
-        match = re.match(br"(\d+):", bits)
+        match = re.match(rb"(\d+):", bits)
         word_size, start = int(match.groups()[0]), match.span()[1]
         finish = start + word_size
         word = bits[start:finish]
@@ -242,7 +242,7 @@ def _decode_int(bits):
             Decoded intiger.
 
         """
-        obj = re.match(br"i(-?\d+)e", bits)
+        obj = re.match(rb"i(-?\d+)e", bits)
         return int(obj.group(1)), obj.end()
 
 
diff --git a/pyben/version.py b/pyben/version.py
@@ -13,4 +13,4 @@
 #####################################################################
 """Module containing the current version."""
 
-version = "0.2.7"
+version = "0.3.0"
diff --git a/setup.py b/setup.py
@@ -23,7 +23,7 @@
 import json
 from setuptools import find_packages, setup
 
-INFO = json.load(open('./package.json'))
+INFO = json.load(open('./package.json', encoding='utf-8'))
 
 with open("README.md", "rt", encoding="UTF-8") as readme:
     long_description = readme.read()
diff --git a/tests/tempfile.pyben b/tests/tempfile.pyben
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -19,8 +19,7 @@
 import pytest
 
 import pyben
-
-from . import context
+from tests import context
 
 
 @pytest.fixture
@@ -40,6 +39,26 @@ def tempmeta():
     return meta, tfile
 
 
+def test_writing_unicode(tempmeta):
+    """Test Unicode support for writing bencode."""
+    meta, tfile = tempmeta
+    parent = os.path.dirname(tfile)
+    txt = "测试测试测试测试.pyben"
+    path = os.path.join(parent, txt)
+    pyben.dump(meta, path)
+    assert os.path.exists(path)
+    context.rmpath(path)
+
+
+def test_reading_unicode(tempmeta):
+    """Test Unicode support for reading bencode."""
+    path = os.path.join(os.path.dirname(tempmeta[1]), "测试测试测试测试.pyben")
+    pyben.dump(tempmeta[0], path)
+    meta = pyben.load(path)
+    assert isinstance(meta, dict)
+    context.rmpath(path)
+
+
 def test_rmpath():
     """Test rmpath function."""
     path = "test_folder"
diff --git a/tests/test_classes.py b/tests/test_classes.py
@@ -36,9 +36,8 @@
 
 from pyben.classes import Bendecoder, Benencoder
 from pyben.exceptions import DecodeError, EncodeError
-
-from .context import (data, dicts, ints, lists, rmpath, strings, testfile,
-                      testmeta)
+from tests.context import (data, dicts, ints, lists, rmpath, strings, testfile,
+                           testmeta)
 
 
 @pytest.fixture
diff --git a/tests/test_funcs.py b/tests/test_funcs.py
@@ -20,8 +20,7 @@
                            bendecode_int, bendecode_list, bendecode_str,
                            benencode)
 from pyben.exceptions import DecodeError, EncodeError
-
-from . import context
+from tests import context
 
 
 def test_malformed_bytes():
@@ -163,3 +162,20 @@ def test_bendecode_all(encoded, decoded):
     """Test decoding all types."""
     item, _ = bendecode(encoded)
     assert item == decoded
+
+
+def test_bencode_unicode():
+    """Test encoding unicode string literals."""
+    text = "丂七丆万丈三上下丌不与丑丒专且丕世丗丘丙业丛东丝丠両丢丣两严丨丩个丫丬中丮丯"
+    benunit = benencode(text)
+    out = text.encode("utf-8")
+    out = (str(len(out)) + ":").encode("utf-8") + out
+    assert benunit == out
+
+
+def test_decode_unicode():
+    """Test decoding unicode strings."""
+    text = "丂七丆万丈三上下丌不与丑丒专且丕世丗丘丙业丛东丝丠両丢丣两严丨丩个丫丬中丮丯"
+    data = benencode(text)
+    result, _ = bendecode(data)
+    assert result == text
