Add example of using the Starlette test client with tox #2026
Conversation
chrisinmtown
force-pushed
the
example-testclient
branch
2 times, most recently
from
bd956aa to
a6706ef
Compare
|
Thanks for approving a run of the test pipeline on this PR. I botched the import order in my initial attempts, I'm learning to run |
chrisinmtown
force-pushed
the
example-testclient
branch
from
a6706ef to
b0d2d6a
Compare
chrisinmtown
force-pushed
the
example-testclient
branch
from
b0d2d6a to
a2e4702
Compare
| :return: ConnexionResponse with RFC7087 problem details | ||
| """ | ||
| # log the request URL, exception and stack trace | ||
| logger.exception("Request to %s caused exception", request.url) |
There was a problem hiding this comment.
Does this work properly, don't we need to supply the exception as an argument via exc_info=ex?
There was a problem hiding this comment.
The python logger does magic when you call its exception method, and that magic breaks when the context changes, like when running the function from a new thread pool. I will test what you suggest - pass the exception - and see if the full stack trace is shown.
There was a problem hiding this comment.
Thank you for @Ruwann for pointing me to the exc_info parameter. Yes, the stack trace appears as expected when that parameter is passed. That seems like a better solution than using async to define the exception handler function.
There was a problem hiding this comment.
What do you think of renaming this file instead of using __init__.py? Or add it to app.py? To keep it more consistent with other examples
There was a problem hiding this comment.
Would appreciate guidance on the right way, or the connexion way, or what have you :) to structure an app for use from tox. Creating the app object in __init__.py makes that easy but I'm sure it's not the only way.
There was a problem hiding this comment.
I restructured this example to use a single file, and eliminate the package hello. Please review again. Thanks in advance.
examples/testclient/hello/app.py
Outdated
| from . import conn_app | ||
|
|
||
| # reuse the configured logger | ||
| logger = logging.getLogger("uvicorn.error") |
There was a problem hiding this comment.
What's the reasong for using the uvicorn.error logger instead of a specific one for this file/application?
There was a problem hiding this comment.
This was basically a cheat, the level is set appropriately on this logger so the output from my code appears together with output from uvicorn, and no additional configuration is necessary.
No worries, I have been using ruff on my other projects as it combines a lot of these into a single tool, that's more easy to use imo. Is it still unclear? |
chrisinmtown
force-pushed
the
example-testclient
branch
3 times, most recently
from
cd037f2 to
3088c4d
Compare
chrisinmtown
changed the title
chrisinmtown
force-pushed
the
example-testclient
branch
3 times, most recently
from
ec13ea7 to
2ac0347
Compare
This example Connexion app processes JSON requests and responses as specified with OpenAPI v2 (aka Swagger) or OpenAPI v3 file format. The app asks Connexion to validate JSON responses against the spec. The app defines an error handler that catches exceptions raised while processing a request. Define automated tests that are run by tox.
chrisinmtown
force-pushed
the
example-testclient
branch
from
2ac0347 to
3ade3ab
Compare
The example Connexion app processes JSON requests and responses as specified with OpenAPI v2 (aka Swagger) or OpenAPI v3 file format.
JSON responses are validated against the spec.
An error handler catches exceptions raised while processing a request.
Tests are run by
toxwhich also reports code coverage.