Reload Flask on API file changes #1418
Conversation
|
Hi @aparcar , thanks for the PR, let me know if you need some help |
|
@Ruwann Thanks for your response. I'll look into adding test cases to this PR. I'm not sure why the current CI is failing on Python 3.9, do you have any ideas? Also do you require any doc updates for this PR? |
connexion/apps/flask_app.py
Outdated
| @@ -101,7 +103,8 @@ def run(self, port=None, server=None, debug=None, host=None, **options): # prag | |||
|
|
|||
| logger.debug('Starting %s HTTP server..', self.server, extra=vars(self)) | |||
| if self.server == 'flask': | |||
| self.app.run(self.host, port=self.port, debug=self.debug, **options) | |||
| self.app.run(self.host, port=self.port, debug=self.debug, | |||
| extra_files=self.extra_files, **options) | |||
There was a problem hiding this comment.
The checks are failing because this line is not correctly indented. It should be aligned with the self.host in the line above (add 5 spaces I think).
connexion/apps/flask_app.py
Outdated
| @@ -64,6 +65,7 @@ def common_error_handler(self, exception): | |||
| def add_api(self, specification, **kwargs): | |||
| api = super().add_api(specification, **kwargs) | |||
| self.app.register_blueprint(api.blueprint) | |||
| self.extra_files.append(specification) | |||
There was a problem hiding this comment.
This can be more than just str, it can also be a pathlib.Path or dict instance
There was a problem hiding this comment.
Now it will only be added in case it's either string or Path
|
For the test cases, I'm not sure whether it is possible to write a test to check whether it is reloading in debug mode? You could write a test for checking whether they are added to the I don't think we necessarily have to add documentation for it, for me it feels natural that the app is reloaded when the swagger is changed. But if you find a good place to add it, feel free to make a suggestion. |
Flask can automatically reload in debug mode whenver specified files change. By default that includes templates, however changes to the API files (i.e. openapi.yml) should result in a reload as well. This PR adds all added API files to be monitored automatically by Flask. Signed-off-by: Paul Spooren <mail@aparcar.org>
There was a problem hiding this comment.
We also need to add this option now to FlaskApp.run() because users might already use the extra_files argument for other things. So we need to append the extra_files in the run() function to the self.extra_files.
Otherwise, this would lead to a TypeError: run() got multiple values for keyword argument 'extra_files'
Is it clear what I mean?
connexion/apps/flask_app.py
Outdated
| @@ -64,6 +65,8 @@ def common_error_handler(self, exception): | |||
| def add_api(self, specification, **kwargs): | |||
| api = super().add_api(specification, **kwargs) | |||
| self.app.register_blueprint(api.blueprint) | |||
| if isinstance(specification, (str, pathlib.Path)): | |||
| self.extra_files.append(specification) | |||
There was a problem hiding this comment.
We need to take into account the specification_dir option (see for example the openapi3/helloworld example).
| self.extra_files.append(specification) | |
| self.extra_files.append(self.specification_dir / specification) |
User can still specify custom extra_files in addition to the swagger specification, so need to account for that in FlaskApp.run().
|
@RobbeSneyders This PR looks good to me, but I have made some changes myself as well, let me know if you'd like to have another look at it before it is merged. |
* Reload Flask on API file changes Flask can automatically reload in debug mode whenver specified files change. By default that includes templates, however changes to the API files (i.e. openapi.yml) should result in a reload as well. This PR adds all added API files to be monitored automatically by Flask. Signed-off-by: Paul Spooren <mail@aparcar.org> * Take into account specification dir * Add extra_files argument. User can still specify custom extra_files in addition to the swagger specification, so need to account for that in FlaskApp.run(). * Update docstring for flake8 * Add extra_files as explicit argument for FlaskApp * Add extra_files docstring Co-authored-by: Ruwan <ruwanlambrichts@gmail.com>
Flask can automatically reload in debug mode whenver specified files
change. By default that includes templates, however changes to the API
files (i.e. openapi.yml) should result in a reload as well.
This PR adds all added API files to be monitored automatically by Flask.
WIP since I have to figure out the used
toxsetup first.Signed-off-by: Paul Spooren mail@aparcar.org