BlueBream How To

Виды по умолчанию для объектов

В BlueBream, вид обозревателя доступен посредством символов @@ перед его именем. Например, если у вас есть зарегистрированный вид с именем testview для контейнера с именем myobject, он доступен следующим образом: myobject/@@testview.

Вид также доступен без использования символов @@, при условии, что контент-объект с тем же именем не существует в рамках данного контейнера. В предыдущем примере, если объекта с именем testview нет в контейнере, то вид доступен через myobject/testview. Но BlueBream рекомендует всегда использовать символы @@ для доступа к видам.

В BlueBream index зарегистрирован как вид для интерфейса zope.container.interfaces.IContainer. Следовательно, если вы попытаетесь получить доступ к контейнеру без указания имени вида - BlueBream постарается отобразить вид зарегистрированный под именем index.

Вы можете изменить имя вида по умолчанию для конкретного типа объектов с помощью директивы browser:defaultView, доступной из zope.publisher. Если имя вида по умолчанию не настроено, и вы пытаетесь получить доступ к объекту не указывая имя вида, то получите ошибку ComponentLookupError со следующим сообщением: Couldn't find default view name. Например, если вы пытаетесь получить доступ к корневой папке следующим образом: http://localhost:8080/, а имя вида по умолчанию не настроено, то ошибка будет следующей:

