confucius 1.0.3

快速开始

from confucius import BaseConfig

class Config(BaseConfig)
    HOST = '127.0.0.1'
    PORT : int = 8000

    DEBUG : bool = False

from myapp import Server
from config import Config


server = Server(Config.HOST, Config.PORT)

$ python app.py
- Starting server: 127.0.0.1:8000

$ PORT=80 python app.py
- Starting server: 127.0.0.1:80

$ DEBUG=y python app.py
- Starting debug server: 127.0.0.1:80

类型

BaseConfig子类的任何ANGRY_SNAKE_CASE属性都将被元类拦截，并使用os.getenv在环境中进行检查。

它们的类型将由类中的注解确定，或者回退到str。

方法将自动像property一样行为，具有对self的访问。

可以通过将其添加到__types__字典来覆盖类型转换的处理[如bool所做的那样]

class Config(BaseConfig):
    __types__ = {
        json: lambda v: json.loads(v) if isinstance(v, str) else v,
    }

    LOGGING : json = {'version': 1 ...}

在父Config类上定义的所有类型都将与此字典合并。

继承

类通常从它们的父类继承。如果属性的类型的改变，将引发一个AssertionError。

方法

全大写的方法将被调用，并且可以像往常一样访问self。

class Config(BaseConfig):
   DB_ENGINE = 'postgresql'
   DB_HOST = 'localhost'
   DB_PORT : int = 5432
   DB_USER = 'test_user'
   DB_PASS = 'secret'
   DB_NAME = 'test-db'

   def CONNECTION_STRING(self):
       return f'{self.DB_ENGINE}://{self.DB_USER}:{self.DB_PASS}@{self.DB_HOST}/{self.DB_NAME}'

在Python 3.7中

在Python 3.7中，增加了一个新功能，允许你为模块定义__getattr__（参见PEP 562 <https://pythonlang.cn/dev/peps/pep-0562/>）。

BaseConfig元类提供了一个module_getattr_factory工厂方法来提供一个将查找Config对象的__getattr__。

from confucius import BaseConfig

class Config(BaseConfig):
    DB_HOST = 'localhost'
    DB_PORT = 5432

__getattr__ = Config.module_getattr_factory()

导入此模块后，尝试访问属性将正常解析，如果找不到，将调用__getattr__，就像在对象上一样。