• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    迪恩网络公众号

trest: T-Rest( T = Tornado ; Rest = Restful)基于Tornado结合asyncio的web框架lib ...

原作者: [db:作者] 来自: 网络 收藏 邀请

T-Rest

  • T = Tornado
  • Rest = Restful

介绍

基于Tornado结合asyncio的web mvc框架

依赖 Tornado SQLAlchemy pycryptodome pytz 等

软件架构

tree -I '*svn|*node_module*|*git|py3|*.pyc|__pycache__|statics'.├── LICENSE├── Pipfile├── README.md├── applications│   ├── common│   │   ├── const.py│   │   ├── models│   │   │   └── *.py│   │   ├── assemblers│   │   │     └── *.py│   │   ├── services│   │   │   └── *.py│   │   └── utils.py│   ├── app1│   │   ├── handlers│   │   │   └── *.py│   │   ├── models│   │   │   └── *.py│   │   ├── modules.py│   │   ├── services│   │   │   └── *.py│   │   ├── assemblers│   │   │     └── *.py│   │   ├── templates│   │   │   └── */*.html│   │   └── utils.py│   └── app2│   └── app3├── configs│   ├── dev.yaml│   └── local.yaml├── datas│   ├── locales│   │   ├── en_US.csv│   │   └── zh_CN.csv│   ├── menu│   │   └── menu0.json│   ├── mysql│   │   └── *.sql│   ├── nginx_vhost.conf│   ├── production_deploy.md│   ├── supervisor_tornado.conf│   └── supervisord.conf├── logs│   └── *.log├── server.py└── tests    └── *_test.py

软件架构说明

  • .env 环境配置文件,只有一个section [sys],一个变量 RUNTIME_ENV
  • configs 应用配置文件
    • configs/local.yaml 本地开发环境相关配置
    • configs/dev.yaml 开发环境相关配置
    • configs/test.yaml 测试环境相关配置
    • configs/product.yaml 生产环境相关配置
  • applications 应用rest api相关代码
    • applications/common/models 公共应用数据模型层
    • applications/common/services 公共应用服务层
    • applications/common/assemblers 公共组装器层
    • applications/common/const.py 公共应用常量
    • applications/common/utils.py 公共应用助手函数
    • applications/app1 独立应用
    • applications/app1/handlers app1用控制器层,有路由器调用,负责接收并且校验参数
    • applications/app1/services app1应用服务层,在控制器里面调用,负责一个业务逻辑
    • applications/app1/models app1用数据模型层,在服务层调用,负责对一个数据库表CURD操作
    • applications/app1/assemblers app1组装器层,在控制器里面调用,负责把服务层数据响应给API
    • applications/app1/templates app1应用视图层,渲染service数据
  • datas 数据
    • datas/locales 多语言数据
    • datas/json JSON数据文件
    • datas/sql SQL数据文件
    • *.* 其他数据文件
  • logs 日志文件
  • statics Web静态资源
  • tests 测试脚本
  • server.py 项目入口文件
  • README.md 项目说明文件
  • Pipfile pipenv配置文件
  • LICENSE 开源许可证
  • .gitignore Git忽略文件

安装教程

把下面一行代码放入Pipfile文件 [packages]下面

trest = {editable = true,git = "https://gitee.com/leeyi/trest.git",ref = "main"}

或者直接

pipenv install -e git+https://gitee.com/leeyi/trest.git@main#egg=trest

或者

pip install git+https://gitee.com/leeyi/trest.git

使用说明

参考 下面Demo项目,

在项目根目录( ROOT_PATH )下面创建 server.py 文件

#!/usr/bin/env python# -*- coding: utf-8 -*-import osimport sysimport resourceresource.setrlimit(resource.RLIMIT_NOFILE, (10240, 9223372036854775807))from tornado.options import defineabs_file = os.path.abspath(sys.argv[0])ROOT_PATH = abs_file[:abs_file.rfind('/')]define('ROOT_PATH', ROOT_PATH)# 把当前目录添加到 sys.path 开头sys.path.insert(0, ROOT_PATH)from trest.webserver import runif __name__ == "__main__":    try:       server = run()    except KeyboardInterrupt:        sys.exit(0)

在 项目根目录( ROOT_PATH ) 下面创建 .env 文件

# RUNTIME_ENV is not one of the local, dev, test, or product# the colon must have Spaces around itRUNTIME_ENV : local

run

pipenv install --skip-lockpipenv shellpython server.py --port=5080python tests/app_demo/server.py --port=5081

f'{ROOT_PATH}/configs/{env}.yaml' demo

like this ./tests/app_demo/configs/dev.yaml

开发约定

Demo

#!/usr/bin/env python# -*- coding: utf-8 -*-"""[description]"""from trest.router import putfrom trest.router import getfrom trest.router import postfrom trest.router import deletefrom trest.handler import Handlerfrom trest.exception import JsonErrorclass DemoHandler(Handler):    @post('demo0')    def add(self):        return self.success(data = ['post', 'demo0'])class Demo1Handler(Handler):    @post('demo1')    def add(self):        return self.success(data = ['post', 'demo1'])class Demo2Handler(Handler):    @get('demo2')    def get_demo2(self):        return self.success(data = ['get', 'demo2', ])    @get('demo2')    def get_demo2(self):        return self.success(data = ['get', 'demo23', ])    @delete('demo3/(?P<id>\d*)')    def del_demo3(self, id):        return self.success(data = ['delete', 'demo3', id])    @delete('demo2/(?P<id>\d*)')    def del_demo2(self, id):        return self.success(data = ['delete', 'demo2', id])
API响应

在任意的地方使用 raise JsonError

from trest.exception import JsonErrorraise JsonError('msg')raise JsonError('msg', 0)raise JsonError('msg', 1, [])raise JsonError('msg', 1, [1,2,3])

避免 master/slave 等术语

OldNew说明
mastermain主要的
slavesubordinate从属的
blacklistdenylist拒绝名单
whitelistallowlist允许名单

参与贡献

  1. Fork 本仓库
  2. 新建 Feat_xxx 分支
  3. 提交代码
  4. 新建 Pull Request

码云特技

  1. 使用 Readme_XXX.md 来支持不同的语言,例如 Readme_en.md, Readme_zh.md
  2. 码云官方博客 blog.gitee.com
  3. 你可以 https://gitee.com/explore 这个地址来了解码云上的优秀开源项目
  4. GVP 全称是码云最有价值开源项目,是码云综合评定出的优秀开源项目
  5. 码云官方提供的使用手册 https://gitee.com/help
  6. 码云封面人物是一档用来展示码云会员风采的栏目 https://gitee.com/gitee-stars/

鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
热门话题
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap