🔨 Add script to remove Python 3.9 files, migrate to Python 3.10#1767

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
tiangolo merged 1 commit into from
Feb 20, 2026
Merged

🔨 Add script to remove Python 3.9 files, migrate to Python 3.10 #1767

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
237 changes: 237 additions & 0 deletions scripts/docs.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
import logging
import os
import re
import shutil
import subprocess
from http.server import HTTPServer, SimpleHTTPRequestHandler
from pathlib import Path

import mkdocs.utils
import typer
from jinja2 import Template
from ruff.__main__ import find_ruff_bin

logging.basicConfig(level=logging.INFO)

mkdocs_name = "mkdocs.yml"
docs_path = Path("docs")
en_docs_path = Path("")

app = typer.Typer()
Expand DownExpand Up@@ -143,5 +146,239 @@ def serve() -> None:
server.serve_forever()


@app.command()
def generate_docs_src_versions_for_file(file_path: Path) -> None:
target_versions = ["py39", "py310"]
full_path_str = str(file_path)
for target_version in target_versions:
if f"_{target_version}" in full_path_str:
logging.info(
f"Skipping {file_path}, already a version file for {target_version}"
)
return
base_content = file_path.read_text(encoding="utf-8")
previous_content = {base_content}
for target_version in target_versions:
version_result = subprocess.run(
[
find_ruff_bin(),
"check",
"--target-version",
target_version,
"--fix",
"--unsafe-fixes",
"-",
],
input=base_content.encode("utf-8"),
capture_output=True,
)
content_target = version_result.stdout.decode("utf-8")
format_result = subprocess.run(
[find_ruff_bin(), "format", "-"],
input=content_target.encode("utf-8"),
capture_output=True,
)
content_format = format_result.stdout.decode("utf-8")
if content_format in previous_content:
continue
previous_content.add(content_format)
# Determine where the version label should go: in the parent directory
# name or in the file name, matching the source structure.
label_in_parent = False
for v in target_versions:
if f"_{v}" in file_path.parent.name:
label_in_parent = True
break
if label_in_parent:
parent_name = file_path.parent.name
for v in target_versions:
parent_name = parent_name.replace(f"_{v}", "")
new_parent = file_path.parent.parent / f"{parent_name}_{target_version}"
new_parent.mkdir(parents=True, exist_ok=True)
version_file = new_parent / file_path.name
else:
base_name = file_path.stem
for v in target_versions:
if base_name.endswith(f"_{v}"):
base_name = base_name[: -len(f"_{v}")]
break
version_file = file_path.with_name(f"{base_name}_{target_version}.py")
logging.info(f"Writing to {version_file}")
version_file.write_text(content_format, encoding="utf-8")


@app.command()
def generate_docs_src_versions() -> None:
"""
Generate Python version-specific files for all .py files in docs_src.
"""
docs_src_path = Path("docs_src")
for py_file in sorted(docs_src_path.rglob("*.py")):
generate_docs_src_versions_for_file(py_file)


@app.command()
def copy_py39_to_py310() -> None:
"""
For each docs_src file/directory with a _py39 label that has no _py310
counterpart, copy it with the _py310 label.
"""
docs_src_path = Path("docs_src")
# Handle directory-level labels (e.g. app_b_an_py39/)
for dir_path in sorted(docs_src_path.rglob("*_py39")):
if not dir_path.is_dir():
continue
py310_dir = dir_path.parent / dir_path.name.replace("_py39", "_py310")
if py310_dir.exists():
continue
logging.info(f"Copying directory {dir_path} -> {py310_dir}")
shutil.copytree(dir_path, py310_dir)
# Handle file-level labels (e.g. tutorial001_py39.py)
for file_path in sorted(docs_src_path.rglob("*_py39.py")):
if not file_path.is_file():
continue
# Skip files inside _py39 directories (already handled above)
if "_py39" in file_path.parent.name:
continue
py310_file = file_path.with_name(
file_path.name.replace("_py39.py", "_py310.py")
)
if py310_file.exists():
continue
logging.info(f"Copying file {file_path} -> {py310_file}")
shutil.copy2(file_path, py310_file)


@app.command()
def update_docs_includes_py39_to_py310() -> None:
"""
Update .md files in docs/en/ to replace _py39 includes with _py310 versions.

For each include line referencing a _py39 file or directory in docs_src, replace
the _py39 label with _py310.
"""
include_pattern = re.compile(r"\{[^}]*docs_src/[^}]*_py39[^}]*\.py[^}]*\}")
count = 0
for md_file in sorted(en_docs_path.rglob("*.md")):
content = md_file.read_text(encoding="utf-8")
if "_py39" not in content:
continue
new_content = include_pattern.sub(
lambda m: m.group(0).replace("_py39", "_py310"), content
)
if new_content != content:
md_file.write_text(new_content, encoding="utf-8")
count += 1
logging.info(f"Updated includes in {md_file}")
print(f"Updated {count} file(s) ✅")


@app.command()
def remove_unused_docs_src() -> None:
"""
Delete .py files in docs_src that are not included in any .md file under docs/.
"""
docs_src_path = Path("docs_src")
# Collect all docs .md content referencing docs_src
all_docs_content = ""
for md_file in docs_path.rglob("*.md"):
all_docs_content += md_file.read_text(encoding="utf-8")
# Build a set of directory-based package roots (e.g. docs_src/bigger_applications/app_py39)
# where at least one file is referenced in docs. All files in these directories
# should be kept since they may be internally imported by the referenced files.
used_package_dirs: set[Path] = set()
for py_file in docs_src_path.rglob("*.py"):
if py_file.name == "__init__.py":
continue
rel_path = str(py_file)
if rel_path in all_docs_content:
parts = py_file.relative_to(docs_src_path).parts
if len(parts) > 2 and not py_file.name.startswith("tutorial"):
# File is inside a package directory (e.g.
# docs_src/tutorial/fastapi/app_testing/tutorial001_py310/).
# Mark the immediate parent as a used package so sibling
# files (likely imported by the referenced file) are kept.
used_package_dirs.add(py_file.parent)
removed = 0
for py_file in sorted(docs_src_path.rglob("*.py")):
if py_file.name == "__init__.py":
continue
# Build the relative path as it appears in includes (e.g. docs_src/first_steps/tutorial001.py)
rel_path = str(py_file)
if rel_path in all_docs_content:
continue
# If this file is inside a directory-based package where any sibling is
# referenced, keep it (it's likely imported internally).
if py_file.parent in used_package_dirs:
continue
# Check if the _an counterpart (or non-_an counterpart) is referenced.
# If either variant is included, keep both.
# Handle both file-level _an (tutorial001_an.py) and directory-level _an
# (app_an/main.py)
counterpart_found = False
full_path_str = str(py_file)
if "_an" in py_file.stem:
# This is an _an file, check if the non-_an version is referenced
counterpart = full_path_str.replace(
f"/{py_file.stem}", f"/{py_file.stem.replace('_an', '', 1)}"
)
if counterpart in all_docs_content:
counterpart_found = True
else:
# This is a non-_an file, check if there's an _an version referenced
# Insert _an before any version suffix or at the end of the stem
stem = py_file.stem
for suffix in ("_py39", "_py310"):
if suffix in stem:
an_stem = stem.replace(suffix, f"_an{suffix}", 1)
break
else:
an_stem = f"{stem}_an"
counterpart = full_path_str.replace(f"/{stem}.", f"/{an_stem}.")
if counterpart in all_docs_content:
counterpart_found = True
# Also check directory-level _an counterparts
if not counterpart_found:
parent_name = py_file.parent.name
if "_an" in parent_name:
counterpart_parent = parent_name.replace("_an", "", 1)
counterpart_dir = str(py_file).replace(
f"/{parent_name}/", f"/{counterpart_parent}/"
)
if counterpart_dir in all_docs_content:
counterpart_found = True
else:
# Try inserting _an into parent directory name
for suffix in ("_py39", "_py310"):
if suffix in parent_name:
an_parent = parent_name.replace(suffix, f"_an{suffix}", 1)
break
else:
an_parent = f"{parent_name}_an"
counterpart_dir = str(py_file).replace(
f"/{parent_name}/", f"/{an_parent}/"
)
if counterpart_dir in all_docs_content:
counterpart_found = True
if counterpart_found:
continue
logging.info(f"Removing unused file: {py_file}")
py_file.unlink()
removed += 1
# Clean up directories that are empty or only contain __init__.py / __pycache__
for dir_path in sorted(docs_src_path.rglob("*"), reverse=True):
if not dir_path.is_dir():
continue
remaining = [
f
for f in dir_path.iterdir()
if f.name != "__pycache__" and f.name != "__init__.py"
]
if not remaining:
logging.info(f"Removing empty/init-only directory: {dir_path}")
shutil.rmtree(dir_path)
print(f"Removed {removed} unused file(s) ✅")


if __name__ == "__main__":
app()
, '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
🔨 Add script to remove Python 3.9 files, migrate to Python 3.10#1767

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

Feb 20, 2026
 Merged


🔨 Add script to remove Python 3.9 files, migrate to Python 3.10
#1767
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


237 changes: 237 additions & 0 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
import logging
import os
import re
import shutil
import subprocess
from http.server import HTTPServer, SimpleHTTPRequestHandler
from pathlib import Path

