tahoe-lafs/trac-2024-07-25
2
0
Issues 1.1k Wiki Activity

Document the -b flag 

[Imported from Trac: page Python3, version 79]
itamarst 2021-03-05 22:03:01 +00:00
parent 2e1e29f4e5
commit e18b2cc9fa
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
Python3.md

@ -178,4 +178,16 @@ The interim solution will likely be dicts that enforce key type to be only bytes
## Avoid massive changes ## Avoid massive changes
Sometimes it's easier to be a little more lenient in input (support both unicode and bytes), or to change some type to unicode, instead of having to change hundreds of lines of code from unicode to bytes when porting. When to do so is a judgement call, but if you are changing massive amounts of code to have `b""` prefix _and_ byteness isn't important, consider alternative approaches. Sometimes it's easier to be a little more lenient in input (support both unicode and bytes), or to change some type to unicode, instead of having to change hundreds of lines of code from unicode to bytes when porting. When to do so is a judgement call, but if you are changing massive amounts of code to have `b""` prefix _and_ byteness isn't important, consider alternative approaches.
## Catching string/bytes issues
The following can cause bugs and aren't always caught in tests:
* `str(some_bytes)` (used to return `"hello"`, now returns `"b'hello'"`)
* `"%s" % (some_bytes,)`
* `some_bytes == some_unicode`
Python 3 has a `-b` command line flag for `python` that turns these into warnings. In the test runner you can then setup a warnings filter that turns those into exceptions for the package being ported (3rd party packages might do this too, and don't want to fail tests because of them). This helps catch bugs that wouldn't be caught otherwise. The cost is that you also need to fix all the logging messages that do this, but ... that's probably worth it.
tox.ini setup for Python 3 now has this setup for Tahoe-LAFS, so if you get [BytesWarning](BytesWarning) as exception that's what's going on. For debugging purposes it can be useful to disable the exceptions and just look at the warnings; warnings don't fail the tests, so you can grep for them from tests output, sort and uniquify and then fix them in one go.