V3 fastapi #173

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

Copilot

Pull Request Overview

This PR migrates DEEPaaS from aiohttp to FastAPI as the web framework backend, marking a major version bump to 3.0.0. The migration removes training functionality and modernizes the API architecture.

Replaces aiohttp/aiohttp-apispec with FastAPI for HTTP handling and OpenAPI generation
Removes training endpoint support entirely across the codebase
Updates Python version requirements and dependency management

Reviewed Changes

Copilot reviewed 36 out of 37 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
pyproject.toml	Updates version to 3.0.0, replaces aiohttp with fastapi dependencies
deepaas/api/	Complete rewrite of API modules to use FastAPI routing and responses
deepaas/model/v2/	Removes training methods and simplifies model wrapper architecture
deepaas/cmd/run.py	Switches from aiohttp web server to uvicorn for FastAPI
deepaas/tests/	Updates test suite to work with new FastAPI-based architecture
doc/	Updates documentation to reflect removal of training endpoints

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-26T09:56:26Z

deepaas/api/v2/utils.py

+    assume its a custom field"""
+    ftype = type(field)
+    if issubclass(ftype, marshmallow.fields.Field) and ftype not in FIELD_CONVERTERS:
+        print("     Custom field")


Debug print statements should be removed from production code. Use logging instead or remove these statements entirely.

Copilot · 2025-09-26T09:56:26Z

deepaas/api/v2/utils.py

+def is_file_field(field):
+    """If this is a file field, we need to handle it differently."""
+    if field is not None and field.metadata.get("type") == "file":
+        print("     File field")


Debug print statements should be removed from production code. Use logging instead or remove these statements entirely.

Copilot · 2025-09-26T09:56:27Z

deepaas/cmd/deepaas_test_v2_v3.py

+    """Compare endpoints in both OpenAPI specs.
+
+    This method ignoring methods that have been removed.
+    """


The function accesses dictionary keys without checking if 'paths' key exists, which could raise a KeyError if the OpenAPI spec is malformed. Add validation to ensure required keys exist in the spec.

Suggested change

"""