import mkdocs.utils
import typer
from jinja2 import Template
from ruff.__main__ import find_ruff_bin

logging.basicConfig(level=logging.INFO)

mkdocs_name = "mkdocs.yml"
docs_path = Path("docs")
en_docs_path = Path("")

app = typer.Typer()
Expand DownExpand Up@@ -143,5 +146,239 @@ def serve() -> None:
 server.serve_forever()


@app.command()
def generate_docs_src_versions_for_file(file_path: Path) -> None:
 target_versions = ["py39", "py310"]
 full_path_str = str(file_path)
 for target_version in target_versions:
 if f"_{target_version}" in full_path_str:
 logging.info(
 f"Skipping {file_path}, already a version file for {target_version}"
 )
 return
 base_content = file_path.read_text(encoding="utf-8")
 previous_content = {base_content}
 for target_version in target_versions:
 version_result = subprocess.run(
 [
 find_ruff_bin(),
 "check",
 "--target-version",
 target_version,
 "--fix",
 "--unsafe-fixes",
 "-",
 ],
 input=base_content.encode("utf-8"),
 capture_output=True,
 )
 content_target = version_result.stdout.decode("utf-8")
 format_result = subprocess.run(
 [find_ruff_bin(), "format", "-"],
 input=content_target.encode("utf-8"),
 capture_output=True,
 )
 content_format = format_result.stdout.decode("utf-8")
 if content_format in previous_content:
 continue
 previous_content.add(content_format)
 # Determine where the version label should go: in the parent directory
 # name or in the file name, matching the source structure.
 label_in_parent = False
 for v in target_versions:
 if f"_{v}" in file_path.parent.name:
 label_in_parent = True
 break
 if label_in_parent:
 parent_name = file_path.parent.name
 for v in target_versions:
 parent_name = parent_name.replace(f"_{v}", "")
 new_parent = file_path.parent.parent / f"{parent_name}_{target_version}"
 new_parent.mkdir(parents=True, exist_ok=True)
 version_file = new_parent / file_path.name
 else:
 base_name = file_path.stem
 for v in target_versions:
 if base_name.endswith(f"_{v}"):
 base_name = base_name[: -len(f"_{v}")]
 break
 version_file = file_path.with_name(f"{base_name}_{target_version}.py")
 logging.info(f"Writing to {version_file}")
 version_file.write_text(content_format, encoding="utf-8")


@app.command()
def generate_docs_src_versions() -> None:
 """
 Generate Python version-specific files for all .py files in docs_src.
 """
 docs_src_path = Path("docs_src")
 for py_file in sorted(docs_src_path.rglob("*.py")):
 generate_docs_src_versions_for_file(py_file)


@app.command()
def copy_py39_to_py310() -> None:
 """
 For each docs_src file/directory with a _py39 label that has no _py310
 counterpart, copy it with the _py310 label.
 """
 docs_src_path = Path("docs_src")
 # Handle directory-level labels (e.g. app_b_an_py39/)
 for dir_path in sorted(docs_src_path.rglob("*_py39")):
 if not dir_path.is_dir():
 continue
 py310_dir = dir_path.parent / dir_path.name.replace("_py39", "_py310")
 if py310_dir.exists():
 continue
 logging.info(f"Copying directory {dir_path} -> {py310_dir}")
 shutil.copytree(dir_path, py310_dir)
 # Handle file-level labels (e.g. tutorial001_py39.py)
 for file_path in sorted(docs_src_path.rglob("*_py39.py")):
 if not file_path.is_file():
 continue
 # Skip files inside _py39 directories (already handled above)
 if "_py39" in file_path.parent.name:
 continue
 py310_file = file_path.with_name(
 file_path.name.replace("_py39.py", "_py310.py")
 )
 if py310_file.exists():
 continue
 logging.info(f"Copying file {file_path} -> {py310_file}")
 shutil.copy2(file_path, py310_file)


@app.command()
def update_docs_includes_py39_to_py310() -> None:
 """
 Update .md files in docs/en/ to replace _py39 includes with _py310 versions.

 For each include line referencing a _py39 file or directory in docs_src, replace
 the _py39 label with _py310.
 """
 include_pattern = re.compile(r"\{[^}]*docs_src/[^}]*_py39[^}]*\.py[^}]*\}")
 count = 0
 for md_file in sorted(en_docs_path.rglob("*.md")):
 content = md_file.read_text(encoding="utf-8")
 if "_py39" not in content:
 continue
 new_content = include_pattern.sub(
 lambda m: m.group(0).replace("_py39", "_py310"), content
 )
 if new_content != content:
 md_file.write_text(new_content, encoding="utf-8")
 count += 1
 logging.info(f"Updated includes in {md_file}")
 print(f"Updated {count} file(s) ✅")


@app.command()
def remove_unused_docs_src() -> None:
 """
 Delete .py files in docs_src that are not included in any .md file under docs/.
 """
 docs_src_path = Path("docs_src")
 # Collect all docs .md content referencing docs_src
 all_docs_content = ""
 for md_file in docs_path.rglob("*.md"):
 all_docs_content += md_file.read_text(encoding="utf-8")
 # Build a set of directory-based package roots (e.g. docs_src/bigger_applications/app_py39)
 # where at least one file is referenced in docs. All files in these directories
 # should be kept since they may be internally imported by the referenced files.
 used_package_dirs: set[Path] = set()
 for py_file in docs_src_path.rglob("*.py"):
 if py_file.name == "__init__.py":
 continue
 rel_path = str(py_file)
 if rel_path in all_docs_content:
 parts = py_file.relative_to(docs_src_path).parts
 if len(parts) > 2 and not py_file.name.startswith("tutorial"):
 # File is inside a package directory (e.g.
 # docs_src/tutorial/fastapi/app_testing/tutorial001_py310/).
 # Mark the immediate parent as a used package so sibling
 # files (likely imported by the referenced file) are kept.
 used_package_dirs.add(py_file.parent)
 removed = 0
 for py_file in sorted(docs_src_path.rglob("*.py")):
 if py_file.name == "__init__.py":
 continue
 # Build the relative path as it appears in includes (e.g. docs_src/first_steps/tutorial001.py)
 rel_path = str(py_file)
 if rel_path in all_docs_content:
 continue
 # If this file is inside a directory-based package where any sibling is
 # referenced, keep it (it's likely imported internally).
 if py_file.parent in used_package_dirs:
 continue
 # Check if the _an counterpart (or non-_an counterpart) is referenced.
 # If either variant is included, keep both.
 # Handle both file-level _an (tutorial001_an.py) and directory-level _an
 # (app_an/main.py)
 counterpart_found = False
 full_path_str = str(py_file)
 if "_an" in py_file.stem:
 # This is an _an file, check if the non-_an version is referenced
 counterpart = full_path_str.replace(
 f"/{py_file.stem}", f"/{py_file.stem.replace('_an', '', 1)}"
 )
 if counterpart in all_docs_content:
 counterpart_found = True
 else:
 # This is a non-_an file, check if there's an _an version referenced
 # Insert _an before any version suffix or at the end of the stem
 stem = py_file.stem
 for suffix in ("_py39", "_py310"):
 if suffix in stem:
 an_stem = stem.replace(suffix, f"_an{suffix}", 1)
 break
 else:
 an_stem = f"{stem}_an"
 counterpart = full_path_str.replace(f"/{stem}.", f"/{an_stem}.")
 if counterpart in all_docs_content:
 counterpart_found = True
 # Also check directory-level _an counterparts
 if not counterpart_found:
 parent_name = py_file.parent.name
 if "_an" in parent_name:
 counterpart_parent = parent_name.replace("_an", "", 1)
 counterpart_dir = str(py_file).replace(
 f"/{parent_name}/", f"/{counterpart_parent}/"
 )
 if counterpart_dir in all_docs_content:
 counterpart_found = True
 else:
 # Try inserting _an into parent directory name
 for suffix in ("_py39", "_py310"):
 if suffix in parent_name:
 an_parent = parent_name.replace(suffix, f"_an{suffix}", 1)
 break
 else:
 an_parent = f"{parent_name}_an"
 counterpart_dir = str(py_file).replace(
 f"/{parent_name}/", f"/{an_parent}/"
 )
 if counterpart_dir in all_docs_content:
 counterpart_found = True
 if counterpart_found:
 continue
 logging.info(f"Removing unused file: {py_file}")
 py_file.unlink()
 removed += 1
 # Clean up directories that are empty or only contain __init__.py / __pycache__
 for dir_path in sorted(docs_src_path.rglob("*"), reverse=True):
 if not dir_path.is_dir():
 continue
 remaining = [
 f
 for f in dir_path.iterdir()
 if f.name != "__pycache__" and f.name != "__init__.py"
 ]
 if not remaining:
 logging.info(f"Removing empty/init-only directory: {dir_path}")
 shutil.rmtree(dir_path)
 print(f"Removed {removed} unused file(s) ✅")


if __name__ == "__main__":
 app()

, '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
🔨 Add script to remove Python 3.9 files, migrate to Python 3.10#1767

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

Feb 20, 2026
 Merged


🔨 Add script to remove Python 3.9 files, migrate to Python 3.10
#1767
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


237 changes: 237 additions & 0 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
import logging
import os
import re
import shutil
import subprocess
from http.server import HTTPServer, SimpleHTTPRequestHandler
from pathlib import Path

