fastapi 0.112.0__tar.gz → 0.112.1__tar.gz

{fastapi-0.112.0 → fastapi-0.112.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastapi
-Version: 0.112.0
+Version: 0.112.1
 Summary: FastAPI framework, high performance, easy to learn, fast to code, ready for production
 Author-Email: =?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= <tiangolo@gmail.com>
 Classifier: Intended Audience :: Information Technology
@@ -33,8 +33,10 @@ Classifier: Topic :: Internet :: WWW/HTTP
 Project-URL: Homepage, https://github.com/fastapi/fastapi
 Project-URL: Documentation, https://fastapi.tiangolo.com/
 Project-URL: Repository, https://github.com/fastapi/fastapi
+Project-URL: Issues, https://github.com/fastapi/fastapi/issues
+Project-URL: Changelog, https://fastapi.tiangolo.com/release-notes/
 Requires-Python: >=3.8
-Requires-Dist: starlette<0.38.0,>=0.37.2
+Requires-Dist: starlette<0.39.0,>=0.37.2
 Requires-Dist: pydantic!=1.8,!=1.8.1,!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0,>=1.7.4
 Requires-Dist: typing-extensions>=4.8.0
 Requires-Dist: fastapi-cli[standard]>=0.0.5; extra == "standard"

{fastapi-0.112.0 → fastapi-0.112.1}/fastapi/__init__.py

@@ -1,6 +1,6 @@
 """FastAPI framework, high performance, easy to learn, fast to code, ready for production"""
 
-__version__ = "0.112.0"
+__version__ = "0.112.1"
 
 from starlette import status as status
 

{fastapi-0.112.0 → fastapi-0.112.1}/pyproject.toml

@@ -43,16 +43,18 @@ classifiers = [
     "Topic :: Internet :: WWW/HTTP",
 ]
 dependencies = [
-    "starlette>=0.37.2,<0.38.0",
+    "starlette>=0.37.2,<0.39.0",
     "pydantic>=1.7.4,!=1.8,!=1.8.1,!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0",
     "typing-extensions>=4.8.0",
 ]
-version = "0.112.0"
+version = "0.112.1"
 
 [project.urls]
 Homepage = "https://github.com/fastapi/fastapi"
 Documentation = "https://fastapi.tiangolo.com/"
 Repository = "https://github.com/fastapi/fastapi"
+Issues = "https://github.com/fastapi/fastapi/issues"
+Changelog = "https://fastapi.tiangolo.com/release-notes/"
 
 [project.optional-dependencies]
 standard = [
@@ -134,10 +136,10 @@ filterwarnings = [
     "ignore:'cgi' is deprecated:DeprecationWarning",
     "ignore:'crypt' is deprecated and slated for removal in Python 3.13:DeprecationWarning",
     "ignore:You seem to already have a custom.*:RuntimeWarning:trio",
-    "ignore::trio.TrioDeprecationWarning",
     "ignore::pytest.PytestDeprecationWarning:pytest_cov",
     "ignore:datetime\\.datetime\\.utcfromtimestamp\\(\\) is deprecated and scheduled for removal in a future version\\..*:DeprecationWarning:sqlalchemy",
     "ignore:datetime\\.datetime\\.utcnow\\(\\) is deprecated and scheduled for removal in a future version\\..*:DeprecationWarning:jose",
+    "ignore:The `hash` argument is deprecated*:DeprecationWarning:trio",
 ]
 
 [tool.coverage.run]

fastapi-0.112.1/requirements-docs-insiders.txt

@@ -0,0 +1,3 @@
+git+https://${TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.5.30-insiders-4.53.11
+git+https://${TOKEN}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
+git+https://${TOKEN}@github.com/pawamoy-insiders/mkdocstrings-python.git

{fastapi-0.112.0 → fastapi-0.112.1}/requirements-docs.txt

@@ -3,16 +3,16 @@
 mkdocs-material==9.5.18
 mdx-include >=1.4.1,<2.0.0
 mkdocs-redirects>=1.2.1,<1.3.0
-typer >=0.12.0
+typer == 0.12.3
 pyyaml >=5.3.1,<7.0.0
 # For Material for MkDocs, Chinese search
 jieba==0.42.1
 # For image processing by Material for MkDocs
 pillow==10.3.0
 # For image processing by Material for MkDocs
-cairosvg==2.7.0
-mkdocstrings[python]==0.24.3
-griffe-typingdoc==0.2.2
+cairosvg==2.7.1
+mkdocstrings[python]==0.25.1
+griffe-typingdoc==0.2.5
 # For griffe, it formats with black
 black==24.3.0
 mkdocs-macros-plugin==1.0.5

fastapi-0.112.1/scripts/deploy_docs_status.py

@@ -0,0 +1,107 @@
+import logging
+import re
+
+from github import Github
+from pydantic import SecretStr
+from pydantic_settings import BaseSettings
+
+
+class Settings(BaseSettings):
+    github_repository: str
+    github_token: SecretStr
+    deploy_url: str | None = None
+    commit_sha: str
+    run_id: int
+    is_done: bool = False
+
+
+def main():
+    logging.basicConfig(level=logging.INFO)
+    settings = Settings()
+
+    logging.info(f"Using config: {settings.model_dump_json()}")
+    g = Github(settings.github_token.get_secret_value())
+    repo = g.get_repo(settings.github_repository)
+    use_pr = next(
+        (pr for pr in repo.get_pulls() if pr.head.sha == settings.commit_sha), None
+    )
+    if not use_pr:
+        logging.error(f"No PR found for hash: {settings.commit_sha}")
+        return
+    commits = list(use_pr.get_commits())
+    current_commit = [c for c in commits if c.sha == settings.commit_sha][0]
+    run_url = f"https://github.com/{settings.github_repository}/actions/runs/{settings.run_id}"
+    if settings.is_done and not settings.deploy_url:
+        current_commit.create_status(
+            state="success",
+            description="No Docs Changes",
+            context="deploy-docs",
+            target_url=run_url,
+        )
+        logging.info("No docs changes found")
+        return
+    if not settings.deploy_url:
+        current_commit.create_status(
+            state="pending",
+            description="Deploying Docs",
+            context="deploy-docs",
+            target_url=run_url,
+        )
+        logging.info("No deploy URL available yet")
+        return
+    current_commit.create_status(
+        state="success",
+        description="Docs Deployed",
+        context="deploy-docs",
+        target_url=run_url,
+    )
+
+    files = list(use_pr.get_files())
+    docs_files = [f for f in files if f.filename.startswith("docs/")]
+
+    deploy_url = settings.deploy_url.rstrip("/")
+    lang_links: dict[str, list[str]] = {}
+    for f in docs_files:
+        match = re.match(r"docs/([^/]+)/docs/(.*)", f.filename)
+        if not match:
+            continue
+        lang = match.group(1)
+        path = match.group(2)
+        if path.endswith("index.md"):
+            path = path.replace("index.md", "")
+        else:
+            path = path.replace(".md", "/")
+        if lang == "en":
+            link = f"{deploy_url}/{path}"
+        else:
+            link = f"{deploy_url}/{lang}/{path}"
+        lang_links.setdefault(lang, []).append(link)
+
+    links: list[str] = []
+    en_links = lang_links.get("en", [])
+    en_links.sort()
+    links.extend(en_links)
+
+    langs = list(lang_links.keys())
+    langs.sort()
+    for lang in langs:
+        if lang == "en":
+            continue
+        current_lang_links = lang_links[lang]
+        current_lang_links.sort()
+        links.extend(current_lang_links)
+
+    message = f"📝 Docs preview for commit {settings.commit_sha} at: {deploy_url}"
+
+    if links:
+        message += "\n\n### Modified Pages\n\n"
+        message += "\n".join([f"* {link}" for link in links])
+
+    print(message)
+    use_pr.as_issue().create_comment(message)
+
+    logging.info("Finished")
+
+
+if __name__ == "__main__":
+    main()

{fastapi-0.112.0 → fastapi-0.112.1}/scripts/docs.py

@@ -11,9 +11,6 @@ from multiprocessing import Pool
 from pathlib import Path
 from typing import Any, Dict, List, Optional, Union
 
-import mkdocs.commands.build
-import mkdocs.commands.serve
-import mkdocs.config
 import mkdocs.utils
 import typer
 import yaml
@@ -29,6 +26,15 @@ missing_translation_snippet = """
 {!../../../docs/missing-translation.md!}
 """
 
+non_translated_sections = [
+    "reference/",
+    "release-notes.md",
+    "external-links.md",
+    "newsletter.md",
+    "management-tasks.md",
+    "management.md",
+]
+
 docs_path = Path("docs")
 en_docs_path = Path("docs/en")
 en_config_path: Path = en_docs_path / mkdocs_name
@@ -165,6 +171,13 @@ def generate_readme_content() -> str:
     pre_content = content[frontmatter_end:pre_end]
     post_content = content[post_start:]
     new_content = pre_content + message + post_content
+    # Remove content between <!-- only-mkdocs --> and <!-- /only-mkdocs -->
+    new_content = re.sub(
+        r"<!-- only-mkdocs -->.*?<!-- /only-mkdocs -->",
+        "",
+        new_content,
+        flags=re.DOTALL,
+    )
     return new_content
 
 
@@ -247,6 +260,7 @@ def live(
     lang: str = typer.Argument(
         None, callback=lang_callback, autocompletion=complete_existing_lang
     ),
+    dirty: bool = False,
 ) -> None:
     """
     Serve with livereload a docs site for a specific language.
@@ -258,12 +272,16 @@ def live(
     en.
     """
     # Enable line numbers during local development to make it easier to highlight
-    os.environ["LINENUMS"] = "true"
     if lang is None:
         lang = "en"
     lang_path: Path = docs_path / lang
-    os.chdir(lang_path)
-    mkdocs.commands.serve.serve(dev_addr="127.0.0.1:8008")
+    # Enable line numbers during local development to make it easier to highlight
+    args = ["mkdocs", "serve", "--dev-addr", "127.0.0.1:8008"]
+    if dirty:
+        args.append("--dirty")
+    subprocess.run(
+        args, env={**os.environ, "LINENUMS": "true"}, cwd=lang_path, check=True
+    )
 
 
 def get_updated_config_content() -> Dict[str, Any]:
@@ -324,10 +342,34 @@ def verify_config() -> None:
     typer.echo("Valid mkdocs.yml ✅")
 
 
+@app.command()
+def verify_non_translated() -> None:
+    """
+    Verify there are no files in the non translatable pages.
+    """
+    print("Verifying non translated pages")
+    lang_paths = get_lang_paths()
+    error_paths = []
+    for lang in lang_paths:
+        if lang.name == "en":
+            continue
+        for non_translatable in non_translated_sections:
+            non_translatable_path = lang / "docs" / non_translatable
+            if non_translatable_path.exists():
+                error_paths.append(non_translatable_path)
+    if error_paths:
+        print("Non-translated pages found, remove them:")
+        for error_path in error_paths:
+            print(error_path)
+        raise typer.Abort()
+    print("No non-translated pages found ✅")
+
+
 @app.command()
 def verify_docs():
     verify_readme()
     verify_config()
+    verify_non_translated()
 
 
 @app.command()

{fastapi-0.112.0 → fastapi-0.112.1}/scripts/mkdocs_hooks.py

@@ -8,9 +8,13 @@ from mkdocs.structure.files import File, Files
 from mkdocs.structure.nav import Link, Navigation, Section
 from mkdocs.structure.pages import Page
 
-non_traslated_sections = [
+non_translated_sections = [
     "reference/",
     "release-notes.md",
+    "external-links.md",
+    "newsletter.md",
+    "management-tasks.md",
+    "management.md",
 ]
 
 
@@ -128,7 +132,7 @@ def on_page_markdown(
     markdown: str, *, page: Page, config: MkDocsConfig, files: Files
 ) -> str:
     if isinstance(page.file, EnFile):
-        for excluded_section in non_traslated_sections:
+        for excluded_section in non_translated_sections:
             if page.file.src_path.startswith(excluded_section):
                 return markdown
         missing_translation_content = get_missing_translation_content(config.docs_dir)

fastapi-0.112.0/scripts/comment_docs_deploy_url_in_pr.py

@@ -1,31 +0,0 @@
-import logging
-import sys
-
-from github import Github
-from pydantic import SecretStr
-from pydantic_settings import BaseSettings
-
-
-class Settings(BaseSettings):
-    github_repository: str
-    github_token: SecretStr
-    deploy_url: str
-    commit_sha: str
-
-
-if __name__ == "__main__":
-    logging.basicConfig(level=logging.INFO)
-    settings = Settings()
-    logging.info(f"Using config: {settings.model_dump_json()}")
-    g = Github(settings.github_token.get_secret_value())
-    repo = g.get_repo(settings.github_repository)
-    use_pr = next(
-        (pr for pr in repo.get_pulls() if pr.head.sha == settings.commit_sha), None
-    )
-    if not use_pr:
-        logging.error(f"No PR found for hash: {settings.commit_sha}")
-        sys.exit(0)
-    use_pr.as_issue().create_comment(
-        f"📝 Docs preview for commit {settings.commit_sha} at: {settings.deploy_url}"
-    )
-    logging.info("Finished")