cherrypy._cpcompat module

Compatibility code for using CherryPy with various versions of Python.

To retain compatibility with older Python versions, this module provides a useful abstraction over the differences between Python versions, sometimes by preferring a newer idiom, sometimes an older one, and sometimes a custom one.

In particular, Python 2 uses str and ‘’ for byte strings, while Python 3 uses str and ‘’ for unicode strings. We will call each of these the ‘native string’ type for each version. Because of this major difference, this module provides two functions: ‘ntob’, which translates native strings (of type ‘str’) into byte strings regardless of Python version, and ‘ntou’, which translates native strings to unicode strings.

Try not to use the compatibility functions ‘ntob’, ‘ntou’, ‘tonative’. They were created with Python 2.3-2.5 compatibility in mind. Instead, use unicode literals (from __future__) and bytes literals and their .encode/.decode methods as needed.

cherrypy._cpcompat.assert_native(n)

Ensure that input is a native str.

cherrypy._cpcompat.ntob(n, encoding='ISO-8859-1')

Convert a native str to a bytes instance.

The encoding can be changed to non-ASCII optionally.

cherrypy._cpcompat.ntou(n, encoding='ISO-8859-1')

Convert a native str to a str instance.

This doesn’t actually do anything.

cherrypy._cpcompat.tonative(n, encoding='ISO-8859-1')

Return the given string as a native string in the given encoding.