import mkdocs.utils
import typer
from jinja2 import Template
from ruff.__main__ import find_ruff_bin

logging.basicConfig(level=logging.INFO)

mkdocs_name = "mkdocs.yml"
docs_path = Path("docs")
en_docs_path = Path("")

app = typer.Typer()
Expand DownExpand Up@@ -143,5 +146,239 @@ def serve() -> None:
 server.serve_forever()


@app.command()
def generate_docs_src_versions_for_file(file_path: Path) -> None:
 target_versions = ["py39", "py310"]
 full_path_str = str(file_path)
 for target_version in target_versions:
 if f"_{target_version}" in full_path_str:
 logging.info(
 f"Skipping {file_path}, already a version file for {target_version}"
 )
 return
 base_content = file_path.read_text(encoding="utf-8")
 previous_content = {base_content}
 for target_version in target_versions:
 version_result = subprocess.run(
 [
 find_ruff_bin(),
 "check",
 "--target-version",
 target_version,
 "--fix",
 "--unsafe-fixes",
 "-",
 ],
 input=base_content.encode("utf-8"),
 capture_output=True,
 )
 content_target = version_result.stdout.decode("utf-8")
 format_result = subprocess.run(
 [find_ruff_bin(), "format", "-"],
 input=content_target.encode("utf-8"),
 capture_output=True,
 )
 content_format = format_result.stdout.decode("utf-8")
 if content_format in previous_content:
 continue
 previous_content.add(content_format)
 # Determine where the version label should go: in the parent directory
 # name or in the file name, matching the source structure.
 label_in_parent = False
 for v in target_versions:
 if f"_{v}" in file_path.parent.name:
 label_in_parent = True
 break
 if label_in_parent:
 parent_name = file_path.parent.name
 for v in target_versions:
 parent_name = parent_name.replace(f"_{v}", "")
 new_parent = file_path.parent.parent / f"{parent_name}_{target_version}"
 new_parent.mkdir(parents=True, exist_ok=True)
 version_file = new_parent / file_path.name
 else:
 base_name = file_path.stem
 for v in target_versions:
 if base_name.endswith(f"_{v}"):
 base_name = base_name[: -len(f"_{v}")]
 break
 version_file = file_path.with_name(f"{base_name}_{target_version}.py")
 logging.info(f"Writing to {version_file}")
 version_file.write_text(content_format, encoding="utf-8")


@app.command()
def generate_docs_src_versions() -> None:
 """
 Generate Python version-specific files for all .py files in docs_src.
 """
 docs_src_path = Path("docs_src")
 for py_file in sorted(docs_src_path.rglob("*.py")):
 generate_docs_src_versions_for_file(py_file)


@app.command()
def copy_py39_to_py310() -> None:
 """
 For each docs_src file/directory with a _py39 label that has no _py310
 counterpart, copy it with the _py310 label.
 """
 docs_src_path = Path("docs_src")
 # Handle directory-level labels (e.g. app_b_an_py39/)
 for dir_path in sorted(docs_src_path.rglob("*_py39")):
 if not dir_path.is_dir():
 continue
 py310_dir = dir_path.parent / dir_path.name.replace("_py39", "_py310")
 if py310_dir.exists():
 continue
 logging.info(f"Copying directory {dir_path} -> {py310_dir}")
 shutil.copytree(dir_path, py310_dir)
 # Handle file-level labels (e.g. tutorial001_py39.py)
 for file_path in sorted(docs_src_path.rglob("*_py39.py")):
 if not file_path.is_file():
 continue
 # Skip files inside _py39 directories (already handled above)
 if "_py39" in file_path.parent.name:
 continue
 py310_file = file_path.with_name(
 file_path.name.replace("_py39.py", "_py310.py")
 )
 if py310_file.exists():
 continue
 logging.info(f"Copying file {file_path} -> {py310_file}")
 shutil.copy2(file_path, py310_file)


@app.command()
def update_docs_includes_py39_to_py310() -> None:
 """
 Update .md files in docs/en/ to replace _py39 includes with _py310 versions.

 For each include line referencing a _py39 file or directory in docs_src, replace
 the _py39 label with _py310.
 """
 include_pattern = re.compile(r"\{[^}]*docs_src/[^}]*_py39[^}]*\.py[^}]*\}")
 count = 0
 for md_file in sorted(en_docs_path.rglob("*.md")):
 content = md_file.read_text(encoding="utf-8")
 if "_py39" not in content:
 continue
 new_content = include_pattern.sub(
 lambda m: m.group(0).replace("_py39", "_py310"), content
 )
 if new_content != content:
 md_file.write_text(new_content, encoding="utf-8")
 count += 1
 logging.info(f"Updated includes in {md_file}")
 print(f"Updated {count} file(s) ✅")


@app.command()
def remove_unused_docs_src() -> None:
 """
 Delete .py files in docs_src that are not included in any .md file under docs/.
 """
 docs_src_path = Path("docs_src")
 # Collect all docs .md content referencing docs_src
 all_docs_content = ""
 for md_file in docs_path.rglob("*.md"):
 all_docs_content += md_file.read_text(encoding="utf-8")
 # Build a set of directory-based package roots (e.g. docs_src/bigger_applications/app_py39)
 # where at least one file is referenced in docs. All files in these directories
 # should be kept since they may be internally imported by the referenced files.
 used_package_dirs: set[Path] = set()
 for py_file in docs_src_path.rglob("*.py"):
 if py_file.name == "__init__.py":
 continue
 rel_path = str(py_file)
 if rel_path in all_docs_content:
 parts = py_file.relative_to(docs_src_path).parts
 if len(parts) > 2 and not py_file.name.startswith("tutorial"):
 # File is inside a package directory (e.g.
 # docs_src/tutorial/fastapi/app_testing/tutorial001_py310/).
 # Mark the immediate parent as a used package so sibling
 # files (likely imported by the referenced file) are kept.
 used_package_dirs.add(py_file.parent)
 removed = 0
 for py_file in sorted(docs_src_path.rglob("*.py")):
 if py_file.name == "__init__.py":
 continue
 # Build the relative path as it appears in includes (e.g. docs_src/first_steps/tutorial001.py)
 rel_path = str(py_file)
 if rel_path in all_docs_content:
 continue
 # If this file is inside a directory-based package where any sibling is
 # referenced, keep it (it's likely imported internally).
 if py_file.parent in used_package_dirs:
 continue
 # Check if the _an counterpart (or non-_an counterpart) is referenced.
 # If either variant is included, keep both.
 # Handle both file-level _an (tutorial001_an.py) and directory-level _an
 # (app_an/main.py)
 counterpart_found = False
 full_path_str = str(py_file)
 if "_an" in py_file.stem:
 # This is an _an file, check if the non-_an version is referenced
 counterpart = full_path_str.replace(
 f"/{py_file.stem}", f"/{py_file.stem.replace('_an', '', 1)}"
 )
 if counterpart in all_docs_content:
 counterpart_found = True
 else:
 # This is a non-_an file, check if there's an _an version referenced
 # Insert _an before any version suffix or at the end of the stem
 stem = py_file.stem
 for suffix in ("_py39", "_py310"):
 if suffix in stem:
 an_stem = stem.replace(suffix, f"_an{suffix}", 1)
 break
 else:
 an_stem = f"{stem}_an"
 counterpart = full_path_str.replace(f"/{stem}.", f"/{an_stem}.")
 if counterpart in all_docs_content:
 counterpart_found = True
 # Also check directory-level _an counterparts
 if not counterpart_found:
 parent_name = py_file.parent.name
 if "_an" in parent_name:
 counterpart_parent = parent_name.replace("_an", "", 1)
 counterpart_dir = str(py_file).replace(
 f"/{parent_name}/", f"/{counterpart_parent}/"
 )
 if counterpart_dir in all_docs_content:
 counterpart_found = True
 else:
 # Try inserting _an into parent directory name
 for suffix in ("_py39", "_py310"):
 if suffix in parent_name:
 an_parent = parent_name.replace(suffix, f"_an{suffix}", 1)
 break
 else:
 an_parent = f"{parent_name}_an"
 counterpart_dir = str(py_file).replace(
 f"/{parent_name}/", f"/{an_parent}/"
 )
 if counterpart_dir in all_docs_content:
 counterpart_found = True
 if counterpart_found:
 continue
 logging.info(f"Removing unused file: {py_file}")
 py_file.unlink()
 removed += 1
 # Clean up directories that are empty or only contain __init__.py / __pycache__
 for dir_path in sorted(docs_src_path.rglob("*"), reverse=True):
 if not dir_path.is_dir():
 continue
 remaining = [
 f
 for f in dir_path.iterdir()
 if f.name != "__pycache__" and f.name != "__init__.py"
 ]
 if not remaining:
 logging.info(f"Removing empty/init-only directory: {dir_path}")
 shutil.rmtree(dir_path)
 print(f"Removed {removed} unused file(s) ✅")


if __name__ == "__main__":
 app()

, '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
🔨 Add script to remove Python 3.9 files, migrate to Python 3.10#1767

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

Feb 20, 2026
 Merged


🔨 Add script to remove Python 3.9 files, migrate to Python 3.10
#1767
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


