sa-token-python-core 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

sa_token/banner.py

@@ -0,0 +1,76 @@
+"""启动横幅。
+
+与 Java / Go 版一致：初始化时默认打印一次 ASCII 标志。
+Web 框架适配会在服务启动时再尝试打印；进程内只输出一次。
+``is_print_banner=False`` 或 ``.print_banner(False)`` 可关闭。
+"""
+
+from __future__ import annotations
+
+import sys
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:  # pragma: no cover - 仅供类型检查
+    from .manager import SaTokenManager
+
+__all__ = ["BANNER", "emit_banner", "emit_configured_banner", "reset_banner_state"]
+
+BANNER = r"""
+   _____         ______      __
+  / ___/____ _  /_  __/___  / /_____  ____
+  \__ \/ __ `/   / / / __ \/ //_/ _ \/ __ \
+ ___/ / /_/ /   / / / /_/ / ,< /  __/ / / /
+/____/\__,_/   /_/  \____/_/|_|\___/_/ /_/
+"""
+
+_printed = False
+
+
+def reset_banner_state() -> None:
+    """测试隔离：允许下一个用例再次打印。"""
+    global _printed
+    _printed = False
+
+
+def render_banner(manager: SaTokenManager) -> str:
+    from .manager import __version__
+
+    timeout = manager.config.timeout
+    timeout_text = "永久" if timeout < 0 else f"{timeout} 秒"
+    lines = [
+        BANNER.rstrip("\n"),
+        f":: sa-token-python ::   (v{__version__})",
+        f":: Python ::            {sys.version.split()[0]}",
+        f":: Token Style ::       {manager.config.token_style}",
+        f":: Token Timeout ::     {timeout_text}",
+        f":: Storage ::           {type(manager.storage).__name__}",
+        "",
+    ]
+    return "\n".join(lines)
+
+
+def write_banner(manager: SaTokenManager) -> None:
+    """无条件写出横幅，供手动调用。"""
+    sys.stdout.write(render_banner(manager) + "\n")
+    sys.stdout.flush()
+
+
+def emit_banner(manager: SaTokenManager) -> None:
+    """按配置打印横幅，同一进程只打印一次。"""
+    global _printed
+    if _printed or not manager.config.is_print_banner:
+        return
+    _printed = True
+    write_banner(manager)
+
+
+def emit_configured_banner() -> None:
+    """框架启动钩子：全局 Manager 已就绪则打印。"""
+    from .exception import SaTokenNotInitializedException
+    from .stp_util import get_manager
+
+    try:
+        manager = get_manager()
+    except SaTokenNotInitializedException:
+        return
+    emit_banner(manager)

sa_token/config.py

@@ -105,7 +105,13 @@ class SaTokenConfig:
     jwt_algorithm: str = "HS256"
 
     is_print_banner: bool = True
-    """初始化时是否打印启动横幅。"""
+    """是否打印启动横幅。默认 True，与 Java / Go 版一致。
+
+    原生 ``build()``、FastAPI / Starlette 服务启动、Flask ``init_app``、
+    Django 中间件加载时都会尝试打印，同一进程只输出一次。
+    关闭：``SaToken.builder().print_banner(False)`` 或
+    ``set_option(is_print_banner=False)``。
+    """
 
     extra: dict[str, Any] = field(default_factory=dict)
     """给扩展模块（OAuth2 / SSO / 在线用户）放自定义配置。"""

sa_token/integration/django.py

@@ -14,6 +14,7 @@ from typing import Any, TypeVar
 from ..adapter.http import HttpContext
 from ..adapter.path import PathAuthConfig
 from ..adapter.pipeline import build_rule, resolve_token, run_auth_flow, run_path_auth
+from ..banner import emit_configured_banner
 from ..exception import SaTokenException
 from ..permission import MatchMode
 from ..stp_util import get_manager
@@ -78,6 +79,7 @@ class SaTokenDjangoMiddleware:
 
     def __init__(self, get_response: Callable[[Any], Any]) -> None:
         self._get_response = get_response
+        emit_configured_banner()
 
     def __call__(self, request: Any) -> Any:
         ctx = DjangoHttpContext(request)

sa_token/integration/flask.py

@@ -13,6 +13,7 @@ from typing import TYPE_CHECKING, Any, TypeVar
 from ..adapter.http import HttpContext
 from ..adapter.path import PathAuthConfig
 from ..adapter.pipeline import build_rule, resolve_token, run_auth_flow, run_path_auth
