How can I break string creation over several lines, but include inline comments

Question

I want to create a string, but include comments for each part. In Python, I can do this inside the function print, but I can't do it if I'm creating a variable.

print("Hello "  + # WORKS
       "World!")

greeting = "Hello " + # FAILS
           "World!"

print(greeting)

Throws the error:

  File "space.py", line 4
    greeting = "Hello " + # FAILS
                                ^
SyntaxError: invalid syntax

I tried line continuation:

greeting = "Hello " + \# FAILS
           "World!"

print(greeting)

  File "line_continuation.py", line 4
    greeting = "Hello " + \# FAILS
                                 ^
SyntaxError: unexpected character after line continuation character

possible duplicate of stackoverflow.com/questions/17630835/… ?? — DSLima90
– DSLima90, Commented Apr 28, 2017 at 18:54
@DSLima90 Somewhat similar, but backslashes was just one thing that I tried. — Christopher Bottoms
– Christopher Bottoms, Commented Apr 28, 2017 at 19:15

Grimmy · Accepted Answer · 2017-04-28 20:15:26Z

2

If you want to have control over spaces you can simply do:

print("This "  # comment 1
      "is "  # comment 2
      "a "  # comment 3
      "test")  # comment 4

s = ("This "  # comment 1
     "is "  # comment 2
     "a "  # comment 3
     "test")  # comment 4
print(s)

Outputs:

This is a test
This is a test

Using comma will add a space between each string and is specific to print. The method shown above works for strings in general anywhere.

Note that this will represent a single string, so if you want to inject variables you need to .format on the last line.

The practice of using () around strings are often confused with making a tuple, but it's not a tuple unless it contains a comma.

s = ("Hello")
print(type(s), s)
s = ("Hello",)
print(type(s), s)

Outputs:

<class 'str'> Hello
<class 'tuple'> ('Hello',)

edited Apr 28, 2017 at 20:15

answered Apr 28, 2017 at 18:53

Grimmy

4,17725 silver badges25 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

solarc · Accepted Answer · 2017-04-28 21:15:59Z

2

You can break a string into multiple lines by simply putting them one after the other:

a = ("hello " # can use comments
    "world")
print(a)

b = "hello " "world" # this also works
print(b)

c = a " again" # but this doesn't, SyntaxError
print(c)

edited Apr 28, 2017 at 21:15

answered Apr 28, 2017 at 18:53

solarc

5,7582 gold badges42 silver badges52 bronze badges

3 Comments

Grimmy Over a year ago

You need to enclose the string with () thought. This will yield a syntax error.

solarc Over a year ago

@Grimmy nice catch, only for the multiline one though, single line works just fine without parenthesis.

Grimmy Over a year ago

yeah it took me maybe two years before I picked up that ("hello") is a string and ("hello",) is a tuple. Even added it to my answer. So easy to mess that up.

Christopher Bottoms · Accepted Answer · 2017-04-28 19:06:59Z

0

I just figured it out. Adding parentheses around the parts of the string being constructed works:

print("Hello "  + # WORKS
       "World!")

greeting =("Hello " + # WORKS TOO
           "World!")

print(greeting)

edited Apr 28, 2017 at 19:06

answered Apr 28, 2017 at 18:44

Christopher Bottoms

11.4k11 gold badges60 silver badges107 bronze badges

2 Comments

BrenBarn Over a year ago

By "commas" do you mean "parentheses"?

Christopher Bottoms Over a year ago

@BrenBarn Thanks! I totally know the difference. Don't know why I wrote "commas".

Collectives™ on Stack Overflow

How can I break string creation over several lines, but include inline comments

3 Answers 3

Comments

3 Comments

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

3 Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related