1#############################################################################
2##
3## Copyright (c) 2021 Riverbank Computing Limited <info@riverbankcomputing.com>
4##
5## This file is part of PyQt5.
6##
7## This file may be used under the terms of the GNU General Public License
8## version 3.0 as published by the Free Software Foundation and appearing in
9## the file LICENSE included in the packaging of this file.  Please review the
10## following information to ensure the GNU General Public License version 3.0
11## requirements will be met: http://www.gnu.org/copyleft/gpl.html.
12##
13## If you do not wish to use this file under the terms of the GPL version 3.0
14## then you may purchase a commercial license.  For more information contact
15## info@riverbankcomputing.com.
16##
17## This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
18## WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
19##
20#############################################################################
21
22
23import re
24
25
26def as_string(obj):
27    if isinstance(obj, basestring):
28        return '"' + _escape(obj.encode('UTF-8')) + '"'
29
30    return str(obj)
31
32
33_esc_regex = re.compile(r"(\"|\'|\\)")
34
35def _escape(text):
36    # This escapes any escaped single or double quote or backslash.
37    x = _esc_regex.sub(r"\\\1", text)
38
39    # This replaces any '\n' with an escaped version and a real line break.
40    return re.sub(r'\n', r'\\n"\n"', x)
41