# BaiZhiSimplePyBoot

**Repository Path**: wbz1234569/bai-zhi-simple-py-boot

## Basic Information

- **Project Name**: BaiZhiSimplePyBoot
- **Description**: 柏智的极简Python框架
- **Primary Language**: Python
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2024-06-08
- **Last Updated**: 2024-06-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 柏智极简Python框架

## 模块简介

## 注意事项  
**不要更改config、driver模块中已有的代码**，如无法满足需求，微信联系我。
如果改了，**不要推送 不要推送 不要推送**

### 模块层级
config -> driver -> mapper -> service  
由左到右层级依次提高。
### [config](src%2Fconfig)模块
- [YamlConfig.py](src%2Fconfig%2FYamlConfig.py)  
读取配置文件。
- [Log.py](src%2Fconfig%2FLog.py)  
日志模块。
- [BaiZhiPaprika.py](src%2Fconfig%2FBaiZhiPaprika.py)
集成paprika的所有功能，同时增加repr装饰器函数  
paprika用于以装饰器的方式重写类的一些魔法函数，BaiZhiPaprika增加了对repr的重写。  
### [driver](src%2Fdriver)模块
- [DBDriver.py](src%2Fdriver%2Fimpl%2FDBDriver.py)
数据库驱动的抽象类，定义了数据库驱动的抽象方法，以及少量有实现的公有方法。
    - get_connect  
获取数据库连接.
    - get_cursor  
获取游标.
    - close  
关闭数据库连接，**开发者无需调用**，会在程序结束后自动调用。
    - execute  
最传统的execute方法，执行SQL语句，获取返回值。**不推荐使用！**
    - get_one  
执行SQL，获取单条数据，传入参数为
        - sql SQL语句
        - class_type 返回值的类型
        - params SQL的参数元组
    - get_list  
执行SQL，获取所有数据，传入参数同get_one
- [MySQLDriver.py](src%2Fdriver%2Fimpl%2FMySQLDriver.py)
MySQL数据库驱动的实现。
- [PostGreSQLDriver.py](src%2Fdriver%2Fimpl%2FPostGreSQLDriver.py)
PostGreSQL数据库驱动的实现。
- [DB.py](src%2Fdriver%2FDB.py)
数据库的驱动本身，开发者只需导入db对象就好  
eg: **from driver import db**
### [mapper](src%2Fmapper)模块
该模块用于定义与数据库进行交互的SQL语句。
### [model](src%2Fmodel)模块
该模块用于定义与数据库交互、程序之间互相传递参数的对象。
### [service](src%2Fservice)模块
该模块用于写业务代码
### [Main.py](src%2FMain.py)
该文件用于执行代码，是程序的入口

## 配置文件
[application.yml](resources%2Fapplication.yml)

## 项目启动方式
pip install requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
python main.py #也可以在IDE工具中运行