[New-bugs-announce] [issue34445] asyncio support in doctests

Stefan Tjarks report at bugs.python.org
Mon Aug 20 13:30:39 EDT 2018


New submission from Stefan Tjarks <stefan.tjarks at eventbase.com>:

When writing a docstring for an async function I wrote a doctest for it.

```
async def hello_world():
    """
    Will great the world with a friendly hello.

    >>> await hello_world()
    "hello world"
    """
    return "hello world"
```

I kind of expected an error that no event loop is running but actually get a SyntaxError.

```
**********************************************************************
File "asyncdoctest.py", line 5, in __main__.hello_world
Failed example:
    await hello_world()
Exception raised:
    Traceback (most recent call last):
      File "/usr/lib/python3.6/doctest.py", line 1330, in __run
        compileflags, 1), test.globs)
      File "<doctest __main__.hello_world[0]>", line 1
        await hello_world()
                        ^
    SyntaxError: invalid syntax
**********************************************************************
1 items had failures:
   1 of   1 in __main__.hello_world
***Test Failed*** 1 failures.
```

Is the SyntaxError intentional or does doctest simply not support asyncio syntax?

----------
components: Library (Lib), asyncio
files: asyncdoctest.py
messages: 323803
nosy: Stefan Tjarks, asvetlov, yselivanov
priority: normal
severity: normal
status: open
title: asyncio support in doctests
type: behavior
versions: Python 3.7
Added file: https://bugs.python.org/file47756/asyncdoctest.py

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue34445>
_______________________________________


More information about the New-bugs-announce mailing list