+from ..banner import emit_configured_banner
 from ..exception import SaTokenException
 from ..permission import MatchMode
 from ..stp_util import get_manager
@@ -77,6 +78,9 @@ class SaTokenFlask:
     def init_app(self, app: Flask) -> None:
         app.before_request(self._before_request)
         app.register_error_handler(SaTokenException, self._handle_exception)
+        if hasattr(app, "before_serving"):
+            app.before_serving(emit_configured_banner)
+        emit_configured_banner()
 
     # 请求钩子 --------------------------------------------------------------
 

sa_token/integration/starlette.py

@@ -26,6 +26,7 @@ except ImportError as exc:  # pragma: no cover - 依赖缺失路径
 from ..adapter.http import HttpContext
 from ..adapter.path import PathAuthConfig
 from ..adapter.pipeline import build_rule, resolve_token, run_auth_flow, run_path_auth
+from ..banner import emit_configured_banner
 from ..exception import SaTokenException
 from ..permission import MatchMode
 from ..stp_util import get_manager
@@ -99,6 +100,7 @@ class SaTokenMiddleware(BaseHTTPMiddleware):
         super().__init__(app)
         self.path_auth = path_auth
         self.login_type = login_type
+        emit_configured_banner()
 
     async def dispatch(
         self,

sa_token/manager.py

@@ -6,9 +6,9 @@ Manager 负责组装：配置 + 存储 + Token 策略 + 事件总线 + 权限数
 
 from __future__ import annotations
 
-import sys
 from typing import TYPE_CHECKING, Any
 
+from .banner import emit_banner, write_banner
 from .config import SaTokenConfig
 from .listener import Event, EventBus, Listener
 from .model import DEFAULT_LOGIN_TYPE
@@ -22,15 +22,7 @@ if TYPE_CHECKING:  # pragma: no cover - 仅供类型检查
 
 __all__ = ["SaTokenManager", "SaTokenBuilder", "SaToken", "__version__"]
 
-__version__ = "0.1.2"
-
-_BANNER = r"""
-   _____         ______      __
-  / ___/____ _  /_  __/___  / /_____  ____
-  \__ \/ __ `/   / / / __ \/ //_/ _ \/ __ \
- ___/ / /_/ /   / / / /_/ / ,< /  __/ / / /
-/____/\__,_/   /_/  \____/_/|_|\___/_/ /_/
-"""
+__version__ = "0.1.4"
 
 
 class SaTokenManager:
@@ -54,6 +46,7 @@ class SaTokenManager:
         self._nonce_manager: NonceManager | None = None
         self._refresh_token_manager: RefreshTokenManager | None = None
         self._temp_token_manager: TempTokenManager | None = None
+        emit_banner(self)
 
     def stp(self, login_type: str = DEFAULT_LOGIN_TYPE) -> StpLogic:
         """取得指定账号体系的逻辑实例，不同 ``login_type`` 之间存储完全隔离。"""
@@ -100,16 +93,8 @@ class SaTokenManager:
         return self._temp_token_manager
 
     def print_banner(self) -> None:
-        lines = [
-            _BANNER,
-            f":: sa-token-python ::   (v{__version__})",
-            f":: Python ::            {sys.version.split()[0]}",
-            f":: Token Style ::       {self.config.token_style}",
-            f":: Token Timeout ::     {self.config.timeout} 秒",
-            f":: Storage ::           {type(self.storage).__name__}",
-            "",
-        ]
-        print("\n".join(lines))
+        """手动打印启动横幅，不受「只打印一次」限制。"""
+        write_banner(self)
 
 
 class SaTokenBuilder:
@@ -190,6 +175,7 @@ class SaTokenBuilder:
         return self
 
     def print_banner(self, value: bool) -> SaTokenBuilder:
+        """是否打印启动横幅，默认 True。传入 False 关闭。"""
         self._config.is_print_banner = value
         return self
 
@@ -227,8 +213,6 @@ class SaTokenBuilder:
             stp_interface=self._stp_interface,
             events=self._events,
         )
-        if self._config.is_print_banner:
-            manager.print_banner()
         if self._set_global:
             from .stp_util import set_manager
 

sa_token/security/refresh.py

@@ -228,15 +228,27 @@ class RefreshTokenManager:
             if cursor is None:
                 return
 
-    async def revoke_all_for_login(self, login_type: str, login_id: str) -> None:
+    async def revoke_all_for_login(
+        self,
+        login_type: str,
+        login_id: str,
+        *,
+        logout_access: bool = True,
+    ) -> None:
         raw = await self._storage.get(self._user_index_key(login_type, login_id))
         families = json.loads(raw) if raw else []
         if isinstance(families, list):
             for family_id in families:
