Merge branch 'release/v1.2.1b1'

Author: rsnitsch

BUILD.md

@@ -1,20 +1,37 @@
-# Building
+# How to build and upload to PyPI
+
+## Build
 
 ```
-python setup.py sdist
-python setup.py bdist_wheel
+python -m build
+twine check dist/*
 ```
 
-# Uploading
+## Upload
+
+### 1. Configuring the API token
+
+Generate an API token at https://pypi.org/manage/account/ and then save the following to `$HOME/.pypirc`:
+
+    [distutils]
+    index-servers =
+        py3createtorrent
+
+    [py3createtorrent]
+    repository = https://upload.pypi.org/legacy/
+    username = __token__
+    password = <INSERT API TOKEN HERE>
+
+### 2. Executing the upload
 
 ```
-twine upload --skip-existing dist/*
+twine upload --skip-existing --repository py3createtorrent dist/*
 twine upload --skip-existing --repository testpypi dist/*
 ```
 
-# Testing
+## Test `pip install`
 
 ```sh
 pip install py3createtorrent
 pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple py3createtorrent
-```
+```

Pipfile

@@ -15,6 +15,7 @@ faker = "*"
 pydocstyle = "*"
 pylint = "*"
 pyright = "~=1.1.339"
+build = "*"
 
 [packages]
 "bencode.py" = "~=4.0"

docs/source/changelog.rst

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+Version 1.2.0b1 (beta)
+----------------------
+
+*Release date: 2024/02/13*
+
+* Attempt to fix the UnicodeEncodeErrors (or similar) that occur when printing files/paths with rare characters that are not
+  compatible with the console's codec. See `#33 <https://github.com/rsnitsch/py3createtorrent/issues/33>`_.
+
 Version 1.2.0
 -------------
 

docs/source/conf.py

@@ -50,7 +50,7 @@
 # The short X.Y version.
 version = '1.2'
 # The full version, including alpha/beta/rc tags.
-release = '1.2.0'
+release = '1.2.1b1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

setup.py

@@ -52,6 +52,8 @@ def get_version(rel_path):
         "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",
         "Programming Language :: Python :: 3 :: Only",
     ],
     # This field adds keywords for your project which will appear on the

src/py3createtorrent.py

@@ -44,7 +44,7 @@
 
 # Do not touch anything below this line unless you know what you're doing!
 
-__version__ = "1.2.0"
+__version__ = "1.2.1b1"
 
 # Note:
 #  Kilobyte = kB  = 1000 Bytes
@@ -114,6 +114,17 @@ def load_config(self) -> None:
                                             "(must be true/false)" % self.best_trackers_url)
 
 
+def clean_str_for_console(path: str) -> str:
+    """
+    Returns the string for printing to the console.
+    
+    Non-printable characters are replaced by a backslashed escape sequence like \\xhh, \\uxxxx or \\Uxxxxxxxx.
+    """
+    encoding = sys.stdout.encoding
+    errors = "backslashreplace"
+    return path.encode(encoding, errors).decode(encoding, errors)
+
+
 def printv(*args: Any, **kwargs: Any) -> None:
     """If VERBOSE is True, act as an alias for print. Else do nothing."""
     if VERBOSE:
@@ -247,7 +258,7 @@ def calculate_sha1_hash_for_piece(i: int, piece_data: bytes) -> None:
             if include_md5:
                 md5 = hashlib.md5()
 
-            printv("Processing file '%s'... " % os.path.relpath(path, directory), end="")
+            printv("Processing file '%s'... " % clean_str_for_console(os.path.relpath(path, directory)), end="")
 
             with open(path, "rb") as fh:
                 while True:
@@ -377,13 +388,15 @@ def _get_files_in_directory(
             path = os.path.join(directory, node)
 
             if os.path.normcase(path) in excluded_paths:
-                printv("Skipping '%s' due to explicit exclusion." % os.path.relpath(path, relative_to))
+                printv("Skipping '%s' due to explicit exclusion." %
+                       clean_str_for_console(os.path.relpath(path, relative_to)))
                 continue
 
             regexp_match = False
             for regexp in excluded_regexps:
                 if regexp.search(path):
-                    printv("Skipping '%s' due to pattern exclusion." % os.path.relpath(path, relative_to))
+                    printv("Skipping '%s' due to pattern exclusion." %
+                           clean_str_for_console(os.path.relpath(path, relative_to)))
                     regexp_match = True
                     break
             if regexp_match:
@@ -392,7 +405,7 @@ def _get_files_in_directory(
             if os.path.normcase(os.path.realpath(path)) in processed_paths:
                 print(
                     "Warning: skipping symlink '%s', because it's target "
-                    "has already been processed." % path,
+                    "has already been processed." % clean_str_for_console(path),
                     file=sys.stderr,
                 )
                 continue