Explore Enterprise Education Gitee Premium Gitee AI AI teammates
Fetch the repository succeeded.
Donate
Please sign in before you donate.
Scan WeChat QR to Pay
Cancel
Complete
Prompt
Switch to Alipay.
OK
Cancel
1 Star 0 Fork 76

it老头/FastAPI

Create your Gitee Account
Explore and code with more than 14 million developers,Free private repositories !:)
Sign up
Already have an account? Sign in
文件
master
Branches (155)
Tags (173)
master
dependabot/pip/starlette-gte-0.27.0-and-lt-0.34.0
dependabot/github_actions/pypa/gh-action-pypi-publish-1.8.11
pre-commit-ci-update-config
dependabot/pip/starlette-gte-0.27.0-and-lt-0.33.0
dependabot/pip/sqlalchemy-gte-1.3.18-and-lt-2.0.24
fastapi-people
dependabot/pip/pillow-10.1.0
dependabot/pip/sqlalchemy-gte-1.3.18-and-lt-2.0.23
dependabot/pip/mkdocs-material-9.4.6
drop-3.7
ref-docs
dependabot/pip/mkdocs-material-9.4.5
dependabot/pip/mkdocs-material-9.4.4
dependabot/pip/mkdocs-material-9.4.3
dependabot/pip/mkdocs-material-9.4.2
dependabot/pip/mkdocs-material-9.4.0
dependabot/github_actions/dawidd6/action-download-artifact-2.28.0
dependabot/pip/mkdocs-material-9.3.2
dependabot/pip/sqlalchemy-gte-1.3.18-and-lt-2.0.22
0.104.1
0.104.0
0.103.2
0.103.1
0.103.0
0.102.0
0.101.1
0.101.0
0.100.1
0.100.0
0.100.0-beta3
0.99.1
0.100.0-beta2
0.99.0
0.98.0
0.100.0-beta1
0.97.0
0.96.1
0.96.0
0.95.2
master
Branches (155)
Tags (173)
master
dependabot/pip/starlette-gte-0.27.0-and-lt-0.34.0
dependabot/github_actions/pypa/gh-action-pypi-publish-1.8.11
pre-commit-ci-update-config
dependabot/pip/starlette-gte-0.27.0-and-lt-0.33.0
dependabot/pip/sqlalchemy-gte-1.3.18-and-lt-2.0.24
fastapi-people
dependabot/pip/pillow-10.1.0
dependabot/pip/sqlalchemy-gte-1.3.18-and-lt-2.0.23
dependabot/pip/mkdocs-material-9.4.6
drop-3.7
ref-docs
dependabot/pip/mkdocs-material-9.4.5
dependabot/pip/mkdocs-material-9.4.4
dependabot/pip/mkdocs-material-9.4.3
dependabot/pip/mkdocs-material-9.4.2
dependabot/pip/mkdocs-material-9.4.0
dependabot/github_actions/dawidd6/action-download-artifact-2.28.0
dependabot/pip/mkdocs-material-9.3.2
dependabot/pip/sqlalchemy-gte-1.3.18-and-lt-2.0.22
0.104.1
0.104.0
0.103.2
0.103.1
0.103.0
0.102.0
0.101.1
0.101.0
0.100.1
0.100.0
0.100.0-beta3
0.99.1
0.100.0-beta2
0.99.0
0.98.0
0.100.0-beta1
0.97.0
0.96.1
0.96.0
0.95.2
Clone or Download
Clone/Download
Prompt
To download the code, please copy the following command and execute it in the terminal
To ensure that your submitted code identity is correctly recognized by Gitee, please execute the following command.
When using the SSH protocol for the first time to clone or push code, follow the prompts below to complete the SSH configuration.
1 Generate RSA keys.
2 Obtain the content of the RSA public key and configure it in SSH Public Keys
To use SVN on Gitee, please visit the usage guide
When using the HTTPS protocol, the command line will prompt for account and password verification as follows. For security reasons, Gitee recommends configure and use personal access tokens instead of login passwords for cloning, pushing, and other operations.
Username for 'https://gitee.com': userName
Password for 'https://userName@gitee.com': # Private Token
master
Branches (155)
Tags (173)
master
dependabot/pip/starlette-gte-0.27.0-and-lt-0.34.0
dependabot/github_actions/pypa/gh-action-pypi-publish-1.8.11
pre-commit-ci-update-config
dependabot/pip/starlette-gte-0.27.0-and-lt-0.33.0
dependabot/pip/sqlalchemy-gte-1.3.18-and-lt-2.0.24
fastapi-people
dependabot/pip/pillow-10.1.0
dependabot/pip/sqlalchemy-gte-1.3.18-and-lt-2.0.23
dependabot/pip/mkdocs-material-9.4.6
drop-3.7
ref-docs
dependabot/pip/mkdocs-material-9.4.5
dependabot/pip/mkdocs-material-9.4.4
dependabot/pip/mkdocs-material-9.4.3
dependabot/pip/mkdocs-material-9.4.2
dependabot/pip/mkdocs-material-9.4.0
dependabot/github_actions/dawidd6/action-download-artifact-2.28.0
dependabot/pip/mkdocs-material-9.3.2
dependabot/pip/sqlalchemy-gte-1.3.18-and-lt-2.0.22
0.104.1
0.104.0
0.103.2
0.103.1
0.103.0
0.102.0
0.101.1
0.101.0
0.100.1
0.100.0
0.100.0-beta3
0.99.1
0.100.0-beta2
0.99.0
0.98.0
0.100.0-beta1
0.97.0
0.96.1
0.96.0
0.95.2
FastAPI
/
scripts
/
docs.py
FastAPI
/
scripts
/
docs.py
docs.py 9.91 KB
Copy Edit Raw Blame History
Sebastián Ramírez authored 2023年10月25日 04:26 +08:00 . 👷 Adopt Ruff format (#10517)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
import json
import logging
import os
import re
import shutil
import subprocess
from functools import lru_cache
from http.server import HTTPServer, SimpleHTTPRequestHandler
from importlib import metadata
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
from jinja2 import Template
logging.basicConfig(level=logging.INFO)
app = typer.Typer()
mkdocs_name = "mkdocs.yml"
missing_translation_snippet = """
{!../../../docs/missing-translation.md!}
"""
docs_path = Path("docs")
en_docs_path = Path("docs/en")
en_config_path: Path = en_docs_path / mkdocs_name
site_path = Path("site").absolute()
build_site_path = Path("site_build").absolute()
@lru_cache
def is_mkdocs_insiders() -> bool:
version = metadata.version("mkdocs-material")
return "insiders" in version
def get_en_config() -> Dict[str, Any]:
return mkdocs.utils.yaml_load(en_config_path.read_text(encoding="utf-8"))
def get_lang_paths() -> List[Path]:
return sorted(docs_path.iterdir())
def lang_callback(lang: Optional[str]) -> Union[str, None]:
if lang is None:
return None
if not lang.isalpha() or len(lang) != 2:
typer.echo("Use a 2 letter language code, like: es")
raise typer.Abort()
lang = lang.lower()
return lang
def complete_existing_lang(incomplete: str):
lang_path: Path
for lang_path in get_lang_paths():
if lang_path.is_dir() and lang_path.name.startswith(incomplete):
yield lang_path.name
@app.callback()
def callback() -> None:
if is_mkdocs_insiders():
os.environ["INSIDERS_FILE"] = "../en/mkdocs.insiders.yml"
# For MacOS with insiders and Cairo
os.environ["DYLD_FALLBACK_LIBRARY_PATH"] = "/opt/homebrew/lib"
@app.command()
def new_lang(lang: str = typer.Argument(..., callback=lang_callback)):
"""
Generate a new docs translation directory for the language LANG.
LANG should be a 2-letter language code, like: en, es, de, pt, etc.
"""
new_path: Path = Path("docs") / lang
if new_path.exists():
typer.echo(f"The language was already created: {lang}")
raise typer.Abort()
new_path.mkdir()
new_config_path: Path = Path(new_path) / mkdocs_name
new_config_path.write_text("INHERIT: ../en/mkdocs.yml\n", encoding="utf-8")
new_config_docs_path: Path = new_path / "docs"
new_config_docs_path.mkdir()
en_index_path: Path = en_docs_path / "docs" / "index.md"
new_index_path: Path = new_config_docs_path / "index.md"
en_index_content = en_index_path.read_text(encoding="utf-8")
new_index_content = f"{missing_translation_snippet}\n\n{en_index_content}"
new_index_path.write_text(new_index_content, encoding="utf-8")
typer.secho(f"Successfully initialized: {new_path}", color=typer.colors.GREEN)
update_languages()
@app.command()
def build_lang(
lang: str = typer.Argument(
..., callback=lang_callback, autocompletion=complete_existing_lang
),
) -> None:
"""
Build the docs for a language.
"""
insiders_env_file = os.environ.get("INSIDERS_FILE")
print(f"Insiders file {insiders_env_file}")
if is_mkdocs_insiders():
print("Using insiders")
lang_path: Path = Path("docs") / lang
if not lang_path.is_dir():
typer.echo(f"The language translation doesn't seem to exist yet: {lang}")
raise typer.Abort()
typer.echo(f"Building docs for: {lang}")
build_site_dist_path = build_site_path / lang
if lang == "en":
dist_path = site_path
# Don't remove en dist_path as it might already contain other languages.
# When running build_all(), that function already removes site_path.
# All this is only relevant locally, on GitHub Actions all this is done through
# artifacts and multiple workflows, so it doesn't matter if directories are
# removed or not.
else:
dist_path = site_path / lang
shutil.rmtree(dist_path, ignore_errors=True)
current_dir = os.getcwd()
os.chdir(lang_path)
shutil.rmtree(build_site_dist_path, ignore_errors=True)
subprocess.run(["mkdocs", "build", "--site-dir", build_site_dist_path], check=True)
shutil.copytree(build_site_dist_path, dist_path, dirs_exist_ok=True)
os.chdir(current_dir)
typer.secho(f"Successfully built docs for: {lang}", color=typer.colors.GREEN)
index_sponsors_template = """
{% if sponsors %}
{% for sponsor in sponsors.gold -%}
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}"></a>
{% endfor -%}
{%- for sponsor in sponsors.silver -%}
<a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}"></a>
{% endfor %}
{% endif %}
"""
def generate_readme_content() -> str:
en_index = en_docs_path / "docs" / "index.md"
content = en_index.read_text("utf-8")
match_pre = re.search(r"</style>\n\n", content)
match_start = re.search(r"<!-- sponsors -->", content)
match_end = re.search(r"<!-- /sponsors -->", content)
sponsors_data_path = en_docs_path / "data" / "sponsors.yml"
sponsors = mkdocs.utils.yaml_load(sponsors_data_path.read_text(encoding="utf-8"))
if not (match_start and match_end):
raise RuntimeError("Couldn't auto-generate sponsors section")
if not match_pre:
raise RuntimeError("Couldn't find pre section (<style>) in index.md")
frontmatter_end = match_pre.end()
pre_end = match_start.end()
post_start = match_end.start()
template = Template(index_sponsors_template)
message = template.render(sponsors=sponsors)
pre_content = content[frontmatter_end:pre_end]
post_content = content[post_start:]
new_content = pre_content + message + post_content
return new_content
@app.command()
def generate_readme() -> None:
"""
Generate README.md content from main index.md
"""
typer.echo("Generating README")
readme_path = Path("README.md")
new_content = generate_readme_content()
readme_path.write_text(new_content, encoding="utf-8")
@app.command()
def verify_readme() -> None:
"""
Verify README.md content from main index.md
"""
typer.echo("Verifying README")
readme_path = Path("README.md")
generated_content = generate_readme_content()
readme_content = readme_path.read_text("utf-8")
if generated_content != readme_content:
typer.secho(
"README.md outdated from the latest index.md", color=typer.colors.RED
)
raise typer.Abort()
typer.echo("Valid README ✅")
@app.command()
def build_all() -> None:
"""
Build mkdocs site for en, and then build each language inside, end result is located
at directory ./site/ with each language inside.
"""
update_languages()
shutil.rmtree(site_path, ignore_errors=True)
langs = [lang.name for lang in get_lang_paths() if lang.is_dir()]
cpu_count = os.cpu_count() or 1
process_pool_size = cpu_count * 4
typer.echo(f"Using process pool size: {process_pool_size}")
with Pool(process_pool_size) as p:
p.map(build_lang, langs)
@app.command()
def update_languages() -> None:
"""
Update the mkdocs.yml file Languages section including all the available languages.
"""
update_config()
@app.command()
def serve() -> None:
"""
A quick server to preview a built site with translations.
For development, prefer the command live (or just mkdocs serve).
This is here only to preview a site with translations already built.
Make sure you run the build-all command first.
"""
typer.echo("Warning: this is a very simple server.")
typer.echo("For development, use the command live instead.")
typer.echo("This is here only to preview a site with translations already built.")
typer.echo("Make sure you run the build-all command first.")
os.chdir("site")
server_address = ("", 8008)
server = HTTPServer(server_address, SimpleHTTPRequestHandler)
typer.echo("Serving at: http://127.0.0.1:8008")
server.serve_forever()
@app.command()
def live(
lang: str = typer.Argument(
None, callback=lang_callback, autocompletion=complete_existing_lang
),
) -> None:
"""
Serve with livereload a docs site for a specific language.
This only shows the actual translated files, not the placeholders created with
build-all.
Takes an optional LANG argument with the name of the language to serve, by default
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")
def update_config() -> None:
config = get_en_config()
languages = [{"en": "/"}]
alternate: List[Dict[str, str]] = config["extra"].get("alternate", [])
alternate_dict = {alt["link"]: alt["name"] for alt in alternate}
new_alternate: List[Dict[str, str]] = []
for lang_path in get_lang_paths():
if lang_path.name == "en" or not lang_path.is_dir():
continue
name = lang_path.name
languages.append({name: f"/{name}/"})
for lang_dict in languages:
name = list(lang_dict.keys())[0]
url = lang_dict[name]
if url not in alternate_dict:
new_alternate.append({"link": url, "name": name})
else:
use_name = alternate_dict[url]
new_alternate.append({"link": url, "name": use_name})
config["extra"]["alternate"] = new_alternate
en_config_path.write_text(
yaml.dump(config, sort_keys=False, width=200, allow_unicode=True),
encoding="utf-8",
)
@app.command()
def langs_json():
langs = []
for lang_path in get_lang_paths():
if lang_path.is_dir():
langs.append(lang_path.name)
print(json.dumps(langs))
if __name__ == "__main__":
app()
Loading...
Report
Report success
We will send you the feedback within 2 working days through the letter!
Please fill in the reason for the report carefully. Provide as detailed a description as possible.
Please select a report type
Cancel
Send
误判申诉

此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。

如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。

取消
提交

About

FastAPI 是一个高性能 Web 框架,用于构建 API
Cancel

Releases

No release

Contributors

All

Activities

can not load any more
Edit
About
Homepage
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Python
1
https://gitee.com/redrice/FastAPI.git
git@gitee.com:redrice/FastAPI.git
redrice
FastAPI
FastAPI
master
Going to Help Center

Search

Comment
Repository Report
Back to the top
Login prompt
This operation requires login to the code cloud account. Please log in before operating.
Go to login
No account. Register

AltStyle によって変換されたページ (->オリジナル) /