-                await self.revoke_family(str(family_id))
+                await self.revoke_family(str(family_id), logout_access=logout_access)
         await self._storage.delete(self._user_index_key(login_type, login_id))
 
-    async def revoke_family(self, family_id: str) -> None:
+    async def revoke_family(self, family_id: str, *, logout_access: bool = True) -> None:
+        """吊销整个 token family。
+
+        ``logout_access=False`` 时只作废 refresh 侧记录。账号级 kickout/replaced
+        已经把 access token 标成下线原因，若这里再 ``logout_by_token`` 会把刚写入
+        的离线记录删掉，客户端就会看到 ``INVALID_TOKEN`` 而不是 ``KICK_OUT``。
+        """
         key = self._family_key(family_id)
         raw = await self._storage.get(key)
         family = _FamilyRecord.from_json(raw) if raw else None
@@ -245,8 +257,12 @@ class RefreshTokenManager:
         family.revoked = True
         await self._storage.set(key, family.to_json(), self._manager.config.refresh_token_timeout)
         logic = self._manager.stp(family.login_type)
-        for access_token in set(family.access_tokens):
-            await logic.logout_by_token(access_token, revoke_refresh=False)
+        if logout_access:
+            for access_token in set(family.access_tokens):
+                info = await logic.get_token_info(access_token)
+                if info is not None and info.is_offline:
+                    continue
+                await logic.logout_by_token(access_token, revoke_refresh=False)
         for token in set(family.refresh_tokens):
             await self._storage.delete(self._refresh_key(token))
 

sa_token/stp_logic.py

@@ -370,8 +370,10 @@ class StpLogic:
         offline_count = await self._offline_terminals(session, normalized_id, device, state)
         await self._save_or_drop_session(session, normalized_id)
         if device is None:
+            # 离线原因已经写进 access token；family 吊销只作废 refresh，不能再
+            # logout 把记录删掉，否则客户端会看到 INVALID_TOKEN。
             await self._manager.refresh_tokens.revoke_all_for_login(
-                self.login_type, normalized_id
+                self.login_type, normalized_id, logout_access=False
             )
         if offline_count:
             await self._emit(event, login_id=normalized_id, device=device)

sa_token/stp_util.py

@@ -29,6 +29,9 @@ def set_manager(manager: SaTokenManager) -> None:
     """设置全局 Manager，一般由 ``SaTokenBuilder.build()`` 自动调用。"""
     global _manager
     _manager = manager
+    from .banner import emit_banner
+
+    emit_banner(manager)
 
 
 def get_manager() -> SaTokenManager:

