Merge pull request #2382 from erikr/deprecate-fix-ampersands

from __future__ import unicode_literals

import re

import warnings

from django.utils.safestring import SafeData, mark_safe

from django.utils.encoding import force_text, force_str

def fix_ampersands(value):

    """Returns the given HTML with all unencoded ampersands encoded correctly."""

    # As fix_ampersands is wrapped in allow_lazy, stacklevel 3 is more useful than 2.

    warnings.warn("The fix_ampersands function is deprecated and will be removed in Django 1.8.",

                  DeprecationWarning, stacklevel=3)

    return unencoded_ampersands_re.sub('&', force_text(value))

fix_ampersands = allow_lazy(fix_ampersands, six.text_type)

        * Remove stuff like "<p>&nbsp;&nbsp;</p>", but only if it's at the

          bottom of the text.

    """

    # As clean_html is wrapped in allow_lazy, stacklevel 3 is more useful than 2.

    warnings.warn("The clean_html function is deprecated and will be removed in Django 1.8.",

                  DeprecationWarning, stacklevel=3)

    text = normalize_newlines(text)

    text = re.sub(r'<(/?)\s*b\s*>', '<\\1strong>', text)

    text = re.sub(r'<(/?)\s*i\s*>', '<\\1em>', text)

  (``django.contrib.gis.sitemaps.views.index`` and

  ``django.contrib.gis.sitemaps.views.sitemap``).

* ``django.utils.html.fix_ampersands``, the ``fix_ampersands`` template filter and

  ``django.utils.html.clean_html`` will be removed following an accelerated deprecation.

.. _deprecation-removed-in-1.7:

1.7

    This is rarely useful as ampersands are automatically escaped. See

    :tfilter:`escape` for more information.

.. deprecated:: 1.7

    This filter has been deprecated and will be removed in Django 1.8.

Replaces ampersands with ``&`` entities.

For example::

:tfilter:`escapejs` template filter.

If all you need is to generate valid javascript strings, you can simply use

``json.dumps()``.

``fix_ampersands`` utils method and template filter

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``django.utils.html.fix_ampersands`` method and the :tfilter:`fix_ampersands`

template filter are deprecated, as the escaping of ampersands is already taken care

of by Django's standard HTML escaping features. Combining this with ``fix_ampersands``

would either result in double escaping, or, if the output is assumed to be safe,

a risk of introducing XSS vulnerabilities. Along with ``fix_ampersands``,

``django.utils.html.clean_html`` is deprecated, an undocumented function that calls

``fix_ampersands``.

As this is an accelerated deprecation, ``fix_ampersands`` and ``clean_html``

will be removed in Django 1.8.

import datetime

import decimal

import unittest

import warnings

from django.template.defaultfilters import (

    add, addslashes, capfirst, center, cut, date, default, default_if_none,

            'paragraph separator:\\u2029and line separator:\\u2028')

    def test_fix_ampersands(self):

        with warnings.catch_warnings(record=True) as w:

            warnings.simplefilter("always", DeprecationWarning)

            self.assertEqual(fix_ampersands_filter('Jack & Jill & Jeroboam'),

                             'Jack & Jill & Jeroboam')

        self.assertEqual(len(w), 1)

    def test_linenumbers(self):

        self.assertEqual(linenumbers('line 1\nline 2'),