bella-openapi 1.0.2__py3-none-any.whl → 1.0.2.1__py3-none-any.whl

bella_openapi/middleware/context_middleware.py

@@ -1,108 +1,108 @@
-import uuid
-
-import werkzeug
-from werkzeug.routing import Map, Rule
-from starlette.datastructures import URL
-from starlette.middleware.base import BaseHTTPMiddleware
-from starlette.responses import JSONResponse
-
-from bella_openapi import caller_id_context, request_url_context, trace_id_context
-from bella_openapi import validate_token
-from bella_openapi.exception import AuthorizationException
-from urllib.parse import parse_qs
-
-
-class WebSocketHttpContextMiddleware:
-    def __init__(self, app, *, exclude_url: list[str] = None):
-        self.app = app
-        self.exclude_url = exclude_url or []
-
-    async def __call__(self, scope, receive, send):
-        if scope["type"] != "websocket":
-            return await self.app(scope, receive, send)
-
-        url = URL(scope=scope)
-        if match_url(self.exclude_url, url.path):
-            return await self.app(scope, receive, send)
-
-        query_params = parse_qs(url.query)
-        if not (query_params.get('token')) or query_params.get('token') == '':
-            # send  token required error
-            await send({
-                "type": "websocket.close",
-                "code": 1006,
-                "reason": "token required",
-            })
-            return
-        try:
-            token = query_params.get('token')
-            caller = validate_token(token[0])
-        except AuthorizationException:
-            await send({
-                "type": "websocket.close",
-                "code": 1006,
-                "reason": "token invalid",
-            })
-            return
-        else:
-            caller_context_token = caller_id_context.set(caller)
-            trace_id_context_token = trace_id_context.set(str(uuid.uuid4()))
-            request_url_context_token = request_url_context.set(url.path)
-            await self.app(scope, receive, send)
-            caller_id_context.reset(caller_context_token)
-            trace_id_context.reset(trace_id_context_token)
-            request_url_context.reset(request_url_context_token)
-
-
-def match_url(patterns, url):
-    if patterns is None:
-        return False
-    # 创建 URL 规则
-    rules = [Rule(pattern) for pattern in patterns]
-    # 匹配 URL
-    adapter = Map(rules).bind('')
-    try:
-        adapter.match(url)
-        return True
-    except werkzeug.exceptions.NotFound:
-        return False
-
-
-class HttpContextMiddleware(BaseHTTPMiddleware):
-    def __init__(self, app, *, exclude_url: list[str] = None, ):
-        """
-        :param app
-        :param exclude_url: 不需要验证token的url,
-        根据https://werkzeug.palletsprojects.com/en/2.2.x/routing/  规则进行配置
-        """
-        super().__init__(app)
-        self.exclude_url = exclude_url
-
-    async def dispatch(self, request, call_next):
-        if match_url(self.exclude_url, request.url.path):
-            return await call_next(request)
-
-        if request.url.path.startswith("/v1/actuator/health"):
-            return await call_next(request)
-        authorization = request.headers.get("Authorization")
-        if authorization is None:
-            return JSONResponse(status_code=401, content={"message": "empty Authorization header"})
-
-        try:
-            caller = validate_token(authorization)
-        except AuthorizationException as e:
-            return JSONResponse(status_code=401, content={"message": e.message})
-
-        caller_context_token = caller_id_context.set(caller)
-        trace_id_context_token = trace_id_context.set(str(uuid.uuid4()))
-        request_url_context_token = request_url_context.set(request.url.path)
-
-        # 继续处理请求
-        response = await call_next(request)
-
-        # 重置contextvars上下文
-        caller_id_context.reset(caller_context_token)
-        trace_id_context.reset(trace_id_context_token)
-        request_url_context.reset(request_url_context_token)
-
-        return response
+import uuid
+
+import werkzeug
+from werkzeug.routing import Map, Rule
+from starlette.datastructures import URL
+from starlette.middleware.base import BaseHTTPMiddleware
+from starlette.responses import JSONResponse
+
+from bella_openapi import caller_id_context, request_url_context, trace_id_context
+from bella_openapi import validate_token
+from bella_openapi.exception import AuthorizationException
+from urllib.parse import parse_qs
+
+
+class WebSocketHttpContextMiddleware:
+    def __init__(self, app, *, exclude_url: list[str] = None):
+        self.app = app
+        self.exclude_url = exclude_url or []
+
+    async def __call__(self, scope, receive, send):
+        if scope["type"] != "websocket":
+            return await self.app(scope, receive, send)
+
+        url = URL(scope=scope)
+        if match_url(self.exclude_url, url.path):
+            return await self.app(scope, receive, send)
+
+        query_params = parse_qs(url.query)
+        if not (query_params.get('token')) or query_params.get('token') == '':
+            # send  token required error
+            await send({
+                "type": "websocket.close",
+                "code": 1006,
+                "reason": "token required",
+            })
+            return
+        try:
+            token = query_params.get('token')
+            caller = validate_token(token[0])
+        except AuthorizationException:
+            await send({
+                "type": "websocket.close",
+                "code": 1006,
+                "reason": "token invalid",
+            })
+            return
+        else:
+            caller_context_token = caller_id_context.set(caller)
+            trace_id_context_token = trace_id_context.set(str(uuid.uuid4()))
+            request_url_context_token = request_url_context.set(url.path)
+            await self.app(scope, receive, send)
+            caller_id_context.reset(caller_context_token)
+            trace_id_context.reset(trace_id_context_token)
+            request_url_context.reset(request_url_context_token)
+
+
+def match_url(patterns, url):
+    if patterns is None:
+        return False
+    # 创建 URL 规则
+    rules = [Rule(pattern) for pattern in patterns]
+    # 匹配 URL
+    adapter = Map(rules).bind('')
+    try:
+        adapter.match(url)
+        return True
+    except werkzeug.exceptions.NotFound:
+        return False
+
+
+class HttpContextMiddleware(BaseHTTPMiddleware):
+    def __init__(self, app, *, exclude_url: list[str] = None, ):
+        """
+        :param app
+        :param exclude_url: 不需要验证token的url,
+        根据https://werkzeug.palletsprojects.com/en/2.2.x/routing/  规则进行配置
+        """
+        super().__init__(app)
+        self.exclude_url = exclude_url
+
+    async def dispatch(self, request, call_next):
+        if match_url(self.exclude_url, request.url.path):
+            return await call_next(request)
+
+        if request.url.path.startswith("/v1/actuator/health"):
+            return await call_next(request)
+        authorization = request.headers.get("Authorization")
+        if authorization is None:
+            return JSONResponse(status_code=401, content={"message": "empty Authorization header"})
+
+        try:
+            caller = validate_token(authorization)
+        except AuthorizationException as e:
+            return JSONResponse(status_code=401, content={"message": e.message})
+
+        caller_context_token = caller_id_context.set(caller)
+        trace_id_context_token = trace_id_context.set(str(uuid.uuid4()))
+        request_url_context_token = request_url_context.set(request.url.path)
+
+        # 继续处理请求
+        response = await call_next(request)
+
+        # 重置contextvars上下文
+        caller_id_context.reset(caller_context_token)
+        trace_id_context.reset(trace_id_context_token)
+        request_url_context.reset(request_url_context_token)
+
+        return response

