Unicode errors occur inside of multi-line comments

[jftuga]

BPO	29285
Nosy	@bitdancer, @zware, @eryksun, @jftuga
Files	example.py: multiline comment example

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2017-01-16.17:33:57.342>
created_at = <Date 2017-01-16.17:06:40.579>
labels = ['interpreter-core', 'type-bug', 'invalid']
title = 'Unicode errors occur inside of multi-line comments'
updated_at = <Date 2017-01-17.18:36:41.665>
user = 'https://github.com/jftuga'

bugs.python.org fields:

activity = <Date 2017-01-17.18:36:41.665>
actor = 'jftuga'
assignee = 'none'
closed = True
closed_date = <Date 2017-01-16.17:33:57.342>
closer = 'zach.ware'
components = ['Interpreter Core']
creation = <Date 2017-01-16.17:06:40.579>
creator = 'jftuga'
dependencies = []
files = ['46303']
hgrepos = []
issue_num = 29285
keywords = []
message_count = 5.0
messages = ['285573', '285577', '285645', '285658', '285675']
nosy_count = 4.0
nosy_names = ['r.david.murray', 'zach.ware', 'eryksun', 'jftuga']
pr_nums = []
priority = 'normal'
resolution = 'not a bug'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue29285'
versions = ['Python 3.5']

[jftuga]

I am using Python 3.5.2 on OS X 10.11.6. The same error occurs with 3.5.2 on Windows 10.

When I run the attached code, I get this error:

SyntaxError: (unicode error) 'unicodeescape' codec can't decode bytes in position 23-24: truncated \uXXXX escape

I think unicode processing should be ignored inside of multiline comments.
Inside of my comments, I really want to use this text verbatim.

[zware]

Triple-quoted strings are strings, not multi-line comments, though people do abuse them for that purpose sometimes. Changing this behavior would be a huge change for next to no benefit, so I'm closing the issue.

If you insist on using a triple-quoted string as a comment (which I repeat, it is not; comments are ignored by the compiler, while triple-quoted strings are treated just as any other string literal by the compiler), you can work around this by using a 'raw' string literal:

r"""
dir \\dept.example.com\user
"""

[bitdancer]

@zach: actually, triple quoted strings *are* suggested as a way to do multiline comments, and are often used for that. In particular, note that they do not appear in the byte code files if they are not assigned to anything or appear in the docstring position. This is something I had to prove to myself at one point when I had the same reaction you just did to their use as comments :)

That said, it is true that they are, first and foremost, strings, so the quoting behavior is not going to change.

[eryksun]

they do not appear in the byte code files

It's simple to coonfirm that unassigned string literals get thrown away.:

    >>> code = compile('"doc"\n"unused"\n"us"+"ed"', '', 'exec')
    >>> code.co_consts
    ('doc', 'us', 'ed', None, 'used')
    >>> dis.dis(code)
      1           0 LOAD_CONST               0 ('doc')
                  3 STORE_NAME               0 (__doc__)

  3           6 LOAD_CONST               4 ('used')
              9 POP_TOP
             10 LOAD_CONST               3 (None)
             13 RETURN_VALUE

However, they're retained up to the abstract syntax tree:

    >>> print(ast.dump(ast.parse('"doc"\n"unused"\n"us"+"ed"', '', 'exec')))
    Module(body=[
        Expr(value=Str(s='doc')),
        Expr(value=Str(s='unused')),
        Expr(value=BinOp(left=Str(s='us'),
                         op=Add(),
                         right=Str(s='ed')))])

Sans the doc string behavior, this applies to literals in general. Thus even though the compiler discards these objects, the literal still has to be parsed like any other.

[jftuga]

OP here, thanks for replying to this. I used Zach's suggestion of placing an 'r' in front of triple-quotes. This accomplishes my goal.