Fix/depricated refrence in sql databases #13253

IdleSys · 2025-01-24T16:59:33Z

Overview

This pull request updates the FastAPI documentation to reflect the deprecation of the @app.on_event decorator in the SQL database section of tutorial. The documentation has been revised to guide users towards using the new lifespan event handling system for managing application startup and shutdown events.

Changes Made

Updated Documentation:

Removed references to @app.on_event in python doc_src files.
Code demonstration updated in documentation markdown files for English.

Testing

Reviewed all modified documentation for accuracy and clarity.
Ensured that all examples are functional and correctly illustrate the new usage patterns.

github-actions · 2025-01-24T17:06:04Z

📝 Docs preview for commit 6840483 at: https://af29a5e2.fastapitiangolo.pages.dev

Modified Pages

https://af29a5e2.fastapitiangolo.pages.dev/tutorial/sql-databases/ - (before)

github-actions · 2025-01-25T08:56:12Z

📝 Docs preview for commit d74bee7 at: https://2fd15ee3.fastapitiangolo.pages.dev

Modified Pages

https://2fd15ee3.fastapitiangolo.pages.dev/tutorial/sql-databases/ - (before)

alv2017 · 2025-01-25T14:56:06Z

docs/en/docs/tutorial/sql-databases.md


 ### Create Database Tables on Startup

 We will create the database tables when the application starts.

-{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[32:37] hl[35:37] *}
+{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[33:40] hl[33:36, 40] *}


It would be good to include into this part of the code the line:

app = FastAPI(lifespan=lifespan)

So that the full lifespan integration process is shown.

I'm pretty sure it was included. as you can see i highlighted a blank line.... I think it must be due to the pre-commit format or my fork not being synced with master.
I'll check it.

alv2017 · 2025-01-25T15:11:58Z

I support the changes proposed by @IdleSys. 👍

The corrections I suggested are optional, and it is up to the PR author to implement them or not. 😊

github-actions · 2025-01-25T15:31:40Z

📝 Docs preview for commit 3afe545 at: https://95e4f9b5.fastapitiangolo.pages.dev

Modified Pages

https://95e4f9b5.fastapitiangolo.pages.dev/tutorial/sql-databases/ - (before)

github-actions · 2025-01-25T16:46:31Z

📝 Docs preview for commit 2f95f2b at: https://427ce36a.fastapitiangolo.pages.dev

Modified Pages

https://427ce36a.fastapitiangolo.pages.dev/tutorial/sql-databases/ - (before)

alv2017 · 2025-01-25T16:53:11Z

There is one more thing to think about: when the reference code is modified all the translations related to it will get corrupted.

IdleSys · 2025-01-25T17:02:51Z

Thank you for your input, @alv2017

Currently, I am facing an issue where my local preview does not match the preview of the link that robot provided. Regarding the problem you mentioned, it arises from my changes to the document sources. I see two possible solutions:

Separate the sources until the translations are updated to align with the new source. This approach would also retain the deprecated statements for translations.
Sync the translations with the new source, although I doubt my time and interest will allow me to pursue this option.

alv2017 · 2025-01-25T21:35:49Z

I reviewed updated code references, everything looks good now.
In the mean time I found out that there are not that many translations of the sql-databases.md:

es
ko
pt
ru
zn

all the groups are quite active, and probably it won't be difficult to get support from them

There is an alternative solution. The source files related to the tutorials have a special structure:
If we create a file named tutorial001_py311_an.py and apply all the necessary changes there, and then link it to the english version of the tutorial, then translations won't be affected.

I think that we will need help from the maintainers to move forwards with that.

IdleSys · 2025-01-26T07:58:01Z

@alv2017 Good News
I successfully navigated through the Spanish version and updated all occurrences of old references using sed and I would appreciate it if someone from another language team could visually check and confirm the changes.

github-actions · 2025-01-26T07:58:27Z

📝 Docs preview for commit 85504e6 at: https://1ac48c4a.fastapitiangolo.pages.dev

Modified Pages

alv2017

Do not rush. 😄 :
I approve your proposal regarding documentation update, but the pull request doesn't look good to me, it just got too complicated. I doubt that it can be approved.

It is time to ask for guidance and advice. 😊

alv2017 · 2025-01-25T15:03:03Z

docs/en/docs/tutorial/sql-databases.md


 ### Create Database Tables on Startup

 We will create the database tables when the application starts.

-{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[32:37] hl[35:37] *}
+{* ../../docs_src/sql_databases/tutorial001_an_py310.py ln[33:40] hl[33:36, 40] *}

 Here we create the tables on an application startup event.


In this place I suggest to explain that with the help of the lifespan we create the tables before the application starts accepting requests, and provide the link to the Lifespan tutorial.

So that we get rid of warning, that introduce extra complication to the content.

alv2017 · 2025-01-25T15:04:09Z

