Examples and tests for async support in SQLModel - #471

Closed
auphofBSF wants to merge 13 commits into
fastapi:mainfrom
auphofBSF:pr-22w42a-tests-for-async-part1
Closed

Examples and tests for async support in SQLModel#471
auphofBSF wants to merge 13 commits into
fastapi:mainfrom
auphofBSF:pr-22w42a-tests-for-async-part1

Conversation

@auphofBSF

@auphofBSFauphofBSF commented Oct 18, 2022•
edited
Loading

Copy link
Copy Markdown
  • (2✅ of 15⏹️ ) asyncio Tutorials matching sync Tutorials.
  • (2✅ of 15⏹️ ) pytest asyncio tutorial tests
  • ✅above tests and tutorials passing mypy static analysis (see note below)

mypy static test dependencies

The work done in #58 resolves the mypy static type analysis issues "AsyncSession" has incompatible type "SelectOfScalar[Hero]"
with mypy docs_src\tutorial_async before: #58
image
after #58
image

Note the PR #435

This PR subclasses outstanding sqlalchemy dependencies and also provides some additional tutorial and pytest tests. I have not assessed those tutorials or tests, I have marked in each tutorial that this PR provides the TODO's to change on PR #435 or equivalent being merged, removing the requirement for sqlalchemy imports

Note on python < 3.9

Python 3.6 support should be retired even 3.7 is EOL 2021/12, have got a clean lint and test running for 3.7 but 3.6 required major dependency surgery on pyproject.toml that looked like it was getting there until I ran into
image

The dependency management for 3.6.15 that was working
image

Summary

I believe there is great value in the existing sync tutorials and so have proceeded with converting those to async tutorials as this provides a simple base for adding, extending and checking coverage

@SLLau
test: initial async tests - wip
299a35a
squashed wip commits
based on `docs_src/tutorial`
Goals ---------
convert to async as working examples
ensure static typing with mypy passes
@SLLau
fix: mypy static typing failures , FieldInfo
886b962
use https://pydantic-docs.helpmanual.io/usage/schema/#typingannotated-fields
@SLLau
test: add missing async test update
bca1a7b
refactor: mypy issues with annotations
refactor: simplify async session using SQLmodel
to pass mypy use typdef Annotation see
https://pydantic-docs.helpmanual.io/usage/schema/#typingannotated-fields
@SLLau
refactor: simplify imports
6dec3fe
doc: TODO depend on PR435
refactor: simply session start
@SLLau
refactor: fix function return types for mypy
14bb1b2
@SLLau
test: workaround for async inspect
9e19608
@SLLau
chore: fixes for mypy static type checks
b60b137
only addresses async tests, does not try to fix
other tests
use: `mypy docs_src\tutorial_async` and
`mypy tests\test_async_tutorial`
@SLLau
chore: async test requirements, Drop 3.6 support
22e93d7
pytest.asyncio dropped support for python 3.6 with version 0.17.0 (22-01-13) as Python 3.6 EOL (23 Dec 2021)
@SLLau
doc: add reference in docs to the async tutorial
1151d85
also references tests and major PR dependencies
@github-actions

github-actionsBot commented Oct 18, 2022

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit 1151d85 at: https://634df5df2d0196544d59a3e1--sqlmodel.netlify.app

@SLLau
fix: mypy "ForwardRef"; implicit reexport disabled
94527a6
current pydantic 1.10.2
see pydantic/pydantic#4358
Fix imports indirectly from pydantic typing #4358
@github-actions

github-actionsBot commented Oct 18, 2022

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit 94527a6 at: https://634e048b16d79567f08bfacd--sqlmodel.netlify.app

@codecov

codecovBot commented Oct 18, 2022•
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing linesCoverage Δ
...ect_async/create_tables_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/delete_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/insert_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial002_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial003_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial004_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial005_async.py100.00% <100.00%> (ø)
...nc/connect_async/update_async/tutorial001_async.py100.00% <100.00%> (ø)
...c/tutorial_async/select_async/tutorial001_async.py100.00% <100.00%> (ø)
... and 13 more

... and 4 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions

github-actionsBot commented Oct 18, 2022

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit 1846878 at: https://634e5720ac7f9d1fde6279d9--sqlmodel.netlify.app

@SLLau
tests: fix typing.annotations support only ^3.9
5aed51e
async tutorials not supported with mypy static type checking
if python version before 3.9
@github-actions

github-actionsBot commented Oct 18, 2022

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit 5aed51e at: https://634e81e23c20c3463fe7cccb--sqlmodel.netlify.app

@SLLau
chore: fix for flake8 on python3.7
6d00e2c
flake8 not compatible with 22Oct1 release of importlib_metadata v5
see PyCQA/flake8#1701
set importlib_metadata to 4.13.0
@github-actions

github-actionsBot commented Oct 18, 2022

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit 6d00e2c at: https://634f09db47ba242e98b80f08--sqlmodel.netlify.app

@auphofBSF

auphofBSF commented Oct 18, 2022

Copy link
Copy Markdown
Author

see comments regarding python < 3.9. I believe support for 3.6 should be retired.

@LulzLoL231

LulzLoL231 commented Jan 31, 2023

Copy link
Copy Markdown

Great addition, any progress?

@tiangolotiangolo added the docs Improvements or additions to documentation label Oct 22, 2023
@hakan-77

hakan-77 commented Mar 29, 2025

Copy link
Copy Markdown

This is a great feature, any progress?

@tiangolo

@github-actions

github-actionsBot commented Sep 5, 2025

Copy link
Copy Markdown
Contributor

This pull request has a merge conflict that needs to be resolved.

@github-actionsgithub-actionsBot added the conflicts Automatically generated when a PR has a merge conflict label Sep 5, 2025
svlandeg
svlandeg reviewed May 13, 2026
View reviewed changes

@svlandegsvlandeg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hi @auphofBSF, all,

Thanks for the contribution 🙏

We've discussed this internally and decided that we prefer to write the first draft of this new documentation section ourselves. We are now tracking this on our internal TODO list. We'll go ahead and close this one in the meantime. Considering how extensive & detailed this PR is though, it's likely that we'll take some ideas/concepts from it, in which case we'll definitely attribute these to @auphofBSF. Thanks for your understanding!

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@svlandegsvlandegsvlandeg left review comments

Assignees

No one assigned

Labels