237 changes: 237 additions & 0 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
import logging
import os
import re
import shutil
import subprocess
from http.server import HTTPServer, SimpleHTTPRequestHandler
from pathlib import Path

import mkdocs.utils
import typer
from jinja2 import Template
from ruff.__main__ import find_ruff_bin

logging.basicConfig(level=logging.INFO)

mkdocs_name = "mkdocs.yml"
docs_path = Path("docs")
en_docs_path = Path("")

app = typer.Typer()
Expand DownExpand Up@@ -143,5 +146,239 @@ def serve() -> None:
 server.serve_forever()


@app.command()
def generate_docs_src_versions_for_file(file_path: Path) -> None:
 target_versions = ["py39", "py310"]
 full_path_str = str(file_path)
 for target_version in target_versions:
 if f"_{target_version}" in full_path_str:
 logging.info(
 f"Skipping {file_path}, already a version file for {target_version}"
 )
 return
 base_content = file_path.read_text(encoding="utf-8")
 previous_content = {base_content}
 for target_version in target_versions:
 version_result = subprocess.run(
 [
 find_ruff_bin(),
 "check",
 "--target-version",
 target_version,
 "--fix",
 "--unsafe-fixes",
 "-",
 ],
 input=base_content.encode("utf-8"),
 capture_output=True,
 )
 content_target = version_result.stdout.decode("utf-8")
 format_result = subprocess.run(
 [find_ruff_bin(), "format", "-"],
 input=content_target.encode("utf-8"),
 capture_output=True,
 )
 content_format = format_result.stdout.decode("utf-8")
 if content_format in previous_content:
 continue
 previous_content.add(content_format)
 # Determine where the version label should go: in the parent directory
 # name or in the file name, matching the source structure.
 label_in_parent = False
 for v in target_versions:
 if f"_{v}" in file_path.parent.name:
 label_in_parent = True
 break
 if label_in_parent:
 parent_name = file_path.parent.name
 for v in target_versions:
 parent_name = parent_name.replace(f"_{v}", "")
 new_parent = file_path.parent.parent / f"{parent_name}_{target_version}"
 new_parent.mkdir(parents=True, exist_ok=True)
 version_file = new_parent / file_path.name
 else:
 base_name = file_path.stem
 for v in target_versions:
 if base_name.endswith(f"_{v}"):
 base_name = base_name[: -len(f"_{v}")]
 break
 version_file = file_path.with_name(f"{base_name}_{target_version}.py")
 logging.info(f"Writing to {version_file}")
 version_file.write_text(content_format, encoding="utf-8")


@app.command()
def generate_docs_src_versions() -> None:
 """
 Generate Python version-specific files for all .py files in docs_src.
 """
 docs_src_path = Path("docs_src")
 for py_file in sorted(docs_src_path.rglob("*.py")):
 generate_docs_src_versions_for_file(py_file)


@app.command()
def copy_py39_to_py310() -> None:
 """
 For each docs_src file/directory with a _py39 label that has no _py310
 counterpart, copy it with the _py310 label.
 """
 docs_src_path = Path("docs_src")
 # Handle directory-level labels (e.g. app_b_an_py39/)
 for dir_path in sorted(docs_src_path.rglob("*_py39")):
 if not dir_path.is_dir():
 continue
 py310_dir = dir_path.parent / dir_path.name.replace("_py39", "_py310")
 if py310_dir.exists():
 continue
 logging.info(f"Copying directory {dir_path} -> {py310_dir}")
 shutil.copytree(dir_path, py310_dir)
 # Handle file-level labels (e.g. tutorial001_py39.py)
 for file_path in sorted(docs_src_path.rglob("*_py39.py")):
 if not file_path.is_file():
 continue
 # Skip files inside _py39 directories (already handled above)
 if "_py39" in file_path.parent.name:
 continue
 py310_file = file_path.with_name(
 file_path.name.replace("_py39.py", "_py310.py")
 )
 if py310_file.exists():
 continue
 logging.info(f"Copying file {file_path} -> {py310_file}")
 shutil.copy2(file_path, py310_file)


@app.command()
def update_docs_includes_py39_to_py310() -> None:
 """
 Update .md files in docs/en/ to replace _py39 includes with _py310 versions.

 For each include line referencing a _py39 file or directory in docs_src, replace
 the _py39 label with _py310.
 """
 include_pattern = re.compile(r"\{[^}]*docs_src/[^}]*_py39[^}]*\.py[^}]*\}")
 count = 0
 for md_file in sorted(en_docs_path.rglob("*.md")):
 content = md_file.read_text(encoding="utf-8")
 if "_py39" not in content:
 continue
 new_content = include_pattern.sub(
 lambda m: m.group(0).replace("_py39", "_py310"), content
 )
 if new_content != content:
 md_file.write_text(new_content, encoding="utf-8")
 count += 1
 logging.info(f"Updated includes in {md_file}")
 print(f"Updated {count} file(s) ✅")


@app.command()
def remove_unused_docs_src() -> None:
 """
 Delete .py files in docs_src that are not included in any .md file under docs/.
 """
 docs_src_path = Path("docs_src")
 # Collect all docs .md content referencing docs_src
 all_docs_content = ""
 for md_file in docs_path.rglob("*.md"):
 all_docs_content += md_file.read_text(encoding="utf-8")
 # Build a set of directory-based package roots (e.g. docs_src/bigger_applications/app_py39)
 # where at least one file is referenced in docs. All files in these directories
 # should be kept since they may be internally imported by the referenced files.
 used_package_dirs: set[Path] = set()
 for py_file in docs_src_path.rglob("*.py"):
 if py_file.name == "__init__.py":
 continue
 rel_path = str(py_file)
 if rel_path in all_docs_content:
 parts = py_file.relative_to(docs_src_path).parts
 if len(parts) > 2 and not py_file.name.startswith("tutorial"):
 # File is inside a package directory (e.g.
 # docs_src/tutorial/fastapi/app_testing/tutorial001_py310/).
 # Mark the immediate parent as a used package so sibling
 # files (likely imported by the referenced file) are kept.
 used_package_dirs.add(py_file.parent)
 removed = 0
 for py_file in sorted(docs_src_path.rglob("*.py")):
 if py_file.name == "__init__.py":
 continue
 # Build the relative path as it appears in includes (e.g. docs_src/first_steps/tutorial001.py)
 rel_path = str(py_file)
 if rel_path in all_docs_content:
 continue
 # If this file is inside a directory-based package where any sibling is
 # referenced, keep it (it's likely imported internally).
 if py_file.parent in used_package_dirs:
 continue
 # Check if the _an counterpart (or non-_an counterpart) is referenced.
 # If either variant is included, keep both.
 # Handle both file-level _an (tutorial001_an.py) and directory-level _an
 # (app_an/main.py)
 counterpart_found = False
 full_path_str = str(py_file)
 if "_an" in py_file.stem:
 # This is an _an file, check if the non-_an version is referenced
 counterpart = full_path_str.replace(
 f"/{py_file.stem}", f"/{py_file.stem.replace('_an', '', 1)}"
 )
 if counterpart in all_docs_content:
 counterpart_found = True
 else:
 # This is a non-_an file, check if there's an _an version referenced
 # Insert _an before any version suffix or at the end of the stem
 stem = py_file.stem
 for suffix in ("_py39", "_py310"):
 if suffix in stem:
 an_stem = stem.replace(suffix, f"_an{suffix}", 1)
 break
 else:
 an_stem = f"{stem}_an"
 counterpart = full_path_str.replace(f"/{stem}.", f"/{an_stem}.")
 if counterpart in all_docs_content:
 counterpart_found = True
 # Also check directory-level _an counterparts
 if not counterpart_found:
 parent_name = py_file.parent.name
 if "_an" in parent_name:
 counterpart_parent = parent_name.replace("_an", "", 1)
 counterpart_dir = str(py_file).replace(
 f"/{parent_name}/", f"/{counterpart_parent}/"
 )
 if counterpart_dir in all_docs_content:
 counterpart_found = True
 else:
 # Try inserting _an into parent directory name
 for suffix in ("_py39", "_py310"):
 if suffix in parent_name:
 an_parent = parent_name.replace(suffix, f"_an{suffix}", 1)
 break
 else:
 an_parent = f"{parent_name}_an"
 counterpart_dir = str(py_file).replace(
 f"/{parent_name}/", f"/{an_parent}/"
 )
 if counterpart_dir in all_docs_content:
 counterpart_found = True
 if counterpart_found:
 continue
 logging.info(f"Removing unused file: {py_file}")
 py_file.unlink()
 removed += 1
 # Clean up directories that are empty or only contain __init__.py / __pycache__
 for dir_path in sorted(docs_src_path.rglob("*"), reverse=True):
 if not dir_path.is_dir():
 continue
 remaining = [
 f
 for f in dir_path.iterdir()
 if f.name != "__pycache__" and f.name != "__init__.py"
 ]
 if not remaining:
 logging.info(f"Removing empty/init-only directory: {dir_path}")
 shutil.rmtree(dir_path)
 print(f"Removed {removed} unused file(s) ✅")


if __name__ == "__main__":
 app()

, '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
🔨 Add script to remove Python 3.9 files, migrate to Python 3.10#1767

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

Feb 20, 2026
 Merged


🔨 Add script to remove Python 3.9 files, migrate to Python 3.10
#1767
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


