一款web协程框架
Project description
CheeseAPI
介绍
一款协程友好的web框架,它有大部分框架都有的功能,以及它的特点:
-
插件支持,更可塑的事件处理。
-
类Django的项目结构。
-
Websocket支持。
-
支持部分配置项动态设置。
目前项目仍处于开发阶段,未来期望提供的功能:
-
对于请求更完善的处理。
-
更好的架构设计以及更快的算法处理。
-
更多的插件。
-
提供命令,以方便管理项目。
-
自定义的工作目录。
-
更多的配置选项。
安装
目前仅支持linux python3.11,这里也推荐将python升级到3.11。
pip install CheeseAPI
使用
简单的示例
目前只支持在当前工作目录下运行。
创建一个启动入口:
# File path: ./app.py
from CheeseAPI import app, Response
'''
路由装饰器装饰的函数参数是可选的,如果你需要获取request,则:
async def test(request):
...
即可,其他参数都是动态获取的。
'''
@app.route.get('/')
async def test():
return Response('您好,这里是CheeseAPI!')
if __name__ == '__main__':
app.run() # 默认的启动地址:'0.0.0.0',默认的启动端口:5214
运行app.py
,可以看到打印了一些基础信息,当当前代码的最后一行启动时,代表系统已经可以访问:
$ python app.py
(STARTING) 2023-08-24 12:20:56.933161 > The master process 700506 started
(STARTING) 2023-08-24 12:20:56.934117 > Workspace information:
CheeseAPI: /xxx/CheeseAPI/CheeseAPI
Base: /xxx/CheeseAPI
(STARTING) 2023-08-24 12:20:56.934274 > Server information:
Host: 0.0.0.0
Port: 5214
Workers: 1
(STARTING) 2023-08-24 12:20:56.934619 > Local Modules:
CheeseAPI
(LOADED) 2023-08-24 12:20:56.937603 > The local modules are loaded, which takes 0.002867 seconds
(DEBUG) 2023-08-24 12:20:56.938326 > The subprocess 700506 started
(STARTING) 2023-08-24 12:20:56.939158 > The server started on http://0.0.0.0:5214
(STARTING) 2023-08-24 12:20:56.939279 > The server startup takes 0.006139 seconds
使用ctrl + c
或kill <pid>
杀死进程,会打印完剩下的内容:
(DEBUG) 2023-08-24 12:29:19.061431 > The 701056 subprocess stopped
(ENDING) 2023-08-24 12:29:19.062018 > The server runs for a total of 11.326843 seconds
(ENDING) 2023-08-24 12:29:19.062144 > The master process 701056 stopped
项目结构
CheeseAPI采用类Django的结构:
| - User
| - model.py
| - api.py
| - service.py
| - Permission
| - model.py
| - api.py
| - service.py
| - app.py
在项目根目录下的文件夹(不包括隐藏文件夹)内的文件会在项目启动时自动导入。
在CheeseAPI中并没有强制规定文件名与其代码的关联性,但建议的文件命名方式如下:
文件名 | 备注 |
---|---|
model.py | 模型类 |
api.py | api接口 |
service.py | 业务逻辑实现 |
更多...
1. 生命周期
2. App
2.1 Workspace
2.2 Server
2.3 Cors
2.4 Handle
3. Route
4. Request
5. Response
6. Websocket
7. Module
8. Signal
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
CheeseAPI-0.1.7.tar.gz
(16.7 kB
view hashes)
Built Distribution
CheeseAPI-0.1.7-py3-none-any.whl
(20.6 kB
view hashes)
Close
Hashes for CheeseAPI-0.1.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0482012d6fe1a4449905a0153f48d0f36f671d8dbd01e9326359337d7f5f5d6 |
|
MD5 | 02e4ce854ceb24ff0cb5da4f72fb3dd0 |
|
BLAKE2b-256 | 5beb2467d4edf9fd3a6867a89e7868da73560fe4593e8223c1a04f5a8b863e6b |