conflictsAutomatically generated when a PR has a merge conflictdocsImprovements or additions to documentationinvestigate

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@auphofBSF@LulzLoL231@hakan-77@svlandeg@tiangolo@YuriiMotov@SLLau
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Examples and tests for async support in SQLModel - #471
Closed
auphofBSF wants to merge 13 commits into
fastapi:mainfrom 
auphofBSF:pr-22w42a-tests-for-async-part1
Closed
Examples and tests for async support in SQLModel#471
auphofBSF wants to merge 13 commits into
fastapi:mainfrom 
auphofBSF:pr-22w42a-tests-for-async-part1
Conversation
@auphofBSF
@auphofBSFauphofBSF
commented
Oct 18, 2022•

edited

Loading

Copy link


Copy Markdown

  • (2✅ of 15⏹️ ) asyncio Tutorials matching sync Tutorials.
  • (2✅ of 15⏹️ ) pytest asyncio tutorial tests
  • ✅above tests and tutorials passing mypy static analysis (see note below)
mypy static test dependencies
The work done in #58 resolves the mypy static type analysis issues "AsyncSession" has incompatible type "SelectOfScalar[Hero]"

with mypy docs_src\tutorial_async before: #58
image

after #58
image
Note the PR #435
This PR subclasses outstanding sqlalchemy dependencies and also provides some additional tutorial and pytest tests. I have not assessed those tutorials or tests, I have marked in each tutorial that this PR provides the TODO's to change on PR #435 or equivalent being merged, removing the requirement for sqlalchemy imports
Note on python < 3.9
Python 3.6 support should be retired even 3.7 is EOL 2021/12, have got a clean lint and test running for 3.7 but 3.6 required major dependency surgery on pyproject.toml that looked like it was getting there until I ran into
image
The dependency management for 3.6.15 that was working
image
Summary
I believe there is great value in the existing sync tutorials and so have proceeded with converting those to async tutorials as this provides a simple base for adding, extending and checking coverage
@SLLau
test: initial async tests - wip
299a35a
squashed wip commits
based on `docs_src/tutorial`
Goals ---------
convert to async as working examples
ensure static typing with mypy passes
@SLLau
fix: mypy static typing failures , FieldInfo
886b962
use https://pydantic-docs.helpmanual.io/usage/schema/#typingannotated-fields
@SLLau
test: add missing async test update
bca1a7b
refactor: mypy issues with annotations
refactor: simplify async session using SQLmodel
to pass mypy use typdef Annotation see
https://pydantic-docs.helpmanual.io/usage/schema/#typingannotated-fields
@SLLau
refactor: simplify imports
6dec3fe
doc: TODO depend on PR435
refactor: simply session start
@SLLau
refactor: fix function return types for mypy
14bb1b2
@SLLau
test: workaround for async inspect
9e19608
@SLLau
chore: fixes for mypy static type checks
b60b137
only addresses async tests, does not try to fix
other tests
use: `mypy docs_src\tutorial_async` and
`mypy tests\test_async_tutorial`
@SLLau
chore: async test requirements, Drop 3.6 support
22e93d7
pytest.asyncio dropped support for python 3.6 with version 0.17.0 (22-01-13) as Python 3.6 EOL (23 Dec 2021)
@SLLau
doc: add reference in docs to the async tutorial
1151d85
also references tests and major PR dependencies
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 1151d85 at: https://634df5df2d0196544d59a3e1--sqlmodel.netlify.app
@SLLau
fix: mypy "ForwardRef"; implicit reexport disabled
94527a6
current pydantic 1.10.2
see pydantic/pydantic#4358
Fix imports indirectly from pydantic typing #4358
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 94527a6 at: https://634e048b16d79567f08bfacd--sqlmodel.netlify.app
@codecov
codecovBot
commented
Oct 18, 2022•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.
Files with missing linesCoverage Δ
...ect_async/create_tables_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/delete_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/insert_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial002_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial003_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial004_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial005_async.py100.00% <100.00%> (ø)
...nc/connect_async/update_async/tutorial001_async.py100.00% <100.00%> (ø)
...c/tutorial_async/select_async/tutorial001_async.py100.00% <100.00%> (ø)
... and 13 more
... and 4 files with indirect coverage changes
 🚀 New features to boost your workflow: 
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 1846878 at: https://634e5720ac7f9d1fde6279d9--sqlmodel.netlify.app
@SLLau
tests: fix typing.annotations support only ^3.9
5aed51e
async tutorials not supported with mypy static type checking
if python version before 3.9
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 5aed51e at: https://634e81e23c20c3463fe7cccb--sqlmodel.netlify.app
@SLLau
chore: fix for flake8 on python3.7
6d00e2c
flake8 not compatible with 22Oct1 release of importlib_metadata v5
see PyCQA/flake8#1701
set importlib_metadata to 4.13.0
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 6d00e2c at: https://634f09db47ba242e98b80f08--sqlmodel.netlify.app
@auphofBSF
auphofBSF
commented
Oct 18, 2022

Copy link


Copy Markdown

Author
see comments regarding python < 3.9. I believe support for 3.6 should be retired.
@LulzLoL231
LulzLoL231
commented
Jan 31, 2023

Copy link


Copy Markdown

Great addition, any progress?
@tiangolotiangolo
added
the 
docs
Improvements or additions to documentation
label
Oct 22, 2023
@hakan-77
hakan-77
commented
Mar 29, 2025

Copy link


Copy Markdown

This is a great feature, any progress?
@tiangolo
@github-actions
github-actionsBot
commented
Sep 5, 2025

Copy link


Copy Markdown

Contributor
This pull request has a merge conflict that needs to be resolved.
@github-actionsgithub-actionsBot
added
the 
conflicts
Automatically generated when a PR has a merge conflict
label
Sep 5, 2025
svlandeg
svlandeg
reviewed
May 13, 2026
View reviewed changes
@svlandegsvlandeg
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Hi @auphofBSF, all,
Thanks for the contribution 🙏
We've discussed this internally and decided that we prefer to write the first draft of this new documentation section ourselves. We are now tracking this on our internal TODO list. We'll go ahead and close this one in the meantime. Considering how extensive & detailed this PR is though, it's likely that we'll take some ideas/concepts from it, in which case we'll definitely attribute these to @auphofBSF. Thanks for your understanding!
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@svlandegsvlandegsvlandeg left review comments

Assignees


No one assigned


Labels

conflictsAutomatically generated when a PR has a merge conflictdocsImprovements or additions to documentationinvestigate

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

7 participants

