summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorAymeric Augustin <aymeric.augustin@m4x.org>2012-08-18 16:36:55 +0200
committerAymeric Augustin <aymeric.augustin@m4x.org>2012-08-18 16:38:49 +0200
commita120fac65a17137bc8ac710477478474e3f9973e (patch)
tree338c9ad149e43accbf8432f12eda66aa2ce73fba /docs/ref
parentf04bb6d798b07aa5e7c1d99d700fa6ddc7d39e62 (diff)
Introduced force_bytes and force_str.
This is consistent with the smart_* series of functions and it's going to be used by the next commit.
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/utils.txt17
1 files changed, 16 insertions, 1 deletions
diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt
index 775d70738b..de19578cac 100644
--- a/docs/ref/utils.txt
+++ b/docs/ref/utils.txt
@@ -240,14 +240,29 @@ The functions defined in this module share the following properties:
If ``strings_only`` is ``True``, don't convert (some) non-string-like
objects.
+.. function:: force_bytes(s, encoding='utf-8', strings_only=False, errors='strict')
+
+ .. versionadded:: 1.5
+
+ Similar to ``smart_bytes``, except that lazy instances are resolved to
+ bytestrings, rather than kept as lazy objects.
+
+ If ``strings_only`` is ``True``, don't convert (some) non-string-like
+ objects.
+
.. function:: smart_str(s, encoding='utf-8', strings_only=False, errors='strict')
Alias of :func:`smart_bytes` on Python 2 and :func:`smart_text` on Python
- 3. This function always returns a :class:`str`.
+ 3. This function returns a :class:`str` or a lazy string.
For instance, this is suitable for writing to :attr:`sys.stdout` on
Python 2 and 3.
+.. function:: force_str(s, encoding='utf-8', strings_only=False, errors='strict')
+
+ Alias of :func:`force_bytes` on Python 2 and :func:`force_text` on Python
+ 3. This function always returns a :class:`str`.
+
.. function:: iri_to_uri(iri)
Convert an Internationalized Resource Identifier (IRI) portion to a URI