237 changes: 237 additions & 0 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
import logging
import os
import re
import shutil
import subprocess
from http.server import HTTPServer, SimpleHTTPRequestHandler
from pathlib import Path

import mkdocs.utils
import typer
from jinja2 import Template
from ruff.__main__ import find_ruff_bin

logging.basicConfig(level=logging.INFO)

mkdocs_name = "mkdocs.yml"
docs_path = Path("docs")
en_docs_path = Path("")

app = typer.Typer()
Expand DownExpand Up@@ -143,5 +146,239 @@ def serve() -> None:
 server.serve_forever()


@app.command()
def generate_docs_src_versions_for_file(file_path: Path) -> None:
 target_versions = ["py39", "py310"]
 full_path_str = str(file_path)
 for target_version in target_versions:
 if f"_{target_version}" in full_path_str:
 logging.info(
 f"Skipping {file_path}, already a version file for {target_version}"
 )
 return
 base_content = file_path.read_text(encoding="utf-8")
 previous_content = {base_content}
 for target_version in target_versions:
 version_result = subprocess.run(
 [
 find_ruff_bin(),
 "check",
 "--target-version",
 target_version,
 "--fix",
 "--unsafe-fixes",
 "-",
 ],
 input=base_content.encode("utf-8"),
 capture_output=True,
 )
 content_target = version_result.stdout.decode("utf-8")
 format_result = subprocess.run(
 [find_ruff_bin(), "format", "-"],
 input=content_target.encode("utf-8"),
 capture_output=True,
 )
 content_format = format_result.stdout.decode("utf-8")
 if content_format in previous_content:
 continue
 previous_content.add(content_format)
 # Determine where the version label should go: in the parent directory
 # name or in the file name, matching the source structure.
 label_in_parent = False
 for v in target_versions:
 if f"_{v}" in file_path.parent.name:
 label_in_parent = True
 break
 if label_in_parent:
 parent_name = file_path.parent.name
 for v in target_versions:
 parent_name = parent_name.replace(f"_{v}", "")
 new_parent = file_path.parent.parent / f"{parent_name}_{target_version}"
 new_parent.mkdir(parents=True, exist_ok=True)
 version_file = new_parent / file_path.name
 else:
 base_name = file_path.stem
 for v in target_versions:
 if base_name.endswith(f"_{v}"):
 base_name = base_name[: -len(f"_{v}")]
 break
 version_file = file_path.with_name(f"{base_name}_{target_version}.py")
 logging.info(f"Writing to {version_file}")
 version_file.write_text(content_format, encoding="utf-8")


@app.command()
def generate_docs_src_versions() -> None:
 """
 Generate Python version-specific files for all .py files in docs_src.
 """
 docs_src_path = Path("docs_src")
 for py_file in sorted(docs_src_path.rglob("*.py")):
 generate_docs_src_versions_for_file(py_file)


@app.command()
def copy_py39_to_py310() -> None:
 """
 For each docs_src file/directory with a _py39 label that has no _py310
 counterpart, copy it with the _py310 label.
 """
 docs_src_path = Path("docs_src")
 # Handle directory-level labels (e.g. app_b_an_py39/)
 for dir_path in sorted(docs_src_path.rglob("*_py39")):
 if not dir_path.is_dir():
 continue
 py310_dir = dir_path.parent / dir_path.name.replace("_py39", "_py310")
 if py310_dir.exists():
 continue
 logging.info(f"Copying directory {dir_path} -> {py310_dir}")
 shutil.copytree(dir_path, py310_dir)
 # Handle file-level labels (e.g. tutorial001_py39.py)
 for file_path in sorted(docs_src_path.rglob("*_py39.py")):
 if not file_path.is_file():
 continue
 # Skip files inside _py39 directories (already handled above)
 if "_py39" in file_path.parent.name:
 continue
 py310_file = file_path.with_name(
 file_path.name.replace("_py39.py", "_py310.py")
 )
 if py310_file.exists():
 continue
 logging.info(f"Copying file {file_path} -> {py310_file}")
 shutil.copy2(file_path, py310_file)


@app.command()
def update_docs_includes_py39_to_py310() -> None:
 """
 Update .md files in docs/en/ to replace _py39 includes with _py310 versions.

 For each include line referencing a _py39 file or directory in docs_src, replace
 the _py39 label with _py310.
 """
 include_pattern = re.compile(r"\{[^}]*docs_src/[^}]*_py39[^}]*\.py[^}]*\}")
 count = 0
 for md_file in sorted(en_docs_path.rglob("*.md")):
 content = md_file.read_text(encoding="utf-8")
 if "_py39" not in content:
 continue
 new_content = include_pattern.sub(
 lambda m: m.group(0).replace("_py39", "_py310"), content
 )
 if new_content != content:
 md_file.write_text(new_content, encoding="utf-8")
 count += 1
 logging.info(f"Updated includes in {md_file}")
 print(f"Updated {count} file(s) ✅")


@app.command()
def remove_unused_docs_src() -> None:
 """
 Delete .py files in docs_src that are not included in any .md file under docs/.
 """
 docs_src_path = Path("docs_src")
 # Collect all docs .md content referencing docs_src
 all_docs_content = ""
 for md_file in docs_path.rglob("*.md"):
 all_docs_content += md_file.read_text(encoding="utf-8")
 # Build a set of directory-based package roots (e.g. docs_src/bigger_applications/app_py39)
 # where at least one file is referenced in docs. All files in these directories
 # should be kept since they may be internally imported by the referenced files.
 used_package_dirs: set[Path] = set()
 for py_file in docs_src_path.rglob("*.py"):
 if py_file.name == "__init__.py":
 continue
 rel_path = str(py_file)
 if rel_path in all_docs_content:
 parts = py_file.relative_to(docs_src_path).parts
 if len(parts) > 2 and not py_file.name.startswith("tutorial"):
 # File is inside a package directory (e.g.
 # docs_src/tutorial/fastapi/app_testing/tutorial001_py310/).
 # Mark the immediate parent as a used package so sibling
 # files (likely imported by the referenced file) are kept.
 used_package_dirs.add(py_file.parent)
 removed = 0
 for py_file in sorted(docs_src_path.rglob("*.py")):
 if py_file.name == "__init__.py":
 continue
 # Build the relative path as it appears in includes (e.g. docs_src/first_steps/tutorial001.py)
 rel_path = str(py_file)
 if rel_path in all_docs_content:
 continue
 # If this file is inside a directory-based package where any sibling is
 # referenced, keep it (it's likely imported internally).
 if py_file.parent in used_package_dirs:
 continue
 # Check if the _an counterpart (or non-_an counterpart) is referenced.
 # If either variant is included, keep both.
 # Handle both file-level _an (tutorial001_an.py) and directory-level _an
 # (app_an/main.py)
 counterpart_found = False
 full_path_str = str(py_file)
 if "_an" in py_file.stem:
 # This is an _an file, check if the non-_an version is referenced
 counterpart = full_path_str.replace(
 f"/{py_file.stem}", f"/{py_file.stem.replace('_an', '', 1)}"
 )
 if counterpart in all_docs_content:
 counterpart_found = True
 else:
 # This is a non-_an file, check if there's an _an version referenced
 # Insert _an before any version suffix or at the end of the stem
 stem = py_file.stem
 for suffix in ("_py39", "_py310"):
 if suffix in stem:
 an_stem = stem.replace(suffix, f"_an{suffix}", 1)
 break
 else:
 an_stem = f"{stem}_an"
 counterpart = full_path_str.replace(f"/{stem}.", f"/{an_stem}.")
 if counterpart in all_docs_content:
 counterpart_found = True
 # Also check directory-level _an counterparts
 if not counterpart_found:
 parent_name = py_file.parent.name
 if "_an" in parent_name:
 counterpart_parent = parent_name.replace("_an", "", 1)
 counterpart_dir = str(py_file).replace(
 f"/{parent_name}/", f"/{counterpart_parent}/"
 )
 if counterpart_dir in all_docs_content:
 counterpart_found = True
 else:
 # Try inserting _an into parent directory name
 for suffix in ("_py39", "_py310"):
 if suffix in parent_name:
 an_parent = parent_name.replace(suffix, f"_an{suffix}", 1)
 break
 else:
 an_parent = f"{parent_name}_an"
 counterpart_dir = str(py_file).replace(
 f"/{parent_name}/", f"/{an_parent}/"
 )
 if counterpart_dir in all_docs_content:
 counterpart_found = True
 if counterpart_found:
 continue
 logging.info(f"Removing unused file: {py_file}")
 py_file.unlink()
 removed += 1
 # Clean up directories that are empty or only contain __init__.py / __pycache__
 for dir_path in sorted(docs_src_path.rglob("*"), reverse=True):
 if not dir_path.is_dir():
 continue
 remaining = [
 f
 for f in dir_path.iterdir()
 if f.name != "__pycache__" and f.name != "__init__.py"
 ]
 if not remaining:
 logging.info(f"Removing empty/init-only directory: {dir_path}")
 shutil.rmtree(dir_path)
 print(f"Removed {removed} unused file(s) ✅")


if __name__ == "__main__":
 app()

, '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
🔨 Add script to remove Python 3.9 files, migrate to Python 3.10#1767

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

Feb 20, 2026
 Merged


🔨 Add script to remove Python 3.9 files, migrate to Python 3.10
#1767
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