@auphofBSF@LulzLoL231@hakan-77@svlandeg@tiangolo@YuriiMotov@SLLau

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Examples and tests for async support in SQLModel - #471
Closed
auphofBSF wants to merge 13 commits into
fastapi:mainfrom 
auphofBSF:pr-22w42a-tests-for-async-part1
Closed
Examples and tests for async support in SQLModel#471
auphofBSF wants to merge 13 commits into
fastapi:mainfrom 
auphofBSF:pr-22w42a-tests-for-async-part1
Conversation
@auphofBSF
@auphofBSFauphofBSF
commented
Oct 18, 2022•

edited

Loading

Copy link


Copy Markdown

  • (2✅ of 15⏹️ ) asyncio Tutorials matching sync Tutorials.
  • (2✅ of 15⏹️ ) pytest asyncio tutorial tests
  • ✅above tests and tutorials passing mypy static analysis (see note below)
mypy static test dependencies
The work done in #58 resolves the mypy static type analysis issues "AsyncSession" has incompatible type "SelectOfScalar[Hero]"

with mypy docs_src\tutorial_async before: #58
image

after #58
image
Note the PR #435
This PR subclasses outstanding sqlalchemy dependencies and also provides some additional tutorial and pytest tests. I have not assessed those tutorials or tests, I have marked in each tutorial that this PR provides the TODO's to change on PR #435 or equivalent being merged, removing the requirement for sqlalchemy imports
Note on python < 3.9
Python 3.6 support should be retired even 3.7 is EOL 2021/12, have got a clean lint and test running for 3.7 but 3.6 required major dependency surgery on pyproject.toml that looked like it was getting there until I ran into
image
The dependency management for 3.6.15 that was working
image
Summary
I believe there is great value in the existing sync tutorials and so have proceeded with converting those to async tutorials as this provides a simple base for adding, extending and checking coverage
@SLLau
test: initial async tests - wip
299a35a
squashed wip commits
based on `docs_src/tutorial`
Goals ---------
convert to async as working examples
ensure static typing with mypy passes
@SLLau
fix: mypy static typing failures , FieldInfo
886b962
use https://pydantic-docs.helpmanual.io/usage/schema/#typingannotated-fields
@SLLau
test: add missing async test update
bca1a7b
refactor: mypy issues with annotations
refactor: simplify async session using SQLmodel
to pass mypy use typdef Annotation see
https://pydantic-docs.helpmanual.io/usage/schema/#typingannotated-fields
@SLLau
refactor: simplify imports
6dec3fe
doc: TODO depend on PR435
refactor: simply session start
@SLLau
refactor: fix function return types for mypy
14bb1b2
@SLLau
test: workaround for async inspect
9e19608
@SLLau
chore: fixes for mypy static type checks
b60b137
only addresses async tests, does not try to fix
other tests
use: `mypy docs_src\tutorial_async` and
`mypy tests\test_async_tutorial`
@SLLau
chore: async test requirements, Drop 3.6 support
22e93d7
pytest.asyncio dropped support for python 3.6 with version 0.17.0 (22-01-13) as Python 3.6 EOL (23 Dec 2021)
@SLLau
doc: add reference in docs to the async tutorial
1151d85
also references tests and major PR dependencies
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 1151d85 at: https://634df5df2d0196544d59a3e1--sqlmodel.netlify.app
@SLLau
fix: mypy "ForwardRef"; implicit reexport disabled
94527a6
current pydantic 1.10.2
see pydantic/pydantic#4358
Fix imports indirectly from pydantic typing #4358
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 94527a6 at: https://634e048b16d79567f08bfacd--sqlmodel.netlify.app
@codecov
codecovBot
commented
Oct 18, 2022•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.
Files with missing linesCoverage Δ
...ect_async/create_tables_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/delete_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/insert_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial002_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial003_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial004_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial005_async.py100.00% <100.00%> (ø)
...nc/connect_async/update_async/tutorial001_async.py100.00% <100.00%> (ø)
...c/tutorial_async/select_async/tutorial001_async.py100.00% <100.00%> (ø)
... and 13 more
... and 4 files with indirect coverage changes
 🚀 New features to boost your workflow: 
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 1846878 at: https://634e5720ac7f9d1fde6279d9--sqlmodel.netlify.app
@SLLau
tests: fix typing.annotations support only ^3.9
5aed51e
async tutorials not supported with mypy static type checking
if python version before 3.9
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 5aed51e at: https://634e81e23c20c3463fe7cccb--sqlmodel.netlify.app
@SLLau
chore: fix for flake8 on python3.7
6d00e2c
flake8 not compatible with 22Oct1 release of importlib_metadata v5
see PyCQA/flake8#1701
set importlib_metadata to 4.13.0
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 6d00e2c at: https://634f09db47ba242e98b80f08--sqlmodel.netlify.app
@auphofBSF
auphofBSF
commented
Oct 18, 2022

Copy link


Copy Markdown

Author
see comments regarding python < 3.9. I believe support for 3.6 should be retired.
@LulzLoL231
LulzLoL231
commented
Jan 31, 2023

Copy link


Copy Markdown

Great addition, any progress?
@tiangolotiangolo
added
the 
docs
Improvements or additions to documentation
label
Oct 22, 2023
@hakan-77
hakan-77
commented
Mar 29, 2025

Copy link


Copy Markdown

This is a great feature, any progress?
@tiangolo
@github-actions
github-actionsBot
commented
Sep 5, 2025

Copy link


Copy Markdown

Contributor
This pull request has a merge conflict that needs to be resolved.
@github-actionsgithub-actionsBot
added
the 
conflicts
Automatically generated when a PR has a merge conflict
label
Sep 5, 2025
svlandeg
svlandeg
reviewed
May 13, 2026
View reviewed changes
@svlandegsvlandeg
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Hi @auphofBSF, all,
Thanks for the contribution 🙏
We've discussed this internally and decided that we prefer to write the first draft of this new documentation section ourselves. We are now tracking this on our internal TODO list. We'll go ahead and close this one in the meantime. Considering how extensive & detailed this PR is though, it's likely that we'll take some ideas/concepts from it, in which case we'll definitely attribute these to @auphofBSF. Thanks for your understanding!
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@svlandegsvlandegsvlandeg left review comments

Assignees


No one assigned


Labels

conflictsAutomatically generated when a PR has a merge conflictdocsImprovements or additions to documentationinvestigate

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

7 participants

