config.py

"""
环境配置
可以通过设置APP_CONFIG环境变量，切换到不同的环境
"""
import configparser
import os
from datetime import timedelta

basedir = os.path.abspath(os.path.dirname(__file__))


class Config:
    # Flask参数，用于安全签署会话cookie的密钥，并可用于扩展应用程序的任何其他安全相关需求。它应该是一个长随机字符串
    SECRET_KEY = 'hard to guess string'
    # Flask参数，提供页面服务时，浏览器上文件的缓存时间，如果是None，则浏览器不会缓存页面文件，datetime.timedelta/秒数
    SEND_FILE_MAX_AGE_DEFAULT = timedelta(hours=16)
    # Flask参数，采用session实现用户登录管理时，session的过期时间，datetime.timedelta/秒数
    PERMANENT_SESSION_LIFETIME = timedelta(hours=16)
    # Flask-Login参数，选中保持登录/记住我时，cookie的过期时间，datetime.timedelta/秒数
    REMEMBER_COOKIE_DURATION = timedelta(days=30)

    # 采用token管理用户登录时，token的名字，用于从header中获取对应的token值
    APP_TOKEN_AUTHORIZATION = 'Authorization'
    # 采用token管理用户登录时，token的过期时间
    APP_TOKEN_EXPIRES_IN = int(timedelta(hours=16).total_seconds())

    # APP_UPLOAD_FOLDER = 'uploads'
    APP_UPLOAD_FILE_ALLOWED_EXTENSIONS = {'txt', 'dat', 'xlsx', 'xls', 'csv', 'xml', 'json', 'yaml'}

    # 数据库相关配置，请参考 -http://zhangyiheng.com/blog/articles/py_flaskz_model_init.html
    FLASKZ_DATABASE_URI = None
    FLASKZ_DATABASE_ECHO = False
    FLASKZ_DATABASE_POOL_RECYCLE = int(timedelta(hours=2).total_seconds())  # recycle connections seconds
    FLASKZ_DATABASE_DEBUG = True
    FLASKZ_DATABASE_DEBUG_SLOW_TIME = -1
    FLASKZ_DATABASE_DEBUG_ACCESS_TIMES = -1

    # 系统日志相关配置，请参考 -http://zhangyiheng.com/blog/articles/py_flaskz_api.html
    FLASKZ_LOGGER_FILENAME = None
    FLASKZ_LOGGER_FILEPATH = '_syslog'
    FLASKZ_LOGGER_LEVEL = 'INFO'  # 'DEBUG'/'INFO'/'WARNING'/'WARN'/'ERROR'/'FATAL'/'CRITICAL'
    FLASKZ_LOGGER_FORMAT = '%(asctime)s %(filename)16s[line:%(lineno)-3d] %(levelname)8s: \n%(message)s\n'
    FLASKZ_LOGGER_WHEN = 'midnight'  # 每天midnight，将当日志文件按日期重命名保存，并生成一个新的日志文件
    FLASKZ_LOGGER_BACKUP_COUNT = 90
    FLASKZ_LOGGER_DISABLED = False
    FLASKZ_WZ_LOGGER_DISABLED = True

    # 请求响应相关配置，请参考 -http://zhangyiheng.com/blog/articles/py_flaskz_utils.html#toc-res
    FLASKZ_RES_SUCCESS_STATUS = "success"
    FLASKZ_RES_FAIL_STATUS = "fail"

    # redis相关配置, 按需配置
    REDIS_URL = None
    # websocket配置, 按需配置
    WEBSOCKET_HOST = None  # 如果为None, host=0.0.0.0
    WEBSOCKET_PORT = 3667  # websocket端口号
    REDIS_WEBSOCKET_DEFAULT_CHANNEL = "ws:channel"  # redis websocket订阅的默认channel
    REDIS_WEBSOCKET_MESSAGE_TIMEOUT = 1  # redis websocket消息等待时间

    @staticmethod
    def init_app(app):
        pass


class DevelopmentConfig(Config):
    """
    开发环境相关配置
    """
    SEND_FILE_MAX_AGE_DEFAULT = 0
    # FLASKZ_LOGGER_FILENAME = 'syslog.txt'
    # REDIS_URL = 'redis://localhost'
    FLASKZ_DATABASE_URI = os.environ.get('FLASKZ_DEV_DATABASE_URI') or'sqlite:///./_sqlite/flaskz-admin.db?check_same_thread=False'
    # '/Users/taozh/Codes/PY/flaskz-admin/_sqlite/flaskz-admin.db'


class TestConfig(Config):
    """
    测试环境相关配置
    """
    SEND_FILE_MAX_AGE_DEFAULT = 0  # no cache
    FLASKZ_DATABASE_URI = os.environ.get('FLASKZ_TEST_DATABASE_URI') or 'sqlite:///./_sqlite/flaskz-admin-test.db?check_same_thread=False'


class ProductionConfig(Config):
    """
    产品环境相关配置
    如果不想将一些信息暴露在代码中，可以通过环境变量的方式进行设置
    """
    SECRET_KEY = os.environ.get('APP_SECRET_KEY') or 'hard to guess string'
    FLASKZ_LOGGER_FILENAME = 'syslog.txt'
    FLASKZ_DATABASE_URI = os.environ.get('FLASKZ_PRO_DATABASE_URI') or 'mysql+pymysql://{username}:{password}@{url}:{port}/{db}'


def config_from_file():
    """
    读取配置文件，优先级config.ini>config.py
    """
    if not os.path.isfile('./config.ini'):
        return
    cp = configparser.ConfigParser()
    cp.read('config.ini', encoding='utf-8')

    def _update_from_file(section, config_cls):
        opts = None
        if section == 'DEFAULT':
            opts = cp.defaults()
        elif section in cp:
            opts = cp.options(section)
        if not opts:
            return
        for opt in opts:
            setattr(config_cls, opt.upper(), cp.get(section, opt))

    for item in [('DEFAULT', Config), ('DEVELOPMENT', DevelopmentConfig), ('TEST', TestConfig), ('PRODUCTION', ProductionConfig)]:
        _update_from_file(item[0], item[1])


config_from_file()

config = {
    'development': DevelopmentConfig,
    'test': TestConfig,
    'production': ProductionConfig,

    'default': DevelopmentConfig
}