Update coding styles in code and docs (#31)

Author: wu-clan

README.md

@@ -21,4 +21,4 @@ pip install fastapi_oauth20
 
 ## Sponsor
 
-如果此项目能够帮助到你，你可以赞助作者一些咖啡豆表示鼓励：[:coffee: Sponsor :coffee:](https://wu-clan.github.io/sponsor/)
+如果这个项目对你有帮助，欢迎[请作者喝杯咖啡](https://wu-clan.github.io/sponsor/) ☕

docs/index.md

@@ -14,35 +14,37 @@
 
 ### Installation
 
-```bash
-pip install fastapi-oauth20
-```
+=== "pip"
+
+    ```bash
+    pip install fastapi-oauth20
+    ```
+
+=== "uv"
+
+    ```bash
+    uv add fastapi-oauth20
+    ```
 
 ### Basic Usage
 
 ```python
+from typing import Annotated
+
 from fastapi import FastAPI, Depends
-from fastapi_oauth20 import GitHubOAuth20, FastAPIOAuth20
 from fastapi.responses import RedirectResponse
-import secrets
+
+from fastapi_oauth20 import GitHubOAuth20, FastAPIOAuth20
 
 app = FastAPI()
 
-# 定义重定向地址
 redirect_uri = "http://localhost:8000/auth/github/callback"
 
-# 初始化 GitHub OAuth2 客户端
 github_client = GitHubOAuth20(
     client_id="your_github_client_id",
     client_secret="your_github_client_secret"
 )
 
-# 创建 FastAPI OAuth2 依赖项
-github_oauth = FastAPIOAuth20(
-    client=github_client,
-    redirect_uri=redirect_uri
-)
-
 
 @app.get("/auth/github")
 async def github_auth():
@@ -51,16 +53,14 @@ async def github_auth():
 
 
 @app.get("/auth/github/callback")
-async def github_callback(oauth_result: tuple = Depends(github_oauth)):
-    token_data, state = oauth_result
-    user_info = await github_client.get_userinfo(token_data["access_token"])
+async def github_callback(
+        oauth2: Annotated[
+            FastAPIOAuth20,
+            Depends(FastAPIOAuth20(github_client, redirect_uri=redirect_uri)),
+        ],
+):
+    token_data, state = oauth2
+    access_token = token_data['access_token']
+    user_info = await github_client.get_userinfo(access_token)
     return {"user": user_info}
 ```
-
-## 互动
-
-[TG / Discord](https://wu-clan.github.io/homepage/)
-
-## 赞助
-
-如果此项目能够帮助到你，你可以赞助作者一些咖啡豆表示鼓励：[Sponsor](https://wu-clan.github.io/sponsor/)

docs/status.md

@@ -1,9 +1,5 @@
 下面展示了我们的计划，如果你有更多需求，请在仓库内创建 Issues，我们将尽力完成所有目标
 
-!!! danger
-
-    对于强制要求【实名 + 人脸认证】的平台，植入变得困难，所以它们不会很快到来
-
 ## FINISHED
 
 - [x] [LinuxDo](clients/linuxdo.md)
@@ -20,5 +16,3 @@
 - [ ] [企业微信二维码登录](clients/wechat_work.md)
 - [ ] [钉钉](clients/dingtalk.md)
 - [ ] [QQ](clients/qq.md)
-- [ ] [微博](clients/weibo.md)
-- [ ] [抖音](clients/douyin.md)

docs/usage.md

@@ -56,7 +56,10 @@ async def oauth2_github():
 ```python
 @app.get("/oauth2/github/callback")
 async def oauth2_github_callback(
-    oauth_result: Annotated[FastAPIOAuth20, Depends(github_oauth)]
+        oauth_result: Annotated[
+            FastAPIOAuth20,
+            Depends(github_oauth),
+        ],
 ):
     """处理 GitHub OAuth 回调"""
     token_data, state = oauth_result
@@ -131,46 +134,37 @@ async def oauth2_authorize_callback_error_handler(request: Request, exc: OAuth20
 ```python
 from typing import Annotated
 
-from fastapi import FastAPI, Depends, HTTPException
+from fastapi import FastAPI, Depends
 from fastapi.responses import RedirectResponse
-from fastapi_oauth20 import GitHubOAuth20, FastAPIOAuth20
-from fastapi_oauth20 import OAuth20AuthorizeCallbackError
 
-import secrets
+from fastapi_oauth20 import GitHubOAuth20, FastAPIOAuth20
 
 app = FastAPI()
 
-# 初始化客户端
-github_client = GitHubOAuth20(
-    client_id="your_client_id",
-    client_secret="your_client_secret"
-)
+redirect_uri = "http://localhost:8000/auth/github/callback"
 
-# 创建依赖
-github_oauth = FastAPIOAuth20(
-    client=github_client,
-    redirect_uri="http://localhost:8000/auth/github/callback"
+github_client = GitHubOAuth20(
+    client_id="your_github_client_id",
+    client_secret="your_github_client_secret"
 )
 
 
-@app.get("/oauth2/github")
-async def oauth2_github():
-    """GitHub 授权入口"""
-    state = secrets.token_urlsafe(32)
-    auth_url = await github_client.get_authorization_url(
-        redirect_uri="http://localhost:8000/auth/github/callback",
-        state=state
-    )
+@app.get("/auth/github")
+async def github_auth():
+    auth_url = await github_client.get_authorization_url(redirect_uri=redirect_uri)
     return RedirectResponse(url=auth_url)
 
 
-@app.get("/oauth2/github/callback")
-async def oauth2_github_callback(
-    oauth_result: Annotated[FastAPIOAuth20, Depends(github_oauth)]
+@app.get("/auth/github/callback")
+async def github_callback(
+        oauth2: Annotated[
+            FastAPIOAuth20,
+            Depends(FastAPIOAuth20(github_client, redirect_uri=redirect_uri)),
+        ],
 ):
-    """GitHub 授权回调"""
-    token_data, state = oauth_result
-    user_info = await github_client.get_userinfo(token_data["access_token"])
+    token_data, state = oauth2
+    access_token = token_data['access_token']
+    user_info = await github_client.get_userinfo(access_token)
     return {"user": user_info}
 
 

fastapi_oauth20/__init__.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 from .callback import FastAPIOAuth20 as FastAPIOAuth20
 from .callback import OAuth20AuthorizeCallbackError as OAuth20AuthorizeCallbackError
 from .clients.feishu import FeiShuOAuth20 as FeiShuOAuth20

fastapi_oauth20/callback.py

@@ -1,10 +1,8 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-from typing import Any
+from typing import Annotated, Any
 
 import httpx
 
-from fastapi import HTTPException, Request
+from fastapi import HTTPException, Query, Request
 
 from fastapi_oauth20.errors import OAuth20BaseError, OAuth20RequestError
 from fastapi_oauth20.oauth20 import OAuth20Base
@@ -53,10 +51,10 @@ def __init__(
     async def __call__(
         self,
         request: Request,
-        code: str | None = None,
-        state: str | None = None,
-        code_verifier: str | None = None,
-        error: str | None = None,
+        code: Annotated[str | None, Query(description='Authorization code from OAuth2 provider')] = None,
+        state: Annotated[str | None, Query(description='State parameter for CSRF protection')] = None,
+        code_verifier: Annotated[str | None, Query(description='PKCE code verifier for enhanced security')] = None,
+        error: Annotated[str | None, Query(description='Error code if authorization failed')] = None,
     ) -> tuple[dict[str, Any], str | None]:
         """
         Process OAuth2 callback request and exchange authorization code for access token.

fastapi_oauth20/clients/__init__.py

@@ -1,2 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-

fastapi_oauth20/clients/feishu.py

@@ -1,6 +1,3 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
 from fastapi_oauth20.oauth20 import OAuth20Base
 
 

fastapi_oauth20/clients/gitee.py

@@ -1,6 +1,3 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
 from fastapi_oauth20.oauth20 import OAuth20Base
 
 

fastapi_oauth20/clients/github.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 from typing import Any
 
 import httpx