ComponentLookupError: ("Couldn't find default view name",
<zope.site.folder.Folder object at 0xa3a09ac>,
<zope.publisher.browser.BrowserRequest instance
URL=http://localhost:8080>)

Если вы создали приложение посредством шаблона проекта bluebream, у вас этой ошибки не возникнет, потому что в этом случае вид по умолчанию с именем index уже есть и настроен в конфигурационном файле application.zcml внутри главного пакета.

Если имя по умолчанию настроено, но вида с таким именем не существует, вы получите ошибку NotFound при попытке получить доступ к объекту прямо без указания имени вида. Например, если вид по умолчанию - index, а такой вид не зарегистрирован для корневой папки, то вы получите примерно следующую ошибку:

NotFound: Object: <zope.site.folder.Folder object at 0xac9b9ec>,
name: u'@@index'

Как упоминалось ранее, директива browser:defaultView определена в zope.publisher. Чтобы ее использовать, нужно включить meta.zcml директивой include:

   1 <include package="zope.publisher" file="meta.zcml" />

Например, вы можете указать вид по молчанию для IContainer следующим образом:

   1 <browser:defaultView
   2    name="index"
   3    for="zope.container.interfaces.IContainer"
   4    />

Если index зарегистрирован как имя вида по умолчанию, а вид явно не указан в URL, BlueBream попытается получить вид @@index для контейнеров. Но вы должны иметь вид, зарегистрированный под таким именем для получения к нему доступа, в противном случае будет вызвано исключение NotFound.

Подробнее о регистрации браузерных видов директивой browser:page рассматривается в документации к браузерным видам.

Добавление новой зависимости (пакета)

Вы работаете в вашем экземпляре приложения или разрабатываете свой пакет, и понимаете, что он может быть полезным еще где-нибудь, скажем пакет ldappas. Отредактируйте setup.py и добавьте имя пакета в install_requires:

   1 setup(name='ticketcollector'
   2       ...
   3       install_requires = ['setuptools',
   4                           ...
   5                           'ldappas',
   6                          ],
   7       ...

Теперь наступает время для перестройки приложения:

   1 $ ./bin/buildout

И наконец, не забудьте зарегистрировать новый пакет в etc/site.zcml:

   1 <configure xmlns="http://namespaces.zope.org/zope"
   2   ...
   3   <include package="ldappas" />
   4   ...
   5 </configure>

Если в этом пакете есть новая ZCML директива, вам нужно подключить конфигурационный файл, в котором эта директива зарегистрирована. Принято регистрировать ZCML директивы в пакете meta. Используйте опцию file как показано ниже:

   1 <configure xmlns="http://namespaces.zope.org/zope"
   2   ...
   3   <include package="some.package" file="meta.zcml" />
   4   <include package="ldappas" />
   5   ...
   6 </configure>

Теперь нужно перезапустить приложение:

   1 $ ./bin/paster serve debug.ini

Получение абсолютного URL объекта

BlueBream имеет другой, более ясный подход к обработке URL'ов объектов. Этот рецепт показывает, как получить URL для заданного объекта, и логику действий, которые выполняются за кулисами. Этот HOWTO предполагает, что вы подключили zope.traversing.browser в etc/site.zcml следующим образом:

   1 <include package="zope.traversing.browser" />

Понимание механизма URL

Каждый персистентный объект, хранящийся в ZODB, доступен через виды, которые отвечают за его отображение. URL - это местонахождение, из которого объект доступен через браузер. Например, если пользователь пытается отобразить foo, который находится в bar, то наберет: http://server/foo/bar. Объект вытаскивается публикатором (publisher), который проходится по дереву объектов, начиная с корня. В нашем случае, он переходит на foo, опрашивает его на предмет наличия в нем объекта bar, и так дальше. foo укажет на bar публикатору, потому что его свойство _ _name_ _ содержит значение bar.

Получения URL объекта производится обратным проходом от объекта к корню, с параллельным построением строки с именами всех объектов, по которым проходится публикатор.

Основная разница между более старыми версиями в том, что bar не хранит свой URL.

Получение URL'а объекта

Таким образом, URL'ы всех публикуемых объектов могут быть получены, а общий класс вида AbsoluteURL обеспечивает эту возможность и существует под именем absolute_url.

Например, в ZPT, URL данного объекта можно получить так: my_object/@@absolute_url. В Python коде можно использовать вызов функции zope.traversing.browser.absoluteurl.absoluteURL.

Чтобы попробовать эту функцию, откройте отладочную оболочку:

   1 $ ./bin/paster shell debug.ini

Получить URL объекта можно следующим образом:

   1 >>> from zope.publisher.browser import TestRequest
   2 >>> from zope.traversing.browser.absoluteurl import absoluteURL
   3 >>> request = TestRequest()
   4 >>> absoluteURL(root, request)
   5 'http://127.0.0.1'

В предыдущем примере root - корневая папка.

Динамические поля в формах

Для того, чтобы динамически добавлять поля используя механизмы zope.formlib, нужно избегать наследования от form.EditForm. form.EditForm потребует также настроить адаптер для поля формы. Следующий код показывает, что нужно сделать для вставки еще одного поля в форму.

   1 from zope.formlib import form
   2 from zope.schema import TextLine
   3 
   4 class TestForm(form.PageForm):
   5        my_field_name = 'something'
   6 
   7    def __init__(self, context, request):
   8        super(TestForm, self).__init__(context, request)
   9        self.form_fields = form.Fields(TextLine(__name__=self.my_field_name,
  10                                                title=u"Test Field"))
  11 
  12    def setUpWidgets(self, ignore_request=False):
  13        name = self.name
  14        self.widgets = form.setUpWidgets(
  15                          self.form_fields, self.prefix, self.context, self.request,
  16                          data={self.my_field_name:SOME_VALUE},
  17                          ignore_request=ignore_request)
  18 
  19    @form.action(label=_("Submit"))
  20    def handleSubmitAction(self, action, data):
  21        #do something relevant to you here

Тестирование персистентных объектов

Вы можете создать искусственный модуль для тестирования персистентных объектов с коммитом транзакций, в противном случае получите примерно следующую ошибку:

PicklingError: Can't pickle <class 'TestItem'>: attribute lookup __builtin__.TestItem failed

Этот HOWTO объясняет создание таких модулей для написания тестов. Функциональность для создания таких модулей обеспечивается с помощью zope.testing.module.

Внутри вашего приложения сборки заявок, создайте файл persistent_test.txt следующего формата:

{{{highlight python :doctest:

>>> from ZODB.tests.util import DB >>> import transaction >>> db = DB() >>> conn = db.open() >>> root = conn.root()

>>> from persistent import Persistent

>>> class TestItem(Persistent): ... pass

>>> item = TestItem() >>> root['item'] = item >>> transaction.commit() }}}

Теперь вызовите тест как показано ниже:

   1 $ ./bin/test

Вы должны получить следующую ошибку:

PicklingError: Can't pickle <class 'TestItem'>: attribute lookup __builtin__.TestItem failed

Теперь откройте tests.py и добавьте два ключевых аргумента в функцию z3c.testsetup.register_all_tests с именами setup и teardown. Значения этих ключевых аргументов могут быть zope.testing.module.setUp и zope.testing.module.tearDown соответственно, как показано ниже:

   1 from zope.testing import module
   2 test_suite = z3c.testsetup.register_all_tests('testp2.main', setup=module.setUp, teardown=module.tearDown)

Лучше будет создать свои собственные функции setUp и tearDown, как показано ниже, так как в этом случае их, при необходимости, можно расширить. Вот функции setUp и tearDown с дополнительным кодом:

   1 import z3c.testsetup
   2 from zope.testing import module
   3 
   4 def setUp(test):
   5     module.setUp(test)
   6 
   7 def tearDown(test):
   8     module.tearDown(test)
   9 
  10 test_suite = z3c.testsetup.register_all_tests('testp2.main', setup=setUp, teardown=tearDown)

По умолчанию, искусственный модуль становится main. Если вам необходимо другое имя модуля, можете указать его следующим образом:

   1 module.setUp(test, 'mymodule')
   2 module.tearDown(test, 'mymodule')

Теперь можно импортировать mymodule из тестов (persistent_test.txt). Основываясь на функциональности этого модуля, вот лучший способ создать функции setUp и tearDown:

   1 import z3c.testsetup
   2 from zope.testing import module
   3 
   4 module_name = 'testp2.main.mypersistent'
   5 
   6 def setUp(test):
   7     module.setUp(test, module_name)
   8 
   9 def tearDown(test):
  10     module.tearDown(test, module_name)
  11 
  12 test_suite = z3c.testsetup.register_all_tests('testp2.main', setup=setUp, teardown=tearDown)