67

What is a clean way to create a multi-line with in python? I want to open up several files inside a single with, but it's far enough to the right that I want it on multiple lines. Like this:

class Dummy:
    def __enter__(self): pass
    def __exit__(self, type, value, traceback): pass

with Dummy() as a, Dummy() as b,
     Dummy() as c:
    pass

Unfortunately, that is a SyntaxError. So I tried this:

with (Dummy() as a, Dummy() as b,
      Dummy() as c):
    pass

Also a syntax error. However, this worked:

with Dummy() as a, Dummy() as b,\
     Dummy() as c:
    pass

But what if I wanted to place a comment? This does not work:

with Dummy() as a, Dummy() as b,\
     # my comment explaining why I wanted Dummy() as c\
     Dummy() as c:
    pass

Nor does any obvious variation on the placement of the \s.

Is there a clean way to create a multi-line with statement that allows comments inside it?

3
  • Actually, the big question is what PEP-8 says about this stuff, since PEP-8 restricts line-length to 80 chars, which is what makes doing this necessary. Commented Jun 25, 2015 at 0:02
  • 1
    @TigerhawkT3 I think that the 80 char limit is low too, but I see a benefit to it when I'm working on a project that requires me to have 5 files open simultaneously. It's much easier to be able to see every file. I might make an exception for this file, though. Commented Jun 25, 2015 at 0:15
  • 8
    PEP-8 is explicitly ok with ` \ ` line continuation for multiline with statements, since you can't use implicit continuation. That doesn't really help your situation if you want to inline comments, though. Commented Jun 25, 2015 at 0:29

7 Answers 7

76

As of Python 3.10, it is now possible to parenthesize the whole group of context managers, as you originally tried:

with (Dummy() as a, Dummy() as b,
      # comment about c
      Dummy() as c):
    pass

This is also technically possible in 3.9, but in a sort of semi-documented limbo.

On one hand, it's documented as new in 3.10, 3.9 wasn't supposed to introduce any features (like this one) that depend on the new parser implementation, and the 3.9 with docs forbid this form. On the other hand, the functionality ended up getting activated in the 3.9 CPython implementation, and the (mostly?) auto-generated 3.9 full grammar spec includes the parenthesized form.


On previous Python 3 versions, if you need to intersperse comments with your context managers, I would use a contextlib.ExitStack:

from contextlib import ExitStack

with ExitStack() as stack:
    a = stack.enter_context(Dummy()) # Relevant comment
    b = stack.enter_context(Dummy()) # Comment about b
    c = stack.enter_context(Dummy()) # Further information

This is equivalent to

with Dummy() as a, Dummy() as b, Dummy() as c:

This has the benefit that you can generate your context managers in a loop instead of needing to separately list each one. The documentation gives the example that if you want to open a bunch of files, and you have the filenames in a list, you can do

with ExitStack() as stack:
    files = [stack.enter_context(open(fname)) for fname in filenames]

If your context managers take so much screen space that you want to put comments between them, you probably have enough to want to use some sort of loop.


As Mr. Deathless mentions in the comments, there's a contextlib backport on PyPI under the name contextlib2. If you're on Python 2, you can use the backport's implementation of ExitStack.


Incidentally, the reason you can't do something like

with (
        ThingA() as a,
        ThingB() as b):
    ...

before the new parser implementation is because a ( can also be the first token of the expression for a context manager, and CPython's old parser wouldn't be able to tell what rule it's supposed to be parsing when it sees the first (. This is one of the motivating examples for PEP 617's new PEG-based parser.

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

1 Comment

There is a backport of contextlib improvements to Python 2 on pypi. It provides ExitStack() among other things.
19

Python 3.9+ only:

with (
    Dummy() as a,
    Dummy() as b,
    # my comment explaining why I wanted Dummy() as c
    Dummy() as c,
):
    pass

Python ≤ 3.8:

with \
    Dummy() as a, \
    Dummy() as b, \
    Dummy() as c:
    pass

Unfortunately, comments are not possible with this syntax.

8 Comments

@Justin It works in 3.90a6, which you can install using pyenv :)
@justin 3.9 got released
@ThomasGrainger Thanks for the ping. I tried this out and it does indeed work with Python 3.9
The official docs for the with statement disallow parentheses. It looks like when they generated the full grammar spec in the docs, they generated it from a grammar file that has the with-parentheses rule and left that rule in, though, so I guess this change is now in a semi-documented limbo.
@user2357112supportsMonica Fair enough, this should be PR in cpython though. Guido's pretty proud of the new PEG grammar. He was quick to show me that the parenthesized with statement now works.
|
13

This seems tidiest to me:

with open('firstfile', 'r') as (f1 # first
  ), open('secondfile', 'r') as (f2 # second
  ):
    pass

Comments

4

This isn't exactly clean, but you could do this:

with Dummy() as a, Dummy() as b, (
     #my comment
     Dummy()) as c:
    pass

There are no syntax errors, but it's not the cleanest. You could also do this:

with Dummy() as a, Dummy() as b, Dummy(
     #my comment
     ) as c:
    pass

Consider finding a way of doing this without using the comments in the middle of the with.

7 Comments

Fun fact: he is the OP.
@DevShark This does what I want, but is there a way to do this that isn't so crazy? That's the question I want to know. Sometimes I wish python was able to say, "There's an operator at the end of this line that requires something to be after it, so I'd better check the next line for the other operand."
No offense intended; my amusement came from @DevShark's lack of realization. But, if you often just need to give it a few more minutes to figure something out yourself, maybe you could so before asking a question? Be more self-confident. :)
@Downvoter Can you please explain what is bad about this answer so I can improve my future answers?
@Justin if you usually figure things out after finally breaking down and asking a question, might I suggest a rubber duck by your side? ;-) Either way, it's seldom a bad thing to post a question online if only to answer it yourself shortly after. It's good for posterity, and for others' benefit!
|
3

I would keep things simple and readable by adding the comment before the with statement, or on the line itself:

# my comment explaining why I wanted Dummy() as c
with Dummy() as a, Dummy() as b,\
     Dummy() as c: # or add the comment here
    pass

Comments

0

Like TigerhawkT3's answer, but with indenting that doesn't trigger pycodestyle's error E124:

with (
        open('firstfile', 'r')) as f1, (  # first
        open('secondfile', 'r')) as f2:  # second
    pass

IMO it's still ugly, but at least it passes the linter.

Comments

0

To avoid too long lines, you can do the following.

Instead of:

with open(filename, 'wb') as file, request.urlopen(image.url) as response:
    pass

I, do for example:

f = lambda: open(filename, 'wb')
r = lambda: request.urlopen(image.url)
with r() as response, f() as file:
    pass

1 Comment

While technically OK, most linters would raise a warning on assigning the lambda expression to a variable. See E731 do not assign a lambda expression, use a def

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.