@auphofBSF@LulzLoL231@hakan-77@svlandeg@tiangolo@YuriiMotov@SLLau

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Examples and tests for async support in SQLModel - #471
Closed
auphofBSF wants to merge 13 commits into
fastapi:mainfrom 
auphofBSF:pr-22w42a-tests-for-async-part1
Closed
Examples and tests for async support in SQLModel#471
auphofBSF wants to merge 13 commits into
fastapi:mainfrom 
auphofBSF:pr-22w42a-tests-for-async-part1
Conversation
@auphofBSF
@auphofBSFauphofBSF
commented
Oct 18, 2022•

edited

Loading

Copy link


Copy Markdown

  • (2✅ of 15⏹️ ) asyncio Tutorials matching sync Tutorials.
  • (2✅ of 15⏹️ ) pytest asyncio tutorial tests
  • ✅above tests and tutorials passing mypy static analysis (see note below)
mypy static test dependencies
The work done in #58 resolves the mypy static type analysis issues "AsyncSession" has incompatible type "SelectOfScalar[Hero]"

with mypy docs_src\tutorial_async before: #58
image

after #58
image
Note the PR #435
This PR subclasses outstanding sqlalchemy dependencies and also provides some additional tutorial and pytest tests. I have not assessed those tutorials or tests, I have marked in each tutorial that this PR provides the TODO's to change on PR #435 or equivalent being merged, removing the requirement for sqlalchemy imports
Note on python < 3.9
Python 3.6 support should be retired even 3.7 is EOL 2021/12, have got a clean lint and test running for 3.7 but 3.6 required major dependency surgery on pyproject.toml that looked like it was getting there until I ran into
image
The dependency management for 3.6.15 that was working
image
Summary
I believe there is great value in the existing sync tutorials and so have proceeded with converting those to async tutorials as this provides a simple base for adding, extending and checking coverage
@SLLau
test: initial async tests - wip
299a35a
squashed wip commits
based on `docs_src/tutorial`
Goals ---------
convert to async as working examples
ensure static typing with mypy passes
@SLLau
fix: mypy static typing failures , FieldInfo
886b962
use https://pydantic-docs.helpmanual.io/usage/schema/#typingannotated-fields
@SLLau
test: add missing async test update
bca1a7b
refactor: mypy issues with annotations
refactor: simplify async session using SQLmodel
to pass mypy use typdef Annotation see
https://pydantic-docs.helpmanual.io/usage/schema/#typingannotated-fields
@SLLau
refactor: simplify imports
6dec3fe
doc: TODO depend on PR435
refactor: simply session start
@SLLau
refactor: fix function return types for mypy
14bb1b2
@SLLau
test: workaround for async inspect
9e19608
@SLLau
chore: fixes for mypy static type checks
b60b137
only addresses async tests, does not try to fix
other tests
use: `mypy docs_src\tutorial_async` and
`mypy tests\test_async_tutorial`
@SLLau
chore: async test requirements, Drop 3.6 support
22e93d7
pytest.asyncio dropped support for python 3.6 with version 0.17.0 (22-01-13) as Python 3.6 EOL (23 Dec 2021)
@SLLau
doc: add reference in docs to the async tutorial
1151d85
also references tests and major PR dependencies
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 1151d85 at: https://634df5df2d0196544d59a3e1--sqlmodel.netlify.app
@SLLau
fix: mypy "ForwardRef"; implicit reexport disabled
94527a6
current pydantic 1.10.2
see pydantic/pydantic#4358
Fix imports indirectly from pydantic typing #4358
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 94527a6 at: https://634e048b16d79567f08bfacd--sqlmodel.netlify.app
@codecov
codecovBot
commented
Oct 18, 2022•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.
Files with missing linesCoverage Δ
...ect_async/create_tables_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/delete_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/insert_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial002_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial003_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial004_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial005_async.py100.00% <100.00%> (ø)
...nc/connect_async/update_async/tutorial001_async.py100.00% <100.00%> (ø)
...c/tutorial_async/select_async/tutorial001_async.py100.00% <100.00%> (ø)
... and 13 more
... and 4 files with indirect coverage changes
 🚀 New features to boost your workflow: 
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 1846878 at: https://634e5720ac7f9d1fde6279d9--sqlmodel.netlify.app
@SLLau
tests: fix typing.annotations support only ^3.9
5aed51e
async tutorials not supported with mypy static type checking
if python version before 3.9
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 5aed51e at: https://634e81e23c20c3463fe7cccb--sqlmodel.netlify.app
@SLLau
chore: fix for flake8 on python3.7
6d00e2c
flake8 not compatible with 22Oct1 release of importlib_metadata v5
see PyCQA/flake8#1701
set importlib_metadata to 4.13.0
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 6d00e2c at: https://634f09db47ba242e98b80f08--sqlmodel.netlify.app
@auphofBSF
auphofBSF
commented
Oct 18, 2022

Copy link


Copy Markdown

Author
see comments regarding python < 3.9. I believe support for 3.6 should be retired.
@LulzLoL231
LulzLoL231
commented
Jan 31, 2023

Copy link


Copy Markdown

Great addition, any progress?
@tiangolotiangolo
added
the 
docs
Improvements or additions to documentation
label
Oct 22, 2023
@hakan-77
hakan-77
commented
Mar 29, 2025

Copy link


Copy Markdown

This is a great feature, any progress?
@tiangolo
@github-actions
github-actionsBot
commented
Sep 5, 2025

Copy link


Copy Markdown

Contributor
This pull request has a merge conflict that needs to be resolved.
@github-actionsgithub-actionsBot
added
the 
conflicts
Automatically generated when a PR has a merge conflict
label
Sep 5, 2025
svlandeg
svlandeg
reviewed
May 13, 2026
View reviewed changes
@svlandegsvlandeg
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Hi @auphofBSF, all,
Thanks for the contribution 🙏
We've discussed this internally and decided that we prefer to write the first draft of this new documentation section ourselves. We are now tracking this on our internal TODO list. We'll go ahead and close this one in the meantime. Considering how extensive & detailed this PR is though, it's likely that we'll take some ideas/concepts from it, in which case we'll definitely attribute these to @auphofBSF. Thanks for your understanding!
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@svlandegsvlandegsvlandeg left review comments

Assignees


No one assigned


Labels

conflictsAutomatically generated when a PR has a merge conflictdocsImprovements or additions to documentationinvestigate

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

7 participants

