ChatGPT解决这个技术问题 Extra ChatGPT

Why can't Python's raw string literals end with a single backslash?

Technically, any odd number of backslashes, as described in the documentation.

>>> r'\'
  File "<stdin>", line 1
    r'\'
       ^
SyntaxError: EOL while scanning string literal
>>> r'\\'
'\\\\'
>>> r'\\\'
  File "<stdin>", line 1
    r'\\\'
         ^
SyntaxError: EOL while scanning string literal

It seems like the parser could just treat backslashes in raw strings as regular characters (isn't that what raw strings are all about?), but I'm probably missing something obvious.

looks like this is now a faq. might not have been when you asked the question. i know the docs you cited say pretty much the same thing, but i just thought i would add another source of documentation.
@oob And that doc clearly explains they were meant primarily for regular expressions (which shouldn't end with a backslash) not Windows paths, which should.

F
Faheem Mitha

The whole misconception about python's raw strings is that most of people think that backslash (within a raw string) is just a regular character as all others. It is NOT. The key to understand is this python's tutorial sequence:

When an 'r' or 'R' prefix is present, a character following a backslash is included in the string without change, and all backslashes are left in the string

So any character following a backslash is part of raw string. Once parser enters a raw string (non Unicode one) and encounters a backslash it knows there are 2 characters (a backslash and a char following it).

This way:

r'abc\d' comprises a, b, c, \, d r'abc\'d' comprises a, b, c, \, ', d r'abc\'' comprises a, b, c, \, '

and:

r'abc\' comprises a, b, c, \, ' but there is no terminating quote now.

Last case shows that according to documentation now a parser cannot find closing quote as the last quote you see above is part of the string i.e. backslash cannot be last here as it will 'devour' string closing char.


So I understand the mechanics but why? why is it implemented so? I do not see rational behind this. So the explanation above tells us that essentially raw-string makes everything inside the quotation mark as itself but backslash can't not appear as the last character. So why? So that make it sure that it can not be used a s a file path string????
As I read further down the page, I found it has the purpose of having quotation mark in the string ,then again, why can't I put just a quotation mark but I have to put in a set with backslash in front of it? I figure there must be reasons for it, maybe related to regex expressions?
I think if it is not related to regular expression, it is a design flaw since there are another options to take, like doubling quotation marks, like using "" for " like in most .csv files. x = r"I have ""an apple""" stands for I have "an apple". One problem is python allows something like a="a""b" or a="a" "b" resulting in a="ab". So to use doubling quotation marks, python needs to ban use case of a="a""b".
I suggest to include one more: r'abc\\' comprises a, b, c, \, \
c
cdleary

The reason is explained in the part of that section which I highlighted in bold:

String quotes can be escaped with a backslash, but the backslash remains in the string; for example, r"\"" is a valid string literal consisting of two characters: a backslash and a double quote; r"\" is not a valid string literal (even a raw string cannot end in an odd number of backslashes). Specifically, a raw string cannot end in a single backslash (since the backslash would escape the following quote character). Note also that a single backslash followed by a newline is interpreted as those two characters as part of the string, not as a line continuation.

So raw strings are not 100% raw, there is still some rudimentary backslash-processing.


Oh wow... that's weird. Nice catch. Makes sense that r'\'' == "\\'" but it's still strange that the escape character has an effect without disappearing.
@ihightower this may work for file system paths, but there are other uses of the backslash. And for file system paths, don't hardcode the separator. Use 'os.path.sep', or better the higher level features of 'os.path'. (Or 'pathlib', when available)
Note: Workaround is to use adjacent literal concatentation. r"foo\bar\baz" "\\" (wrap in parens if ambiguous) will create a single literal at compile time, the first part of which is raw, and only the last tiny bit is non-raw, to allow the trailing backslash.
IMO this just restates the question (what is allowed/will work, and what not), without saying why it's designed this way. There's a FAQ entry that sort of explains the why (raw strings were designed for a specific purpose, and it makes sense in the context of that purpose).
What's the point of raw strings then? Seems like a shady implementation of the concept.
h
hasen

That's the way it is! I see it as one of those small defects in python!

I don't think there's a good reason for it, but it's definitely not parsing; it's really easy to parse raw strings with \ as a last character.

The catch is, if you allow \ to be the last character in a raw string then you won't be able to put " inside a raw string. It seems python went with allowing " instead of allowing \ as the last character.

However, this shouldn't cause any trouble.

If you're worried about not being able to easily write windows folder pathes such as c:\mypath\ then worry not, for, you can represent them as r"C:\mypath", and, if you need to append a subdirectory name, don't do it with string concatenation, for it's not the right way to do it anyway! use os.path.join

>>> import os
>>> os.path.join(r"C:\mypath", "subfolder")
'C:\\mypath\\subfolder'

Good ancillary material. :-) Devil's advocate, though: sometimes you want to differentiate file paths from directory paths by appending the path separator. Nice thing about os.path.join is that it will collapse them: assert os.path.join('/home/cdleary/', 'foo/', 'bar/') == '/home/cdleary/foo/bar/'
It doesn't make a (technical) difference though! os.path.isdir will tell you whether a certain path is a directory (folder)
Yep, it's just to indicate to someone reading the code whether you expect a path to be a directory or a file.
The convention on windows is that files have an extension, always. it's not likely at all (under normal circumstances) to have a text file with a path such as c:\path\data
..or you can represent them as "c:/mypath" and forget your backslash woes altogether :-)
C
Charles Beattie

In order for you to end a raw string with a slash I suggest you can use this trick:

>>> print r"c:\test"'\\'
test\

f
famousgarkin

Another trick is to use chr(92) as it evaluates to "\".

I recently had to clean a string of backslashes and the following did the trick:

CleanString = DirtyString.replace(chr(92),'')

I realize that this does not take care of the "why" but the thread attracts many people looking for a solution to an immediate problem.


But what if the original string contains backslashes?
chr(92) is awfully obscure, probably better to use "\\" (non-raw string with backslash)
B
Brian R. Bondy

Since \" is allowed inside the raw string. Then it can't be used to identify the end of the string literal.

Why not stop parsing the string literal when you encounter the first "?

If that was the case, then \" wouldn't be allowed inside the string literal. But it is.


Exactly. Python designers likely evaluated the liklihood of the two alternatives: the two-character sequence \" anywhere within a double-quoted raw string, OR \ at end of double-quoted raw string. The usage statistics must favor the two character sequence anywhere vs. the one-character sequence at the end.
G
Gumbo

The reason for why r'\' is syntactical incorrect is that although the string expression is raw the used quotes (single or double) always have to be escape since they would mark the end of the quote otherwise. So if you want to express a single quote inside single quoted string, there is no other way than using \'. Same applies for double quotes.

But you could use:

'\\'

c
cdleary

Another user who has since deleted their answer (not sure if they'd like to be credited) suggested that the Python language designers may be able to simplify the parser design by using the same parsing rules and expanding escaped characters to raw form as an afterthought (if the literal was marked as raw).

I thought it was an interesting idea and am including it as community wiki for posterity.


But it might let you avoid having two separate string-literal-parser code paths.
佚名

Comming from C it pretty clear to me that a single \ works as escape character allowing you to put special characters such as newlines, tabs and quotes into strings.

That does indeed disallow \ as last character since it will escape the " and make the parser choke. But as pointed out earlier \ is legal.


Yeah -- the heart of the issue was that raw strings treat \ as a literal instead of the start of an escape sequence. The strange thing is that it still has escape properties for quoting, despite being treated as a literal character.
佚名

some tips :

1) if you need to manipulate backslash for path then standard python module os.path is your friend. for example :

os.path.normpath('c:/folder1/')

2) if you want to build strings with backslash in it BUT without backslash at the END of your string then raw string is your friend (use 'r' prefix before your literal string). for example :

r'\one \two \three'

3) if you need to prefix a string in a variable X with a backslash then you can do this :

X='dummy'
bs=r'\ ' # don't forget the space after backslash or you will get EOL error
X2=bs[0]+X  # X2 now contains \dummy

4) if you need to create a string with a backslash at the end then combine tip 2 and 3 :

voice_name='upper'
lilypond_display=r'\DisplayLilyMusic \ ' # don't forget the space at the end
lilypond_statement=lilypond_display[:-1]+voice_name

now lilypond_statement contains "\DisplayLilyMusic \upper"

long live python ! :)

n3on


None of these answer the question of "why", but #3 and #4 should not be used. Slicing and adding strings is generally bad practice, and you should prefer r'\dummy' for #3 (which works fine) and ' '.join([r'\DisplayLilyMusic', r'\upper']) to #4.
Reason being that strings are immutable and each slice/concatenation creates a new immutable string object that is typically discarded. Better to accumulate them all and join them together in one step with str.join(components)
Oh, whoops -- misunderstood what you meant for #3. I think there a simple '\\' + X is preferred to creating a string just to slice it.
Just find os.path.normpath will remove the tailing backslash... Then how should I concat the filename into the path...
E
Ed Avis

Despite its role, even a raw string cannot end in a single backslash, because the backslash escapes the following quote character—you still must escape the surrounding quote character to embed it in the string. That is, r"...\" is not a valid string literal—a raw string cannot end in an odd number of backslashes. If you need to end a raw string with a single backslash, you can use two and slice off the second.


What are you quoting?
Seems to be from apprize.best/python/learning_1/8.html without attribution.
B
BossaNova

I encountered this problem and found a partial solution which is good for some cases. Despite python not being able to end a string with a single backslash, it can be serialized and saved in a text file with a single backslash at the end. Therefore if what you need is saving a text with a single backslash on you computer, it is possible:

x = 'a string\\' 
x
'a string\\' 

# Now save it in a text file and it will appear with a single backslash:

with open("my_file.txt", 'w') as h:
    h.write(x)

BTW it is not working with json if you dump it using python's json library.

Finally, I work with Spyder, and I noticed that if I open the variable in spider's text editor by double clicking on its name in the variable explorer, it is presented with a single backslash and can be copied to the clipboard that way (it's not very helpful for most needs but maybe for some..).