个别地方注释和错别字纠正

liaogx · liaogx · commit 30240a9a6f39 · 2021-01-12T10:50:02.000+08:00
diff --git a/tutorial/chapter03.py b/tutorial/chapter03.py
@@ -43,9 +43,9 @@ def filepath(file_path: str):
     return f"The file path is {file_path}"
 
 
-@app03.get("/path/{num}")  # 长度+正则表达式验证，比如长度8-16位，以a开头。其它校验方法看Query类的源码
+@app03.get("/path_/{num}")
 def path_params_validate(
-    num: int = Path(None, title="Your Number", description="不可描述", ge=1, le=10),  # None换成...就变成必填的参数
+    num: int = Path(..., title="Your Number", description="不可描述", ge=1, le=10),
 ):
     return num
 
@@ -77,10 +77,10 @@ def query_params_validate(
 
 
 class CityInfo(BaseModel):
-    name: str = Field(..., example="Beijing")  # example是注解的作用，只不会被验证
+    name: str = Field(..., example="Beijing")  # example是注解的作用，值不会被验证
     country: str
     country_code: str = None  # 给一个默认值
-    country_population: int = Field(default=0, title="人口数量", description="国家的人口数量", ge=800)
+    country_population: int = Field(default=800, title="人口数量", description="国家的人口数量", ge=800)
 
     class Config:
         schema_extra = {
@@ -141,23 +141,20 @@ def nested_models(data: Data):
     return data
 
 
-"""Cookie 参数"""
+"""Cookie 和 Header 参数"""
 
 
 @app03.get("/cookie")  # 效果只能用Postman测试
 def cookie(cookie_id: Optional[str] = Cookie(None)):  # 定义Cookie参数需要使用Cookie类，否则就是查询参数
     return {"cookie_id": cookie_id}
 
 
-"""Header 参数"""
-
-
 @app03.get("/header")
 def header(user_agent: Optional[str] = Header(None, convert_underscores=True), x_token: List[str] = Header(None)):
     """
     有些HTTP代理和服务器是不允许在请求头中带有下划线的，所以Header提供convert_underscores属性让设置
     :param user_agent: convert_underscores=True 会把 user_agent 变成 user-agent
-    :param x_token x_token是包含多个值的列表
+    :param x_token: x_token是包含多个值的列表
     :return:
     """
     return {"User-Agent": user_agent, "x_token": x_token}
diff --git a/tutorial/chapter04.py b/tutorial/chapter04.py
@@ -106,7 +106,7 @@ async def upload_files(files: List[UploadFile] = File(...)):  # 如果要上传
     return {"filename": files[0].filename, "content_type": files[0].content_type}
 
 
-"""【见main.py】FastAPI项目的静态文件配置"""
+"""【见run.py】FastAPI项目的静态文件配置"""
 
 """Path Operation Configuration 路径操作配置"""
 
diff --git a/tutorial/chapter05.py b/tutorial/chapter05.py
@@ -9,7 +9,7 @@
 
 app05 = APIRouter()
 
-"""Dependencies 导入、创建和声明依赖"""
+"""Dependencies 创建、导入和声明依赖"""
 
 
 async def common_parameters(q: Optional[str] = None, page: int = 1, limit: int = 100):
diff --git a/tutorial/chapter06.py b/tutorial/chapter06.py
@@ -5,8 +5,7 @@
 from datetime import datetime, timedelta
 from typing import Optional
 
-from fastapi import APIRouter
-from fastapi import Depends, HTTPException, status
+from fastapi import APIRouter, Depends, HTTPException, status
 from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
 from jose import JWTError, jwt
 from passlib.context import CryptContext
@@ -15,15 +14,22 @@
 app06 = APIRouter()
 
 """OAuth2 密码模式和 FastAPI 的 OAuth2PasswordBearer"""
-oauth2_scheme = OAuth2PasswordBearer(tokenUrl="chapter06/token")  # 请求Token的URL地址 http://127.0.0.1:8000/chapter06/token
+
+"""
+OAuth2PasswordBearer是接收URL作为参数的一个类：客户端会向该URL发送username和password参数，然后得到一个Token值
+OAuth2PasswordBearer并不会创建相应的URL路径操作，只是指明客户端用来请求Token的URL地址
+当请求到来的时候，FastAPI会检查请求的Authorization头信息，如果没有找到Authorization头信息，或者头信息的内容不是Bearer token，它会返回401状态码(UNAUTHORIZED)
+"""
+
+oauth2_schema = OAuth2PasswordBearer(tokenUrl="/chapter06/token")  # 请求Token的URL地址 http://127.0.0.1:8000/chapter06/token
 
 
 @app06.get("/oauth2_password_bearer")
-async def oauth2_password_bearer(token: str = Depends(oauth2_scheme)):
+async def oauth2_password_bearer(token: str = Depends(oauth2_schema)):
     return {"token": token}
 
 
-"""基于 Password 和 Bearer token 的 OAuth2 认证	"""
+"""基于 Password 和 Bearer token 的 OAuth2 认证"""
 
 fake_users_db = {
     "john snow": {
@@ -58,18 +64,30 @@ class UserInDB(User):
     hashed_password: str
 
 
+@app06.post("/token")
+async def login(form_data: OAuth2PasswordRequestForm = Depends()):
+    user_dict = fake_users_db.get(form_data.username)
+    if not user_dict:
+        raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail="Incorrect username or password")
+    user = UserInDB(**user_dict)
+    hashed_password = fake_hash_password(form_data.password)
+    if not hashed_password == user.hashed_password:
+        raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail="Incorrect username or password")
+    return {"access_token": user.username, "token_type": "bearer"}
+
+
 def get_user(db, username: str):
     if username in db:
         user_dict = db[username]
         return UserInDB(**user_dict)
 
 
-def fake_decode_token(token):
+def fake_decode_token(token: str):
     user = get_user(fake_users_db, token)
     return user
 
 
-async def get_current_user(token: str = Depends(oauth2_scheme)):
+async def get_current_user(token: str = Depends(oauth2_schema)):
     user = fake_decode_token(token)
     if not user:
         raise HTTPException(
@@ -82,23 +100,10 @@ async def get_current_user(token: str = Depends(oauth2_scheme)):
 
 async def get_current_active_user(current_user: User = Depends(get_current_user)):
     if current_user.disabled:
-        raise HTTPException(status_code=400, detail="Inactive user")
+        raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail="Inactive user")
     return current_user
 
 
-@app06.post("/token")
-async def login(form_data: OAuth2PasswordRequestForm = Depends()):
-    user_dict = fake_users_db.get(form_data.username)
-    if not user_dict:
-        raise HTTPException(status_code=400, detail="Incorrect username or password")
-    user = UserInDB(**user_dict)
-    hashed_password = fake_hash_password(form_data.password)
-    if not hashed_password == user.hashed_password:
-        raise HTTPException(status_code=400, detail="Incorrect username or password")
-
-    return {"access_token": user.username, "token_type": "bearer"}
-
-
 @app06.get("/users/me")
 async def read_users_me(current_user: User = Depends(get_current_active_user)):
     return current_user
@@ -116,44 +121,38 @@ async def read_users_me(current_user: User = Depends(get_current_active_user)):
     }
 })
 
