notslowapi 0.1.0__tar.gz

notslowapi-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sebastián Ramírez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

notslowapi-0.1.0/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: notslowapi
+Version: 0.1.0
+Summary: FastAPI, minus the slow. A fork of FastAPI that does less work per request, with the same API and test suite.
+Author-Email: =?utf-8?q?Sebasti=C3=A1n_Ram=C3=ADrez?= <tiangolo@gmail.com>
+Maintainer: 4thel00z
+License-Expression: MIT
+License-File: LICENSE
+License-File: notslowapi/starlette/LICENSE.md
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development
+Classifier: Typing :: Typed
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: FastAPI
+Classifier: Framework :: Pydantic
+Classifier: Framework :: Pydantic :: 2
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Internet :: WWW/HTTP
+Project-URL: Homepage, https://notslowapi.com
+Project-URL: Documentation, https://notslowapi.com/docs/
+Project-URL: Benchmarks, https://notslowapi.com/benchmarks/
+Project-URL: Repository, https://github.com/4thel00z/notslowapi
+Project-URL: Issues, https://github.com/4thel00z/notslowapi/issues
+Project-URL: Changelog, https://github.com/4thel00z/notslowapi/releases
+Requires-Python: >=3.10
+Requires-Dist: anyio<5,>=3.6.2
+Requires-Dist: pydantic>=2.9.0
+Requires-Dist: typing-extensions>=4.8.0
+Requires-Dist: typing-inspection>=0.4.2
+Requires-Dist: annotated-doc>=0.0.2
+Provides-Extra: granian
+Requires-Dist: granian>=2.0; extra == "granian"
+Provides-Extra: standard
+Requires-Dist: httpx<1.0.0,>=0.23.0; extra == "standard"
+Requires-Dist: jinja2>=3.1.5; extra == "standard"
+Requires-Dist: python-multipart>=0.0.18; extra == "standard"
+Requires-Dist: email-validator>=2.0.0; extra == "standard"
+Requires-Dist: uvicorn[standard]>=0.12.0; extra == "standard"
+Requires-Dist: pydantic-settings>=2.0.0; extra == "standard"
+Requires-Dist: pydantic-extra-types>=2.0.0; extra == "standard"
+Provides-Extra: all
+Requires-Dist: httpx<1.0.0,>=0.23.0; extra == "all"
+Requires-Dist: jinja2>=3.1.5; extra == "all"
+Requires-Dist: python-multipart>=0.0.18; extra == "all"
+Requires-Dist: itsdangerous>=1.1.0; extra == "all"
+Requires-Dist: pyyaml>=5.3.1; extra == "all"
+Requires-Dist: email-validator>=2.0.0; extra == "all"
+Requires-Dist: uvicorn[standard]>=0.12.0; extra == "all"
+Requires-Dist: pydantic-settings>=2.0.0; extra == "all"
+Requires-Dist: pydantic-extra-types>=2.0.0; extra == "all"
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <a href="https://notslowapi.com"><img src="https://raw.githubusercontent.com/4thel00z/notslowapi/master/site/landing/assets/logo.svg" alt="notslowapi" width="360"></a>
+</p>
+
+<p align="center"><strong>FastAPI, minus the slow.</strong></p>
+
+<p align="center">A fork of FastAPI 0.141.1 that does less work per request: the same public API and test suite, with the plain JSON route down from 31.2 to 18.3 µs on uvicorn and 9.1 µs on granian.</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/notslowapi"><img src="https://img.shields.io/pypi/v/notslowapi" alt="PyPI version"></a>
+  <a href="https://pypi.org/project/notslowapi"><img src="https://img.shields.io/pypi/pyversions/notslowapi" alt="Python versions"></a>
+  <a href="https://github.com/4thel00z/notslowapi/actions/workflows/ci.yml"><img src="https://github.com/4thel00z/notslowapi/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+</p>
+
+**Site**: [https://notslowapi.com](https://notslowapi.com)
+
+**Docs**: [https://notslowapi.com/docs/](https://notslowapi.com/docs/)
+
+**Source**: [https://github.com/4thel00z/notslowapi](https://github.com/4thel00z/notslowapi)
+
+## Install
+
+```console
+uv add notslowapi[granian]
+```
+
+```console
+pip install "notslowapi[granian]"
+```
+
+Python 3.10 to 3.14 and `pydantic>=2.9.0`. Pydantic v1 is not supported. The base install brings no ASGI server; the `granian` extra adds `granian>=2.0`. The `standard` extra is FastAPI's and pulls the same set upstream does. Nothing is installed under the `fastapi` or `starlette` names, and existing installs of those packages are left alone.
+
+## Switch
+
+```python
+from notslowapi import FastAPI
+```
+
+Replace the package name `fastapi` with `notslowapi` in every import. The modules upstream exposes under `fastapi.*` exist under `notslowapi.*`: `responses`, `requests`, `middleware`, `security`, `openapi`, `encoders`, `exceptions`, `background`, `staticfiles`, `templating`, `testclient`, `websockets`, `sse`, `status`.
+
+## Run
+
+```console
+granian --interface asgi --workers 1 --loop uvloop myapp:app
+```
+
+`myapp:app` is the module path and attribute of your `FastAPI` instance. granian's I/O runs on Rust threads alongside the Python thread, so the framework's Python is the only thing left on the critical path. On a bare ASGI callable the server alone costs 7.8 µs per request under granian against 13.5 µs under uvicorn, and the notslowapi route adds 1.3 µs on top of that under granian against 4.8 µs under uvicorn.
+
+On uvicorn, install `uvicorn[standard]` for uvloop and httptools (18.3 µs on the plain route against 64.0 µs on asyncio and h11) and run:
+
+```console
+uvicorn myapp:app --loop uvloop --http httptools --no-proxy-headers --no-server-header --no-date-header
+```
+
+Leave `--proxy-headers` on if a proxy in front of you sets `X-Forwarded-*` headers and your app reads them.
+
+## Numbers
+
+One core (Apple M3 Pro, Python 3.13), 64 keep-alive connections, median of 3 x 5 s oha runs, one worker. The first column is upstream FastAPI 0.141.1 on uvicorn at the start of the work; the other two are notslowapi 0.1.0. Raw files: `bench/baseline/results_ladder_v1.json` and `results_ladder_v3.json` in the repository.
+
+| route | day one, uvicorn (FastAPI 0.141.1) | notslowapi, uvicorn | notslowapi, granian |
+|---|---|---|---|
+| raw ASGI app, fixed bytes (server floor) | 13.7 µs, 73,040 req/s | 13.5 µs, 74,172 req/s | 7.8 µs, 128,801 req/s |
+| plain JSON route | 31.2 µs, 32,033 req/s | 18.3 µs, 54,793 req/s | 9.1 µs, 110,154 req/s |
+| int path + str query param | 57.0 µs, 17,531 req/s | 24.2 µs, 41,405 req/s | 14.3 µs, 69,742 req/s |
+| pydantic body + response_model | 52.1 µs, 19,212 req/s | 26.1 µs, 38,295 req/s | 20.1 µs, 49,777 req/s |
+| 50 routes via include_router | 92.2 µs, 10,800 req/s * | 26.3 µs, 37,968 req/s | 17.3 µs, 57,864 req/s |
+
+\* This rung did not exist in `results_ladder_v1.json`. The 92.2 µs is the before-run of the include_router change (`bench/baseline/results_fix11_before.json`), measured on a tree that already had the first ten changes, so it understates the day-one gap.
+
+The changes are inside the framework: parameter extraction, the dependency solver, routing, exception handling and response encoding. Each is one commit with a before and after measurement, listed at [What changed](https://notslowapi.com/docs/what-changed/). The method, the tools and the raw files are at [Benchmark method](https://notslowapi.com/docs/benchmarks-method/); the full tables are at [notslowapi.com/benchmarks/](https://notslowapi.com/benchmarks/).
+
+## Compatibility
+
+notslowapi 0.1.0 has the public API of FastAPI 0.141.1: classes, functions, parameters and behaviors are upstream's, and the changes are internal. The check is the upstream test suite with its imports rewritten: 3,335 FastAPI tests plus 1,154 Starlette tests, 4,489 pass, with the same 8 environmental failures before and after every change. The modified Starlette 1.6.0 ships inside the package as `notslowapi.starlette` and nothing is installed under the `starlette` name, so code that imports `starlette.*` directly needs upstream Starlette installed and gets upstream behavior for those objects.
+
+```python
+from notslowapi.starlette.middleware.base import BaseHTTPMiddleware
+from notslowapi.starlette.responses import Response
+```
+
+Two observable differences: `AsyncExitStackMiddleware` is importable but no longer installed, so the scope no longer carries `fastapi_middleware_astack`, and `solve_dependencies` raises `RuntimeError` instead of failing an `assert` when a `yield` dependency runs without an exit stack. Details at [Compatibility](https://notslowapi.com/docs/compatibility/).
+
+## Reporting a regression
+
+Open an issue at [github.com/4thel00z/notslowapi/issues](https://github.com/4thel00z/notslowapi/issues) with the notslowapi version, a minimal app, and what FastAPI 0.141.1 does with the same code. For a performance regression, name the machine, Python version and server, and attach `bench/out/results.json` from a before and an after run of the ladder.
+
+## Credits
+
+notslowapi is built from [FastAPI](https://fastapi.tiangolo.com) by Sebastián Ramírez and [Starlette](https://starlette.dev) by Encode. The code is theirs; this fork changes how much of it runs per request. FastAPI's documentation applies to notslowapi with the package name swapped.
+
+## License
+
+The FastAPI code is MIT licensed, copyright 2018 Sebastián Ramírez (`LICENSE`). The vendored Starlette is BSD-3-Clause, copyright 2018 Encode OSS Ltd (`notslowapi/starlette/LICENSE.md`). Both files ship in the wheel; the package metadata declares `MIT`.

notslowapi-0.1.0/README.md

@@ -0,0 +1,94 @@
+<p align="center">
+  <a href="https://notslowapi.com"><img src="https://raw.githubusercontent.com/4thel00z/notslowapi/master/site/landing/assets/logo.svg" alt="notslowapi" width="360"></a>
+</p>
+
+<p align="center"><strong>FastAPI, minus the slow.</strong></p>
+
+<p align="center">A fork of FastAPI 0.141.1 that does less work per request: the same public API and test suite, with the plain JSON route down from 31.2 to 18.3 µs on uvicorn and 9.1 µs on granian.</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/notslowapi"><img src="https://img.shields.io/pypi/v/notslowapi" alt="PyPI version"></a>
+  <a href="https://pypi.org/project/notslowapi"><img src="https://img.shields.io/pypi/pyversions/notslowapi" alt="Python versions"></a>
+  <a href="https://github.com/4thel00z/notslowapi/actions/workflows/ci.yml"><img src="https://github.com/4thel00z/notslowapi/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+</p>
+
+**Site**: [https://notslowapi.com](https://notslowapi.com)
+
+**Docs**: [https://notslowapi.com/docs/](https://notslowapi.com/docs/)
+
+**Source**: [https://github.com/4thel00z/notslowapi](https://github.com/4thel00z/notslowapi)
+
+## Install
+
+```console
+uv add notslowapi[granian]
+```
+
+```console
+pip install "notslowapi[granian]"
+```
+
+Python 3.10 to 3.14 and `pydantic>=2.9.0`. Pydantic v1 is not supported. The base install brings no ASGI server; the `granian` extra adds `granian>=2.0`. The `standard` extra is FastAPI's and pulls the same set upstream does. Nothing is installed under the `fastapi` or `starlette` names, and existing installs of those packages are left alone.
+
+## Switch
+
+```python
+from notslowapi import FastAPI
+```
+
+Replace the package name `fastapi` with `notslowapi` in every import. The modules upstream exposes under `fastapi.*` exist under `notslowapi.*`: `responses`, `requests`, `middleware`, `security`, `openapi`, `encoders`, `exceptions`, `background`, `staticfiles`, `templating`, `testclient`, `websockets`, `sse`, `status`.
+
+## Run
+
+```console
+granian --interface asgi --workers 1 --loop uvloop myapp:app
+```
+
+`myapp:app` is the module path and attribute of your `FastAPI` instance. granian's I/O runs on Rust threads alongside the Python thread, so the framework's Python is the only thing left on the critical path. On a bare ASGI callable the server alone costs 7.8 µs per request under granian against 13.5 µs under uvicorn, and the notslowapi route adds 1.3 µs on top of that under granian against 4.8 µs under uvicorn.
+
+On uvicorn, install `uvicorn[standard]` for uvloop and httptools (18.3 µs on the plain route against 64.0 µs on asyncio and h11) and run:
+
+```console
+uvicorn myapp:app --loop uvloop --http httptools --no-proxy-headers --no-server-header --no-date-header
+```
+
+Leave `--proxy-headers` on if a proxy in front of you sets `X-Forwarded-*` headers and your app reads them.
+
+## Numbers
+
+One core (Apple M3 Pro, Python 3.13), 64 keep-alive connections, median of 3 x 5 s oha runs, one worker. The first column is upstream FastAPI 0.141.1 on uvicorn at the start of the work; the other two are notslowapi 0.1.0. Raw files: `bench/baseline/results_ladder_v1.json` and `results_ladder_v3.json` in the repository.
+
+| route | day one, uvicorn (FastAPI 0.141.1) | notslowapi, uvicorn | notslowapi, granian |
+|---|---|---|---|
+| raw ASGI app, fixed bytes (server floor) | 13.7 µs, 73,040 req/s | 13.5 µs, 74,172 req/s | 7.8 µs, 128,801 req/s |
+| plain JSON route | 31.2 µs, 32,033 req/s | 18.3 µs, 54,793 req/s | 9.1 µs, 110,154 req/s |
+| int path + str query param | 57.0 µs, 17,531 req/s | 24.2 µs, 41,405 req/s | 14.3 µs, 69,742 req/s |
+| pydantic body + response_model | 52.1 µs, 19,212 req/s | 26.1 µs, 38,295 req/s | 20.1 µs, 49,777 req/s |
+| 50 routes via include_router | 92.2 µs, 10,800 req/s * | 26.3 µs, 37,968 req/s | 17.3 µs, 57,864 req/s |
+
+\* This rung did not exist in `results_ladder_v1.json`. The 92.2 µs is the before-run of the include_router change (`bench/baseline/results_fix11_before.json`), measured on a tree that already had the first ten changes, so it understates the day-one gap.
+
+The changes are inside the framework: parameter extraction, the dependency solver, routing, exception handling and response encoding. Each is one commit with a before and after measurement, listed at [What changed](https://notslowapi.com/docs/what-changed/). The method, the tools and the raw files are at [Benchmark method](https://notslowapi.com/docs/benchmarks-method/); the full tables are at [notslowapi.com/benchmarks/](https://notslowapi.com/benchmarks/).
+
+## Compatibility
+
+notslowapi 0.1.0 has the public API of FastAPI 0.141.1: classes, functions, parameters and behaviors are upstream's, and the changes are internal. The check is the upstream test suite with its imports rewritten: 3,335 FastAPI tests plus 1,154 Starlette tests, 4,489 pass, with the same 8 environmental failures before and after every change. The modified Starlette 1.6.0 ships inside the package as `notslowapi.starlette` and nothing is installed under the `starlette` name, so code that imports `starlette.*` directly needs upstream Starlette installed and gets upstream behavior for those objects.
+
+```python
+from notslowapi.starlette.middleware.base import BaseHTTPMiddleware
+from notslowapi.starlette.responses import Response
+```
+
+Two observable differences: `AsyncExitStackMiddleware` is importable but no longer installed, so the scope no longer carries `fastapi_middleware_astack`, and `solve_dependencies` raises `RuntimeError` instead of failing an `assert` when a `yield` dependency runs without an exit stack. Details at [Compatibility](https://notslowapi.com/docs/compatibility/).
+
+## Reporting a regression
+
+Open an issue at [github.com/4thel00z/notslowapi/issues](https://github.com/4thel00z/notslowapi/issues) with the notslowapi version, a minimal app, and what FastAPI 0.141.1 does with the same code. For a performance regression, name the machine, Python version and server, and attach `bench/out/results.json` from a before and an after run of the ladder.
+
+## Credits
+
+notslowapi is built from [FastAPI](https://fastapi.tiangolo.com) by Sebastián Ramírez and [Starlette](https://starlette.dev) by Encode. The code is theirs; this fork changes how much of it runs per request. FastAPI's documentation applies to notslowapi with the package name swapped.
+
+## License
+
+The FastAPI code is MIT licensed, copyright 2018 Sebastián Ramírez (`LICENSE`). The vendored Starlette is BSD-3-Clause, copyright 2018 Encode OSS Ltd (`notslowapi/starlette/LICENSE.md`). Both files ship in the wheel; the package metadata declares `MIT`.

notslowapi-0.1.0/docs_src/additional_responses/tutorial001_py310.py

@@ -0,0 +1,22 @@
+from notslowapi import FastAPI
+from notslowapi.responses import JSONResponse
+from pydantic import BaseModel
+
+
+class Item(BaseModel):
+    id: str
+    value: str
+
+
+class Message(BaseModel):
+    message: str
+
+
+app = FastAPI()
+
+
+@app.get("/items/{item_id}", response_model=Item, responses={404: {"model": Message}})
+async def read_item(item_id: str):
+    if item_id == "foo":
+        return {"id": "foo", "value": "there goes my hero"}
+    return JSONResponse(status_code=404, content={"message": "Item not found"})

notslowapi-0.1.0/docs_src/additional_responses/tutorial002_py310.py

@@ -0,0 +1,28 @@
+from notslowapi import FastAPI
+from notslowapi.responses import FileResponse
+from pydantic import BaseModel
+
+
+class Item(BaseModel):
+    id: str
+    value: str
+
+
+app = FastAPI()
+
+
+@app.get(
+    "/items/{item_id}",
+    response_model=Item,
+    responses={
+        200: {
+            "content": {"image/png": {}},
+            "description": "Return the JSON item or an image.",
+        }
+    },
+)
+async def read_item(item_id: str, img: bool | None = None):
+    if img:
+        return FileResponse("image.png", media_type="image/png")
+    else:
+        return {"id": "foo", "value": "there goes my hero"}

notslowapi-0.1.0/docs_src/additional_responses/tutorial003_py310.py

@@ -0,0 +1,37 @@
+from notslowapi import FastAPI
+from notslowapi.responses import JSONResponse
+from pydantic import BaseModel
+
+
+class Item(BaseModel):
+    id: str
+    value: str
+
+
+class Message(BaseModel):
+    message: str
+
+
+app = FastAPI()
+
+
+@app.get(
+    "/items/{item_id}",
+    response_model=Item,
+    responses={
+        404: {"model": Message, "description": "The item was not found"},
+        200: {
+            "description": "Item requested by ID",
+            "content": {
+                "application/json": {
+                    "example": {"id": "bar", "value": "The bar tenders"}
+                }
+            },
+        },
+    },
+)
+async def read_item(item_id: str):
+    if item_id == "foo":
+        return {"id": "foo", "value": "there goes my hero"}
+    else:
+        return JSONResponse(status_code=404, content={"message": "Item not found"})

notslowapi-0.1.0/docs_src/additional_responses/tutorial004_py310.py

@@ -0,0 +1,30 @@
+from notslowapi import FastAPI
+from notslowapi.responses import FileResponse
+from pydantic import BaseModel
+
+
+class Item(BaseModel):
+    id: str
+    value: str
+
+
+responses = {
+    404: {"description": "Item not found"},
+    302: {"description": "The item was moved"},
+    403: {"description": "Not enough privileges"},
+}
+
+
+app = FastAPI()
+
+
+@app.get(
+    "/items/{item_id}",
+    response_model=Item,
+    responses={**responses, 200: {"content": {"image/png": {}}}},
+)
+async def read_item(item_id: str, img: bool | None = None):
+    if img:
+        return FileResponse("image.png", media_type="image/png")
+    else:
+        return {"id": "foo", "value": "there goes my hero"}

notslowapi-0.1.0/docs_src/additional_status_codes/tutorial001_an_py310.py

@@ -0,0 +1,25 @@
+from typing import Annotated
+
+from notslowapi import Body, FastAPI, status
+from notslowapi.responses import JSONResponse
+
+app = FastAPI()
+
+items = {"foo": {"name": "Fighters", "size": 6}, "bar": {"name": "Tenders", "size": 3}}
+
+
+@app.put("/items/{item_id}")
+async def upsert_item(
+    item_id: str,
+    name: Annotated[str | None, Body()] = None,
+    size: Annotated[int | None, Body()] = None,
+):
+    if item_id in items:
+        item = items[item_id]
+        item["name"] = name
+        item["size"] = size
+        return item
+    else:
+        item = {"name": name, "size": size}
+        items[item_id] = item
+        return JSONResponse(status_code=status.HTTP_201_CREATED, content=item)

notslowapi-0.1.0/docs_src/additional_status_codes/tutorial001_py310.py

@@ -0,0 +1,23 @@
+from notslowapi import Body, FastAPI, status
+from notslowapi.responses import JSONResponse
+
+app = FastAPI()
+
+items = {"foo": {"name": "Fighters", "size": 6}, "bar": {"name": "Tenders", "size": 3}}
+
+
+@app.put("/items/{item_id}")
+async def upsert_item(
+    item_id: str,
+    name: str | None = Body(default=None),
+    size: int | None = Body(default=None),
+):
+    if item_id in items:
+        item = items[item_id]
+        item["name"] = name
+        item["size"] = size
+        return item
+    else:
+        item = {"name": name, "size": size}
+        items[item_id] = item
+        return JSONResponse(status_code=status.HTTP_201_CREATED, content=item)

notslowapi-0.1.0/docs_src/advanced_middleware/tutorial001_py310.py

@@ -0,0 +1,11 @@
+from notslowapi import FastAPI
+from notslowapi.middleware.httpsredirect import HTTPSRedirectMiddleware
+
+app = FastAPI()
+
+app.add_middleware(HTTPSRedirectMiddleware)
+
+
+@app.get("/")
+async def main():
+    return {"message": "Hello World"}

notslowapi-0.1.0/docs_src/advanced_middleware/tutorial002_py310.py

@@ -0,0 +1,13 @@
+from notslowapi import FastAPI
+from notslowapi.middleware.trustedhost import TrustedHostMiddleware
+
+app = FastAPI()
+
+app.add_middleware(
+    TrustedHostMiddleware, allowed_hosts=["example.com", "*.example.com"]
+)
+
+
+@app.get("/")
+async def main():
+    return {"message": "Hello World"}

notslowapi-0.1.0/docs_src/advanced_middleware/tutorial003_py310.py

@@ -0,0 +1,11 @@
+from notslowapi import FastAPI
+from notslowapi.middleware.gzip import GZipMiddleware
+
+app = FastAPI()
+
+app.add_middleware(GZipMiddleware, minimum_size=1000, compresslevel=5)
+
+
+@app.get("/")
+async def main():
+    return "somebigcontent"

notslowapi-0.1.0/docs_src/app_testing/app_a_py310/main.py

@@ -0,0 +1,8 @@
+from notslowapi import FastAPI
+
+app = FastAPI()
+
+
+@app.get("/")
+async def read_main():
+    return {"msg": "Hello World"}

notslowapi-0.1.0/docs_src/app_testing/app_a_py310/test_main.py

@@ -0,0 +1,11 @@
+from notslowapi.testclient import TestClient
+
+from .main import app
+
+client = TestClient(app)
+
+
+def test_read_main():
+    response = client.get("/")
+    assert response.status_code == 200
+    assert response.json() == {"msg": "Hello World"}

notslowapi-0.1.0/docs_src/app_testing/app_b_an_py310/main.py

@@ -0,0 +1,38 @@
+from typing import Annotated
+
+from notslowapi import FastAPI, Header, HTTPException
+from pydantic import BaseModel
+
+fake_secret_token = "coneofsilence"
+
+fake_db = {
+    "foo": {"id": "foo", "title": "Foo", "description": "There goes my hero"},
+    "bar": {"id": "bar", "title": "Bar", "description": "The bartenders"},
+}
+
+app = FastAPI()
+
+
+class Item(BaseModel):
+    id: str
+    title: str
+    description: str | None = None
+
+
+@app.get("/items/{item_id}", response_model=Item)
+async def read_main(item_id: str, x_token: Annotated[str, Header()]):
+    if x_token != fake_secret_token:
+        raise HTTPException(status_code=400, detail="Invalid X-Token header")
+    if item_id not in fake_db:
+        raise HTTPException(status_code=404, detail="Item not found")
+    return fake_db[item_id]
+
+
+@app.post("/items/")
+async def create_item(item: Item, x_token: Annotated[str, Header()]) -> Item:
+    if x_token != fake_secret_token:
+        raise HTTPException(status_code=400, detail="Invalid X-Token header")
+    if item.id in fake_db:
+        raise HTTPException(status_code=409, detail="Item already exists")
+    fake_db[item.id] = item.model_dump()
+    return item

notslowapi-0.1.0/docs_src/app_testing/app_b_an_py310/test_main.py

@@ -0,0 +1,65 @@
+from notslowapi.testclient import TestClient
+
+from .main import app
+
+client = TestClient(app)
+
+
+def test_read_item():
+    response = client.get("/items/foo", headers={"X-Token": "coneofsilence"})
+    assert response.status_code == 200
+    assert response.json() == {
+        "id": "foo",
+        "title": "Foo",
+        "description": "There goes my hero",
+    }
+
+
+def test_read_item_bad_token():
+    response = client.get("/items/foo", headers={"X-Token": "hailhydra"})
+    assert response.status_code == 400
+    assert response.json() == {"detail": "Invalid X-Token header"}
+
+
+def test_read_nonexistent_item():
+    response = client.get("/items/baz", headers={"X-Token": "coneofsilence"})
+    assert response.status_code == 404
+    assert response.json() == {"detail": "Item not found"}
+
+
+def test_create_item():
+    response = client.post(
+        "/items/",
+        headers={"X-Token": "coneofsilence"},
+        json={"id": "foobar", "title": "Foo Bar", "description": "The Foo Barters"},
+    )
+    assert response.status_code == 200
+    assert response.json() == {
+        "id": "foobar",
+        "title": "Foo Bar",
+        "description": "The Foo Barters",
+    }
+
+
+def test_create_item_bad_token():
+    response = client.post(
+        "/items/",
+        headers={"X-Token": "hailhydra"},
+        json={"id": "bazz", "title": "Bazz", "description": "Drop the bazz"},
+    )
+    assert response.status_code == 400
+    assert response.json() == {"detail": "Invalid X-Token header"}
+
+
+def test_create_existing_item():
+    response = client.post(
+        "/items/",
+        headers={"X-Token": "coneofsilence"},
+        json={
+            "id": "foo",
+            "title": "The Foo ID Stealers",
+            "description": "There goes my stealer",
+        },
+    )
+    assert response.status_code == 409
+    assert response.json() == {"detail": "Item already exists"}