Merge branch 'main' into manytoone

Author: Chise1

README.md

@@ -2,7 +2,7 @@
 
 [![Python package](https://github.com/Chise1/fast-tmp/actions/workflows/test.yml/badge.svg)](https://github.com/Chise1/fast-tmp/actions/workflows/test.yml)
 [![codecov](https://codecov.io/gh/Chise1/fast-tmp/branch/main/graph/badge.svg?token=7CZE532R0H)](https://codecov.io/gh/Chise1/fast-tmp)
-[![Documentation Status](https://readthedocs.org/projects/fast-tmp/badge/?version=latest)](https://fast-tmp.readthedocs.io/zh_TW/latest/?badge=latest)
+[![Documentation Status](https://readthedocs.org/projects/fast-tmp/badge/?version=latest)](https://fast-tmp.readthedocs.io/?badge=latest)
 ![GitHub](https://img.shields.io/github/license/Chise1/fast-tmp)
 
 # 介绍
@@ -14,7 +14,7 @@ fast-tmp项目受django-admin的影响，旨在实现一个基于sqlalchemy+fast
 - amis:一款利用json数据生成页面的前端低代码项目。
 
 笔者前端能力比较弱，从实用主义出发，利用amis搭建后台管理的页面。这也为未来页面的功能拓展提供了无限可能。并摆脱前端开发的影响。（由于偷懒，登陆页面用的taber构建的。以后有时间了修改）
-
+更多内容查看[教程](https://fast-tmp.readthedocs.io/)
 ## 示例
 
 url:                http://124.222.119.206:8000/admin

docs/ModelAdmin.md

@@ -0,0 +1,74 @@
+# ModelAdmin类说明
+
+该类是整个项目的核心类，主要用于生成前端页面。 方法如下:
+
+```python
+from typing import Any, Tuple
+from sqlalchemy import Column
+
+
+class ModelAdmin:
+    model: Any  # sqlalchemy的model
+    # list
+    list_display: Tuple[Column, ...] = ()  # 在前端显示的内容，注意，如果要支持修改和删除功能，这里必须有类的主键
+    list_per_page: int = 10  # 每页显示数量
+    list_max_show_all: int = 200  # 最大每页数量
+    # create
+    create_fields: Tuple[Column, ...] = ()  # 创建页面需要的字段，如果有关系型字段（多对多，多对一，一对多，一对一等）则不要使用关系字段对应的外键字段，目前暂时只支持多对一和多对多
+    update_fields: Tuple[Column, ...] = ()  # 同create_fields
+    methods: Tuple[str, ...] = ("list", "create", "update", "delete",)  # 支持的方法 
+
+    @classmethod
+    def get_create_dialogation_button(cls):  # 新增按钮，如果要自定义按钮可重构这里
+        ...
+
+    @classmethod
+    def get_list_page(cls):  # list页面展示的字段
+        ...
+
+    @classmethod
+    def pks(cls):  # 获取主键
+        ...
+
+    @classmethod
+    def get_del_one_button(cls):  # 删除按钮
+        ...
+
+    @classmethod
+    def get_update_one_button(cls):  # 更新按钮和页面
+        ...
+
+    @classmethod
+    def get_operation(cls):  # 生成每条数据后面的按钮面板,要增加自定义按钮可以在这里增加
+        ...
+
+    @classmethod
+    def get_crud(cls):  # 获取整个页面的json模型
+        ...
+
+    @classmethod
+    def get_app_page(cls):  # 获取页面
+        ...
+
+    @classmethod
+    def create_model(cls, data: dict):
+        """
+        写入数据库之前调用
+        """
+        ...
+
+    @classmethod
+    def update_model(cls, instance: Any, data: dict) -> Any:
+        """
+        更新数据之前调用
+        """
+        ...
+
+    @classmethod
+    def get_list_sql(cls):  # 获取显示list的sql
+        ...
+
+    @classmethod
+    def get_one_sql(cls, pks: list):  # 获取update使用的sql
+        ...
+```

docs/cli.md

@@ -0,0 +1,35 @@
+# fast-tmp脚本指令说明
+
+## createsupuser
+
+创建一个超级用户，用法如下:
+
+```shell
+fast-tmp createsuperuser username password
+```
+
+## 初始化一个项目
+
+通过自定义的模板进行，需要安装cookiecutter，或者在安装fast-tmp的时候执行```pip install fast-tmp[cli]```
+
+然后可以执行```fast-tmp startproject```即可创建一个项目的基本结构。
+
+## 自定义脚本
+
+在settings.py里面引入自定义脚本所在的路径，即可自动读取并注册到脚本里面去， 例如：
+
+```python
+# cli.py
+def hello():
+    """
+    你好.
+    """
+    print("hello world.")
+
+
+# settings.py
+EXTRA_SCRIPT = ['cli.hello']  # 自定义执行脚本
+
+```
+
+然后执行```fast-tmp```即可查看到自己注册的方法。

docs/index.md

@@ -2,7 +2,7 @@
 
 [![Python package](https://github.com/Chise1/fast-tmp/actions/workflows/test.yml/badge.svg)](https://github.com/Chise1/fast-tmp/actions/workflows/test.yml)
 [![codecov](https://codecov.io/gh/Chise1/fast-tmp/branch/main/graph/badge.svg?token=7CZE532R0H)](https://codecov.io/gh/Chise1/fast-tmp)
-[![Documentation Status](https://readthedocs.org/projects/fast-tmp/badge/?version=latest)](https://fast-tmp.readthedocs.io/zh_TW/latest/?badge=latest)
+[![Documentation Status](https://readthedocs.org/projects/fast-tmp/badge/?version=latest)](https://fast-tmp.readthedocs.io/?badge=latest)
 ![GitHub](https://img.shields.io/github/license/Chise1/fast-tmp)
 
 # 介绍

example/app.py

@@ -8,13 +8,14 @@
 from fast_tmp.admin.server import admin
 from example.factory import create_app
 from fast_tmp.site import register_model_site
-from example.admin import UserInfoAdmin
+from example.admin import UserInfoAdmin, AuthorAdmin, BookAdmin
 
-register_model_site({"Example":[UserInfoAdmin]})
+register_model_site({"Example": [UserInfoAdmin, AuthorAdmin, BookAdmin]})
 app: FastAPI = create_app()
 app.mount("/admin", admin, name="admin", )
 Base.metadata.create_all(engine)
 
 if __name__ == '__main__':
     import uvicorn
+
     uvicorn.run(app, host="0.0.0.0", port=8000, lifespan="on")

example/example/admin.py

@@ -1,11 +1,25 @@
 from fast_tmp.site import ModelAdmin
-from .models import UserInfo
+from .models import UserInfo, Author, Book
 
 
 class UserInfoAdmin(ModelAdmin):
     model = UserInfo
     create_fields = [UserInfo.name, UserInfo.age, UserInfo.birthday, UserInfo.money, UserInfo.height, UserInfo.info,
+                     UserInfo.tag, UserInfo.is_superuser]
+    update_fields = create_fields
+    list_display = [UserInfo.id, UserInfo.name, UserInfo.age, UserInfo.birthday, UserInfo.money, UserInfo.height,
+                    UserInfo.info,
                     UserInfo.tag, UserInfo.is_superuser]
+
+
+class AuthorAdmin(ModelAdmin):
+    model = Author
+    create_fields = [Author.name]
+    list_display = create_fields
+
+
+class BookAdmin(ModelAdmin):
+    model = Book
+    create_fields = [Book.name, Book.author]  # todo 增加提醒，可以为关系，可以为id
+    list_display = [Book.id, Book.name, Book.author]  # todo 增加检查，必须在listplay里面带主键
     update_fields = create_fields
-    list_display =  [UserInfo.id,UserInfo.name, UserInfo.age, UserInfo.birthday, UserInfo.money, UserInfo.height, UserInfo.info,
-                    UserInfo.tag, UserInfo.is_superuser]

example/example/models.py

@@ -1,19 +1,37 @@
 import time
 
-from sqlalchemy import String, Boolean, Integer, DateTime, DECIMAL, Float, JSON, Text, Time, Column
+from sqlalchemy import String, Boolean, Integer, DateTime, DECIMAL, Float, JSON, Text, Time, Column, ForeignKey
 # todo Image,File
+from sqlalchemy.orm import relationship
+
 from fast_tmp.models import Base
 
 
 class UserInfo(Base):
     __tablename__ = "userinfo"
     id = Column(Integer, primary_key=True)
     name = Column(String(128), unique=True)
-    age = Column(Integer,default=10,)
-    birthday=Column(DateTime)
-    money=Column(DECIMAL(scale=3))
-    height=Column(Float)
-    info=Column(JSON)
-    tag=Column(Text)
+    age = Column(Integer, default=10, )
+    birthday = Column(DateTime)
+    money = Column(DECIMAL(scale=3))
+    height = Column(Float)
+    info = Column(JSON)
+    tag = Column(Text)
     # create_time=Column(Time,default=time.time)
     is_superuser = Column(Boolean(), default=True)
+
+
+class Author(Base):
+    __tablename__ = "author"
+    id = Column(Integer, primary_key=True)
+    name = Column(String(32),nullable=False)
+    # books: Author = relationship("Author", back_populates="books")
+
+
+class Book(Base):
+    __tablename__ = "book"
+
+    id = Column(Integer, primary_key=True)
+    name = Column(String(128), nullable=False)
+    author_id = Column(Integer, ForeignKey('author.id'), info={"admin_name": "name"},nullable=False)  # todo 增加提示
+    author: Author = relationship("Author", backref="books")

fast_tmp/admin/endpoint.py

@@ -1,8 +1,22 @@
+from datetime import datetime
 from typing import List, Optional
 
 from fastapi import APIRouter, Depends
+from fastapi.params import Path
 from pydantic import BaseModel
-from sqlalchemy import delete, func, select
+from sqlalchemy import (
+    DECIMAL,
+    INTEGER,
+    BigInteger,
+    DateTime,
+    Float,
+    Integer,
+    Numeric,
+    SmallInteger,
+    delete,
+    func,
+    select,
+)
 from sqlalchemy.orm import Session
 from starlette.requests import Request
 from starlette.responses import RedirectResponse
@@ -41,10 +55,10 @@ def list_view(
 ):
     if not user:
         return RedirectResponse(request.url_for("admin:login"))
-
-    datas = session.execute(
-        select(page_model.list_display).limit(perPage).offset((page - 1) * perPage)
-    )
+    sql = page_model.get_list_sql()
+    if sql == None:
+        return BaseRes()
+    datas = session.execute(sql.limit(perPage).offset((page - 1) * perPage))
     items = []
     for data in datas:
         items.append(dict(data))
@@ -70,7 +84,7 @@ def update_data(
 ):
     if not user:
         return RedirectResponse(request.url_for("admin:login"))
-    data = clean_data_to_model(page_model.update_fields, data)
+    data = clean_data_to_model(page_model.get_clean_fields(page_model.update_fields), data)
     w = get_pks(page_model, request)
     if isinstance(w, BaseRes):
         return w
@@ -92,10 +106,10 @@ def update_view(
     if not user:
         return RedirectResponse(request.url_for("admin:login"))
 
-    w = get_pks(page_model, request)
-    if isinstance(w, BaseRes):
-        return w
-    data = session.execute(select(page_model.update_fields).where(*w)).fetchone()
+    pks = get_pks(page_model, request)
+    if isinstance(pks, BaseRes):
+        return pks
+    data = session.execute(page_model.get_one_sql(pks)).fetchone()
     if not data:
         return not_found_instance
     return BaseRes(data=dict(data))
@@ -138,12 +152,23 @@ def delete_one(
 
 
 def get_pks(page_model: ModelAdmin, request: Request):
+    """
+    获取要查询的单个instance的主键
+    """
     params = dict(request.query_params)
     pks = get_pk(page_model.model)
     w = []
     for k, v in params.items():
         if pks.get(k) is not None:
-            w.append(pks[k] == v)
+            field = pks[k]
+            if isinstance(
+                field.type, (Integer, DECIMAL, BigInteger, Float, INTEGER, Numeric, SmallInteger)
+            ):
+                w.append(pks[k] == int(v))
+            elif isinstance(field.type, DateTime):
+                w.append(pks[k] == datetime.strptime(v, "%Y-%m-%dT%H:%M:%S"))
+            else:
+                w.append(pks[k] == v)
         else:
             return key_error
     return w
@@ -173,3 +198,29 @@ def get_schema(
         return RedirectResponse(request.url_for("admin:login"))
 
     return BaseRes(data=page.get_app_page())
+
+
+@router.get("/{resource}/selects/{field}")
+def get_selects(
+    request: Request,
+    field: str = Path(...),  # type: ignore
+    page_model: ModelAdmin = Depends(get_model_site),
+    user: Optional[User] = Depends(decode_access_token_from_data),
+    session: Session = Depends(get_db_session),
+    perPage: int = 10,
+    page: int = 1,
+):
+    source_field = getattr(page_model.model, field)
+    relation_model = source_field.property.mapper.class_
+
+    datas = session.execute(
+        select(list(get_pk(relation_model).values())).limit(perPage).offset((page - 1) * perPage)
+    )
+    items = []
+    for data in datas:
+        items.append(dict(data))
+    s = session.execute(select(func.count()).select_from(relation_model))
+    total = 0
+    for i in s:
+        total = i[0]
+    return BaseRes(data={"total": total, "rows": items})

fast_tmp/admin/schema/zs.py

@@ -0,0 +1,16 @@
+"""
+展示页面需要的model
+"""
+from typing import List
+
+from pydantic import BaseModel
+
+from fast_tmp.admin.schema.forms import Column
+
+
+class ZSTable(BaseModel):
+    type: str = "table"
+    title: str
+    name: str
+    source: str
+    columns: List[Column]