factory/apps/bi/views.py

227 lines
9.2 KiB
Python

from django.shortcuts import render
from apps.utils.viewsets import CustomModelViewSet, CustomGenericViewSet
from rest_framework.decorators import action
from rest_framework.response import Response
from apps.bi.models import Dataset, DatasetRecord
from apps.bi.serializers import (
DataExecSerializer,
DatasetCreateUpdateSerializer,
DatasetListResponseSerializer,
DatasetRecordSerializer,
DatasetSerializer,
)
from django.apps import apps
from django.core.cache import cache
from apps.bi.services import execute_rendered_dataset, render_dataset_sql
from rest_framework.exceptions import ParseError
from rest_framework.generics import get_object_or_404
from apps.utils.mixins import ListModelMixin
from drf_yasg import openapi
from drf_yasg.utils import swagger_auto_schema
# Create your views here.
class DatasetViewSet(CustomModelViewSet):
queryset = Dataset.objects.all()
serializer_class = DatasetSerializer
create_serializer_class = DatasetCreateUpdateSerializer
update_serializer_class = DatasetCreateUpdateSerializer
search_fields = ['name', 'code', 'description']
ordering = ['name', 'code', 'id']
@swagger_auto_schema(
operation_id="bi_dataset_list",
operation_summary="查询复杂统计报表的数据集目录",
operation_description=(
"产量、良率、缺陷、库存、绩效、趋势和按日/月汇总等统计聚合查询的统一入口。"
"先调用本接口,根据 name、description、default_param 和 test_param 选择数据集,"
"再调用 bi_dataset_exec。建议使用 query={id,name,code,description,default_param,"
"test_param,enabled} 裁剪字段,并设置 page_size=100 查看完整目录;"
"search 可按名称、code 或 description 检索。"
),
manual_parameters=[
openapi.Parameter(
"search",
openapi.IN_QUERY,
description="按数据集名称、code 或适用场景关键词检索",
type=openapi.TYPE_STRING,
),
openapi.Parameter(
"page",
openapi.IN_QUERY,
description="页码,从 1 开始",
type=openapi.TYPE_INTEGER,
),
openapi.Parameter(
"page_size",
openapi.IN_QUERY,
description="每页数量;当前目录建议传 100",
type=openapi.TYPE_INTEGER,
),
openapi.Parameter(
"query",
openapi.IN_QUERY,
description=(
"django-restql 字段裁剪表达式,例如 "
"{id,name,code,description,default_param,test_param,enabled}"
),
type=openapi.TYPE_STRING,
),
],
responses={200: DatasetListResponseSerializer},
tags=["BI 数据集与报表"],
)
def list(self, request, *args, **kwargs):
return super().list(request, *args, **kwargs)
def get_object(self):
"""
Returns the object the view is displaying.
You may want to override this if you need to provide non-standard
queryset lookups. Eg if objects are referenced using multiple
keyword arguments in the url conf.
"""
queryset = self.filter_queryset(self.get_queryset())
# Perform the lookup filtering.
lookup_url_kwarg = self.lookup_url_kwarg or self.lookup_field
assert lookup_url_kwarg in self.kwargs, (
'Expected view %s to be called with a URL keyword argument '
'named "%s". Fix your URL conf, or set the `.lookup_field` '
'attribute on the view correctly.' %
(self.__class__.__name__, lookup_url_kwarg)
)
filter_kwargs = {self.lookup_field: self.kwargs[lookup_url_kwarg]}
try:
obj = get_object_or_404(queryset, **filter_kwargs)
except:
filter_kwargs = {'code': self.kwargs[lookup_url_kwarg]}
obj = get_object_or_404(queryset, **filter_kwargs)
# May raise a permission denied
self.check_object_permissions(self.request, obj)
return obj
@swagger_auto_schema(
operation_id="bi_dataset_exec",
operation_summary="执行已配置的只读统计数据集",
operation_description=(
"使用 dataset list 返回的 id 或 code 执行数据集。body.query 只填写该数据集"
"description/default_param 声明的业务参数;正常查询设置 is_test=false。"
"统计聚合使用本接口,日志和业务明细列表用于逐条追溯。"
),
request_body=DataExecSerializer,
responses={200: DatasetSerializer},
tags=["BI 数据集与报表"],
)
@action(methods=['post'], detail=True, perms_map={'post': 'dataset.exec'}, serializer_class=DataExecSerializer, cache_seconds=0, logging_methods=[])
def exec(self, request, pk=None):
"""执行sql查询
执行sql查询支持code
"""
dt: Dataset = self.get_object()
if not dt.enabled:
raise ParseError(f'{dt.name}-该查询未启用')
rdata = DatasetSerializer(instance=dt).data
xquery = dict(request.data.get('query') or {})
is_test = request.data.get('is_test', False)
raise_exception = request.data.get('raise_exception', True)
xquery['r_user'] = request.user.id
xquery['r_dept'] = request.user.belong_dept.id if request.user.belong_dept else ''
full_sql = render_dataset_sql(dt, xquery, is_test=is_test)
hash_k = None
if full_sql:
sql_f_strip = full_sql.strip(';')
hash_k = hash(sql_f_strip)
hash_v = cache.get(hash_k, None)
if hash_v:
return Response(hash_v)
response_data, can_cache = execute_rendered_dataset(
dt, full_sql, raise_exception=raise_exception
)
rdata.update(response_data)
if response_data['data'] and can_cache and hash_k is not None:
cache.set(hash_k, rdata, dt.cache_seconds)
return Response(rdata)
@action(methods=['get'], detail=False, perms_map={'get': '*'})
def base(self, request, pk=None):
all_models = apps.get_models()
rdict = {}
# 遍历所有模型
for model in all_models:
# 获取表名称
table_name = model._meta.db_table
rdict[table_name] = []
# 获取字段信息
fields = model._meta.get_fields()
for field in fields:
rdict[table_name].append(
{'name': field.name, 'type': field.get_internal_type()})
return Response(rdict)
class DatasetRecordViewSet(ListModelMixin, CustomGenericViewSet):
perms_map = {"get": "*"}
queryset = DatasetRecord.objects.all()
serializer_class = DatasetRecordSerializer
filterset_fields = {
"timex": ["year", "month", "day"],
"dataset": ["exact"],
"dataset__code": ["exact"]
}
# class ReportViewSet(CustomModelViewSet): # 暂时不用了
# queryset = Report.objects.all()
# serializer_class = ReportSerializer
# search_fields = ['name', 'code']
# @action(methods=['post'], detail=True, perms_map={'post': 'report.exec'}, serializer_class=DataExecSerializer, cache_seconds=0)
# def exec(self, request, pk=None):
# """执行报表查询
# 执行报表查询并用于返回前端渲染
# """
# report = self.get_object()
# rdata = ReportSerializer(instance=report).data
# query = request.data.get('query', {})
# return_type = request.data.get('return_type', 2)
# query['r_user'] = request.user.id
# query['r_dept'] = request.user.belong_dept.id if request.user.belong_dept else ''
# datasets = report.datasets.all()
# results = {}
# seconds = 10 # 缓存秒数
# with concurrent.futures.ThreadPoolExecutor(max_workers=6) as executor: # 多线程运行并返回字典结果
# fun_ps = []
# for ds in datasets:
# sql_query = ds.sql_query
# if sql_query:
# sql_f = check_sql_safe(sql_query.format(**query)) # 有风险先这样处理一下
# res = cache.get(sql_f, None)
# if isinstance(res, tuple):
# results[ds.name] = format_sqldata(res[0], res[1], return_type)
# else:
# fun_ps.append((ds.name, execute_raw_sql, sql_f))
# # 生成执行函数
# futures = {executor.submit(i[1], i[2]): i for i in fun_ps}
# for future in concurrent.futures.as_completed(futures):
# name, *_, sql_f = futures[future] # 获取对应的键
# try:
# res = future.result()
# results[name] = format_sqldata(res[0], res[1], return_type)
# if seconds:
# cache.set(sql_f, res, seconds)
# except Exception as e:
# results[name] = 'error: ' + str(e)
# rdata['data'] = results
# return Response(rdata)