@auphofBSF@LulzLoL231@hakan-77@svlandeg@tiangolo@YuriiMotov@SLLau

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Examples and tests for async support in SQLModel - #471
Closed
auphofBSF wants to merge 13 commits into
fastapi:mainfrom 
auphofBSF:pr-22w42a-tests-for-async-part1
Closed
Examples and tests for async support in SQLModel#471
auphofBSF wants to merge 13 commits into
fastapi:mainfrom 
auphofBSF:pr-22w42a-tests-for-async-part1
Conversation
@auphofBSF
@auphofBSFauphofBSF
commented
Oct 18, 2022•

edited

Loading

Copy link


Copy Markdown

  • (2✅ of 15⏹️ ) asyncio Tutorials matching sync Tutorials.
  • (2✅ of 15⏹️ ) pytest asyncio tutorial tests
  • ✅above tests and tutorials passing mypy static analysis (see note below)
mypy static test dependencies
The work done in #58 resolves the mypy static type analysis issues "AsyncSession" has incompatible type "SelectOfScalar[Hero]"

with mypy docs_src\tutorial_async before: #58
image

after #58
image
Note the PR #435
This PR subclasses outstanding sqlalchemy dependencies and also provides some additional tutorial and pytest tests. I have not assessed those tutorials or tests, I have marked in each tutorial that this PR provides the TODO's to change on PR #435 or equivalent being merged, removing the requirement for sqlalchemy imports
Note on python < 3.9
Python 3.6 support should be retired even 3.7 is EOL 2021/12, have got a clean lint and test running for 3.7 but 3.6 required major dependency surgery on pyproject.toml that looked like it was getting there until I ran into
image
The dependency management for 3.6.15 that was working
image
Summary
I believe there is great value in the existing sync tutorials and so have proceeded with converting those to async tutorials as this provides a simple base for adding, extending and checking coverage
@SLLau
test: initial async tests - wip
299a35a
squashed wip commits
based on `docs_src/tutorial`
Goals ---------
convert to async as working examples
ensure static typing with mypy passes
@SLLau
fix: mypy static typing failures , FieldInfo
886b962
use https://pydantic-docs.helpmanual.io/usage/schema/#typingannotated-fields
@SLLau
test: add missing async test update
bca1a7b
refactor: mypy issues with annotations
refactor: simplify async session using SQLmodel
to pass mypy use typdef Annotation see
https://pydantic-docs.helpmanual.io/usage/schema/#typingannotated-fields
@SLLau
refactor: simplify imports
6dec3fe
doc: TODO depend on PR435
refactor: simply session start
@SLLau
refactor: fix function return types for mypy
14bb1b2
@SLLau
test: workaround for async inspect
9e19608
@SLLau
chore: fixes for mypy static type checks
b60b137
only addresses async tests, does not try to fix
other tests
use: `mypy docs_src\tutorial_async` and
`mypy tests\test_async_tutorial`
@SLLau
chore: async test requirements, Drop 3.6 support
22e93d7
pytest.asyncio dropped support for python 3.6 with version 0.17.0 (22-01-13) as Python 3.6 EOL (23 Dec 2021)
@SLLau
doc: add reference in docs to the async tutorial
1151d85
also references tests and major PR dependencies
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 1151d85 at: https://634df5df2d0196544d59a3e1--sqlmodel.netlify.app
@SLLau
fix: mypy "ForwardRef"; implicit reexport disabled
94527a6
current pydantic 1.10.2
see pydantic/pydantic#4358
Fix imports indirectly from pydantic typing #4358
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 94527a6 at: https://634e048b16d79567f08bfacd--sqlmodel.netlify.app
@codecov
codecovBot
commented
Oct 18, 2022•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.
Files with missing linesCoverage Δ
...ect_async/create_tables_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/delete_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/insert_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial002_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial003_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial004_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial005_async.py100.00% <100.00%> (ø)
...nc/connect_async/update_async/tutorial001_async.py100.00% <100.00%> (ø)
...c/tutorial_async/select_async/tutorial001_async.py100.00% <100.00%> (ø)
... and 13 more
... and 4 files with indirect coverage changes
 🚀 New features to boost your workflow: 
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 1846878 at: https://634e5720ac7f9d1fde6279d9--sqlmodel.netlify.app
@SLLau
tests: fix typing.annotations support only ^3.9
5aed51e
async tutorials not supported with mypy static type checking
if python version before 3.9
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 5aed51e at: https://634e81e23c20c3463fe7cccb--sqlmodel.netlify.app
@SLLau
chore: fix for flake8 on python3.7
6d00e2c
flake8 not compatible with 22Oct1 release of importlib_metadata v5
see PyCQA/flake8#1701
set importlib_metadata to 4.13.0
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 6d00e2c at: https://634f09db47ba242e98b80f08--sqlmodel.netlify.app
@auphofBSF
auphofBSF
commented
Oct 18, 2022

Copy link


Copy Markdown

Author
see comments regarding python < 3.9. I believe support for 3.6 should be retired.
@LulzLoL231
LulzLoL231
commented
Jan 31, 2023

Copy link


Copy Markdown

Great addition, any progress?
@tiangolotiangolo
added
the 
docs
Improvements or additions to documentation
label
Oct 22, 2023
@hakan-77
hakan-77
commented
Mar 29, 2025

Copy link


Copy Markdown

This is a great feature, any progress?
@tiangolo
@github-actions
github-actionsBot
commented
Sep 5, 2025

Copy link


Copy Markdown

Contributor
This pull request has a merge conflict that needs to be resolved.
@github-actionsgithub-actionsBot
added
the 
conflicts
Automatically generated when a PR has a merge conflict
label
Sep 5, 2025
svlandeg
svlandeg
reviewed
May 13, 2026
View reviewed changes
@svlandegsvlandeg
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Hi @auphofBSF, all,
Thanks for the contribution 🙏
We've discussed this internally and decided that we prefer to write the first draft of this new documentation section ourselves. We are now tracking this on our internal TODO list. We'll go ahead and close this one in the meantime. Considering how extensive & detailed this PR is though, it's likely that we'll take some ideas/concepts from it, in which case we'll definitely attribute these to @auphofBSF. Thanks for your understanding!
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@svlandegsvlandegsvlandeg left review comments

Assignees


No one assigned


Labels

conflictsAutomatically generated when a PR has a merge conflictdocsImprovements or additions to documentationinvestigate

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

7 participants