"""

# Validate that 'paths' key exists in both specs

if 'paths' not in old_spec:

raise ValueError("The old OpenAPI spec is missing the 'paths' key.")

if 'paths' not in new_spec:

raise ValueError("The new OpenAPI spec is missing the 'paths' key.")

Copilot · 2025-09-26T09:56:27Z

deepaas/api/v2/predict.py

+                # FIXME(aloga): Validation does not work, as we are converting from
+                # Marshmallow to Pydantic, check this as son as possible.
+                # self.model_obj.validate_response(ret)


Response validation is disabled which could allow invalid responses to be returned to clients. This should be fixed before production use as it bypasses important data validation.

Copilot · 2025-09-26T09:56:27Z

deepaas/cmd/deepaas_test_v2_v3.py

+            f"Old: {old_response.status_code}, New: {new_response.status_code}"
+        )


There's a typo in the comment on line 75 - 'son' should be 'soon' in the FIXME comment above.

Copilot · 2025-09-26T09:56:27Z

deepaas/api/v2/predict.py

+    We use this function to be able to include the router in the main
+    application and do things before it gets included.
+
+    In this case we explicitly include the model precit endpoint.


Typo in docstring: 'precit' should be 'predict'.

Suggested change

In this case we explicitly include the model precit endpoint.

In this case we explicitly include the model predict endpoint.

This requires that we change all model args/responses from Marshmallow to Pydantic. Most of the code is in this change, we can split it later on two different changes (marshmallow + pydantic and FastAPI for predict).

After checking with people using the package for a while, the training methods were not used at all, therefore we are now removing the training endpoints. This also allows us to have a much more simple codebase.

Co-authored-by: alvarolopez <[email protected]>

sonarqubecloud · 2025-09-29T10:15:40Z

Quality Gate passed

Issues
0 New issues
4 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

alvarolopez force-pushed the v3-fastapi branch from 977554c to 3f5cc74 Compare June 28, 2024 08:39

alvarolopez force-pushed the v3-fastapi branch from 3f5cc74 to fb89404 Compare August 8, 2024 14:34

alvarolopez force-pushed the v3-fastapi branch from fb89404 to 4a4d4a7 Compare September 30, 2024 16:16

alvarolopez force-pushed the v3-fastapi branch 3 times, most recently from 16e1ad0 to 6965b58 Compare March 21, 2025 21:36

alvarolopez requested a review from Copilot September 26, 2025 09:55

Copilot AI reviewed Sep 26, 2025

View reviewed changes

alvarolopez force-pushed the v3-fastapi branch 2 times, most recently from 7eaf30a to 219bdc6 Compare September 26, 2025 10:22

alvarolopez added 16 commits September 26, 2025 14:07

feat!: start migrating code to fastapi

5836fd3

fix: remove handling of multiple models

187d756

fix: do not run models in complex process pool

dd627f3

feat!: move debug endpoint to FastAPI

ebc8204

fix: global variables should be used FIXME

0fbb791

fix: use get_router() function to get the router

fb683ad

feat!: move models endpoint to FastAPI

b402754

feat!: move predict method to FastAPI

549485b

This requires that we change all model args/responses from Marshmallow to Pydantic. Most of the code is in this change, we can split it later on two different changes (marshmallow + pydantic and FastAPI for predict).

feat: bump version to v3 to clarify when developing

cb4acea

fix: remove old commented aiohttp code

be68c9c

fix: remove old testing dependency

3ea867f

fix: dependencies in tox are not used anymore

cf33f7a

fix: use .get_router() function to setup router at API level

3824b43

feat: move version habdling to app root router

6891fb6

fix: warm model according to configuration

d3acbee

fix: honour base_path

f296afe

alvarolopez and others added 17 commits September 26, 2025 14:07

fix: comment training responses

b4dc3db

fix: update some old links to point to AI4EOSC

340330c

fix: remove wrong comment

11a94aa

style: make black happy

692ae77

feat!: remove /train endpoints for all models

174e8d6

After checking with people using the package for a while, the training methods were not used at all, therefore we are now removing the training endpoints. This also allows us to have a much more simple codebase.

fix: remove unused assignment

221ed3f

fix: use correct variable name

d6ec939

style: change code style and fix linters

5f20c66

fix: improve unit testing

1b5c231

fix: remove aiohttp dependencies

2b4d03f

feat: add utility to check V2 and V3 compatibility

5c8e609

build: update poetry commands and Python versions

42d14f1

fix: VERSIONS is not a global, as it is not assigned in scope

014ccfa

Remove enable_predict functionality and predict-endpoint configuration

6f9ca6b

Co-authored-by: alvarolopez <[email protected]>

Clean up old commented code references

0212253

Co-authored-by: alvarolopez <[email protected]>

Fix CLI exit code issue - return None instead of result objects

efbf786

Co-authored-by: alvarolopez <[email protected]>

fix: remove FIXME

471eb1a

alvarolopez force-pushed the v3-fastapi branch from f0df6de to 471eb1a Compare September 26, 2025 12:08

alvarolopez and others added 9 commits September 26, 2025 14:09

fix: remove commented code

5f14e30

fix: remove commented code

298bf18

fix: remove TODO note, as this is not a TODO

7e9be33

Remove async keyword from tests that don't require async features

d5b9578

Co-authored-by: alvarolopez <[email protected]>

fix: remove commented code

d8cd9c5

fix: make async calls actually async

97c5d19

fix: remove wrong fixme

5eb555e

fix: raise exception on model loading error

efc6142

style: fix pep8 errors

cb0398d

alvarolopez force-pushed the v3-fastapi branch from 1f582dc to cb0398d Compare September 29, 2025 10:09

fix: use set literal

c0dddc2

-    """
+    """
+    # Validate that 'paths' key exists in both specs
+    if 'paths' not in old_spec:
+        raise ValueError("The old OpenAPI spec is missing the 'paths' key.")
+    if 'paths' not in new_spec:
+        raise ValueError("The new OpenAPI spec is missing the 'paths' key.")

		f"Old: {old_response.status_code}, New: {new_response.status_code}"
		)

	In this case we explicitly include the model precit endpoint.
	In this case we explicitly include the model predict endpoint.

V3 fastapi #173

Are you sure you want to change the base?

V3 fastapi #173

Uh oh!

Conversation

alvarolopez commented Jun 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sonarqubecloud bot commented Jun 28, 2024

Quality Gate passed

Uh oh!

sonarqubecloud bot commented Aug 8, 2024

Quality Gate passed

Uh oh!

sonarqubecloud bot commented Sep 30, 2024

Quality Gate passed

Uh oh!

github-advanced-security bot commented Mar 21, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Sep 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

alvarolopez commented Jun 28, 2024 •

edited

Loading

sonarqubecloud bot commented Sep 29, 2025 •

edited

Loading