django-envconf 0.3.5

快速启动

1. 在settings.py文件的顶部添加“envconf”，如下所示：

fromenvconfimportEnvenv=Env(# Set default values and castingDEBUG=(bool,False))env.read_env()# Tries to read the `.env` file which is next to the `manage.py` script.# It's probably better to give the path to be sure it'll read the correct file.

1. 在项目的根目录下创建一个.env文件

DEBUG=on  # or off / false
# DJANGO_SETTINGS_MODULE=myapp.settings.dev
SECRET_KEY=Tom-Marvolo-Riddle
DATABASE_URL=psql://user:un-gitted-password@127.0.0.1:8458/database
# DATABASE_URL=sqlite:////my-local-sqlite.db  # sqlite, notice the 4 slashes. See below for more cases.
CACHE_URL=memcache://127.0.0.1:11211,127.0.0.1:11212,127.0.0.1:11213
REDIS_URL=rediscache://127.0.0.1:6379:1?client_class=django_redis.client.DefaultClient&password=un-gitted-password

1. 然后从settings.py文件的环境中获取所需的变量：

DEBUG=env('DEBUG')# Defaults to FalseSECRET_KEY=env('SECRET_KEY')# Raises ImproperlyConfigured exception if SECRET_KEY is not setDATABASES={'default':env.db(),# Raises ImproperlyConfigured exception if DATABASE_URL not in os.environ'extra':env.db('SQLITE_URL',default='sqlite:////tmp/my-tmp-sqlite.db')}

安装

通过PYPI

(venv)$ pip install django-envconf

直接来自Git

(venv)$ pip install git+https://github.com/achedeuzot/django-envconf.git
# or
(venv)$ git clone https://github.com/achedeuzot/django-envconf.git &&cd django-envconf
(venv)$ python setup.py install

用法

在设置或配置模块中，首先导入标准解析器或django模式：

# DefaultfromenvconfimportEnvenv=Env()# Schemasfromenvconf.schemas.django110importDjango110Envasenvenv('DEBUG')# defaults to False# Defaults with the following:# DEBUG bool# SECRET_KEY str# DATABASES extracted from DATABASE_URL to dict()

env可以通过两种方式调用：

• 显式键入：env('VAR_NAME', cast=bool)
• 隐式类型（有关支持的类型，请参见下文）：env.TYPE('ANOTHER_VAR')。如果未指定类型，则为默认值 到str

显式投射：

# Environment variable: MAIL_ENABLED=1mail_enabled=env('MAIL_ENABLED',cast=bool)# OR mail_enabled = env.bool('MAIL_ENABLED')assertmail_enabledisTrue

强制转换嵌套类型（列表和dict）：

# Environment variable: FOO=1,2,3foo=env('FOO'),cast=list(int))assertfoo==[1,2,3]

您还可以设置默认值：

# Environment variable MAX_ROWS has not been definedmax_rows=env.int('MAX_ROWS',default=100)assertmax_rows==100

有一些方便的方法： -json（需要常规json字符串） -url（返回一个urlparse.ParseResult对象）

# Environment variable: DATA={"foo":"bar","baz":true}data=env.json('DATA')# data = {#   "foo": "bar",#   "baz": True,# }# Environment variable: SERVICE=ftp://user:password@example.com/some/path?var=foo>>>env.url('SERVICE')ParseResult(scheme='ftp',netloc='user:password@example.com',path='/some/path',params='',query='var=foo',fragment='')

PROXIED_VAL='hello'TEST_VAL='$PROXIED_VAL'environ('TEST_VAL')=='helloenviron('UNKNOWN_VAL',default='$PROXIED_VAL')=='hello'

# Environment variables: MAILGUN_SMTP_LOGIN=foo,# SMTP_LOGIN='$MAILGUN_SMTP_LOGIN'smtp_login=env('SMTP_LOGIN')assertsmtp_login=='foo'# Change of mind# Environment variales: MANDRILL_SMTP_LOGIN=bar# SMTP_LOGIN='$MANDRILL_SMTP_LOGIN'smtp_login=env('SMTP_LOGIN)  # Look ma',nohands!assertsmtp_login=='bar'

测试

克隆repo并运行测试；）

(venv)$ git clone git@github.com/achedeuzot/django-envconf.git
(venv)$ cd django-envconf
(venv)$ python setup.py test

许可证

django envconf是在bsd许可下获得许可的—有关详细信息，请参见许可文件

兼容性

python 2.6、2.7、3.3、3.4、3.5版

django 1.4、1.5、1.6、1.7、1.8、1.9、1.10

学分

• django-environ及其co当然是贡献者和自己的信誉！感谢您的精彩套餐：）

更改日志

0.1.0、0.2.0、0.3.*-2016年9月12日

• fork fromdjango_environ和codebase的更新：删除6个依赖项，更好的oracle支持， 更好的URL解析