On Wed, Feb 27, 2019 at 9:34 AM Scott, Barry <barry.scott@forcepoint.com> wrote:
On Tuesday, 26 February 2019 06:34:28 GMT Glyph wrote:
> > On Feb 25, 2019, at 3:32 AM, Scott, Barry <barry.scott@forcepoint.com>
> > wrote:>
> > On Tuesday, 19 February 2019 11:00:57 GMT Chris Withers wrote:
> >> Hi All,
> >>
> >> There's this assert:
> >>
> >> https://github.com/twisted/twisted/blob/trunk/src/twisted/internet/defer.
> >> py# L459
> >>
> >> ...and I'd like to understand why it's there.
> >
> > We hit this assert when porting from very old twisted to current twisted.
> > In all cases the problem was with our code that used deferreds in a poor,
> > not well understood way. After refactoring we are a lot happier with the
> > resulting code as it easier to maintain now.
> Thanks for the feedback, Barry!
> It would still be great to figure out, if we can, how we might make the
> error message a bit more legible to folks with less knowledge of Twisted's
> internals.

Let suppose that I need work done by doWork function.
It returns a deferred for me to hang call backs and error backs on.

        d = doWork()

In my handleWorkDone I expect to get the result of doWork completing.

The assert fires if instead of a result value is returned a Deferred is
returned. This I consider a bug in the doWork() implementation.

This doesn't sound right.  Can you provide an example implementation of doWork that provokes this behavior?  Here's an implementation that seems like it matches your description and which does not provoke the behavior:

    def doWork():
        d = Deferred()
        return d

    d = doWork()

This doesn't trigger the assert.  This calls handleWorkDone with "result".  If you simplify the code so the Deferred interaction remains the same but all the extraneous code is removed, it looks like this:

    d = Deferred()

which must work or Deferred is completely useless.



What must happen in doWork is that it must arrange that
any Deferred it used internally has an addCallback used to
cause the d returned to the user to complete. Leaking the
any internal Deferred() objects must not happen to the user
of doWork.

def doWork():
        d = Deferred()

        def completeWork(result, d):

        inner_d = doAsyncWork()
        inner_d.addCallback(completeWork, d)

        return d

The error message would need to say something like:
"Cannot return a Deferred as a result. Did you forgot to addCallback to the

Maybe add something to docs based on the above and refer to it in the message?


Twisted-Python mailing list