bella_openapi/openapi_contexvar.py

@@ -1,6 +1,6 @@
-from contextvars import ContextVar
-from typing import Optional
-
-trace_id_context: ContextVar[Optional[str]] = ContextVar("trace_id", default=None)
-caller_id_context: ContextVar[Optional[str]] = ContextVar("caller_id", default=None)
-request_url_context: ContextVar[Optional[str]] = ContextVar("request_url", default=None)
+from contextvars import ContextVar
+from typing import Optional
+
+trace_id_context: ContextVar[Optional[str]] = ContextVar("trace_id", default=None)
+caller_id_context: ContextVar[Optional[str]] = ContextVar("caller_id", default=None)
+request_url_context: ContextVar[Optional[str]] = ContextVar("request_url", default=None)

bella_openapi/schema.py

@@ -1,63 +1,63 @@
-from datetime import datetime
-from typing import Optional
-
-import uuid
-
-import pydantic
-from pydantic import BaseModel, Field
-from .openapi_contexvar import trace_id_context, caller_id_context, request_url_context
-
-
-class BaseOperationLog(BaseModel):
-    uuid: str = Field(default_factory=lambda: str(uuid.uuid4()))
-    request_id: Optional[str] = Field(default_factory=lambda: trace_id_context.get(),
-                                      alias='requestId')
-    caller_id: Optional[str] = Field(default_factory=lambda: caller_id_context.get(),
-                                     alias='callerId')
-    request_url: Optional[str] = Field(default_factory=lambda: request_url_context.get(),
-                                       alias='requestUrl')
-    op_log_type: str = Field(alias='opLogType')
-    op_type: str = Field(alias='opType')
-    is_cost_log: bool = Field(default=False, alias='isCostLog')
-    operation_status: str = Field(alias='operationStatus')
-    start_time_millis: int = Field(default_factory=lambda: int(datetime.now().timestamp() * 1000),
-                                   alias='startTimeMillis')
-    duration_millis: int = Field(default=0, alias='durationMillis')
-    request: object
-    response: object = Field(default=None)
-    err_msg: Optional[str] = Field(default=None, alias='errMsg')
-    extra_info: dict = Field(default={}, alias='extraInfo')
-    ucid: str = Field(default='ucid')
-
-    @staticmethod
-    def validate(values):
-        if 'request_id' not in values or values['request_id'] is None:
-            raise ValueError('request_id is required, please set trace_id_context')
-        if 'caller_id' not in values or values['caller_id'] is None:
-            raise ValueError('caller_id is required, please set caller_id_context')
-        if 'request_url' not in values or values['request_url'] is None:
-            raise ValueError('request_url is required, please set request_url_context')
-        return values
-
-
-if pydantic.version.VERSION.startswith('1.'):
-    from pydantic import root_validator
-
-
-    class OperationLog(BaseOperationLog):
-        @root_validator
-        def validate_duration_millis(cls, values):
-            super().validate(values)
-            return values
-
-
-else:
-    from pydantic import model_validator
-
-
-    class OperationLog(BaseOperationLog):
-
-        @model_validator(mode='after')
-        def validate_duration_millis(cls, values):
-            super().validate(values.dict())
-            return values
+from datetime import datetime
+from typing import Optional
+
+import uuid
+
+import pydantic
+from pydantic import BaseModel, Field
+from .openapi_contexvar import trace_id_context, caller_id_context, request_url_context
+
+
+class BaseOperationLog(BaseModel):
+    uuid: str = Field(default_factory=lambda: str(uuid.uuid4()))
+    request_id: Optional[str] = Field(default_factory=lambda: trace_id_context.get(),
+                                      alias='requestId')
+    caller_id: Optional[str] = Field(default_factory=lambda: caller_id_context.get(),
+                                     alias='callerId')
+    request_url: Optional[str] = Field(default_factory=lambda: request_url_context.get(),
+                                       alias='requestUrl')
+    op_log_type: str = Field(alias='opLogType')
+    op_type: str = Field(alias='opType')
+    is_cost_log: bool = Field(default=False, alias='isCostLog')
+    operation_status: str = Field(alias='operationStatus')
+    start_time_millis: int = Field(default_factory=lambda: int(datetime.now().timestamp() * 1000),
+                                   alias='startTimeMillis')
+    duration_millis: int = Field(default=0, alias='durationMillis')
+    request: object
+    response: object = Field(default=None)
+    err_msg: Optional[str] = Field(default=None, alias='errMsg')
+    extra_info: dict = Field(default={}, alias='extraInfo')
+    ucid: str = Field(default='ucid')
+
+    @staticmethod
+    def validate(values):
+        if 'request_id' not in values or values['request_id'] is None:
+            raise ValueError('request_id is required, please set trace_id_context')
+        if 'caller_id' not in values or values['caller_id'] is None:
+            raise ValueError('caller_id is required, please set caller_id_context')
+        if 'request_url' not in values or values['request_url'] is None:
+            raise ValueError('request_url is required, please set request_url_context')
+        return values
+
+
+if pydantic.version.VERSION.startswith('1.'):
+    from pydantic import root_validator
+
+
+    class OperationLog(BaseOperationLog):
+        @root_validator
+        def validate_duration_millis(cls, values):
+            super().validate(values)
+            return values
+
+
+else:
+    from pydantic import model_validator
+
+
+    class OperationLog(BaseOperationLog):
+
+        @model_validator(mode='after')
+        def validate_duration_millis(cls, values):
+            super().validate(values.dict())
+            return values