Python ORM and Utils
python下的极简orm框架，核心思想，领域对象+仓库
地址：https://github.com/Dreampie/pesto
依赖安装 requirements.txt
pesto-common==0.0.6
pesto-orm==0.0.71、特色
1、自动化的模型结构映射，不需要复杂的创建数据模型和数据库表结构直接的映射信息，只需要一个简单的继承就可以实现属性自动映射
class Example(MysqlBaseModel):
def __init__(self):
super(Example, self).__init__(table_name='example')
#使用
example= Example()
...
example.save() #update delete query 基于领域对象id的增删改查 轻松实现2、领域repository操作数据库
#数据操作对象
class ExampleRepository(MysqlBaseRepository):
def __init__(self):
super(ExampleRepository, self).__init__(Example)
#创建操作对象，表信息直接来源于领域模型
record_repository = ExampleRepository()
example = record_repository.query_by(where='`id` = %s', params=(1,))
#如果你连领域模型都不想使用，完全基于repository操作 请使用 record的操作，不依赖封装结构
record_repository = MysqlRecordRepository(table_name='example')
#直接执行sql，返回的结构为dict，不会封装成class
example = record_repository.query_by(where='`id` = %s', params=(1,))3、超轻量级的配置初始化，只需要在 config.ini 配置对应的数据库信息，自动初始化连接，随时随地的执行sql
; db config 目前只支持mysql，欢迎提交其他数据库的实现
db.database = example
db.raise_on_warnings = True
db.charset = utf8mb4
db.show_sql = True
; profiles config for env
[local]
db.user = root
db.password =
db.host = 127.0.0.1
db.port = 33064、简单实用的日志工具
# 配置 config.ini
log.path = /opt/logs/pesto-orm/pesto-orm.log
log.level = INFO
# 使用简单
logger = LoggerFactory.get_logger('dialect.mysql.domain')
logger.info('打印日志')5、支持数据库事务
#一个注解告别，python下的事务烦恼
@transaction()
def methodX():
pass6、环境隔离的参数配置工具 config.ini, 公共参数放default，定制参数放在各自的环境
[default]
a=x
[dev]
[test]
[prod]
#取值
#Configer.get('param_name')6、等等
2、结构
领域对象：领域模型对应的属性和行为
仓库：批量操作领域对象，或者特殊的一些数据操作逻辑
领域服务：统筹领域模型的行为，或者更复杂的单个模型无法完成的行为
只需要配置数据库相关的参数，通过领域模型，或者仓库即可操作数据，简单易用，业务逻辑复杂可以加入领域服务概念
3、示例
pesto-example(flask + pesto-orm) build in python 3.7
add dependencies in requirements(重要，必须要有，为什么项目的可以迁移好好管理依赖，放在项目root目录):
pesto-orm==0.0.7
mysql-connector-python==8.0.11
Flask==1.0.2
add config in config.ini(重要，如果要使用配置，日志等依赖配置的组件，此文件需和requirements同级目录):
[DEFAULT]
app.key = $root_project
log.path = $root_path/pesto-orm.log
log.level = INFO
; db config 目前只支持mysql，欢迎提交其他数据库的实现
db.database = example
db.raise_on_warnings = True
db.charset = utf8mb4
db.show_sql = True
; profiles config for env
[local]
db.user = root
db.password =
db.host = 127.0.0.1
db.port = 3306
[dev]
[test]
[prod]
run with env(default is local, dev, test, prod)
env=$ENV python ./pesto_example/main.py >> std_out.log 2>&1main 示例example，可以直接执行main方法启动(需先执行数据库的创建，以及配置数据的相关信息)
make pesto_example as SourcesRoot
创建数据库
create database example;
use example;
create table example(
id INT UNSIGNED AUTO_INCREMENT,
title VARCHAR(255) NOT NULL,
created_at DATETIME NOT NULL,
updated_at DATETIME NOT NULL,
deleted_at DATETIME NULL,
PRIMARY KEY(id)
)ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;启动入口
@app.route('/')
def index():
data = {'name': 'pesto-example'}
return jsonify(data)
if __name__ == '__main__':
port = 8080
try:
app.run(host='0.0.0.0', port=port)
except (KeyboardInterrupt, SystemExit):
print('')
logger.info('Program exited.')
except (Exception,):
logger.error('Program exited. error info:\n')
logger.error(traceback.format_exc())
sys.exit(0)model 模型创建，只需要配置对应的表名和主键，领域模型的行为可以扩展到该类
class Example(MysqlBaseModel):
def __init__(self):
super(Example, self).__init__(table_name='example', primary_key='id')repository 依赖于模型，执行批量或者复杂的sql逻辑
class ExampleRepository(MysqlBaseRepository):
def __init__(self):
super(ExampleRepository, self).__init__(Example)router api的路由信息，数据操作方式
app_example = Blueprint('example', __name__, url_prefix='/examples')
example_repository = ExampleRepository()
@app_example.route('', methods=['GET'])
def examples():
# 条件查询
data = example_repository.query_by(where="")
if len(data) <= 0:
jsonify(error="not found any data"), 404
return jsonify(data)
@app_example.route('/<id>', methods=['GET'])
def example(id):
# 条件查询
data = example_repository.query_first_by(where="`id`= %s", params=(id,))
if data is None:
jsonify(error="not found any data"), 404
return jsonify(data)
@app_example.route('', methods=['POST'])
def save():
data = request.get_json()
if data is not None and len(data) > 0:
example = Example()
example.set_attrs(data)
example.created_at = datetime.datetime.now()
example.updated_at = datetime.datetime.now()
# 保存数据
example.save()
return jsonify(example.id)
else:
return jsonify(error="not found any data to save"), 400
@app_example.route('/<id>', methods=['DELETE'])
def delete(id):
result = True
example = Example()
example.id = id
example.deleted_at = datetime.datetime.now()
# 根据id删除数据
example.delete()
return jsonify(result)
@app_example.route('/<id>', methods=['PUT'])
def update(id):
result = True
data = request.get_json()
example = Example()
example.set_attrs(data)
example.id = id
example.updated_at = datetime.datetime.now()
# 根据id更新数据
example.update()
return jsonify(result)4、测试
# 查询全部数据
curl -X GET \
http://localhost:8080/examples
# 添加一条数据
curl -X POST \
http://localhost:8080/examples \
-H 'content-type: application/json' \
-d '{
"title":"第三个测试"
}'
# 根据id查询
curl -X GET \
http://localhost:8080/examples/1
# 根据id 更新数据
curl -X PUT \
http://localhost:8080/examples/1 \
-H 'content-type: application/json' \
-d '{
"title":"这是第一个已改测试"
}'
# 根据id删除数据
curl -X DELETE \
http://localhost:8080/examples/3
上传pypi包
pip install twine
python setup.py sdist bdist_wheel
twine upload --repository-url https://upload.pypi.org/legacy/ dist/*