{sa_token_python_core-0.1.2.dist-info → sa_token_python_core-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: sa-token-python-core
-Version: 0.1.2
+Version: 0.1.4
 Summary: 有状态 Token 认证与权限鉴权框架（轻量核心）。灵感来源于 Java 的 Sa-Token。常用依赖请安装 sa-token-python；Web 框架按 extras 安装。
 Project-URL: Homepage, https://github.com/Star-yb/sa-token-python
 Project-URL: Documentation, https://github.com/Star-yb/sa-token-python
@@ -313,6 +313,7 @@ SaToken.builder() \
 | `is_write_cookie` | `False` | FastAPI 显式调用写 Cookie 助手时是否生效 |
 | `storage_key_prefix` | `satoken:` | 所有存储键前缀 |
 | `jwt_secret_key` | `None` | JWT 风格时必填 |
+| `is_print_banner` | `True` | 启动时打印 Sa-Token 标志，`.print_banner(False)` 关闭 |
 
 Token 读取顺序全局唯一：**Header → Authorization 兜底 → Cookie → Query**。各框架禁止自己再解析一遍。
 
@@ -504,8 +505,8 @@ class MyappConfig(AppConfig):
         from sa_token import SaToken
         from sa_token.storage import MemoryStorage, RedisStorage
 
-        SaToken.builder().storage(MemoryStorage()).timeout(86400).print_banner(False).build()
-        SaToken.builder().storage(RedisStorage.from_url("redis://127.0.0.1:6379/0")).timeout(86400).print_banner(False).build()
+        SaToken.builder().storage(MemoryStorage()).timeout(86400).build()
+        SaToken.builder().storage(RedisStorage.from_url("redis://127.0.0.1:6379/0")).timeout(86400).build()
 ```
 
 ### 2. 注册中间件

{sa_token_python_core-0.1.2.dist-info → sa_token_python_core-0.1.4.dist-info}/RECORD

@@ -1,16 +1,17 @@
 sa_token/__init__.py,sha256=pv7sfIXDmQMmRJuNRuXDb_q_bjVFnUrDw1kxk7gkhms,2165
-sa_token/config.py,sha256=CkRuH7mtBlnyp9DrbVZvbt1ESBjWbBKJndIjH2hbG6I,4540
+sa_token/banner.py,sha256=vNNoPd2Q9ynT3FJvxOifAWFUI9f8QmCyOw5MTuzsCzE,2240
+sa_token/config.py,sha256=vwwhUzLCMuw8RP9NPsalWy9HAGtR4VGsUhLCvCvlrWk,4841
 sa_token/context.py,sha256=cwI320c07fhHFkNawlhjOLQbhMkWm5jeb69vD3qVxuw,2002
 sa_token/exception.py,sha256=4KOgvZOx6nRuLB482Ehm5l841SWxRsiw_T-mbkR6Z14,3997
 sa_token/listener.py,sha256=pNLry8yllu35fTw9CnjmgaYLHuI8iyzS_d7NhXxoWm8,3129
-sa_token/manager.py,sha256=eSERfj8w2iIMCWLDlGKFsQPlZOyggfMqDNwfZLcSMI0,8287
+sa_token/manager.py,sha256=XZkZJergXRs63r7VzzbxI9BfyOggmQ-ys3nvOh8kZ-0,7808
 sa_token/model.py,sha256=2Twvy2XXkTBuab1Mg4SSQfXRDXSIKaQ6xnu8NUtMN0w,4374
 sa_token/permission.py,sha256=B_KKGaANfPtFSdGlNrp0bk2s_ZVbeHkYvLzoOlwQvkk,2487
 sa_token/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sa_token/session.py,sha256=9DkqLcPxppiqbVVwf2ybjSDv--4okWs__cPYbfsWGW0,2696
 sa_token/stp_interface.py,sha256=dxjPRj5jvuLLiGgh-o0EXhqouL42q59xob6e5IWhCBE,616
-sa_token/stp_logic.py,sha256=mWp9g_hAV8B3LQisGQD0RcYsuJe3N-dY7fTzL0E2k_Y,35627
-sa_token/stp_util.py,sha256=3G2jkDAulUsymQWxwf3AjrfcgUClt7oQmz8bNQ0iwgo,12685
+sa_token/stp_logic.py,sha256=VvJG6wEZkTbpCW-Dm4SQkXmJ69tkU2ihyxRmUrBYWSc,35826
+sa_token/stp_util.py,sha256=LRP_2csZybI-YxnuqQY-iCUDROwy51PtP9pV2hIu_RI,12747
 sa_token/sync.py,sha256=8ac7w2k0ER58jblXXV2ZaKk30qBiuwooPjniTjvWcjg,8890
 sa_token/token_io.py,sha256=rWqKJMGVZ-DCu0kjLMMZoaq2pR-rJql-96qkfyjkHuw,2174
 sa_token/adapter/__init__.py,sha256=NamL0PvdUaLMJgEs1Yo9MXeVkmFRUudhw9FtlELyEOc,638
@@ -18,18 +19,18 @@ sa_token/adapter/http.py,sha256=1pOdrT-1RcurejFYHj4MoNCD4Yr6UjcBiV5JdVeOwAc,1998
 sa_token/adapter/path.py,sha256=ZJpfY7SKVkDb5Pz9bdlUwsiJHyfP5FswIe80qbtApsU,5231
 sa_token/adapter/pipeline.py,sha256=0Eq_W6pOM4D6yV3LMomeA-XnrGB-GXSzbzn9k-7tyGI,2837
 sa_token/integration/__init__.py,sha256=lc4Bi1kdQnsN3McdcNPHptuOg8MY5InYCL7ZkugJk7I,380
-sa_token/integration/django.py,sha256=7E0ibwfGK9pt_fHTxnVQk5TcFNqNCtl339HQJhDF_PE,4178
+sa_token/integration/django.py,sha256=IWqq7ytKytj3mC_waMe0ww1fgXatyKZh4NwLeL4FeMs,4255
 sa_token/integration/fastapi.py,sha256=oHNC_ErZikkbRWDXcBnWvR2gL9vZlNIKHcyUbG2FAyQ,9988
 sa_token/integration/fastapi_oauth2.py,sha256=2pZPgYtZiYBS7Wne7VRqlcGfjEz5jm882xBlOYIXgH8,5109
-sa_token/integration/flask.py,sha256=_PxsKbyTCqm22uy1EOSIhoKPlGvbY5SpN0l2JCazKZw,6351
-sa_token/integration/starlette.py,sha256=XIcKDhsIcjmjDDrUYegwhDYBZiK5LA5vjaP8XJ7akFA,7464
+sa_token/integration/flask.py,sha256=rFkFvms5wvJWm0KsrFl8upCtUPxKJQCucxeMU7dNvdg,6526
+sa_token/integration/starlette.py,sha256=bMZk2a6yBqqhayUSv9XcTuJ8SXp78oO5b0OgOt3nmBs,7541
 sa_token/oauth2/__init__.py,sha256=J4tV401Y7hcLiyKUhypxrOoaZwgx-jMV_tee1QwyCsM,487
 sa_token/oauth2/model.py,sha256=OWQCiNWKro4elFwgEeFz7iviW7IqHD4Dhw7OQ32rvi8,3764
 sa_token/oauth2/server.py,sha256=NSzjwFU1ukO1jK-gUAdxkJZTID4-rUO0p7ZzAL_AY6Q,13884
 sa_token/online/__init__.py,sha256=7rpfFYPvnSMhoVBLs6TCmwwpFGcjqP7BgszBGj3NSYg,11218
 sa_token/security/__init__.py,sha256=v8W2uxXwRD-F_GteZhl_v4NFQS4QkObRiIo6kl4ctzg,369
 sa_token/security/nonce.py,sha256=wc3fHjM_-lgjK-jrkFkfW4Zc4RkwZrgs5ceBp6Ce9ZQ,3344
-sa_token/security/refresh.py,sha256=C6cqFe0KHmMvweaJo9gkuodic48tZfZdP6vUy_HihPs,11430
+sa_token/security/refresh.py,sha256=A5fmJG_SzrwHU77KX6fGBAcCIJmm2xg_631I4hLl8g8,12096
 sa_token/security/temp_token.py,sha256=Jgd9-Pk_Q5NVGesN5g41PhxfTRg1i4yr2Z6Z2cqM7M0,4454
 sa_token/sso/__init__.py,sha256=GYpX1oIGKMjTggUnHQCM9s-n3fN7NasdmCRZfnCCICU,7830
 sa_token/storage/__init__.py,sha256=7yv-26bmOT1cFDtsIYI1KmiPXkng7-3pe50uPzOTcXI,633
@@ -40,7 +41,7 @@ sa_token/strategy/__init__.py,sha256=j3DzIIMPqHF3L6_6VxxQAHtwEH9AX7GPv1ON-dyp67c
 sa_token/strategy/base.py,sha256=lNGwe-cW7gEnE6xn7_9gsCSkT4u-Ty5SZElqsoUMpck,634
 sa_token/strategy/builtin.py,sha256=2tYH32UXMbUu-Uup_yMouNSYNjO6XMXPNpnjZOGNMC0,2722
 sa_token/strategy/jwt.py,sha256=qZo2DoBG4Cq_tz5swtgasYiQACARzk-_ri-nO9_kWq8,2360
-sa_token_python_core-0.1.2.dist-info/METADATA,sha256=8euj85fNOos4pVUePjn8ROcRWdpkoXNvk6oJipKZOeY,26797
-sa_token_python_core-0.1.2.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
-sa_token_python_core-0.1.2.dist-info/licenses/LICENSE,sha256=KglpXsmvkzfIiEB2FvZnD5SuCyEtV1px4b4nTzQFHG8,10860
-sa_token_python_core-0.1.2.dist-info/RECORD,,
+sa_token_python_core-0.1.4.dist-info/METADATA,sha256=k5dSP9KU6tzgLZjAcDtt2X9hp5WXmZ3sVj-kfuUULu4,26854
+sa_token_python_core-0.1.4.dist-info/WHEEL,sha256=THafob7ofN-NsuMN7Mg4qZyHaQI7KkD-QlcQatYhXPo,87
+sa_token_python_core-0.1.4.dist-info/licenses/LICENSE,sha256=KglpXsmvkzfIiEB2FvZnD5SuCyEtV1px4b4nTzQFHG8,10860
+sa_token_python_core-0.1.4.dist-info/RECORD,,

{sa_token_python_core-0.1.2.dist-info → sa_token_python_core-0.1.4.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.32.0
+Generator: hatchling 1.32.3
 Root-Is-Purelib: true
 Tag: py3-none-any