Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example of the Starlette test client on a simple Connexion REST app #2026

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

chrisinmtown
Copy link
Contributor

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 tox which also reports code coverage.

@chrisinmtown chrisinmtown force-pushed the example-testclient branch 2 times, most recently from bd956aa to a6706ef Compare January 4, 2025 13:22
@chrisinmtown
Copy link
Contributor Author

chrisinmtown commented Jan 4, 2025

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 isort on everything first. I'm struggling to figure out the exact version of isort to use, or the right configuration, because the import ordering set by my local isort was rejected by the tox pre-commit step :/

@coveralls
Copy link

coveralls commented Jan 4, 2025

Coverage Status

coverage: 94.419%. remained the same
when pulling a2e4702 on chrisinmtown:example-testclient
into 550ba1a on spec-first:main.

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 `tox` which also reports code coverage.
Copy link
Member

@Ruwann Ruwann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Already looking very nice, left some small comments/questions

:return: ConnexionResponse with RFC7087 problem details
"""
# log the request URL, exception and stack trace
logger.exception("Request to %s caused exception", request.url)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this work properly, don't we need to supply the exception as an argument via exc_info=ex?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

from . import conn_app

# reuse the configured logger
logger = logging.getLogger("uvicorn.error")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the reasong for using the uvicorn.error logger instead of a specific one for this file/application?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@Ruwann
Copy link
Member

Ruwann commented Feb 1, 2025

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 isort on everything first. I'm struggling to figure out the exact version of isort to use, or the right configuration, because the import ordering set by my local isort was rejected by the tox pre-commit step :/

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
Copy link
Contributor Author

chrisinmtown commented Feb 5, 2025

Thank you for the comments. I will wait for your answers on my questions then revise.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants