'''!BlueBream How To'''

<<TableOfContents()>>

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

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

{{{#!wiki note
'''Контейнер'''

любой объект, реализующий интерфейс '''zope.content.interfaces.IContainer'''.
}}}

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

{{{#!wiki note
'''Контент-объект'''

Если интерфейс предоставляет интерфейсный тип '''zope.app.content.interfaces.IContentType''', то все объекты, предоставляющие этот интерфейс считаются контент-объектами.
}}}

В !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>)
}}}

{{{#!wiki note
In order to use any ZCML except few built-ins like configure and include, you include the ZCML where it is defined the directive, conventionally in BlueBream it will be inside meta.zcml for any package. For example, to use defaultView directive, you need to include meta.zcml file inside zope.publisher:

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

Если вы создали приложение посредством шаблона проекта 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''':

{{{#!highlight xml
<include package="zope.publisher" file="meta.zcml" />
}}}

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

{{{#!highlight xml
<browser:defaultView
   name="index"
   for="zope.container.interfaces.IContainer"
   />
}}}

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

Подробнее о регистрации браузерных видов директивой '''browser:page''' рассматривается в [[http://bluebream.zope.org/doc/1.0/manual/browserpage.html#man-browser-page|документации к браузерным видам]].

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

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

{{{#!highlight python
setup(name='ticketcollector'
      ...
      install_requires = ['setuptools',
                          ...
                          'ldappas',
                         ],
      ...
}}}

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

{{{#!highlight bash
$ ./bin/buildout
}}}

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

{{{#!highlight xml
<configure xmlns="http://namespaces.zope.org/zope"
  ...
  <include package="ldappas" />
  ...
</configure>
}}}

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

{{{#!highlight xml
<configure xmlns="http://namespaces.zope.org/zope"
  ...
  <include package="some.package" file="meta.zcml" />
  <include package="ldappas" />
  ...
</configure>
}}}

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

{{{#!highlight bash
$ ./bin/paster serve debug.ini
}}}

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

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

{{{#!highlight xml
<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'''.

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

{{{#!highlight bash
$ ./bin/paster shell debug.ini
}}}

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

{{{#!highlight python
>>> from zope.publisher.browser import TestRequest
>>> from zope.traversing.browser.absoluteurl import absoluteURL
>>> request = TestRequest()
>>> absoluteURL(root, request)
'http://127.0.0.1'
}}}

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

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

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

{{{#!highlight python
from zope.formlib import form
from zope.schema import TextLine

class TestForm(form.PageForm):
       my_field_name = 'something'

   def __init__(self, context, request):
       super(TestForm, self).__init__(context, request)
       self.form_fields = form.Fields(TextLine(__name__=self.my_field_name,
                                               title=u"Test Field"))

   def setUpWidgets(self, ignore_request=False):
       name = self.name
       self.widgets = form.setUpWidgets(
                         self.form_fields, self.prefix, self.context, self.request,
                         data={self.my_field_name:SOME_VALUE},
                         ignore_request=ignore_request)

   @form.action(label=_("Submit"))
   def handleSubmitAction(self, action, data):
       #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()
}}}

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

{{{#!highlight bash
$ ./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''' соответственно, как показано ниже:

{{{#!highlight python
from zope.testing import module
test_suite = z3c.testsetup.register_all_tests('testp2.main', setup=module.setUp, teardown=module.tearDown)
}}}

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

{{{#!highlight python
import z3c.testsetup
from zope.testing import module

def setUp(test):
    module.setUp(test)

def tearDown(test):
    module.tearDown(test)

test_suite = z3c.testsetup.register_all_tests('testp2.main', setup=setUp, teardown=tearDown)
}}}

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

{{{#!highlight python
module.setUp(test, 'mymodule')
module.tearDown(test, 'mymodule')
}}}

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

{{{#!highlight python
import z3c.testsetup
from zope.testing import module

module_name = 'testp2.main.mypersistent'

def setUp(test):
    module.setUp(test, module_name)

def tearDown(test):
    module.tearDown(test, module_name)

test_suite = z3c.testsetup.register_all_tests('testp2.main', setup=setUp, teardown=tearDown)
}}}