Merge lp:~cjwatson/lazr.restful/remove-safe_js_escape into lp:lazr.restful

[Colin Watson]

Remove lazr.restful.utils.safe_js_escape.

Launchpad hasn't used it since 2012, and it was a confusing interface in that it combined JavaScript and HTML escaping. If any code is still using this, it should use cgi.escape/html.escape (if necessary) and json.dumps directly instead.

[Ioana Lasc (ilasc)]

review: Approve

=== modified file 'NEWS.rst'
--- NEWS.rst	2020-09-03 18:35:08 +0000
+++ NEWS.rst	2020-09-06 23:00:40 +0000
@@ -14,6 +14,12 @@
 Stop ``lazr.restful.utils.make_identifier_safe`` having locale-dependent
 behaviour.
 
+Remove ``lazr.restful.utils.safe_js_escape``.  Launchpad hasn't used it
+since 2012, and it was a confusing interface in that it combined JavaScript
+and HTML escaping.  If any code is still using this, it should use
+``cgi.escape``/``html.escape`` (if necessary) and ``json.dumps`` directly
+instead.
+
 0.22.2 (2020-09-02)
 ===================
 

=== modified file 'src/lazr/restful/docs/utils.rst'
--- src/lazr/restful/docs/utils.rst	2020-09-02 22:22:37 +0000
+++ src/lazr/restful/docs/utils.rst	2020-09-06 23:00:40 +0000
@@ -344,17 +344,3 @@
     “foo”.
     >>> print(smartquote('a lot of "foo"?'))
     a lot of “foo”?
-
-safe_js_escape()
-================
-
-This will escape the given text so that it can be used in Javascript
-code.
-
-    >>> from lazr.restful.utils import safe_js_escape
-    >>> print(safe_js_escape('John "nasty" O\'Brien'))
-    "John "nasty" O'Brien"
-    >>> print(safe_js_escape("John O\'Brien"))
-    "John O'Brien"
-    >>> print(safe_js_escape("John <strong>O\'Brien</strong>"))
-    "John &lt;strong&gt;O'Brien&lt;/strong&gt;"

=== modified file 'src/lazr/restful/utils.py'
--- src/lazr/restful/utils.py	2020-09-03 18:35:08 +0000
+++ src/lazr/restful/utils.py	2020-09-06 23:00:40 +0000
@@ -12,7 +12,6 @@
     'implement_from_dict',
     'make_identifier_safe',
     'parse_accept_style_header',
-    'safe_js_escape',
     'safe_hasattr',
     'smartquote',
     'simple_popen2',
@@ -22,7 +21,6 @@
     ]
 
 
-import cgi
 import collections
 import copy
 import operator
@@ -30,7 +28,6 @@
 import string
 import subprocess
 
-from simplejson import encoder
 import six
 
 from zope.component import getUtility
@@ -367,14 +364,6 @@
     return str
 
 
-def safe_js_escape(text):
-    """Return the given text escaped for use in Javascript code.
-
-    This will also perform a cgi.escape() on the given text.
-    """
-    return encoder.encode_basestring(cgi.escape(text, True))
-
-
 def get_current_browser_request():
     """Return the current browser request, looked up from the interaction.