@auphofBSF@LulzLoL231@hakan-77@svlandeg@tiangolo@YuriiMotov@SLLau

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Examples and tests for async support in SQLModel - #471
Closed
auphofBSF wants to merge 13 commits into
fastapi:mainfrom 
auphofBSF:pr-22w42a-tests-for-async-part1
Closed
Examples and tests for async support in SQLModel#471
auphofBSF wants to merge 13 commits into
fastapi:mainfrom 
auphofBSF:pr-22w42a-tests-for-async-part1
Conversation
@auphofBSF
@auphofBSFauphofBSF
commented
Oct 18, 2022•

edited

Loading

Copy link


Copy Markdown

  • (2✅ of 15⏹️ ) asyncio Tutorials matching sync Tutorials.
  • (2✅ of 15⏹️ ) pytest asyncio tutorial tests
  • ✅above tests and tutorials passing mypy static analysis (see note below)
mypy static test dependencies
The work done in #58 resolves the mypy static type analysis issues "AsyncSession" has incompatible type "SelectOfScalar[Hero]"

with mypy docs_src\tutorial_async before: #58
image

after #58
image
Note the PR #435
This PR subclasses outstanding sqlalchemy dependencies and also provides some additional tutorial and pytest tests. I have not assessed those tutorials or tests, I have marked in each tutorial that this PR provides the TODO's to change on PR #435 or equivalent being merged, removing the requirement for sqlalchemy imports
Note on python < 3.9
Python 3.6 support should be retired even 3.7 is EOL 2021/12, have got a clean lint and test running for 3.7 but 3.6 required major dependency surgery on pyproject.toml that looked like it was getting there until I ran into
image
The dependency management for 3.6.15 that was working
image
Summary
I believe there is great value in the existing sync tutorials and so have proceeded with converting those to async tutorials as this provides a simple base for adding, extending and checking coverage
@SLLau
test: initial async tests - wip
299a35a
squashed wip commits
based on `docs_src/tutorial`
Goals ---------
convert to async as working examples
ensure static typing with mypy passes
@SLLau
fix: mypy static typing failures , FieldInfo
886b962
use https://pydantic-docs.helpmanual.io/usage/schema/#typingannotated-fields
@SLLau
test: add missing async test update
bca1a7b
refactor: mypy issues with annotations
refactor: simplify async session using SQLmodel
to pass mypy use typdef Annotation see
https://pydantic-docs.helpmanual.io/usage/schema/#typingannotated-fields
@SLLau
refactor: simplify imports
6dec3fe
doc: TODO depend on PR435
refactor: simply session start
@SLLau
refactor: fix function return types for mypy
14bb1b2
@SLLau
test: workaround for async inspect
9e19608
@SLLau
chore: fixes for mypy static type checks
b60b137
only addresses async tests, does not try to fix
other tests
use: `mypy docs_src\tutorial_async` and
`mypy tests\test_async_tutorial`
@SLLau
chore: async test requirements, Drop 3.6 support
22e93d7
pytest.asyncio dropped support for python 3.6 with version 0.17.0 (22-01-13) as Python 3.6 EOL (23 Dec 2021)
@SLLau
doc: add reference in docs to the async tutorial
1151d85
also references tests and major PR dependencies
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 1151d85 at: https://634df5df2d0196544d59a3e1--sqlmodel.netlify.app
@SLLau
fix: mypy "ForwardRef"; implicit reexport disabled
94527a6
current pydantic 1.10.2
see pydantic/pydantic#4358
Fix imports indirectly from pydantic typing #4358
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 94527a6 at: https://634e048b16d79567f08bfacd--sqlmodel.netlify.app
@codecov
codecovBot
commented
Oct 18, 2022•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.
Files with missing linesCoverage Δ
...ect_async/create_tables_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/delete_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/insert_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial002_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial003_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial004_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial005_async.py100.00% <100.00%> (ø)
...nc/connect_async/update_async/tutorial001_async.py100.00% <100.00%> (ø)
...c/tutorial_async/select_async/tutorial001_async.py100.00% <100.00%> (ø)
... and 13 more
... and 4 files with indirect coverage changes
 🚀 New features to boost your workflow: 
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 1846878 at: https://634e5720ac7f9d1fde6279d9--sqlmodel.netlify.app
@SLLau
tests: fix typing.annotations support only ^3.9
5aed51e
async tutorials not supported with mypy static type checking
if python version before 3.9
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 5aed51e at: https://634e81e23c20c3463fe7cccb--sqlmodel.netlify.app
@SLLau
chore: fix for flake8 on python3.7
6d00e2c
flake8 not compatible with 22Oct1 release of importlib_metadata v5
see PyCQA/flake8#1701
set importlib_metadata to 4.13.0
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 6d00e2c at: https://634f09db47ba242e98b80f08--sqlmodel.netlify.app
@auphofBSF
auphofBSF
commented
Oct 18, 2022

Copy link


Copy Markdown

Author
see comments regarding python < 3.9. I believe support for 3.6 should be retired.
@LulzLoL231
LulzLoL231
commented
Jan 31, 2023

Copy link


Copy Markdown

Great addition, any progress?
@tiangolotiangolo
added
the 
docs
Improvements or additions to documentation
label
Oct 22, 2023
@hakan-77
hakan-77
commented
Mar 29, 2025

Copy link


Copy Markdown

This is a great feature, any progress?
@tiangolo
@github-actions
github-actionsBot
commented
Sep 5, 2025

Copy link


Copy Markdown

Contributor
This pull request has a merge conflict that needs to be resolved.
@github-actionsgithub-actionsBot
added
the 
conflicts
Automatically generated when a PR has a merge conflict
label
Sep 5, 2025
svlandeg
svlandeg
reviewed
May 13, 2026
View reviewed changes
@svlandegsvlandeg
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Hi @auphofBSF, all,
Thanks for the contribution 🙏
We've discussed this internally and decided that we prefer to write the first draft of this new documentation section ourselves. We are now tracking this on our internal TODO list. We'll go ahead and close this one in the meantime. Considering how extensive & detailed this PR is though, it's likely that we'll take some ideas/concepts from it, in which case we'll definitely attribute these to @auphofBSF. Thanks for your understanding!
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@svlandegsvlandegsvlandeg left review comments

Assignees


No one assigned


Labels

conflictsAutomatically generated when a PR has a merge conflictdocsImprovements or additions to documentationinvestigate

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

7 participants