237 changes: 237 additions & 0 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
import logging
import os
import re
import shutil
import subprocess
from http.server import HTTPServer, SimpleHTTPRequestHandler
from pathlib import Path

import mkdocs.utils
import typer
from jinja2 import Template
from ruff.__main__ import find_ruff_bin

logging.basicConfig(level=logging.INFO)

mkdocs_name = "mkdocs.yml"
docs_path = Path("docs")
en_docs_path = Path("")

app = typer.Typer()
Expand DownExpand Up@@ -143,5 +146,239 @@ def serve() -> None:
 server.serve_forever()


@app.command()
def generate_docs_src_versions_for_file(file_path: Path) -> None:
 target_versions = ["py39", "py310"]
 full_path_str = str(file_path)
 for target_version in target_versions:
 if f"_{target_version}" in full_path_str:
 logging.info(
 f"Skipping {file_path}, already a version file for {target_version}"
 )
 return
 base_content = file_path.read_text(encoding="utf-8")
 previous_content = {base_content}
 for target_version in target_versions:
 version_result = subprocess.run(
 [
 find_ruff_bin(),
 "check",
 "--target-version",
 target_version,
 "--fix",
 "--unsafe-fixes",
 "-",
 ],
 input=base_content.encode("utf-8"),
 capture_output=True,
 )
 content_target = version_result.stdout.decode("utf-8")
 format_result = subprocess.run(
 [find_ruff_bin(), "format", "-"],
 input=content_target.encode("utf-8"),
 capture_output=True,
 )
 content_format = format_result.stdout.decode("utf-8")
 if content_format in previous_content:
 continue
 previous_content.add(content_format)
 # Determine where the version label should go: in the parent directory
 # name or in the file name, matching the source structure.
 label_in_parent = False
 for v in target_versions:
 if f"_{v}" in file_path.parent.name:
 label_in_parent = True
 break
 if label_in_parent:
 parent_name = file_path.parent.name
 for v in target_versions:
 parent_name = parent_name.replace(f"_{v}", "")
 new_parent = file_path.parent.parent / f"{parent_name}_{target_version}"
 new_parent.mkdir(parents=True, exist_ok=True)
 version_file = new_parent / file_path.name
 else:
 base_name = file_path.stem
 for v in target_versions:
 if base_name.endswith(f"_{v}"):
 base_name = base_name[: -len(f"_{v}")]
 break
 version_file = file_path.with_name(f"{base_name}_{target_version}.py")
 logging.info(f"Writing to {version_file}")
 version_file.write_text(content_format, encoding="utf-8")


@app.command()
def generate_docs_src_versions() -> None:
 """
 Generate Python version-specific files for all .py files in docs_src.
 """
 docs_src_path = Path("docs_src")
 for py_file in sorted(docs_src_path.rglob("*.py")):
 generate_docs_src_versions_for_file(py_file)


@app.command()
def copy_py39_to_py310() -> None:
 """
 For each docs_src file/directory with a _py39 label that has no _py310
 counterpart, copy it with the _py310 label.
 """
 docs_src_path = Path("docs_src")
 # Handle directory-level labels (e.g. app_b_an_py39/)
 for dir_path in sorted(docs_src_path.rglob("*_py39")):
 if not dir_path.is_dir():
 continue
 py310_dir = dir_path.parent / dir_path.name.replace("_py39", "_py310")
 if py310_dir.exists():
 continue
 logging.info(f"Copying directory {dir_path} -> {py310_dir}")
 shutil.copytree(dir_path, py310_dir)
 # Handle file-level labels (e.g. tutorial001_py39.py)
 for file_path in sorted(docs_src_path.rglob("*_py39.py")):
 if not file_path.is_file():
 continue
 # Skip files inside _py39 directories (already handled above)
 if "_py39" in file_path.parent.name:
 continue
 py310_file = file_path.with_name(
 file_path.name.replace("_py39.py", "_py310.py")
 )
 if py310_file.exists():
 continue
 logging.info(f"Copying file {file_path} -> {py310_file}")
 shutil.copy2(file_path, py310_file)


@app.command()
def update_docs_includes_py39_to_py310() -> None:
 """
 Update .md files in docs/en/ to replace _py39 includes with _py310 versions.

 For each include line referencing a _py39 file or directory in docs_src, replace
 the _py39 label with _py310.
 """
 include_pattern = re.compile(r"\{[^}]*docs_src/[^}]*_py39[^}]*\.py[^}]*\}")
 count = 0
 for md_file in sorted(en_docs_path.rglob("*.md")):
 content = md_file.read_text(encoding="utf-8")
 if "_py39" not in content:
 continue
 new_content = include_pattern.sub(
 lambda m: m.group(0).replace("_py39", "_py310"), content
 )
 if new_content != content:
 md_file.write_text(new_content, encoding="utf-8")
 count += 1
 logging.info(f"Updated includes in {md_file}")
 print(f"Updated {count} file(s) ✅")


@app.command()
def remove_unused_docs_src() -> None:
 """
 Delete .py files in docs_src that are not included in any .md file under docs/.
 """
 docs_src_path = Path("docs_src")
 # Collect all docs .md content referencing docs_src
 all_docs_content = ""
 for md_file in docs_path.rglob("*.md"):
 all_docs_content += md_file.read_text(encoding="utf-8")
 # Build a set of directory-based package roots (e.g. docs_src/bigger_applications/app_py39)
 # where at least one file is referenced in docs. All files in these directories
 # should be kept since they may be internally imported by the referenced files.
 used_package_dirs: set[Path] = set()
 for py_file in docs_src_path.rglob("*.py"):
 if py_file.name == "__init__.py":
 continue
 rel_path = str(py_file)
 if rel_path in all_docs_content:
 parts = py_file.relative_to(docs_src_path).parts
 if len(parts) > 2 and not py_file.name.startswith("tutorial"):
 # File is inside a package directory (e.g.
 # docs_src/tutorial/fastapi/app_testing/tutorial001_py310/).
 # Mark the immediate parent as a used package so sibling
 # files (likely imported by the referenced file) are kept.
 used_package_dirs.add(py_file.parent)
 removed = 0
 for py_file in sorted(docs_src_path.rglob("*.py")):
 if py_file.name == "__init__.py":
 continue
 # Build the relative path as it appears in includes (e.g. docs_src/first_steps/tutorial001.py)
 rel_path = str(py_file)
 if rel_path in all_docs_content:
 continue
 # If this file is inside a directory-based package where any sibling is
 # referenced, keep it (it's likely imported internally).
 if py_file.parent in used_package_dirs:
 continue
 # Check if the _an counterpart (or non-_an counterpart) is referenced.
 # If either variant is included, keep both.
 # Handle both file-level _an (tutorial001_an.py) and directory-level _an
 # (app_an/main.py)
 counterpart_found = False
 full_path_str = str(py_file)
 if "_an" in py_file.stem:
 # This is an _an file, check if the non-_an version is referenced
 counterpart = full_path_str.replace(
 f"/{py_file.stem}", f"/{py_file.stem.replace('_an', '', 1)}"
 )
 if counterpart in all_docs_content:
 counterpart_found = True
 else:
 # This is a non-_an file, check if there's an _an version referenced
 # Insert _an before any version suffix or at the end of the stem
 stem = py_file.stem
 for suffix in ("_py39", "_py310"):
 if suffix in stem:
 an_stem = stem.replace(suffix, f"_an{suffix}", 1)
 break
 else:
 an_stem = f"{stem}_an"
 counterpart = full_path_str.replace(f"/{stem}.", f"/{an_stem}.")
 if counterpart in all_docs_content:
 counterpart_found = True
 # Also check directory-level _an counterparts
 if not counterpart_found:
 parent_name = py_file.parent.name
 if "_an" in parent_name:
 counterpart_parent = parent_name.replace("_an", "", 1)
 counterpart_dir = str(py_file).replace(
 f"/{parent_name}/", f"/{counterpart_parent}/"
 )
 if counterpart_dir in all_docs_content:
 counterpart_found = True
 else:
 # Try inserting _an into parent directory name
 for suffix in ("_py39", "_py310"):
 if suffix in parent_name:
 an_parent = parent_name.replace(suffix, f"_an{suffix}", 1)
 break
 else:
 an_parent = f"{parent_name}_an"
 counterpart_dir = str(py_file).replace(
 f"/{parent_name}/", f"/{an_parent}/"
 )
 if counterpart_dir in all_docs_content:
 counterpart_found = True
 if counterpart_found:
 continue
 logging.info(f"Removing unused file: {py_file}")
 py_file.unlink()
 removed += 1
 # Clean up directories that are empty or only contain __init__.py / __pycache__
 for dir_path in sorted(docs_src_path.rglob("*"), reverse=True):
 if not dir_path.is_dir():
 continue
 remaining = [
 f
 for f in dir_path.iterdir()
 if f.name != "__pycache__" and f.name != "__init__.py"
 ]
 if not remaining:
 logging.info(f"Removing empty/init-only directory: {dir_path}")
 shutil.rmtree(dir_path)
 print(f"Removed {removed} unused file(s) ✅")


if __name__ == "__main__":
 app()

, '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
🔨 Add script to remove Python 3.9 files, migrate to Python 3.10#1767

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

Feb 20, 2026
 Merged


