summaryrefslogtreecommitdiffstats
path: root/Python/Dependencies/future-0.18.2/docs/custom_str_methods.rst
diff options
context:
space:
mode:
authoryum <yum.food.vr@gmail.com>2022-12-17 17:26:16 -0800
committeryum <yum.food.vr@gmail.com>2022-12-17 17:26:16 -0800
commit4d836989720523cd0363927e3e066f56b9dc445c (patch)
treef7a9ff7cb50eda1ff29e91c78067dcc5e0ce6233 /Python/Dependencies/future-0.18.2/docs/custom_str_methods.rst
parentda754e9cf5b192239826aa1619e1ada3c98daa45 (diff)
Check in `future` package
I hit some issues installing Whisper and had to embed this package. I haven't taken the time to deeply understand what's going on. I think that embedded Python follows different rules about resolving module paths than regular system Python. Basically, `future`'s setup.py has a line like `import src`, where `src` is a module inside future (like `future/src/__init__.py`). This doesn't work unless we put that directory on the search path.
Diffstat (limited to 'Python/Dependencies/future-0.18.2/docs/custom_str_methods.rst')
-rw-r--r--Python/Dependencies/future-0.18.2/docs/custom_str_methods.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/Python/Dependencies/future-0.18.2/docs/custom_str_methods.rst b/Python/Dependencies/future-0.18.2/docs/custom_str_methods.rst
new file mode 100644
index 0000000..12c3c6b
--- /dev/null
+++ b/Python/Dependencies/future-0.18.2/docs/custom_str_methods.rst
@@ -0,0 +1,27 @@
+.. _custom-str-methods:
+
+Custom __str__ methods
+----------------------
+
+If you define a custom ``__str__`` method for any of your classes,
+functions like ``print()`` expect ``__str__`` on Py2 to return a byte
+string, whereas on Py3 they expect a (unicode) string.
+
+Use the following decorator to map the ``__str__`` to ``__unicode__`` on
+Py2 and define ``__str__`` to encode it as utf-8::
+
+ from future.utils import python_2_unicode_compatible
+
+ @python_2_unicode_compatible
+ class MyClass(object):
+ def __str__(self):
+ return u'Unicode string: \u5b54\u5b50'
+ a = MyClass()
+
+ # This then prints the name of a Chinese philosopher:
+ print(a)
+
+This decorator is identical to the decorator of the same name in
+:mod:`django.utils.encoding`.
+
+This decorator is a no-op on Python 3.