Use doctest with bytes, str & unicode on Python 2.x and 3.x
Project description
This package is an experiment in writing doctests that involve strings, and that are cross-compatible with Python 2.6, 2.7, and 3.3+.
The problem
Suppose you have the following doctest
>>> textfunc()
u'I return a textual (unicode) string'
>>> bytesfunc()
b'I return a byte (binary) string'
On Python 3.x the first test case will fail, because doctest will compare repr(textfunc()) which will not include a u'' prefix.
On Python 2.x the second test will fail, because repr(bytesfunc()) will not include the b'' prefix.
If the tests cases are editted to remove the prefixes, i.e.
>>> textfunc()
'I return a textual (unicode) string'
>>> bytesfunc()
'I return a byte (binary) string'
then the failures will be reversed. textfunc() will now fail on Python 2.x, bytesfunc() will fail on Python 3.x.
The hack
Replace repr() and sys.displayhook with versions that always prefix string literals, regardless of the Python version. Now the doctests can
directly show the string values returned by functions/methods, without resorting to print(), or .encode() etc
successfully test the examples on all Python versions
Proof of concept:
r"""
>>> import sys
>>> import pretext
>>> myrepr = bar.PrefixRepr()
>>> repr = myrepr.repr
>>> def _displayhook(value):
... if value is not None:
... sys.stdout.write(myrepr.repr(value))
>>> sys.displayhook = _displayhook
>>> u''
u''
>>> b''
b''
>>> bytes()
b''
>>> b'\0'
b'\x00'
>>> b"'"
b"'"
"""
Alternatives
If you’re ready to run screaming at the above, there are alternatives e.g.
Wrap byte-string returns in bytearray(). repr(bytearray(b'abc')) == "bytearray(b'abc'))" on all versions of python that have bytearray() (2.6 onward) e.g.
>>> bytearray(bytesfunc()) bytearray(b'I return a byte (binary) string')
Support Python 3.x exclusively
Use print(bytesfunc().decode('ascii')) and choose your input values carefully
Use #doctest: +SKIP
Use #doctest: +ELLIPSIS
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pretext-0.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be76bac3c4a659f29d78bed619a22a4d93b8743d764f2ac197d0f5343378d81c |
|
MD5 | 030688ad7cc247eb8f0e3d70bf800f68 |
|
BLAKE2b-256 | 31fc0b12ec6d512120871dcd6c0513eaf4e3afab9f89b79ec02d61c6e0121a30 |