@auphofBSF@LulzLoL231@hakan-77@svlandeg@tiangolo@YuriiMotov@SLLau

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Examples and tests for async support in SQLModel - #471
Closed
auphofBSF wants to merge 13 commits into
fastapi:mainfrom 
auphofBSF:pr-22w42a-tests-for-async-part1
Closed
Examples and tests for async support in SQLModel#471
auphofBSF wants to merge 13 commits into
fastapi:mainfrom 
auphofBSF:pr-22w42a-tests-for-async-part1
Conversation
@auphofBSF
@auphofBSFauphofBSF
commented
Oct 18, 2022•

edited

Loading

Copy link


Copy Markdown

  • (2✅ of 15⏹️ ) asyncio Tutorials matching sync Tutorials.
  • (2✅ of 15⏹️ ) pytest asyncio tutorial tests
  • ✅above tests and tutorials passing mypy static analysis (see note below)
mypy static test dependencies
The work done in #58 resolves the mypy static type analysis issues "AsyncSession" has incompatible type "SelectOfScalar[Hero]"

with mypy docs_src\tutorial_async before: #58
image

after #58
image
Note the PR #435
This PR subclasses outstanding sqlalchemy dependencies and also provides some additional tutorial and pytest tests. I have not assessed those tutorials or tests, I have marked in each tutorial that this PR provides the TODO's to change on PR #435 or equivalent being merged, removing the requirement for sqlalchemy imports
Note on python < 3.9
Python 3.6 support should be retired even 3.7 is EOL 2021/12, have got a clean lint and test running for 3.7 but 3.6 required major dependency surgery on pyproject.toml that looked like it was getting there until I ran into
image
The dependency management for 3.6.15 that was working
image
Summary
I believe there is great value in the existing sync tutorials and so have proceeded with converting those to async tutorials as this provides a simple base for adding, extending and checking coverage
@SLLau
test: initial async tests - wip
299a35a
squashed wip commits
based on `docs_src/tutorial`
Goals ---------
convert to async as working examples
ensure static typing with mypy passes
@SLLau
fix: mypy static typing failures , FieldInfo
886b962
use https://pydantic-docs.helpmanual.io/usage/schema/#typingannotated-fields
@SLLau
test: add missing async test update
bca1a7b
refactor: mypy issues with annotations
refactor: simplify async session using SQLmodel
to pass mypy use typdef Annotation see
https://pydantic-docs.helpmanual.io/usage/schema/#typingannotated-fields
@SLLau
refactor: simplify imports
6dec3fe
doc: TODO depend on PR435
refactor: simply session start
@SLLau
refactor: fix function return types for mypy
14bb1b2
@SLLau
test: workaround for async inspect
9e19608
@SLLau
chore: fixes for mypy static type checks
b60b137
only addresses async tests, does not try to fix
other tests
use: `mypy docs_src\tutorial_async` and
`mypy tests\test_async_tutorial`
@SLLau
chore: async test requirements, Drop 3.6 support
22e93d7
pytest.asyncio dropped support for python 3.6 with version 0.17.0 (22-01-13) as Python 3.6 EOL (23 Dec 2021)
@SLLau
doc: add reference in docs to the async tutorial
1151d85
also references tests and major PR dependencies
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 1151d85 at: https://634df5df2d0196544d59a3e1--sqlmodel.netlify.app
@SLLau
fix: mypy "ForwardRef"; implicit reexport disabled
94527a6
current pydantic 1.10.2
see pydantic/pydantic#4358
Fix imports indirectly from pydantic typing #4358
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 94527a6 at: https://634e048b16d79567f08bfacd--sqlmodel.netlify.app
@codecov
codecovBot
commented
Oct 18, 2022•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.
Files with missing linesCoverage Δ
...ect_async/create_tables_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/delete_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/insert_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial002_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial003_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial004_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial005_async.py100.00% <100.00%> (ø)
...nc/connect_async/update_async/tutorial001_async.py100.00% <100.00%> (ø)
...c/tutorial_async/select_async/tutorial001_async.py100.00% <100.00%> (ø)
... and 13 more
... and 4 files with indirect coverage changes
 🚀 New features to boost your workflow: 
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 1846878 at: https://634e5720ac7f9d1fde6279d9--sqlmodel.netlify.app
@SLLau
tests: fix typing.annotations support only ^3.9
5aed51e
async tutorials not supported with mypy static type checking
if python version before 3.9
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 5aed51e at: https://634e81e23c20c3463fe7cccb--sqlmodel.netlify.app
@SLLau
chore: fix for flake8 on python3.7
6d00e2c
flake8 not compatible with 22Oct1 release of importlib_metadata v5
see PyCQA/flake8#1701
set importlib_metadata to 4.13.0
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 6d00e2c at: https://634f09db47ba242e98b80f08--sqlmodel.netlify.app
@auphofBSF
auphofBSF
commented
Oct 18, 2022

Copy link


Copy Markdown

Author
see comments regarding python < 3.9. I believe support for 3.6 should be retired.
@LulzLoL231
LulzLoL231
commented
Jan 31, 2023

Copy link


Copy Markdown

Great addition, any progress?
@tiangolotiangolo
added
the 
docs
Improvements or additions to documentation
label
Oct 22, 2023
@hakan-77
hakan-77
commented
Mar 29, 2025

Copy link


Copy Markdown

This is a great feature, any progress?
@tiangolo
@github-actions
github-actionsBot
commented
Sep 5, 2025

Copy link


Copy Markdown

Contributor
This pull request has a merge conflict that needs to be resolved.
@github-actionsgithub-actionsBot
added
the 
conflicts
Automatically generated when a PR has a merge conflict
label
Sep 5, 2025
svlandeg
svlandeg
reviewed
May 13, 2026
View reviewed changes
@svlandegsvlandeg
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Hi @auphofBSF, all,
Thanks for the contribution 🙏
We've discussed this internally and decided that we prefer to write the first draft of this new documentation section ourselves. We are now tracking this on our internal TODO list. We'll go ahead and close this one in the meantime. Considering how extensive & detailed this PR is though, it's likely that we'll take some ideas/concepts from it, in which case we'll definitely attribute these to @auphofBSF. Thanks for your understanding!
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@svlandegsvlandegsvlandeg left review comments

Assignees


No one assigned


Labels

conflictsAutomatically generated when a PR has a merge conflictdocsImprovements or additions to documentationinvestigate

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

7 participants