-SECRET_KEY = "09d25e094faa6ca2556c818166b7a9563b93f7099f6f0f4caa6cf63b88e8d3e7"
-ALGORITHM = "HS256"
-ACCESS_TOKEN_EXPIRE_MINUTES = 30
+SECRET_KEY = "09d25e094faa6ca2556c818166b7a9563b93f7099f6f0f4caa6cf63b88e8d3e7"  # 生成密钥 openssl rand -hex 32
+ALGORITHM = "HS256"  # 算法
+ACCESS_TOKEN_EXPIRE_MINUTES = 30  # 访问令牌过期分钟
 
 
 class Token(BaseModel):
+    """返回给用户的Token"""
     access_token: str
     token_type: str
 
 
-class TokenData(BaseModel):
-    username: Optional[str] = None
-
-
 pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")
 
-oauth2_scheme = OAuth2PasswordBearer(tokenUrl="chapter06/jwt/token")
+oauth2_schema = OAuth2PasswordBearer(tokenUrl="/chapter06/jwt/token")
 
 
-def verify_password(plain_password, hashed_password):
+def verity_password(plain_password: str, hashed_password: str):
+    """对密码进行校验"""
     return pwd_context.verify(plain_password, hashed_password)
 
 
-def get_password_hash(password):
-    return pwd_context.hash(password)
-
-
 def jwt_get_user(db, username: str):
     if username in db:
         user_dict = db[username]
         return UserInDB(**user_dict)
 
 
