uomp-drf 0.1.2__tar.gz

uomp_drf-0.1.2/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.3
+Name: uomp-drf
+Version: 0.1.2
+Summary: Add your description here
+Author: freeflyday
+Author-email: freeflyday <freeflyday@163.com>
+Requires-Dist: django-filter==25.1
+Requires-Dist: djangorestframework>=3.17
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+

uomp_drf-0.1.2/pyproject.toml

@@ -0,0 +1,20 @@
+[project]
+name = "uomp-drf"
+version = "0.1.2"
+description = "Add your description here"
+readme = "README.md"
+authors = [
+    { name = "freeflyday", email = "freeflyday@163.com" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "django-filter==25.1",
+    "djangorestframework>=3.17",
+]
+
+[project.scripts]
+uomp-drf = "uomp_drf:main"
+
+[build-system]
+requires = ["uv_build>=0.11.17,<0.12.0"]
+build-backend = "uv_build"

uomp_drf-0.1.2/src/uomp_drf/__init__.py

@@ -0,0 +1,2 @@
+def main() -> None:
+    print("Hello from uomp-drf!")

uomp_drf-0.1.2/src/uomp_drf/authentication.py

@@ -0,0 +1,11 @@
+from rest_framework import permissions
+from rest_framework.authentication import SessionAuthentication as DrfSessionAuthentication
+
+
+class SessionAuthentication(DrfSessionAuthentication):
+    def enforce_csrf(self, request):
+        pass
+
+
+class MyPermissions(permissions.BasePermission):
+    pass

uomp_drf-0.1.2/src/uomp_drf/exception.py

@@ -0,0 +1,38 @@
+# uomp_drf/exception.py
+
+from rest_framework import status
+from rest_framework.response import Response
+from rest_framework.views import exception_handler as drf_exception_handler
+
+
+def exception_handler(exc, context):
+    # 调用默认的异常处理获取 response 对象
+    response = drf_exception_handler(exc, context)
+
+    if response is not None:
+        # --- 核心修复点：判断数据类型 ---
+        if isinstance(response.data, list):
+            # 如果是列表，通常取第一个元素作为错误信息
+            error_msg = str(response.data[0])
+        elif isinstance(response.data, dict):
+            # 如果是字典，尝试获取 'detail' 字段
+            error_msg = response.data.get('detail', str(response.data))
+        else:
+            # 兜底，直接转字符串
+            error_msg = str(response.data)
+
+        # 统一包装格式
+        response.data = {
+            "code": -1,
+            "msg": error_msg
+        }
+        return response
+
+    # 处理未被捕获的服务器内部错误
+    return Response(
+        {
+            "code": -1,
+            "msg": "服务器内部错误"
+        },
+        status=status.HTTP_500_INTERNAL_SERVER_ERROR
+    )

uomp_drf-0.1.2/src/uomp_drf/pnp.py

@@ -0,0 +1,18 @@
+from rest_framework.pagination import PageNumberPagination as DrfPageNumberPagination
+
+
+class PageNumberPagination(DrfPageNumberPagination):
+    """
+    定义分页器
+    """
+    page_size = 10  # 默认一页显示10个
+    max_page_size = 10000  # 设置单次取的最大值
+    page_query_param = 'page'  # 获取URL参数中传入的页码key字段
+    page_size_query_param = 'size'  # 指定单页最大值的字段
+
+
+class MyMaxPageNumberPagination(PageNumberPagination):
+    """
+    定义查询所有，数据不会最大
+    """
+    page_size = 10000  # 默认一页显示10000个

uomp_drf-0.1.2/src/uomp_drf/render.py

@@ -0,0 +1,44 @@
+# utils/response.py
+from rest_framework.renderers import JSONRenderer as DrfJSONRenderer
+
+
+class JSONRenderer(DrfJSONRenderer):
+    """
+    自定义全局渲染器，统一包装成功响应的格式
+    """
+
+    def render(self, data, accepted_media_type=None, renderer_context=None):
+        # 获取当前的 HTTP 状态码
+        status_code = renderer_context['response'].status_code
+
+        # 判断是否为成功的响应（以 2 开头的状态码）
+        if str(status_code).startswith('2'):
+            # 将原始数据自动包装为期望的统一格式
+            response_data = {
+                'code': status_code,
+                'msg': 'success',
+                'data': data
+            }
+            # 调用父类方法，将包装后的字典重新渲染为 JSON 字符串
+            return super().render(response_data, accepted_media_type, renderer_context)
+
+        # 如果是非 2xx 状态码（即异常情况），直接返回原数据
+        # （因为异常情况已经由全局异常处理器格式化好了，这里无需再次包装）
+        renderer_context['response'].status_code = 200
+        return super().render(data, accepted_media_type, renderer_context)
+
+
+class IBSRenderer(JSONRenderer):
+    def render(self, data, accepted_media_type=None, renderer_context=None):
+        if renderer_context:
+            response = renderer_context['response']
+            status_code = response.status_code
+            if status_code != 200:
+                if status_code == 401:
+                    data = {'error_code': 2, 'error_msg': data.get('detail')}
+                else:
+                    data = {'error_code': 9, 'error_msg': data.get('detail')}
+                response.status_code = 200
+            return super().render(data, accepted_media_type, renderer_context)
+        else:
+            return super().render(data, accepted_media_type, renderer_context)

uomp_drf-0.1.2/src/uomp_drf/viewsets.py

@@ -0,0 +1,30 @@
+from rest_framework.views import APIView
+from rest_framework.viewsets import ModelViewSet, ReadOnlyModelViewSet
+
+from .render import JSONRenderer, IBSRenderer
+
+
+class MyAPIView(APIView):
+    '''
+    Api试图数据返回
+    '''
+    renderer_classes = [JSONRenderer]
+
+
+class MyModelViewSet(MyAPIView, ModelViewSet):
+    '''
+    新版本自定义返回规范
+    '''
+
+
+class MyReadOnlyModelViewSet(MyAPIView, ReadOnlyModelViewSet):
+    '''
+    只读模型数据返回
+    '''
+
+
+class IbsAPIView(APIView):
+    '''
+    Api试图数据返回
+    '''
+    renderer_classes = [IBSRenderer]