docs/en/docs/tutorial/sql-databases.md

+
+/// warning
+
+The `@app.on_event("startup")` and `@app.on_event("shutdown")` decorators are **deprecated** as of FastAPI v0.103.0.
+
+Use the <a href="https://fastapi.tiangolo.com/advanced/events/#lifespan" class="external-link" target="_blank">`lifespan`</a> parameter in the `FastAPI` class instead for lifecycle management.
+
+///
+
+


I suggest to get rid of the warning, and explain the usage of the lifespan in the sentence that I commented above.

alv2017 · 2025-01-26T11:51:52Z

Hi @tiangolo, @alejsdev, sorry for bothering you, but we need your help and guidance.

We would like to make some updates to the code related to the SQL (Relational) Databases tutorial, and guide users towards using the new lifespan event handling system for managing application startup and shutdown events.

However when working on the PR we noticed, that it gets overly complex.
The PR in its current state demonstrates the scope of work that needs to be done in order to introduce the change.

The required changes are as follows:

Code updates
English documentation update
The update of existing translations (mainly code references): At the moment the following translations are available: es, ko, pt, ru, zh

Questions:

Do you agree with this change in documentation?
If yes, then we will be happy to help, but we need your guidance and advice on making the PR.

Thank you! 😊

IdleSys and others added 3 commits January 23, 2025 21:05

fix(docs_src): changing all app.event refrence to asynccontextmanager

a2c5b28

ref(docs): updating docs representation of code segments

896e101

🎨 [pre-commit.ci] Auto format from pre-commit.com hooks

6840483

github-actions bot added the docs Documentation about how to use FastAPI label Jan 24, 2025

Merge branch 'master' into fix/depricatedRefrenceInSqlDatabases

d74bee7

alv2017 reviewed Jan 25, 2025

View reviewed changes

fix(docs/en): fixing the conflicts made by precommit formatting

2f95f2b

IdleSys force-pushed the fix/depricatedRefrenceInSqlDatabases branch from 3afe545 to 2f95f2b Compare January 25, 2025 16:43

IdleSys added 2 commits January 26, 2025 10:12

fix(docs/en): second revision on code blocks representaion in docs

5f1ef30

feat(docs): updating other languages with new resources

85504e6

alv2017 suggested changes Jan 26, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix/depricated refrence in sql databases #13253

Fix/depricated refrence in sql databases #13253

IdleSys commented Jan 24, 2025 •

edited

Loading

github-actions bot commented Jan 24, 2025

github-actions bot commented Jan 25, 2025

alv2017 Jan 25, 2025

IdleSys Jan 25, 2025 •

edited

Loading

alv2017 commented Jan 25, 2025

github-actions bot commented Jan 25, 2025

github-actions bot commented Jan 25, 2025

alv2017 commented Jan 25, 2025

IdleSys commented Jan 25, 2025 •

edited

Loading

alv2017 commented Jan 25, 2025

IdleSys commented Jan 26, 2025 •

edited

Loading

github-actions bot commented Jan 26, 2025

alv2017 left a comment •

edited

Loading

alv2017 Jan 25, 2025

alv2017 Jan 25, 2025

alv2017 commented Jan 26, 2025 •

edited

Loading

Fix/depricated refrence in sql databases #13253

Are you sure you want to change the base?

Fix/depricated refrence in sql databases #13253

Conversation

IdleSys commented Jan 24, 2025 • edited Loading

Overview

Changes Made

Updated Documentation:

Testing

github-actions bot commented Jan 24, 2025

Modified Pages

github-actions bot commented Jan 25, 2025

Modified Pages

alv2017 Jan 25, 2025

Choose a reason for hiding this comment

IdleSys Jan 25, 2025 • edited Loading

Choose a reason for hiding this comment

alv2017 commented Jan 25, 2025

github-actions bot commented Jan 25, 2025

Modified Pages

github-actions bot commented Jan 25, 2025

Modified Pages

alv2017 commented Jan 25, 2025

IdleSys commented Jan 25, 2025 • edited Loading

alv2017 commented Jan 25, 2025

IdleSys commented Jan 26, 2025 • edited Loading

github-actions bot commented Jan 26, 2025

Modified Pages

alv2017 left a comment • edited Loading

Choose a reason for hiding this comment

alv2017 Jan 25, 2025

Choose a reason for hiding this comment

alv2017 Jan 25, 2025

Choose a reason for hiding this comment

alv2017 commented Jan 26, 2025 • edited Loading

IdleSys commented Jan 24, 2025 •

edited

Loading

IdleSys Jan 25, 2025 •

edited

Loading

IdleSys commented Jan 25, 2025 •

edited

Loading

IdleSys commented Jan 26, 2025 •

edited

Loading

alv2017 left a comment •

edited

Loading

alv2017 commented Jan 26, 2025 •

edited

Loading