学习flask-script模块的使用
1、什么是flask-script
flask-script是flask的一个扩展模块,Flask-Script的作用是可以通过命令行的形式来操作Flask。
2、安装flask-script
pip install flask-script
3、flask-script的使用
例如有这样一种需求:
我们需要通过命令来执行模块中的hello函数,代码如下:
from flask_script import Manager
from Shopping import create_app
app = create_app('develop')
manager = Manager(app)
@manager.command
def hello():
print("您的命令已经成功执行!")
if __name__ == '__main__':
manager.run()
用命令来执行函数:
函数执行成功。
4、小结
通过命令来调用函数或者某些方法方便快捷,一般由管理员来进行操作,可以实现命令添加用户到数据库等一系列操作,使用频率较低。
flask-migrate数据库模型映射
1、flask-migrate功能
用来进行数据库的迁移和映射。
2、安装flask-migrate
pip install flask-migrate
3、flask-migrate的使用
# 通过执行命令创建数据的表
from flask_migrate import Migrate,MigrateCommand
from flask_script import Manager
from Shopping import create_app
from comment.models import db
# 初始化app
app = create_app('develop')
manager = Manager(app)
Migrate(app,db)
manager.add_command('shopping_db',MigrateCommand)
if __name__ == '__main__':
manager.run()
4、在终端执行命令(将模型映射到数据库)
- 初始化一个环境:python db_manage.py db init,会生成一个migrations文件夹和如下文件
- 自动检测模型,生成迁移脚本:python db_manage.py db migrate
- 将迁移脚本映射到数据库中:python db_manage.py db upgrade
- 更多命令:python db_manage.py db --help
依此在终端执行以上前三个命令,第四个命令可以查看更多用法。
第一个init命令只需要执行一次,如果后续还有新模型需要映射到数据库的时候,只需要执行migrate和upgrade命令即可。
项目日志配置
我们项目里,需要在初始化APP的时候,初始化日志;
便于加载APP的时候,顺便也加载日志。
1、为什么要做日志配置
便于回溯工作内容。
例如:我们开发小组的程序在我们休息期间运行产生错误,会返回错误信息(默认输出到控制台),我们无法即使发现并且处理,我们就需要做项目日志配置,便于记录程序运行中出现的问题。
2、日志的配置
# 日志等级默认为DEBUG
LOGGING_LEVEL = 'DEBUG'
# 日志存储相对路径
LOGGING_FILE_DIR = 'logs/'
# 日志大小
LOGGING_FILE_MAX_BYTES = 300*1024*1024
# 日志备份数目为10
LOGGING_FILE_BACKUP = 10
3、设置日志输出格式
import logging
import logging.handlers
from flask import request
import os
class RequestShoppingFormatter(logging.Formatter):
"""
自定义的日志输出格式
"""
def format(self, record):
record.url = request.url # 需要在日志中记录请求地址
record.remote_addr = request.remote_addr # 需要在日志中记录客户端的地址
return super().format(record)
# 创建一个个性化的logger对象
def create_logger(app):
"""
设置日志配置
:param app: Flask中的app对象
:return:
"""
logging_file_dir = app.config['LOGGING_FILE_DIR'] # 日志文件所在的目录
logging_file_max_bytes = app.config['LOGGING_FILE_MAX_BYTES'] # 日志文件最大的大小
logging_file_backup = app.config['LOGGING_FILE_BACKUP'] # 保留备份的日志文件个数
logging_level = app.config['LOGGING_LEVEL'] # 默认的日志级别
# 设置日志的输出格式(针对文件)
request_formatter = RequestShoppingFormatter(
'[%(asctime)s] %(remote_addr)s 请求 %(url)s \t %(levelname)s 在 %(module)s %(lineno)d : %(message)s')
# 检查如果目录不存在,则创建目录
if os.path.isdir(logging_file_dir):
pass
else:
os.mkdir(logging_file_dir) # 如果目录不存在,创建
# 自定义一个目录和日志文件
flask_file_handler = logging.handlers.RotatingFileHandler(filename=os.path.join(logging_file_dir, 'shopping.log'),
maxBytes=logging_file_max_bytes,
backupCount=logging_file_backup)
# 给当前的handler设置格式
flask_file_handler.setFormatter(request_formatter)
# 得到一个logger对象
flask_logger = logging.getLogger('Shopping')
flask_logger.addHandler(flask_file_handler)
flask_logger.setLevel(logging_level)
# 整个项目需要两个handler:文件,控制台
flask_console_handler = logging.StreamHandler()
flask_console_handler.setFormatter(logging.Formatter('[%(asctime)s] %(levelname)s %(module)s %(lineno)d : %('
'message)s'))
# 当项目运行环境是debug,才用控制台输出
if app.debug:
flask_logger.addHandler(flask_console_handler)
4、运行主程序main.py,日志记录会输出到文档中