summaryrefslogtreecommitdiff
path: root/docs/topics
diff options
context:
space:
mode:
authorClaude Paroz <claude@2xlibre.net>2014-04-26 16:00:15 +0200
committerClaude Paroz <claude@2xlibre.net>2014-04-26 16:03:40 +0200
commite441cebce340f54741be957817cc034000deab3c (patch)
tree0a1b9730a86f6a3660961e220cd099494f9fd8f2 /docs/topics
parentabd68b5affaec35e941b49f1b0a4cb8d70c22d7b (diff)
[1.7.x] Updated doc links to point to Python 3 documentation
Backport of 680a0f08b from master.
Diffstat (limited to 'docs/topics')
-rw-r--r--docs/topics/db/examples/many_to_many.txt2
-rw-r--r--docs/topics/i18n/timezones.txt5
-rw-r--r--docs/topics/python3.txt31
-rw-r--r--docs/topics/testing/tools.txt11
4 files changed, 25 insertions, 24 deletions
diff --git a/docs/topics/db/examples/many_to_many.txt b/docs/topics/db/examples/many_to_many.txt
index cd38d57b45..79605ac158 100644
--- a/docs/topics/db/examples/many_to_many.txt
+++ b/docs/topics/db/examples/many_to_many.txt
@@ -78,7 +78,7 @@ Adding a second time is OK::
>>> a2.publications.add(p3)
-Adding an object of the wrong type raises :exc:`~exceptions.TypeError`::
+Adding an object of the wrong type raises :exc:`TypeError`::
>>> a2.publications.add(a1)
Traceback (most recent call last):
diff --git a/docs/topics/i18n/timezones.txt b/docs/topics/i18n/timezones.txt
index 839813a823..23b0f197a1 100644
--- a/docs/topics/i18n/timezones.txt
+++ b/docs/topics/i18n/timezones.txt
@@ -460,9 +460,8 @@ zone support.
Fixtures generated with ``USE_TZ = False``, or before Django 1.4, use the
"naive" format. If your project contains such fixtures, after you enable time
-zone support, you'll see :exc:`~exceptions.RuntimeWarning`\ s when you load
-them. To get rid of the warnings, you must convert your fixtures to the "aware"
-format.
+zone support, you'll see :exc:`RuntimeWarning`\ s when you load them. To get
+rid of the warnings, you must convert your fixtures to the "aware" format.
You can regenerate fixtures with :djadmin:`loaddata` then :djadmin:`dumpdata`.
Or, if they're small enough, you can simply edit them to add the UTC offset
diff --git a/docs/topics/python3.txt b/docs/topics/python3.txt
index 15c07ccbf0..c10f2b42ab 100644
--- a/docs/topics/python3.txt
+++ b/docs/topics/python3.txt
@@ -78,8 +78,8 @@ wherever possible and avoid the ``b`` prefixes.
String handling
---------------
-Python 2's :func:`unicode` type was renamed :func:`str` in Python 3,
-:func:`str` was renamed ``bytes()``, and :func:`basestring` disappeared.
+Python 2's `unicode`_ type was renamed :class:`str` in Python 3,
+``str()`` was renamed :func:`bytes`, and `basestring`_ disappeared.
six_ provides :ref:`tools <string-handling-with-six>` to deal with these
changes.
@@ -131,35 +131,34 @@ and ``SafeText`` respectively.
For forwards compatibility, the new names work as of Django 1.4.2.
-:meth:`~object.__str__` and :meth:`~object.__unicode__` methods
----------------------------------------------------------------
+:meth:`~object.__str__` and ` __unicode__()`_ methods
+-----------------------------------------------------
In Python 2, the object model specifies :meth:`~object.__str__` and
-:meth:`~object.__unicode__` methods. If these methods exist, they must return
+` __unicode__()`_ methods. If these methods exist, they must return
``str`` (bytes) and ``unicode`` (text) respectively.
-The ``print`` statement and the :func:`str` built-in call
+The ``print`` statement and the :class:`str` built-in call
:meth:`~object.__str__` to determine the human-readable representation of an
-object. The :func:`unicode` built-in calls :meth:`~object.__unicode__` if it
+object. The ``unicode`` built-in calls ` __unicode__()`_ if it
exists, and otherwise falls back to :meth:`~object.__str__` and decodes the
result with the system encoding. Conversely, the
:class:`~django.db.models.Model` base class automatically derives
-:meth:`~object.__str__` from :meth:`~object.__unicode__` by encoding to UTF-8.
+:meth:`~object.__str__` from ` __unicode__()`_ by encoding to UTF-8.
In Python 3, there's simply :meth:`~object.__str__`, which must return ``str``
(text).
-(It is also possible to define ``__bytes__()``, but Django application have
-little use for that method, because they hardly ever deal with
-``bytes``.)
+(It is also possible to define :meth:`~object.__bytes__`, but Django application
+have little use for that method, because they hardly ever deal with ``bytes``.)
Django provides a simple way to define :meth:`~object.__str__` and
-:meth:`~object.__unicode__` methods that work on Python 2 and 3: you must
+` __unicode__()`_ methods that work on Python 2 and 3: you must
define a :meth:`~object.__str__` method returning text and to apply the
:func:`~django.utils.encoding.python_2_unicode_compatible` decorator.
On Python 3, the decorator is a no-op. On Python 2, it defines appropriate
-:meth:`~object.__unicode__` and :meth:`~object.__str__` methods (replacing the
+` __unicode__()`_ and :meth:`~object.__str__` methods (replacing the
original :meth:`~object.__str__` method in the process). Here's an example::
from __future__ import unicode_literals
@@ -233,7 +232,7 @@ In order to enable the same behavior in Python 2, every module must import
my_bytestring = b"This is a bytestring"
If you need a byte string literal under Python 2 and a unicode string literal
-under Python 3, use the :func:`str` builtin::
+under Python 3, use the :class:`str` builtin::
str('my string')
@@ -402,3 +401,7 @@ extras.
In addition to six' defaults moves, Django's version provides ``thread`` as
``_thread`` and ``dummy_thread`` as ``_dummy_thread``.
+
+.. _unicode: http://docs.python.org/2/library/functions.html#unicode
+.. _ __unicode__(): https://docs.python.org/2/reference/datamodel.html#object.__unicode__
+.. _basestring: http://docs.python.org/2/library/functions.html#basestring
diff --git a/docs/topics/testing/tools.txt b/docs/topics/testing/tools.txt
index e217245f4a..223fcd45a8 100644
--- a/docs/topics/testing/tools.txt
+++ b/docs/topics/testing/tools.txt
@@ -77,8 +77,7 @@ Note a few important things about how the test client works:
The test client is not capable of retrieving Web pages that are not
powered by your Django project. If you need to retrieve other Web pages,
- use a Python standard library module such as :mod:`urllib` or
- :mod:`urllib2`.
+ use a Python standard library module such as :mod:`urllib`.
* To resolve URLs, the test client uses whatever URLconf is pointed-to by
your :setting:`ROOT_URLCONF` setting.
@@ -479,9 +478,9 @@ can access these properties as part of a test condition.
.. attribute:: Client.cookies
- A Python :class:`~Cookie.SimpleCookie` object, containing the current values
- of all the client cookies. See the documentation of the :mod:`Cookie` module
- for more.
+ A Python :class:`~http.cookies.SimpleCookie` object, containing the current
+ values of all the client cookies. See the documentation of the
+ :mod:`http.cookies` module for more.
.. attribute:: Client.session
@@ -1247,7 +1246,7 @@ your test suite.
Asserts that execution of callable ``callable_obj`` raised the
``expected_exception`` exception and that such exception has an
``expected_message`` representation. Any other outcome is reported as a
- failure. Similar to unittest's :meth:`~unittest.TestCase.assertRaisesRegexp`
+ failure. Similar to unittest's :meth:`~unittest.TestCase.assertRaisesRegex`
with the difference that ``expected_message`` isn't a regular expression.
.. method:: SimpleTestCase.assertFieldOutput(fieldclass, valid, invalid, field_args=None, field_kwargs=None, empty_value=u'')