Process escape sequences in a string in Python
Asked Answered
S

8

174

Sometimes when I get input from a file or the user, I get a string with escape sequences in it. I would like to process the escape sequences in the same way that Python processes escape sequences in string literals.

For example, let's say myString is defined as:

>>> myString = "spam\\neggs"
>>> print(myString)
spam\neggs

I want a function (I'll call it process) that does this:

>>> print(process(myString))
spam
eggs

It's important that the function can process all of the escape sequences in Python (listed in a table in the link above).

Does Python have a function to do this?

Shayne answered 26/10, 2010 at 3:43 Comment(10)
hmmm, how exactly would you expect a string containing 'spam'+"eggs"+'''some'''+"""more""" to be processed?Supposing
@Nas Banov That's a good test. That string contains no escape sequences, so it should be exactly the same after processing. myString = "'spam'+\"eggs\"+'''some'''+\"\"\"more\"\"\"", print(bytes(myString, "utf-8").decode("unicode_escape")) seems to work.Shayne
Most answers to this question have serious problems. There seems to be no standard way to honor escape sequences in Python without breaking unicode. The answer posted by @rspeer is the one that I adopted for Grako as it so far handles all known cases.Recor
I disagree with Apalala; using unicode_escape (on a properly latin1-encoded input) is completely reliable, and as the issue that Hack5 links to in his comment to user19087's answer shows, is the method recommended by the python developers.Exam
Related: how do I .decode('string-escape') in Python3?Camelopardus
Related: #63219487Thebaid
Related: #43662974Thebaid
Note that most of these approaches will work with bytes input - for the ones that involve converting to bytes first, just skip that step. Similarly, str output can be converted to bytes if needed by simply using an appropriate encoding - latin-1 is probably what you want.Thebaid
For the opposite problem - converting from "special" characters into escape sequences - see Python print string like a raw string. However, note that this is not a round-trip conversion; there are multiple ways to represent a given string with escape sequences, and only one of them is particularly easy to get.Thebaid
Maybe you can try using eval? For example, print(eval('"spam\\neggs"')) prints your desired output, and of course you may need to add/adjust some quotes before/after your original string.Hourigan
S
185

The correct thing to do is use the 'string-escape' code to decode the string.

>>> myString = "spam\\neggs"
>>> decoded_string = bytes(myString, "utf-8").decode("unicode_escape") # python3 
>>> decoded_string = myString.decode('string_escape') # python2
>>> print(decoded_string)
spam
eggs

Don't use the AST or eval. Using the string codecs is much safer.

Semiprofessional answered 26/10, 2010 at 5:1 Comment(15)
hands down, the best solution! btw, by docs it should be "string_escape" (with underscore) but for some reason accepts anything in the pattern 'string escape', 'string@escape" and whatnot... basically 'string\W+escape'Supposing
@Nas Banov The documentation does make a small mention about that: Notice that spelling alternatives that only differ in case or use a hyphen instead of an underscore are also valid aliases; therefore, e.g. 'utf-8' is a valid alias for the 'utf_8' codec.Shayne
In Python 3, the command needs to be print(bytes(myString, "utf-8").decode("unicode_escape"))Shayne
@Shayne Does it work with non-ascii characters? I have some non-ascii chars with \\t. In python2, string-escape just works for that. But in python3, the codec is removed. And the unicode-escape just escapes all non-ascii bytes and breaks my encoding.Coplanar
In Python 2.7, myStr.decode('unicode_escape') seems better than myStr.decode('string_escape'), because it will also unescape unicode \udddd escape sequences into actual unicode characters. For example, r"\u2014").decode('unicode_escape') yields u"\u2014". string_escape, in contrast, leaves unicode escapes untouched. Though note that (at least in my locale) while I can put non-ASCII unicode escapes in myStr, I can't put actual non-ASCII characters in myStr, or decode will give me "UnicodeEncodeError: 'ascii' codec can't encode character" problems.Calumnious
This solution is not good enough because it doesn't handle the case in which there are legit unicode characters in the original string. If you try: >>> print("juancarlo\\tañez".encode('utf-8').decode('unicode_escape')) You get: juancarlo añezRecor
Agreed with @Apalala: this is not good enough. Check out rseeper's answer below for a complete solution that works in Python2 and 3!Alcyone
Since latin1 is assumed by unicode_escape, redo the encode/decode bit, e.g. s.encode('utf-8').decode('unicode_escape').encode('latin1').decode('utf8')Cadence
@Cadence As stated in my answer, that doesn't work if your string contains any characters that aren't in latin-1.Horodko
@Horodko the whole string when being decoded as unicode_escape is bytes, which means it doesn't have any encoding, but unicode_escape is a valid codec which would produce the same bytes as unicode encoded in latin1 from the input string. For ease of illustration please look at this example and see how that actually works through every single step (to ease the effort from having to manually try it on your end). Hence I said "redo the encode/decode bit".Cadence
@Cadence Oh, I see! Yes, that actually does work. Nice.Horodko
Just wanted to note that metatoaster is correct, unicode_escape does need a latin-1 coded byte sequence, but it's not necessary to make two roundtrips between strings and byte sequences (see alternate answer for python3).Exam
@Cadence But isn't your solution still a bit fragile, since s.encode('utf-8') encodes the output in utf-8 and decode('unicode_escape') assumes the input is latin-1? Is it possible that the utf-8 encoding introduces some backslash bytes? It would probably work fine most of the time, but if the input string included a unicode character that when utf-8 encoded included a 0x5c latin-1 backslash character, that backslash would get escaped, which would then probably break the final decode('utf-8').Flabbergast
@DonovanBaarda no, there are no multi-byte utf-8 representation of any unicode codepoints > 127 that produce bytes within the ascii range (0-127), as all multi-byte characters are in the range 128-255 (i.e. 0x80 - 0xff) because the designers of unicode and utf-8 understood this exact issue. In other words, no, it is impossible to for str.encode('utf-8') to produce the bytes b'\x5c' (0x5c) from anything other than the unicode codepoint U+005C.Cadence
Tried using codecs.decode(myString, 'unicode-escape'), since codecs.decode accepts Unicode input directly. Turns out that still fails on input outside the ASCII range, in the exact same way Apalala pointed out the current version of the answer already fails.Hinkle
H
170

unicode_escape doesn't work in general

It turns out that the string_escape or unicode_escape solution does not work in general -- particularly, it doesn't work in the presence of actual Unicode.

If you can be sure that every non-ASCII character will be escaped (and remember, anything beyond the first 128 characters is non-ASCII), unicode_escape will do the right thing for you. But if there are any literal non-ASCII characters already in your string, things will go wrong.

unicode_escape is fundamentally designed to convert bytes into Unicode text. But in many places -- for example, Python source code -- the source data is already Unicode text.

The only way this can work correctly is if you encode the text into bytes first. UTF-8 is the sensible encoding for all text, so that should work, right?

The following examples are in Python 3, so that the string literals are cleaner, but the same problem exists with slightly different manifestations on both Python 2 and 3.

>>> s = 'naïve \\t test'
>>> print(s.encode('utf-8').decode('unicode_escape'))
naïve   test

Well, that's wrong.

The new recommended way to use codecs that decode text into text is to call codecs.decode directly. Does that help?

>>> import codecs
>>> print(codecs.decode(s, 'unicode_escape'))
naïve   test

Not at all. (Also, the above is a UnicodeError on Python 2.)

The unicode_escape codec, despite its name, turns out to assume that all non-ASCII bytes are in the Latin-1 (ISO-8859-1) encoding. So you would have to do it like this:

>>> print(s.encode('latin-1').decode('unicode_escape'))
naïve    test

But that's terrible. This limits you to the 256 Latin-1 characters, as if Unicode had never been invented at all!

>>> print('Ernő \\t Rubik'.encode('latin-1').decode('unicode_escape'))
UnicodeEncodeError: 'latin-1' codec can't encode character '\u0151'
in position 3: ordinal not in range(256)

Adding a regular expression to solve the problem

(Surprisingly, we do now have two problems.)

What we need to do is only apply the unicode_escape decoder to things that we are certain to be ASCII text. In particular, we can make sure only to apply it to valid Python escape sequences, which are guaranteed to be ASCII text.

The plan is, we'll find escape sequences using a regular expression, and use a function as the argument to re.sub to replace them with their unescaped value.

import re
import codecs

ESCAPE_SEQUENCE_RE = re.compile(r'''
    ( \\U........      # 8-digit hex escapes
    | \\u....          # 4-digit hex escapes
    | \\x..            # 2-digit hex escapes
    | \\[0-7]{1,3}     # Octal escapes
    | \\N\{[^}]+\}     # Unicode characters by name
    | \\[\\'"abfnrtv]  # Single-character escapes
    )''', re.UNICODE | re.VERBOSE)

def decode_escapes(s):
    def decode_match(match):
        return codecs.decode(match.group(0), 'unicode-escape')

    return ESCAPE_SEQUENCE_RE.sub(decode_match, s)

And with that:

>>> print(decode_escapes('Ernő \\t Rubik'))
Ernő     Rubik
Horodko answered 1/7, 2014 at 21:12 Comment(15)
we need more encompassing types of answers like that. thanks.Eglantine
Does this work with os.sep at all? I'm trying to do this: patt = '^' + self.prefix + os.sep ; name = sub(decode_escapes(patt), '', name) and it's not working. Semicolon is there in place of a new line.Overblown
@Pureferret I'm not really sure what you're asking, but you probably shouldn't run this on strings where the backslash has a different meaning, such as Windows file paths. (Is that what your os.sep is?) If you have backslashed escape sequences in your Windows directory names, the situation is pretty much unrecoverable.Horodko
The escape sequence doesn't have escapes in them, but I'm getting a 'bogus escape string ' errorOverblown
That tells me that you ended some other regular expression with a backslash: #4427674Horodko
This doesn't work for me, as unicode-escape doesn't do the right thing: test = "\\xe2\\x80\\xa6" test_bytes = test.encode() test = test_bytes.decode("unicode-escape") Values: test_bytes == b'\\xe2\\x80\\xa6' test == 'â¦'Bowen
@MarkIngram -- this regular expression is a Unicode regular expression about Unicode escapes, where \xe2 actually means "unicode character E2" instead of "byte E2". It's not about bytes. If you were able to get it to try to match a byte string, you must have changed the code or used Python 2 coercion.Horodko
@Horodko Did you try my example with Python3? That's what I was using, and that short example doesn't work.Bowen
@MarkIngram Yes, I'm using Python 3. I don't understand the relevance of the example you posted, which is doing something unrelated to my code. My code doesn't use bytestrings at any step.Horodko
What you have there, by the way, is a bytestring that's the escape-encoding of another bytestring, which is itself the UTF-8 encoding of some unicode. If you need help decoding it, ask it as a separate question.Horodko
just for us lambda's: ESCAPE_SEQUENCE_RE.sub(lambda match: codecs.decode(match.group(0), 'unicode-escape'), s)Bosun
Doesn't work for me... the print statement is doing the conversion, not the function itself?Nonalignment
If we are throwing regular expressions at the problem, why include the unicode_escape codec in the solution at all? In that case, just (re)implement the escape conventions directly with a regular expression. But then the approach is not "DRY" -- the language and the reimplementing regexp might diverge. Better to rely only on the language-internal unicode_escape codec, properly applied to a latin-1 encoding as documented.Exam
@GlenWhitney: That fails on input that cannot be latin-1 encoded. latin-1 only handles a tiny fraction of the full Unicode range.Hinkle
I respectfully disagree; see Karl Knechtel's comment to the answer I posted: "non-latin-1 characters are turned into escape sequences via the 'backslashreplace' error handling." Also what Karl says is true, that solution will fail on input that ends in a backslash, for example, but then the input wasn't actually composed of valid Python escape sequences, so I don't think there is an unambiguous answer. If you have a specific case where using the unicode_escape codec as shown below doesn't work, please comment on the answer I posted and I will be happy to look at it.Exam
Z
47

The actually correct and convenient answer for python 3:

>>> import codecs
>>> myString = "spam\\neggs"
>>> print(codecs.escape_decode(bytes(myString, "utf-8"))[0].decode("utf-8"))
spam
eggs
>>> myString = "naïve \\t test"
>>> print(codecs.escape_decode(bytes(myString, "utf-8"))[0].decode("utf-8"))
naïve    test

Details regarding codecs.escape_decode:

  • codecs.escape_decode is a bytes-to-bytes decoder
  • codecs.escape_decode decodes ascii escape sequences, such as: b"\\n" -> b"\n", b"\\xce" -> b"\xce".
  • codecs.escape_decode does not care or need to know about the byte object's encoding, but the encoding of the escaped bytes should match the encoding of the rest of the object.

Background:

  • @rspeer is correct: unicode_escape is the incorrect solution for python3. This is because unicode_escape decodes escaped bytes, then decodes bytes to unicode string, but receives no information regarding which codec to use for the second operation.
  • @Jerub is correct: avoid the AST or eval.
  • I first discovered codecs.escape_decode from this answer to "how do I .decode('string-escape') in Python3?". As that answer states, that function is currently not documented for python 3.
Zephyr answered 5/5, 2016 at 20:27 Comment(5)
This is the real answer (: Too bad it relies upon a poorly-documented function.Coddle
This is the answer for situations where the escape sequences you have are \x escapes of UTF-8 bytes. But because it decodes bytes to bytes, it doesn't -- and can't -- decode any escapes of non-ASCII Unicode characters, such as \u escapes.Horodko
Just an FYI, this function is technically not public. see bugs.python.org/issue30588Edam
Moreover, in the link that Hack5 provides, the python maintainers make it clear that escape_decode may be removed without warning in any future version, and that the "unicode_escape" codec is the recommended way to go about this.Exam
Interestingly, six years later escape-decoderemains undocumented!Ever
G
11

The ast.literal_eval function comes close, but it will expect the string to be properly quoted first.

Of course Python's interpretation of backslash escapes depends on how the string is quoted ("" vs r"" vs u"", triple quotes, etc) so you may want to wrap the user input in suitable quotes and pass to literal_eval. Wrapping it in quotes will also prevent literal_eval from returning a number, tuple, dictionary, etc.

Things still might get tricky if the user types unquoted quotes of the type you intend to wrap around the string.

Gabriellegabrielli answered 26/10, 2010 at 3:50 Comment(2)
I see. This seems to be potentially dangerous as you say: myString = "\"\ndoBadStuff()\n\"", print(ast.literal_eval('"' + myString + '"')) seems to try to run code. How is ast.literal_eval any different/safer than eval?Shayne
@dln385: literal_eval never executes code. From the documentation, "This can be used for safely evaluating strings containing Python expressions from untrusted sources without the need to parse the values oneself."Gabriellegabrielli
E
4

The (currently) accepted answer by Jerub is correct for python2, but incorrect and may produce garbled results (as Apalala points out in a comment to that solution), for python3. That's because the unicode_escape codec requires its source to be coded in latin-1, not utf-8, as per the official python docs. Hence, in python3 use:

>>> myString="špåm\\nëðþ\\x73"
>>> print(myString)
špåm\nëðþ\x73
>>> decoded_string = myString.encode('latin-1','backslashreplace').decode('unicode_escape')
>>> print(decoded_string)
špåm
ëðþs

This method also avoids the extra unnecessary roundtrip between strings and bytes in metatoaster's comments to Jerub's solution (but hats off to metatoaster for recognizing the bug in that solution).

Exam answered 17/12, 2020 at 1:26 Comment(5)
When I posted this, I did not realize there was a duplicate question for which this exact answer had already been given: https://mcmap.net/q/144569/-how-to-un-escape-a-backslash-escaped-string-duplicateExam
The important thing here is not just that latin-1 is used, but that non-latin-1 characters are turned into escape sequences via the 'backslashreplace' error handling. This just happens to give the exact format that the .decode step is trying to replace. So this works with, for example, myString='日本\u8a9e', correctly giving 日本語. However, it doesn't handle the truly nasty cases described in my answer.Thebaid
(On the other hand, it certainly can be argued that input with a single trailing backslash should fail...)Thebaid
Is it really always latin-1, or does it depend on the default encoding for your particular version of Python? Is this true even on Linux for example?Earp
Well, in the table in the python docs that I link to above, in the 'unicode_escape' entry, it states "Decode from Latin-1 source code." So that seems pretty clear/definitive to me...Exam
T
1

Quote the string properly so that it looks like the equivalent Python string literal, and then use ast.literal_eval. This is safe, but much trickier to get right than you might expect.

It's easy enough to add a " to the beginning and end of the string, but we also need to make sure that any " inside the string are properly escaped. If we want fully Python-compliant translation, we need to account for the deprecated behaviour of invalid escape sequences.

It works out that we need to add one backslash to:

  • any sequence of an even number of backslashes followed by a double-quote (so that we escape a quote if needed, but don't escape a backslash and un-escape the quote if it was already escaped); as well as

  • a sequence of an odd number of backslashes at the end of the input (because otherwise a backslash would escape our enclosing double-quote).

Here is an acid-test input showing a bunch of difficult cases:

>>> text = r'''\\ \ \" \\" \\\" \'你好'\n\u062a\xff\N{LATIN SMALL LETTER A}"''' + '\\'
>>> text
'\\\\ \\ \\" \\\\" \\\\\\" \\\'你好\'\\n\\u062a\\xff\\N{LATIN SMALL LETTER A}"\\'
>>> print(text)
\\ \ \" \\" \\\" \'你好'\n\u062a\xff\N{LATIN SMALL LETTER A}"\

I was eventually able to work out a regex that handles all these cases properly, allowing literal_eval to be used:

>>> def parse_escapes(text):
...     fixed_escapes = re.sub(r'(?<!\\)(\\\\)*("|\\$)', r'\\\1\2', text)
...     return ast.literal_eval(f'"{fixed_escapes}"')
... 

Testing the results:

>>> parse_escapes(text)
'\\ \\ " \\" \\" \'你好\'\nتÿa"\\'
>>> print(parse_escapes(text))
\ \ " \" \" '你好'
تÿa"\

This should correctly handle everything - strings containing both single and double quotes, every weird situation with backslashes, and non-ASCII characters in the input. (I admit it's a bit difficult to verify the results by eye!)

Thebaid answered 5/8, 2022 at 1:14 Comment(0)
M
0

This is a bad way of doing it, but it worked for me when trying to interpret escaped octals passed in a string argument.

input_string = eval('b"' + sys.argv[1] + '"')

It's worth mentioning that there is a difference between eval and ast.literal_eval (eval being way more unsafe). See Using python's eval() vs. ast.literal_eval()?

Muff answered 4/3, 2019 at 22:45 Comment(1)
Just to make sure the warning is up front: Please do not use eval for input that could ever possibly come from outside the program. It allows the user supplying that input to run arbitrary code on your computer. It is not at all trivial to sandbox.Thebaid
D
-3

Below code should work for \n is required to be displayed on the string.

import string

our_str = 'The String is \\n, \\n and \\n!'
new_str = string.replace(our_str, '/\\n', '/\n', 1)
print(new_str)
Dakota answered 26/3, 2018 at 9:42 Comment(1)
This doesn't work as written (the forward slashes make the replace do nothing), uses wildly outdated APIs (the string module functions of this sort are deprecated as of Python 2.0, replaced by the str methods, and gone completely in Python 3), and only handles the specific case of replacing a single newline, not general escape processing.Effy

© 2022 - 2024 — McMap. All rights reserved.