summaryrefslogtreecommitdiff
path: root/docs/ref/models
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2015-09-25 13:28:12 -0400
committerTim Graham <timograham@gmail.com>2015-09-25 13:28:12 -0400
commitde99f558d806a2a1b30072ec95bc44d412d80dab (patch)
treec4ce0c9de1c22aca12544278fac1e7c0898b8595 /docs/ref/models
parentc42123adb166fd297116880a5322e4e17b11e33f (diff)
Fixed #25462 -- Removed Model.__unicode__() in favor of @python_2_unicode_compatible.
Diffstat (limited to 'docs/ref/models')
-rw-r--r--docs/ref/models/instances.txt69
1 files changed, 8 insertions, 61 deletions
diff --git a/docs/ref/models/instances.txt b/docs/ref/models/instances.txt
index 86438b64bc..16786c09d0 100644
--- a/docs/ref/models/instances.txt
+++ b/docs/ref/models/instances.txt
@@ -588,58 +588,23 @@ Other model instance methods
A few object methods have special purposes.
-.. note::
- On Python 3, as all strings are natively considered Unicode, only use the
- ``__str__()`` method (the ``__unicode__()`` method is obsolete).
- If you'd like compatibility with Python 2, you can decorate your model class
- with :func:`~django.utils.encoding.python_2_unicode_compatible`.
-
-``__unicode__``
----------------
-
-.. method:: Model.__unicode__()
-
-The ``__unicode__()`` method is called whenever you call ``unicode()`` on an
-object. Django uses ``unicode(obj)`` (or the related function, :meth:`str(obj)
-<Model.__str__>`) in a number of places. Most notably, to display an object in
-the Django admin site and as the value inserted into a template when it
-displays an object. Thus, you should always return a nice, human-readable
-representation of the model from the ``__unicode__()`` method.
-
-For example::
-
- from django.db import models
-
- class Person(models.Model):
- first_name = models.CharField(max_length=50)
- last_name = models.CharField(max_length=50)
-
- def __unicode__(self):
- return u'%s %s' % (self.first_name, self.last_name)
-
-If you define a ``__unicode__()`` method on your model and not a
-:meth:`~Model.__str__()` method, Django will automatically provide you with a
-:meth:`~Model.__str__()` that calls ``__unicode__()`` and then converts the
-result correctly to a UTF-8 encoded string object. This is recommended
-development practice: define only ``__unicode__()`` and let Django take care of
-the conversion to string objects when required.
-
``__str__``
-----------
.. method:: Model.__str__()
-The ``__str__()`` method is called whenever you call ``str()`` on an
-object. In Python 3, Django uses ``str(obj)`` in a number of
-places. Most notably, to display an object in the Django admin site
-and as the value inserted into a template when it displays an
-object. Thus, you should always return a nice, human-readable
+The ``__str__()`` method is called whenever you call ``str()`` on an object.
+Django uses ``str(obj)`` in a number of places. Most notably, to display an
+object in the Django admin site and as the value inserted into a template when
+it displays an object. Thus, you should always return a nice, human-readable
representation of the model from the ``__str__()`` method.
For example::
from django.db import models
+ from django.utils.encoding import python_2_unicode_compatible
+ @python_2_unicode_compatible # only if you need to support Python 2
class Person(models.Model):
first_name = models.CharField(max_length=50)
last_name = models.CharField(max_length=50)
@@ -647,26 +612,8 @@ For example::
def __str__(self):
return '%s %s' % (self.first_name, self.last_name)
-In Python 2, the main use of ``__str__`` directly inside Django is
-when the ``repr()`` output of a model is displayed anywhere (for
-example, in debugging output). It isn't required to put ``__str__()``
-methods everywhere if you have sensible :meth:`~Model.__unicode__()`
-methods.
-
-The previous :meth:`~Model.__unicode__()` example could be similarly written
-using ``__str__()`` like this::
-
- from django.db import models
- from django.utils.encoding import force_bytes
-
- class Person(models.Model):
- first_name = models.CharField(max_length=50)
- last_name = models.CharField(max_length=50)
-
- def __str__(self):
- # Note use of django.utils.encoding.force_bytes() here because
- # first_name and last_name will be unicode strings.
- return force_bytes('%s %s' % (self.first_name, self.last_name))
+If you'd like compatibility with Python 2, you can decorate your model class
+with :func:`~django.utils.encoding.python_2_unicode_compatible` as show above.
``__eq__``
----------