一、配置管理
应用总是需要一定的配置的。根据应用环境不同,会需要不同的配置。比如开关调试 模式、设置密钥以及其他依赖于环境的东西。
不管你使用何种方式载入配置,都可以使用 Flask
对象的 config
属性来操作配置的值。 Flask 本身就使用这个对象 来保存一些配置,扩展也可以使用这个对象保存配置。同时这也是你保存配置的地方。
二、配置入门
config
实质上是一个字典的子类,可以像字典一样操作:
app = Flask(__name__)
app.config['TESTING'] = True
某些配置值还转移到了 Flask
对象中,可以直接通过 Flask
来操作:
app.testing = True
三、配置的最佳实践
class Config(object):
TESTING = False
class ProductionConfig(Config):
DATABASE_URI = 'mysql://user@localhost/foo'
class DevelopmentConfig(Config):
DATABASE_URI = "sqlite:////tmp/foo.db"
class TestingConfig(Config):
DATABASE_URI = 'sqlite:///:memory:'
TESTING = True
如果要使用这样的方案,那么必须使用 from_object()
:
app.config.from_object('configmodule.ProductionConfig')
注意 from_object()
不会实例化类对象。如果要操作已经实 例化的类,比如读取一个属性,那么在调用 from_object()
之前应当先实例化这个类:
from configmodule import ProductionConfig
app.config.from_object(ProductionConfig())
# Alternatively, import via string:
from werkzeug.utils import import_string
cfg = import_string('configmodule.ProductionConfig')()
app.config.from_object(cfg)
在你的配置类中,实例化配置对象时允许使用 @property
class Config(object):
"""Base config, uses staging database server."""
TESTING = False
DB_SERVER = '192.168.1.56'
@property
def DATABASE_URI(self): # Note: all caps
return f"mysql://user@{self.DB_SERVER}/foo"
class ProductionConfig(Config):
"""Uses production database server."""
DB_SERVER = '192.168.19.32'
class DevelopmentConfig(Config):
DB_SERVER = 'localhost'
class TestingConfig(Config):
DB_SERVER = 'localhost'
DATABASE_URI = 'sqlite:///:memory:'
配置的方法多种多样,由你定度。以下是一些好的建议:
在版本控制中保存一个缺省配置。要么在应用中使用这些缺省配置,要么先导入 缺省配置然后用你自己的配置文件来重载缺省配置。
使用一个环境变量来切换不同的配置。这样就可以在 Python 解释器外进行切换, 而根本不用改动代码,使开发和部署更方便,更快捷。如果你经常在不同的项目 间切换,那么你甚至可以创建代码来激活 virtualenv 并导出开发配置。
在生产应用中使用 fabric 之类的工具,向服务器分别传送代码和配置。更 多细节参见 使用 Fabric 部署 方案。
四、我的运用
config.py:
MYSQL_DATABASE_HOST = '127.0.0.1'
MYSQL_DATABASE_PORT = '3306'
MYSQL_DATABASE_DB = 'test_py_db'
MYSQL_DATABASE_USER = 'root'
MYSQL_DATABASE_PASSWORD = '123456iou'
DB_URI='mysql+pymysql://{}:{}@{}:{}/{}'.format(MYSQL_DATABASE_USER,MYSQL_DATABASE_PASSWORD, MYSQL_DATABASE_HOST, MYSQL_DATABASE_PORT,MYSQL_DATABASE_DB)
# DB_URI='mysql+pymysql://{}:{}@{}/{}?charset=utf8'.format(MYSQL_DATABASE_USER,MYSQL_DATABASE_PASSWORD, MYSQL_DATABASE_HOST, MYSQL_DATABASE_DB)
print(DB_URI)
SQLALCHEMY_DATABASE_URI=DB_URI
SQLALCHEMY_TRACK_MODIFICATIONS = True
# 邮箱配置
MAIL_SERVER = 'smtp.qq.com'
MAIL_USE_TLS = False
MAIL_USE_SSL = True
MAIL_DEBUG = True
MAIL_USERNAME = '1058008204@qq.com'
MAIL_DEFAULT_SENDER = '1058008204@qq.com'
MAIL_PASSWORD = 'pkmjyzfjqozdbfdf'
MAIL_PORT = 465
SECRET_KEY = 'CCJ'
DEBUG = True
app.py:
import config
app = Flask(__name__)
app.config.from_object(config)
考虑到我目前仅有一个环境,所以没有运用到最佳实践的方式去实现,但是真正的项目实战中,强烈推荐最近实践来实现。
参考文章