mirror/fastapi
1
0
Fork 0
mirror of https://github.com/fastapi/fastapi.git synced 2026-05-18 13:27:45 -04:00
Code Issues Packages Projects Releases Wiki Activity

📝 Use Optional in docs (#1644)

Browse Source 
* Updated .py files with Optional tag (up to body_nested_models)

* Update optionals

* docs_src/ all updates, few I was unsure of

* Updated markdown files with Optional param

* es: Add Optional typing to index.md

* Last of markdown files updated with Optional param

* Update highlight lines

* it: Add Optional typings

* README.md: Update with Optional typings

* Update more highlight increments

* Update highlights

* schema-extra-example.md: Update highlights

* updating highlighting on website to reflect .py changes

* Update highlighting for query-params & response-directly

* Address PR comments

* Get rid of unnecessary comment

* ⏪ Revert Optional in Chinese docs as it probably also requires changes in text

* 🎨 Apply format

* ⏪ Revert modified example

* ♻️ Simplify example in docs

* 📝 Update OpenAPI callback example to use Optional

* ✨ Add Optional types to tests

* 📝 Update docs about query params, default to using Optional

* 🎨 Update code examples line highlighting

* 📝 Update nested models docs to use "type parameters" instead of "subtypes"

* 📝 Add notes about FastAPI usage of None

including:

= None

and

= Query(None)

and clarify relationship with Optional[str]

* 📝 Add note about response_model_by_alias

* ♻️ Simplify query param list example

* 🔥 Remove test for removed example

* ✅ Update test for updated example

Co-authored-by: Christopher Nguyen <chrisngyn99@gmail.com>
Co-authored-by: yk396 <yk396@cornell.edu>
Co-authored-by: Kai Chen <kaichen120@gmail.com>
This commit is contained in:
Sebastián Ramírez
2020-06-28 20:13:30 +02:00
committed by GitHub
parent 352c5f5ecc
commit 1f01ce9615
131 changed files with 535 additions and 466 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs_src/security/tutorial004.py
View File

@@ -1,4 +1,5 @@
from datetime import datetime, timedelta
from typing import Optional
import jwt
from fastapi import Depends, FastAPI, HTTPException, status
@@ -31,14 +32,14 @@ class Token(BaseModel):
class TokenData(BaseModel):
username: str = None
username: Optional[str] = None
class User(BaseModel):
username: str
email: str = None
full_name: str = None
disabled: bool = None
email: Optional[str] = None
full_name: Optional[str] = None
disabled: Optional[bool] = None
class UserInDB(User):
@@ -75,7 +76,7 @@ def authenticate_user(fake_db, username: str, password: str):
return user
def create_access_token(data: dict, expires_delta: timedelta = None):
def create_access_token(data: dict, expires_delta: Optional[timedelta] = None):
to_encode = data.copy()
if expires_delta:
expire = datetime.utcnow() + expires_delta