django-cogwheels 0.2

对应用程序开发者来说太好了！

• 一种稳定的、有文档记录的、标准化的方法，用于实现可覆盖的应用程序特定设置。
• 清楚地定义和传达应用程序设置的弃用状态，使您能够在项目生命周期中灵活地重命名、替换或标记要删除的设置。使用旧设置名称定义的用户覆盖对您仍然可用，允许您在折旧期间继续支持它们。
• 当为模型、模块或其他可重写对象设置提供的默认值无效时，会出现有用的、一致的错误消息。
• 缓存的导入以快速访问模型、模块和其他可导入的python对象。
• 与django的测试框架配合得很好（订阅django的 设置已更改的 信号，以便在使用 覆盖设置时清除缓存值）。

1. 使用pip安装软件包：

   pip install django-cogwheels

2. cd 进入项目的根应用程序目录：

   cd your-django-project/yourproject/

3. 使用cogheels django应用程序模板创建 conf 应用程序：

   django-admin.py startapp conf --template=https://github.com/ababic/cogwheels-conf-app/zipball/master

4. 打开project/conf/defaults.py并添加如下设置值：

   # You can add settings for any type of valueMAX_ITEMS_PER_ORDER=5# For settings that refer to models, use a string in the format 'app_name.Model'ORDER_ITEM_MODEL='yourproject.SimpleOrderItem'# For settings that refer to a python module, use an 'import path' string, like so:DISCOUNTS_BACKEND='yourproject.discount_backends.simple'# For settings that refer to classes, methods, or other python objects from a# python module, use an 'object import path' string, like so:ORDER_FORM_CLASS='yourproject.forms.OrderForm'

5. 要在应用程序中使用设置值，只需导入设置助手，并将相关设置作为属性引用，如下所示：

   >>> from yourproject.conf import settings
   >>> settings.MAX_ITEMS_PER_ORDER
   5
   
   >>> settings.ORDER_ITEM_MODEL
   'yourproject.SimpleOrderItem'
   
   >>> settings.DISCOUNTS_BACKEND
   'yourproject.discount_backends.simple'
   
   >>> settings.ORDER_FORM_CLASS
   'yourproject.forms.OrderForm'

6. 对于引用django模型的设置，可以使用settings助手的特殊 model s 属性访问模型类本身，而不仅仅是字符串值。例如：

   >>> from yourproject.conf import settings
   >>> model= settings.models.ORDER_ITEM_MODEL
   yourproject.models.SimpleOrderItem
   
   >>> obj= model(id=1, product='test product', quantity=15)>>> obj.save()>>> print(model.objects.all())<QuerySet [<SimpleOrderItem: SimpleOrderItem object (1)>]>

   在幕后，调用django的django.apps.apps.get廑model（） 方法，并缓存结果，以便快速有效地处理同一模型的重复请求。

7. 对于引用python模块的设置，可以使用设置帮助器的特殊 模块 属性访问模块本身，而不是使用导入路径字符串：

   >>> from yourproject.conf import settings
   >>> module= settings.modules.DISCOUNTS_BACKEND
   <module 'yourproject.discount_backends.simple' from '/system/path/to/your-django-project/yourproject/discount_backends/simple.py'>

   在后台，调用python的importlib.import_module（） 方法，并缓存结果，以便快速有效地处理同一模块的重复请求。

8. 对于引用类、函数或其他可导入python对象的设置，可以使用设置帮助器的特殊 对象 属性访问这些对象，而不是使用导入路径字符串：

   >>> from yourproject.conf import settings
   >>> form_class= settings.objects.ORDER_FORM_CLASS
   yourproject.formsOrderForm
   
   >>> form= form_class(data={})>>> form.is_valid()False

   在后台，调用python的importlib.import_module（） 方法，并缓存结果，以便快速有效地处理对同一对象的重复请求。

9. 应用程序的用户现在可以通过向其项目的django设置模块中添加可选值来覆盖任何默认值。例如：

   # userproject/settings/base.pyYOURAPP_MAX_ITEMS_PER_ORDER=2YOURAPP_ORDER_ITEM_MODEL='userproject_orders.CustomOrderItem'YOURAPP_DISCOUNTS_BACKEND='userproject.discounts.custom_discount_backend'YOURAPP_ORDER_FORM_CLASS='userproject.orders.forms.CustomOrderForm'

10. 您可能会注意到，上面的变量名都以 yourapp_ 作为前缀。此前缀因应用程序而异，具体取决于软件包名称。

    设置的"命名空间"很重要。它不仅可以帮助您的应用程序的用户记住其覆盖设置用于哪个应用程序，还可以帮助防止应用程序之间的设置名称冲突。

    您可以通过执行以下操作来了解应用程序的前缀：

    pip install django-cogwheels

    0

    通过在settings helper类上设置 前缀 属性，您可以将此前缀更改为您喜欢的任何内容，如下所示：

    pip install django-cogwheels

    1

    pip install django-cogwheels

    2

常见问题

pip install django-cogwheels