🔨 Add script to remove Python 3.9 files, migrate to Python 3.10
#1767
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


237 changes: 237 additions & 0 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
import logging
import os
import re
import shutil
import subprocess
from http.server import HTTPServer, SimpleHTTPRequestHandler
from pathlib import Path

import mkdocs.utils
import typer
from jinja2 import Template
from ruff.__main__ import find_ruff_bin

logging.basicConfig(level=logging.INFO)

mkdocs_name = "mkdocs.yml"
docs_path = Path("docs")
en_docs_path = Path("")

app = typer.Typer()
Expand DownExpand Up@@ -143,5 +146,239 @@ def serve() -> None:
 server.serve_forever()


@app.command()
def generate_docs_src_versions_for_file(file_path: Path) -> None:
 target_versions = ["py39", "py310"]
 full_path_str = str(file_path)
 for target_version in target_versions:
 if f"_{target_version}" in full_path_str:
 logging.info(
 f"Skipping {file_path}, already a version file for {target_version}"
 )
 return
 base_content = file_path.read_text(encoding="utf-8")
 previous_content = {base_content}
 for target_version in target_versions:
 version_result = subprocess.run(
 [
 find_ruff_bin(),
 "check",
 "--target-version",
 target_version,
 "--fix",
 "--unsafe-fixes",
 "-",
 ],
 input=base_content.encode("utf-8"),
 capture_output=True,
 )
 content_target = version_result.stdout.decode("utf-8")
 format_result = subprocess.run(
 [find_ruff_bin(), "format", "-"],
 input=content_target.encode("utf-8"),
 capture_output=True,
 )
 content_format = format_result.stdout.decode("utf-8")
 if content_format in previous_content:
 continue
 previous_content.add(content_format)
 # Determine where the version label should go: in the parent directory
 # name or in the file name, matching the source structure.
 label_in_parent = False
 for v in target_versions:
 if f"_{v}" in file_path.parent.name:
 label_in_parent = True
 break
 if label_in_parent:
 parent_name = file_path.parent.name
 for v in target_versions:
 parent_name = parent_name.replace(f"_{v}", "")
 new_parent = file_path.parent.parent / f"{parent_name}_{target_version}"
 new_parent.mkdir(parents=True, exist_ok=True)
 version_file = new_parent / file_path.name
 else:
 base_name = file_path.stem
 for v in target_versions:
 if base_name.endswith(f"_{v}"):
 base_name = base_name[: -len(f"_{v}")]
 break
 version_file = file_path.with_name(f"{base_name}_{target_version}.py")
 logging.info(f"Writing to {version_file}")
 version_file.write_text(content_format, encoding="utf-8")


@app.command()
def generate_docs_src_versions() -> None:
 """
 Generate Python version-specific files for all .py files in docs_src.
 """
 docs_src_path = Path("docs_src")
 for py_file in sorted(docs_src_path.rglob("*.py")):
 generate_docs_src_versions_for_file(py_file)


@app.command()
def copy_py39_to_py310() -> None:
 """
 For each docs_src file/directory with a _py39 label that has no _py310
 counterpart, copy it with the _py310 label.
 """
 docs_src_path = Path("docs_src")
 # Handle directory-level labels (e.g. app_b_an_py39/)
 for dir_path in sorted(docs_src_path.rglob("*_py39")):
 if not dir_path.is_dir():
 continue
 py310_dir = dir_path.parent / dir_path.name.replace("_py39", "_py310")
 if py310_dir.exists():
 continue
 logging.info(f"Copying directory {dir_path} -> {py310_dir}")
 shutil.copytree(dir_path, py310_dir)
 # Handle file-level labels (e.g. tutorial001_py39.py)
 for file_path in sorted(docs_src_path.rglob("*_py39.py")):
 if not file_path.is_file():
 continue
 # Skip files inside _py39 directories (already handled above)
 if "_py39" in file_path.parent.name:
 continue
 py310_file = file_path.with_name(
 file_path.name.replace("_py39.py", "_py310.py")
 )
 if py310_file.exists():
 continue
 logging.info(f"Copying file {file_path} -> {py310_file}")
 shutil.copy2(file_path, py310_file)


@app.command()
def update_docs_includes_py39_to_py310() -> None:
 """
 Update .md files in docs/en/ to replace _py39 includes with _py310 versions.

 For each include line referencing a _py39 file or directory in docs_src, replace
 the _py39 label with _py310.
 """
 include_pattern = re.compile(r"\{[^}]*docs_src/[^}]*_py39[^}]*\.py[^}]*\}")
 count = 0
 for md_file in sorted(en_docs_path.rglob("*.md")):
 content = md_file.read_text(encoding="utf-8")
 if "_py39" not in content:
 continue
 new_content = include_pattern.sub(
 lambda m: m.group(0).replace("_py39", "_py310"), content
 )
 if new_content != content:
 md_file.write_text(new_content, encoding="utf-8")
 count += 1
 logging.info(f"Updated includes in {md_file}")
 print(f"Updated {count} file(s) ✅")


@app.command()
def remove_unused_docs_src() -> None:
 """
 Delete .py files in docs_src that are not included in any .md file under docs/.
 """
 docs_src_path = Path("docs_src")
 # Collect all docs .md content referencing docs_src
 all_docs_content = ""
 for md_file in docs_path.rglob("*.md"):
 all_docs_content += md_file.read_text(encoding="utf-8")
 # Build a set of directory-based package roots (e.g. docs_src/bigger_applications/app_py39)
 # where at least one file is referenced in docs. All files in these directories
 # should be kept since they may be internally imported by the referenced files.
 used_package_dirs: set[Path] = set()
 for py_file in docs_src_path.rglob("*.py"):
 if py_file.name == "__init__.py":
 continue
 rel_path = str(py_file)
 if rel_path in all_docs_content:
 parts = py_file.relative_to(docs_src_path).parts
 if len(parts) > 2 and not py_file.name.startswith("tutorial"):
 # File is inside a package directory (e.g.
 # docs_src/tutorial/fastapi/app_testing/tutorial001_py310/).
 # Mark the immediate parent as a used package so sibling
 # files (likely imported by the referenced file) are kept.
 used_package_dirs.add(py_file.parent)
 removed = 0
 for py_file in sorted(docs_src_path.rglob("*.py")):
 if py_file.name == "__init__.py":
 continue
 # Build the relative path as it appears in includes (e.g. docs_src/first_steps/tutorial001.py)
 rel_path = str(py_file)
 if rel_path in all_docs_content:
 continue
 # If this file is inside a directory-based package where any sibling is
 # referenced, keep it (it's likely imported internally).
 if py_file.parent in used_package_dirs:
 continue
 # Check if the _an counterpart (or non-_an counterpart) is referenced.
 # If either variant is included, keep both.
 # Handle both file-level _an (tutorial001_an.py) and directory-level _an
 # (app_an/main.py)
 counterpart_found = False
 full_path_str = str(py_file)
 if "_an" in py_file.stem:
 # This is an _an file, check if the non-_an version is referenced
 counterpart = full_path_str.replace(
 f"/{py_file.stem}", f"/{py_file.stem.replace('_an', '', 1)}"
 )
 if counterpart in all_docs_content:
 counterpart_found = True
 else:
 # This is a non-_an file, check if there's an _an version referenced
 # Insert _an before any version suffix or at the end of the stem
 stem = py_file.stem
 for suffix in ("_py39", "_py310"):
 if suffix in stem:
 an_stem = stem.replace(suffix, f"_an{suffix}", 1)
 break
 else:
 an_stem = f"{stem}_an"
 counterpart = full_path_str.replace(f"/{stem}.", f"/{an_stem}.")
 if counterpart in all_docs_content:
 counterpart_found = True
 # Also check directory-level _an counterparts
 if not counterpart_found:
 parent_name = py_file.parent.name
 if "_an" in parent_name:
 counterpart_parent = parent_name.replace("_an", "", 1)
 counterpart_dir = str(py_file).replace(
 f"/{parent_name}/", f"/{counterpart_parent}/"
 )
 if counterpart_dir in all_docs_content:
 counterpart_found = True
 else:
 # Try inserting _an into parent directory name
 for suffix in ("_py39", "_py310"):
 if suffix in parent_name:
 an_parent = parent_name.replace(suffix, f"_an{suffix}", 1)
 break
 else:
 an_parent = f"{parent_name}_an"
 counterpart_dir = str(py_file).replace(
 f"/{parent_name}/", f"/{an_parent}/"
 )
 if counterpart_dir in all_docs_content:
 counterpart_found = True
 if counterpart_found:
 continue
 logging.info(f"Removing unused file: {py_file}")
 py_file.unlink()
 removed += 1
 # Clean up directories that are empty or only contain __init__.py / __pycache__
 for dir_path in sorted(docs_src_path.rglob("*"), reverse=True):
 if not dir_path.is_dir():
 continue
 remaining = [
 f
 for f in dir_path.iterdir()
 if f.name != "__pycache__" and f.name != "__init__.py"
 ]
 if not remaining:
 logging.info(f"Removing empty/init-only directory: {dir_path}")
 shutil.rmtree(dir_path)
 print(f"Removed {removed} unused file(s) ✅")


if __name__ == "__main__":
 app()

, '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
🔨 Add script to remove Python 3.9 files, migrate to Python 3.10#1767

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tiangolo
merged 1 commit into