-def authenticate_user(fake_db, username: str, password: str):
-    user = get_user(fake_db, username)
+def jwt_authenticate_user(db, username: str, password: str):
+    user = jwt_get_user(db=db, username=username)
     if not user:
         return False
-    if not verify_password(password, user.hashed_password):
+    if not verity_password(plain_password=password, hashed_password=user.hashed_password):
         return False
     return user
 
@@ -165,57 +164,51 @@ def create_access_token(data: dict, expires_delta: Optional[timedelta] = None):
     else:
         expire = datetime.utcnow() + timedelta(minutes=15)
     to_encode.update({"exp": expire})
-    encoded_jwt = jwt.encode(to_encode, SECRET_KEY, algorithm=ALGORITHM)
+    encoded_jwt = jwt.encode(claims=to_encode, key=SECRET_KEY, algorithm=ALGORITHM)
     return encoded_jwt
 
 
-async def jwt_get_current_user(token: str = Depends(oauth2_scheme)):
+@app06.post("/jwt/token", response_model=Token)
+async def login_for_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
+    user = jwt_authenticate_user(db=fake_users_db, username=form_data.username, password=form_data.password)
+    if not user:
+        raise HTTPException(
+            status.HTTP_401_UNAUTHORIZED,
+            detail="Incorrect username or password",
+            headers={"WWW-Authenticate": "Bearer"},
+        )
+    access_token_expires = timedelta(minutes=ACCESS_TOKEN_EXPIRE_MINUTES)
+    access_token = create_access_token(
+        data={"sub": user.username}, expires_delta=access_token_expires
+    )
+    return {"access_token": access_token, "token_type": "bearer"}
+
+
+async def jwt_get_current_user(token: str = Depends(oauth2_schema)):
     credentials_exception = HTTPException(
-        status_code=status.HTTP_401_UNAUTHORIZED,
+        status.HTTP_401_UNAUTHORIZED,
         detail="Could not validate credentials",
         headers={"WWW-Authenticate": "Bearer"},
     )
     try:
-        payload = jwt.decode(token, SECRET_KEY, algorithms=[ALGORITHM])
-        username: str = payload.get("sub")
+        payload = jwt.decode(token=token, key=SECRET_KEY, algorithms=[ALGORITHM])
+        username = payload.get("sub")
         if username is None:
             raise credentials_exception
-        token_data = TokenData(username=username)
     except JWTError:
         raise credentials_exception
-    user = get_user(fake_users_db, username=token_data.username)
+    user = jwt_get_user(db=fake_users_db, username=username)
     if user is None:
         raise credentials_exception
     return user
 
 
 async def jwt_get_current_active_user(current_user: User = Depends(jwt_get_current_user)):
     if current_user.disabled:
-        raise HTTPException(status_code=400, detail="Inactive user")
+        raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail="Inactive user")
     return current_user
 
 
-@app06.post("/jwt/token", response_model=Token)
-async def login_for_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
-    user = authenticate_user(fake_users_db, form_data.username, form_data.password)
-    if not user:
-        raise HTTPException(
-            status_code=status.HTTP_401_UNAUTHORIZED,
-            detail="Incorrect username or password",
-            headers={"WWW-Authenticate": "Bearer"},
-        )
-    access_token_expires = timedelta(minutes=ACCESS_TOKEN_EXPIRE_MINUTES)
-    access_token = create_access_token(
-        data={"sub": user.username}, expires_delta=access_token_expires
-    )
-    return {"access_token": access_token, "token_type": "bearer"}
-
-
-@app06.get("/jwt/users/me/", response_model=User)
-async def read_users_me(current_user: User = Depends(jwt_get_current_active_user)):
+@app06.get("/jwt/users/me")
+async def jwt_read_users_me(current_user: User = Depends(jwt_get_current_active_user)):
     return current_user
-
-
-@app06.get("/jwt/users/me/items/")
-async def read_own_items(current_user: User = Depends(jwt_get_current_active_user)):
-    return [{"item_id": "Foo", "owner": current_user.username}]