@auphofBSF@LulzLoL231@hakan-77@svlandeg@tiangolo@YuriiMotov@SLLau

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Examples and tests for async support in SQLModel - #471
Closed
auphofBSF wants to merge 13 commits into
fastapi:mainfrom 
auphofBSF:pr-22w42a-tests-for-async-part1
Closed
Examples and tests for async support in SQLModel#471
auphofBSF wants to merge 13 commits into
fastapi:mainfrom 
auphofBSF:pr-22w42a-tests-for-async-part1
Conversation
@auphofBSF
@auphofBSFauphofBSF
commented
Oct 18, 2022•

edited

Loading

Copy link


Copy Markdown

  • (2✅ of 15⏹️ ) asyncio Tutorials matching sync Tutorials.
  • (2✅ of 15⏹️ ) pytest asyncio tutorial tests
  • ✅above tests and tutorials passing mypy static analysis (see note below)
mypy static test dependencies
The work done in #58 resolves the mypy static type analysis issues "AsyncSession" has incompatible type "SelectOfScalar[Hero]"

with mypy docs_src\tutorial_async before: #58
image

after #58
image
Note the PR #435
This PR subclasses outstanding sqlalchemy dependencies and also provides some additional tutorial and pytest tests. I have not assessed those tutorials or tests, I have marked in each tutorial that this PR provides the TODO's to change on PR #435 or equivalent being merged, removing the requirement for sqlalchemy imports
Note on python < 3.9
Python 3.6 support should be retired even 3.7 is EOL 2021/12, have got a clean lint and test running for 3.7 but 3.6 required major dependency surgery on pyproject.toml that looked like it was getting there until I ran into
image
The dependency management for 3.6.15 that was working
image
Summary
I believe there is great value in the existing sync tutorials and so have proceeded with converting those to async tutorials as this provides a simple base for adding, extending and checking coverage
@SLLau
test: initial async tests - wip
299a35a
squashed wip commits
based on `docs_src/tutorial`
Goals ---------
convert to async as working examples
ensure static typing with mypy passes
@SLLau
fix: mypy static typing failures , FieldInfo
886b962
use https://pydantic-docs.helpmanual.io/usage/schema/#typingannotated-fields
@SLLau
test: add missing async test update
bca1a7b
refactor: mypy issues with annotations
refactor: simplify async session using SQLmodel
to pass mypy use typdef Annotation see
https://pydantic-docs.helpmanual.io/usage/schema/#typingannotated-fields
@SLLau
refactor: simplify imports
6dec3fe
doc: TODO depend on PR435
refactor: simply session start
@SLLau
refactor: fix function return types for mypy
14bb1b2
@SLLau
test: workaround for async inspect
9e19608
@SLLau
chore: fixes for mypy static type checks
b60b137
only addresses async tests, does not try to fix
other tests
use: `mypy docs_src\tutorial_async` and
`mypy tests\test_async_tutorial`
@SLLau
chore: async test requirements, Drop 3.6 support
22e93d7
pytest.asyncio dropped support for python 3.6 with version 0.17.0 (22-01-13) as Python 3.6 EOL (23 Dec 2021)
@SLLau
doc: add reference in docs to the async tutorial
1151d85
also references tests and major PR dependencies
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 1151d85 at: https://634df5df2d0196544d59a3e1--sqlmodel.netlify.app
@SLLau
fix: mypy "ForwardRef"; implicit reexport disabled
94527a6
current pydantic 1.10.2
see pydantic/pydantic#4358
Fix imports indirectly from pydantic typing #4358
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 94527a6 at: https://634e048b16d79567f08bfacd--sqlmodel.netlify.app
@codecov
codecovBot
commented
Oct 18, 2022•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.
Files with missing linesCoverage Δ
...ect_async/create_tables_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/delete_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/insert_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial001_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial002_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial003_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial004_async.py100.00% <100.00%> (ø)
...nc/connect_async/select_async/tutorial005_async.py100.00% <100.00%> (ø)
...nc/connect_async/update_async/tutorial001_async.py100.00% <100.00%> (ø)
...c/tutorial_async/select_async/tutorial001_async.py100.00% <100.00%> (ø)
... and 13 more
... and 4 files with indirect coverage changes
 🚀 New features to boost your workflow: 
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 1846878 at: https://634e5720ac7f9d1fde6279d9--sqlmodel.netlify.app
@SLLau
tests: fix typing.annotations support only ^3.9
5aed51e
async tutorials not supported with mypy static type checking
if python version before 3.9
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 5aed51e at: https://634e81e23c20c3463fe7cccb--sqlmodel.netlify.app
@SLLau
chore: fix for flake8 on python3.7
6d00e2c
flake8 not compatible with 22Oct1 release of importlib_metadata v5
see PyCQA/flake8#1701
set importlib_metadata to 4.13.0
@github-actions
github-actionsBot
commented
Oct 18, 2022

Copy link


Copy Markdown

Contributor
📝 Docs preview for commit 6d00e2c at: https://634f09db47ba242e98b80f08--sqlmodel.netlify.app
@auphofBSF
auphofBSF
commented
Oct 18, 2022

Copy link


Copy Markdown

Author
see comments regarding python < 3.9. I believe support for 3.6 should be retired.
@LulzLoL231
LulzLoL231
commented
Jan 31, 2023

Copy link


Copy Markdown

Great addition, any progress?
@tiangolotiangolo
added
the 
docs
Improvements or additions to documentation
label
Oct 22, 2023
@hakan-77
hakan-77
commented
Mar 29, 2025

Copy link


Copy Markdown

This is a great feature, any progress?
@tiangolo
@github-actions
github-actionsBot
commented
Sep 5, 2025

Copy link


Copy Markdown

Contributor
This pull request has a merge conflict that needs to be resolved.
@github-actionsgithub-actionsBot
added
the 
conflicts
Automatically generated when a PR has a merge conflict
label
Sep 5, 2025
svlandeg
svlandeg
reviewed
May 13, 2026
View reviewed changes
@svlandegsvlandeg
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Hi @auphofBSF, all,
Thanks for the contribution 🙏
We've discussed this internally and decided that we prefer to write the first draft of this new documentation section ourselves. We are now tracking this on our internal TODO list. We'll go ahead and close this one in the meantime. Considering how extensive & detailed this PR is though, it's likely that we'll take some ideas/concepts from it, in which case we'll definitely attribute these to @auphofBSF. Thanks for your understanding!
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@svlandegsvlandegsvlandeg left review comments

Assignees


No one assigned


Labels

conflictsAutomatically generated when a PR has a merge conflictdocsImprovements or additions to documentationinvestigate

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

7 participants

@auphofBSF@LulzLoL231@hakan-77@svlandeg@tiangolo@YuriiMotov@SLLau