from

Feb 20, 2026
 Merged


🔨 Add script to remove Python 3.9 files, migrate to Python 3.10
#1767
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


237 changes: 237 additions & 0 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
import logging
import os
import re
import shutil
import subprocess
from http.server import HTTPServer, SimpleHTTPRequestHandler
from pathlib import Path

import mkdocs.utils
import typer
from jinja2 import Template
from ruff.__main__ import find_ruff_bin

logging.basicConfig(level=logging.INFO)

mkdocs_name = "mkdocs.yml"
docs_path = Path("docs")
en_docs_path = Path("")

app = typer.Typer()
Expand DownExpand Up@@ -143,5 +146,239 @@ def serve() -> None:
 server.serve_forever()


@app.command()
def generate_docs_src_versions_for_file(file_path: Path) -> None:
 target_versions = ["py39", "py310"]
 full_path_str = str(file_path)
 for target_version in target_versions:
 if f"_{target_version}" in full_path_str:
 logging.info(
 f"Skipping {file_path}, already a version file for {target_version}"
 )
 return
 base_content = file_path.read_text(encoding="utf-8")
 previous_content = {base_content}
 for target_version in target_versions:
 version_result = subprocess.run(
 [
 find_ruff_bin(),
 "check",
 "--target-version",
 target_version,
 "--fix",
 "--unsafe-fixes",
 "-",
 ],
 input=base_content.encode("utf-8"),
 capture_output=True,
 )
 content_target = version_result.stdout.decode("utf-8")
 format_result = subprocess.run(
 [find_ruff_bin(), "format", "-"],
 input=content_target.encode("utf-8"),
 capture_output=True,
 )
 content_format = format_result.stdout.decode("utf-8")
 if content_format in previous_content:
 continue
 previous_content.add(content_format)
 # Determine where the version label should go: in the parent directory
 # name or in the file name, matching the source structure.
 label_in_parent = False
 for v in target_versions:
 if f"_{v}" in file_path.parent.name:
 label_in_parent = True
 break
 if label_in_parent:
 parent_name = file_path.parent.name
 for v in target_versions:
 parent_name = parent_name.replace(f"_{v}", "")
 new_parent = file_path.parent.parent / f"{parent_name}_{target_version}"
 new_parent.mkdir(parents=True, exist_ok=True)
 version_file = new_parent / file_path.name
 else:
 base_name = file_path.stem
 for v in target_versions:
 if base_name.endswith(f"_{v}"):
 base_name = base_name[: -len(f"_{v}")]
 break
 version_file = file_path.with_name(f"{base_name}_{target_version}.py")
 logging.info(f"Writing to {version_file}")
 version_file.write_text(content_format, encoding="utf-8")


@app.command()
def generate_docs_src_versions() -> None:
 """
 Generate Python version-specific files for all .py files in docs_src.
 """
 docs_src_path = Path("docs_src")
 for py_file in sorted(docs_src_path.rglob("*.py")):
 generate_docs_src_versions_for_file(py_file)


@app.command()
def copy_py39_to_py310() -> None:
 """
 For each docs_src file/directory with a _py39 label that has no _py310
 counterpart, copy it with the _py310 label.
 """
 docs_src_path = Path("docs_src")
 # Handle directory-level labels (e.g. app_b_an_py39/)
 for dir_path in sorted(docs_src_path.rglob("*_py39")):
 if not dir_path.is_dir():
 continue
 py310_dir = dir_path.parent / dir_path.name.replace("_py39", "_py310")
 if py310_dir.exists():
 continue
 logging.info(f"Copying directory {dir_path} -> {py310_dir}")
 shutil.copytree(dir_path, py310_dir)
 # Handle file-level labels (e.g. tutorial001_py39.py)
 for file_path in sorted(docs_src_path.rglob("*_py39.py")):
 if not file_path.is_file():
 continue
 # Skip files inside _py39 directories (already handled above)
 if "_py39" in file_path.parent.name:
 continue
 py310_file = file_path.with_name(
 file_path.name.replace("_py39.py", "_py310.py")
 )
 if py310_file.exists():
 continue
 logging.info(f"Copying file {file_path} -> {py310_file}")
 shutil.copy2(file_path, py310_file)


@app.command()
def update_docs_includes_py39_to_py310() -> None:
 """
 Update .md files in docs/en/ to replace _py39 includes with _py310 versions.

 For each include line referencing a _py39 file or directory in docs_src, replace
 the _py39 label with _py310.
 """
 include_pattern = re.compile(r"\{[^}]*docs_src/[^}]*_py39[^}]*\.py[^}]*\}")
 count = 0
 for md_file in sorted(en_docs_path.rglob("*.md")):
 content = md_file.read_text(encoding="utf-8")
 if "_py39" not in content:
 continue
 new_content = include_pattern.sub(
 lambda m: m.group(0).replace("_py39", "_py310"), content
 )
 if new_content != content:
 md_file.write_text(new_content, encoding="utf-8")
 count += 1
 logging.info(f"Updated includes in {md_file}")
 print(f"Updated {count} file(s) ✅")


@app.command()
def remove_unused_docs_src() -> None:
 """
 Delete .py files in docs_src that are not included in any .md file under docs/.
 """
 docs_src_path = Path("docs_src")
 # Collect all docs .md content referencing docs_src
 all_docs_content = ""
 for md_file in docs_path.rglob("*.md"):
 all_docs_content += md_file.read_text(encoding="utf-8")
 # Build a set of directory-based package roots (e.g. docs_src/bigger_applications/app_py39)
 # where at least one file is referenced in docs. All files in these directories
 # should be kept since they may be internally imported by the referenced files.
 used_package_dirs: set[Path] = set()
 for py_file in docs_src_path.rglob("*.py"):
 if py_file.name == "__init__.py":
 continue
 rel_path = str(py_file)
 if rel_path in all_docs_content:
 parts = py_file.relative_to(docs_src_path).parts
 if len(parts) > 2 and not py_file.name.startswith("tutorial"):
 # File is inside a package directory (e.g.
 # docs_src/tutorial/fastapi/app_testing/tutorial001_py310/).
 # Mark the immediate parent as a used package so sibling
 # files (likely imported by the referenced file) are kept.
 used_package_dirs.add(py_file.parent)
 removed = 0
 for py_file in sorted(docs_src_path.rglob("*.py")):
 if py_file.name == "__init__.py":
 continue
 # Build the relative path as it appears in includes (e.g. docs_src/first_steps/tutorial001.py)
 rel_path = str(py_file)
 if rel_path in all_docs_content:
 continue
 # If this file is inside a directory-based package where any sibling is
 # referenced, keep it (it's likely imported internally).
 if py_file.parent in used_package_dirs:
 continue
 # Check if the _an counterpart (or non-_an counterpart) is referenced.
 # If either variant is included, keep both.
 # Handle both file-level _an (tutorial001_an.py) and directory-level _an
 # (app_an/main.py)
 counterpart_found = False
 full_path_str = str(py_file)
 if "_an" in py_file.stem:
 # This is an _an file, check if the non-_an version is referenced
 counterpart = full_path_str.replace(
 f"/{py_file.stem}", f"/{py_file.stem.replace('_an', '', 1)}"
 )
 if counterpart in all_docs_content:
 counterpart_found = True
 else:
 # This is a non-_an file, check if there's an _an version referenced
 # Insert _an before any version suffix or at the end of the stem
 stem = py_file.stem
 for suffix in ("_py39", "_py310"):
 if suffix in stem:
 an_stem = stem.replace(suffix, f"_an{suffix}", 1)
 break
 else:
 an_stem = f"{stem}_an"
 counterpart = full_path_str.replace(f"/{stem}.", f"/{an_stem}.")
 if counterpart in all_docs_content:
 counterpart_found = True
 # Also check directory-level _an counterparts
 if not counterpart_found:
 parent_name = py_file.parent.name
 if "_an" in parent_name:
 counterpart_parent = parent_name.replace("_an", "", 1)
 counterpart_dir = str(py_file).replace(
 f"/{parent_name}/", f"/{counterpart_parent}/"
 )
 if counterpart_dir in all_docs_content:
 counterpart_found = True
 else:
 # Try inserting _an into parent directory name
 for suffix in ("_py39", "_py310"):
 if suffix in parent_name:
 an_parent = parent_name.replace(suffix, f"_an{suffix}", 1)
 break
 else:
 an_parent = f"{parent_name}_an"
 counterpart_dir = str(py_file).replace(
 f"/{parent_name}/", f"/{an_parent}/"
 )
 if counterpart_dir in all_docs_content:
 counterpart_found = True
 if counterpart_found:
 continue
 logging.info(f"Removing unused file: {py_file}")
 py_file.unlink()
 removed += 1
 # Clean up directories that are empty or only contain __init__.py / __pycache__
 for dir_path in sorted(docs_src_path.rglob("*"), reverse=True):
 if not dir_path.is_dir():
 continue
 remaining = [
 f
 for f in dir_path.iterdir()
 if f.name != "__pycache__" and f.name != "__init__.py"
 ]
 if not remaining:
 logging.info(f"Removing empty/init-only directory: {dir_path}")
 shutil.rmtree(dir_path)
 print(f"Removed {removed} unused file(s) ✅")


if __name__ == "__main__":
 app()