kotti_settings 0.3

设置

要在您的Kotti网站上激活kotti_settings插件，您需要在Paste Deploy配置中的kotti.configurators设置中添加一个条目。如果您没有kotti.configurators选项，请添加一个。在您的[app:main]（或[app:kotti]，具体取决于您如何设置Fanstatic）部分中的行可能看起来像这样

kotti.configurators = kotti_settings.kotti_configure

该插件为您添加一个新的配置页面，用于保存模块的设置或跨不同模块的设置。它向“网站设置”菜单项添加了一个名为“设置”的新子菜单项。每个设置集合都在一个标签页中展示。它打算使用一个标签页用于一个模块，但如果需要更复杂结构，也可以使用多个标签页。

您可以选择两种模式来设置您的配置。使用“字典模式”，您可以轻松地设置配置。如果您需要更高级的形式，您可以设置自己的模式。

使用字典设置设置选项卡。在此处，您定义了选项卡的名称和标题，以及必需的内容。可选参数包括 success_message、settings 或 schema、schema_factory 和 use_csrf_token。

在字典中定义您的设置

TestSettings = {
'name': 'test_settings',
'title': "Testsettings",
'description': "Some description for my settings",
'success_message': u"Successfully saved test settings.",
'settings': [
    {'type': 'String',
     'name': 'testsetting_1',
     'title': 'Test 1',
     'description': 'a test setting',
     'default': '', },
    {'type': 'Integer',
     'name': 'testsetting_2',
     'title': 'Test 2',
     'description': 'again a test setting',
     'default': 23, }]}

使用模式定义您的设置

class StringSchemaNode(colander.SchemaNode):
    name = 'a_string'
    title = 'hello'
    default = 'hello world'

class RangedIntSchemaNode(colander.SchemaNode):
    name = 'range_int'
    validator = colander.Range(0, 10)
    default = 5
    title = 'Ranged Int'

class TestSchema(colander.MappingSchema):
    string = StringSchemaNode(colander.String())
    ranged_int = RangedIntSchemaNode(colander.Int())

TestSettings = {
    'name': 'test_settings',
    'title': "Testsettings",
    'description': "Some description for my settings",
    'success_message': u"Successfully saved test settings.",
    'schema_factory': TestSchema
}

要将您的配置注册到 kotti_settings 中，请在您的插件中添加设置到填充器。查看 Kotti 文档以获取有关 填充器 的更多信息，以及查看 示例。

在填充器中添加您的设置配置，例如在名为 populate.py 的文件中

def populate():
    from kotti_settings.util import add_settings
    add_settings(TestSettings)

并将其添加到您的配置中

def kotti_configure(settings):
    settings['kotti.populators'] += ' my_addon.populate.populate'

或直接添加到您的 ini 文件中

kotti.populators = my_addon.populate.populate

要将设置返回到您的代码中，您可以使用以下方法

from kotti_settings.util import get_setting

first_test_setting = get_setting('test_setting_1')

from pyramid.events import subscriber
from kotti_settings.events import SettingsAfterSave

@subscriber(SettingsAfterSave)
def do_something_when_settings_saved(event):
    # Check if the settings for this module was saved.
    if not event.module == __package__:
        return
    my_fancy_thing()

from kotti.views.slots import assign_slot
from kotti_settings.config import SlotSchemaNode
from kotti_settings.config import ShowInContextSchemaNode
from kotti_settings.util import add_settings
from kotti_settings.util import get_setting
from kotti_myaddon import _

class MyWidgetSchema(colander.MappingSchema):
    slot = SlotSchemaNode(colander.String())
    show_in_context = ShowInContextSchemaNode(colander.String())

MyAddonSettings = {
    'name': 'myaddon_settings',
    'title': _(u'My Addon Settings'),
    'description': _(u"Settings for my addon"),
    'success_message': _(u"Successfully saved my addon settings."),
    'schema_factory': MyAddonSchema,
}

def populate():
    add_settings(MyAddonSettings)

变更日志