[Checkins] SVN: z3ext.layout/tags/1.5.2/ release tag
Nikolay Kim
fafhrd at datacom.kz
Wed Oct 15 14:20:10 EDT 2008
Log message for revision 92255:
release tag
Changed:
A z3ext.layout/tags/1.5.2/
D z3ext.layout/tags/1.5.2/CHANGES.txt
A z3ext.layout/tags/1.5.2/CHANGES.txt
U z3ext.layout/tags/1.5.2/setup.py
D z3ext.layout/tags/1.5.2/src/z3ext/layout/pagelet.py
A z3ext.layout/tags/1.5.2/src/z3ext/layout/pagelet.py
D z3ext.layout/tags/1.5.2/src/z3ext/layout/pagelet.txt
A z3ext.layout/tags/1.5.2/src/z3ext/layout/pagelet.txt
-=-
Copied: z3ext.layout/tags/1.5.2 (from rev 92220, z3ext.layout/trunk)
Deleted: z3ext.layout/tags/1.5.2/CHANGES.txt
===================================================================
--- z3ext.layout/trunk/CHANGES.txt 2008-10-15 14:30:59 UTC (rev 92220)
+++ z3ext.layout/tags/1.5.2/CHANGES.txt 2008-10-15 18:20:10 UTC (rev 92255)
@@ -1,133 +0,0 @@
-=======
-CHANGES
-=======
-
-1.5.1 (2008-10-14)
-------------------
-
-- Fixed missing NotFount in @@pagelet
-
-- Log errors in @@pagelet
-
-- Default css styles
-
-
-1.5.0 (2008-10-06)
-------------------
-
-- Added @@pagelet browser view for fast access pagelets
-
-
-1.4.6 (2008-10-03)
-------------------
-
-- Fixed bug with multple nameless pagelet
-
-
-1.4.5 (2008-08-18)
-------------------
-
-- `name` attribute is optional for <z3ext:pagelet/> directive
-
-
-1.4.4 (2008-07-22)
-------------------
-
-- Fix IPagelet adapter for content
-
-
-1.4.3 (2008-05-22)
-------------------
-
-- Added LayoutNotFound exception
-
-
-1.4.2 (2008-05-14)
-------------------
-
-- Remove unused interfaces
-
-- Tests updated
-
-
-1.4.1 (2008-04-23)
-------------------
-
-- Use newer version of z3ext.autoinclude
-
-
-1.4 (2008-03-21)
-----------------
-
-- Added z3ext:pagelet directive
-
-- Code cleanup
-
-- Moved to svn.zope.org
-
-
-1.3.2 (2008-03-06)
-------------------
-
-- Removed context layouts
-
-
-1.3.1 (2008-02-21)
-------------------
-
-- Code cleanup
-
-- Remove code related to zope.formlib
-
-
-1.3.0 (2008-02-20)
-------------------
-
-- Removed code related to z3c.form
-
-
-1.2.1 (2008-02-18)
-------------------
-
-- Added 'redirect' method to IBrowserPagelet, this is usefull
- when we need redirect during 'update' method and we don't
- need render pagelet at all.
-
-- Added adapter to IPagelet for (context, request),
- this adapter gets browser:defaultView for context and if it IPagelet return it
-
-
-1.2.0 (2008-02-13)
-------------------
-
-- Remove all code related to persistent templates
-
-
-1.1.2 (2008-02-12)
-------------------
-
-- Added 'title' and 'description' fields layout directive
-
-- check ILayoutTemplateTAL for ISite
-
-
-1.1.0 (2008-02-08)
-------------------
-
-- Added compatibility with z3c.template layouts
-
-- Added ILayoutTemplateTAL interface, other packages
- can define adapter to this interface and change layout template
- TAL program (layout customization)
-
-
-1.0.1 (2008-02-02)
-------------------
-
-- Added required dependencies
-
-
-1.0.0 (2008-01-15)
-------------------
-
-- Initial release
Copied: z3ext.layout/tags/1.5.2/CHANGES.txt (from rev 92254, z3ext.layout/trunk/CHANGES.txt)
===================================================================
--- z3ext.layout/tags/1.5.2/CHANGES.txt (rev 0)
+++ z3ext.layout/tags/1.5.2/CHANGES.txt 2008-10-15 18:20:10 UTC (rev 92255)
@@ -0,0 +1,139 @@
+=======
+CHANGES
+=======
+
+1.5.2 (2008-10-15)
+------------------
+
+- Render IPagelet adapter for @@pagelet view
+
+
+1.5.1 (2008-10-14)
+------------------
+
+- Fixed missing NotFount in @@pagelet
+
+- Log errors in @@pagelet
+
+- Default css styles
+
+
+1.5.0 (2008-10-06)
+------------------
+
+- Added @@pagelet browser view for fast access pagelets
+
+
+1.4.6 (2008-10-03)
+------------------
+
+- Fixed bug with multple nameless pagelet
+
+
+1.4.5 (2008-08-18)
+------------------
+
+- `name` attribute is optional for <z3ext:pagelet/> directive
+
+
+1.4.4 (2008-07-22)
+------------------
+
+- Fix IPagelet adapter for content
+
+
+1.4.3 (2008-05-22)
+------------------
+
+- Added LayoutNotFound exception
+
+
+1.4.2 (2008-05-14)
+------------------
+
+- Remove unused interfaces
+
+- Tests updated
+
+
+1.4.1 (2008-04-23)
+------------------
+
+- Use newer version of z3ext.autoinclude
+
+
+1.4 (2008-03-21)
+----------------
+
+- Added z3ext:pagelet directive
+
+- Code cleanup
+
+- Moved to svn.zope.org
+
+
+1.3.2 (2008-03-06)
+------------------
+
+- Removed context layouts
+
+
+1.3.1 (2008-02-21)
+------------------
+
+- Code cleanup
+
+- Remove code related to zope.formlib
+
+
+1.3.0 (2008-02-20)
+------------------
+
+- Removed code related to z3c.form
+
+
+1.2.1 (2008-02-18)
+------------------
+
+- Added 'redirect' method to IBrowserPagelet, this is usefull
+ when we need redirect during 'update' method and we don't
+ need render pagelet at all.
+
+- Added adapter to IPagelet for (context, request),
+ this adapter gets browser:defaultView for context and if it IPagelet return it
+
+
+1.2.0 (2008-02-13)
+------------------
+
+- Remove all code related to persistent templates
+
+
+1.1.2 (2008-02-12)
+------------------
+
+- Added 'title' and 'description' fields layout directive
+
+- check ILayoutTemplateTAL for ISite
+
+
+1.1.0 (2008-02-08)
+------------------
+
+- Added compatibility with z3c.template layouts
+
+- Added ILayoutTemplateTAL interface, other packages
+ can define adapter to this interface and change layout template
+ TAL program (layout customization)
+
+
+1.0.1 (2008-02-02)
+------------------
+
+- Added required dependencies
+
+
+1.0.0 (2008-01-15)
+------------------
+
+- Initial release
Modified: z3ext.layout/tags/1.5.2/setup.py
===================================================================
--- z3ext.layout/trunk/setup.py 2008-10-15 14:30:59 UTC (rev 92220)
+++ z3ext.layout/tags/1.5.2/setup.py 2008-10-15 18:20:10 UTC (rev 92255)
@@ -21,7 +21,7 @@
def read(*rnames):
return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
-version='1.5.2dev'
+version='1.5.2'
setup(name='z3ext.layout',
Deleted: z3ext.layout/tags/1.5.2/src/z3ext/layout/pagelet.py
===================================================================
--- z3ext.layout/trunk/src/z3ext/layout/pagelet.py 2008-10-15 14:30:59 UTC (rev 92220)
+++ z3ext.layout/tags/1.5.2/src/z3ext/layout/pagelet.py 2008-10-15 18:20:10 UTC (rev 92255)
@@ -1,140 +0,0 @@
-##############################################################################
-#
-# Copyright (c) 2008 Zope Corporation and Contributors.
-# All Rights Reserved.
-#
-# This software is subject to the provisions of the Zope Public License,
-# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
-# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
-# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
-# FOR A PARTICULAR PURPOSE.
-#
-##############################################################################
-"""
-
-$Id$
-"""
-import logging, sys
-from zope import interface, component
-from zope.component import queryUtility
-from zope.component import queryMultiAdapter
-from zope.publisher.browser import BrowserPage
-from zope.publisher.interfaces import NotFound
-from zope.publisher.interfaces.browser import IBrowserPublisher
-from zope.tales.expressions import SimpleModuleImporter
-from zope.pagetemplate.interfaces import IPageTemplate
-from zope.app.publisher.browser import queryDefaultViewName
-
-from z3ext.layout.interfaces import IPagelet, IPageletType, ILayout
-
-
- at interface.implementer(IPagelet)
- at component.adapter(interface.Interface, interface.Interface)
-def queryPagelet(context, request):
- name = queryDefaultViewName(context, request, 'index.html')
- if name:
- view = queryMultiAdapter((context, request), name=name)
- if IPagelet.providedBy(view):
- return view
-
-
-def queryLayout(view, request, context=None, iface=ILayout, name=''):
- if context is None:
- context = view.context
-
- while context is not None:
- layout = queryMultiAdapter((view, context, request), iface, name)
- if layout is not None:
- return layout
-
- context = getattr(context, '__parent__', None)
-
- return None
-
-
-class BrowserPagelet(BrowserPage):
- interface.implements(IPagelet)
-
- layoutname = u''
-
- index = None
- template = None
-
- def update(self):
- pass
-
- def render(self):
- template = queryMultiAdapter((self, self.request), IPageTemplate)
-
- if template is None:
- template = self.template or self.index
- if template is None:
- raise LookupError("Can't find IPageTemplate for pagelet.")
- return template()
-
- return template(self)
-
- def __call__(self):
- self.update()
-
- if self.isRedirected:
- return u''
-
- layout = queryLayout(self, self.request, name=self.layoutname)
- if layout is None:
- return self.render()
- else:
- return layout()
-
- isRedirected = False
-
- def redirect(self, url=''):
- if url:
- self.request.response.redirect(url)
-
- self.isRedirected = True
-
-
-class PageletPublisher(object):
- interface.implements(IBrowserPublisher)
- component.adapts(interface.Interface, interface.Interface)
-
- def __init__(self, context, request):
- self.context = context
- self.request = request
- self.modules = SimpleModuleImporter()
-
- def publishTraverse(self, request, name):
- try:
- return self[name]
- except KeyError:
- pass
-
- raise NotFound(self.context, name, request)
-
- def __getitem__(self, name):
- if name:
- iface = queryUtility(IPageletType, name)
- if iface is None:
- try:
- iface, iname = name.rsplit('.', 1)
- iface = getattr(self.modules[iface], iname)
- except:
- raise KeyError(name)
- else:
- iface = IPagelet
-
- try:
- view = queryMultiAdapter((self.context, self.request), iface)
- if view is not None:
- view.update()
- return view.render()
- except Exception, err:
- log = logging.getLogger('z3ext.layout')
- log.exception(err)
-
- raise KeyError(name)
-
- def browserDefault(self, request):
- return self.context, ('',)
Copied: z3ext.layout/tags/1.5.2/src/z3ext/layout/pagelet.py (from rev 92254, z3ext.layout/trunk/src/z3ext/layout/pagelet.py)
===================================================================
--- z3ext.layout/tags/1.5.2/src/z3ext/layout/pagelet.py (rev 0)
+++ z3ext.layout/tags/1.5.2/src/z3ext/layout/pagelet.py 2008-10-15 18:20:10 UTC (rev 92255)
@@ -0,0 +1,148 @@
+##############################################################################
+#
+# Copyright (c) 2008 Zope Corporation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""
+
+$Id$
+"""
+import logging, sys
+from zope import interface, component
+from zope.component import queryUtility
+from zope.component import queryMultiAdapter
+from zope.publisher.browser import BrowserPage
+from zope.publisher.interfaces import NotFound
+from zope.publisher.interfaces.browser import IBrowserPublisher
+from zope.tales.expressions import SimpleModuleImporter
+from zope.pagetemplate.interfaces import IPageTemplate
+from zope.app.publisher.browser import queryDefaultViewName
+
+from z3ext.layout.interfaces import IPagelet, IPageletType, ILayout
+
+
+ at interface.implementer(IPagelet)
+ at component.adapter(interface.Interface, interface.Interface)
+def queryPagelet(context, request):
+ name = queryDefaultViewName(context, request, 'index.html')
+ if name:
+ view = queryMultiAdapter((context, request), name=name)
+ if IPagelet.providedBy(view):
+ return view
+
+
+def queryLayout(view, request, context=None, iface=ILayout, name=''):
+ if context is None:
+ context = view.context
+
+ while context is not None:
+ layout = queryMultiAdapter((view, context, request), iface, name)
+ if layout is not None:
+ return layout
+
+ context = getattr(context, '__parent__', None)
+
+ return None
+
+
+class BrowserPagelet(BrowserPage):
+ interface.implements(IPagelet)
+
+ layoutname = u''
+
+ index = None
+ template = None
+
+ def update(self):
+ pass
+
+ def render(self):
+ template = queryMultiAdapter((self, self.request), IPageTemplate)
+
+ if template is None:
+ template = self.template or self.index
+ if template is None:
+ raise LookupError("Can't find IPageTemplate for pagelet.")
+ return template()
+
+ return template(self)
+
+ def __call__(self):
+ self.update()
+
+ if self.isRedirected:
+ return u''
+
+ layout = queryLayout(self, self.request, name=self.layoutname)
+ if layout is None:
+ return self.render()
+ else:
+ return layout()
+
+ isRedirected = False
+
+ def redirect(self, url=''):
+ if url:
+ self.request.response.redirect(url)
+
+ self.isRedirected = True
+
+
+class PageletPublisher(object):
+ interface.implements(IBrowserPublisher)
+ component.adapts(interface.Interface, interface.Interface)
+
+ def __init__(self, context, request):
+ self.context = context
+ self.request = request
+ self.modules = SimpleModuleImporter()
+
+ def publishTraverse(self, request, name):
+ try:
+ return self[name]
+ except KeyError:
+ pass
+
+ raise NotFound(self.context, name, request)
+
+ def __call__(self):
+ try:
+ return self['']
+ except KeyError:
+ pass
+
+ return u''
+
+ def __getitem__(self, name):
+ if name:
+ iface = queryUtility(IPageletType, name)
+ if iface is None:
+ try:
+ iface, iname = name.rsplit('.', 1)
+ iface = getattr(self.modules[iface], iname)
+ except:
+ raise KeyError(name)
+ else:
+ iface = IPagelet
+
+ try:
+ view = queryMultiAdapter((self.context, self.request), iface)
+ if view is not None:
+ view.update()
+ return view.render()
+ except Exception, err:
+ log = logging.getLogger('z3ext.layout')
+ log.exception(err)
+
+ raise KeyError(name)
+
+ def browserDefault(self, request):
+ return self.context, ('',)
Deleted: z3ext.layout/tags/1.5.2/src/z3ext/layout/pagelet.txt
===================================================================
--- z3ext.layout/trunk/src/z3ext/layout/pagelet.txt 2008-10-15 14:30:59 UTC (rev 92220)
+++ z3ext.layout/tags/1.5.2/src/z3ext/layout/pagelet.txt 2008-10-15 18:20:10 UTC (rev 92255)
@@ -1,300 +0,0 @@
-=================
-Pagelet directive
-=================
-
-Show how we can use the pagelet directive. Register the meta configuration for
-the directive.
-
- >>> import os, tempfile
- >>> from zope import interface, component
- >>> from zope.configuration import xmlconfig
- >>> import z3ext.layout
- >>> context = xmlconfig.file('meta.zcml', z3ext.layout)
-
-We need also a custom pagelet class:
-
- >>> from z3ext.layout.pagelet import BrowserPagelet
- >>> class MyPagelet(BrowserPagelet):
- ... """Custom pagelet"""
-
-Register a pagelet within the directive with minimal attributes:
-
- >>> context = xmlconfig.string("""
- ... <configure xmlns:z3ext="http://namespaces.zope.org/z3ext">
- ... <z3ext:pagelet
- ... name="index.html"
- ... class="z3ext.layout.TESTS.MyPagelet"
- ... permission="zope.Public"
- ... />
- ... </configure>
- ... """, context)
-
-Let's get the pagelet
-
- >>> from zope.publisher.browser import TestRequest
- >>> pagelet = component.queryMultiAdapter((object(), TestRequest()),
- ... name='index.html')
-
-and check them:
-
- >>> pagelet
- <z3ext.layout.zcml.PageletClass from <class 'z3ext.layout.TESTS.MyPagelet'> ...>
-
- >>> pagelet.context
- <object object at ...>
-
-Register the pagelet with a different name and more attributes provided from
-the directive. We also use a custom attribute called label here.
-Also we don't use BrowserPagelet as parent class, pagelet directive automaticly
-adds BrowserPagetlet to bases classes. Let's define some more components...
-
- >>> class SecondPagelet(object):
- ... label = u''
-
- >>> import zope.interface
- >>> class IContent(zope.interface.Interface):
- ... """Content interface."""
-
- >>> class Content(object):
- ... zope.interface.implements(IContent)
-
- >>> context = xmlconfig.string("""
- ... <configure xmlns:z3ext="http://namespaces.zope.org/z3ext">
- ... <z3ext:pagelet
- ... name="custom.html"
- ... class="z3ext.layout.TESTS.SecondPagelet"
- ... for="z3ext.layout.TESTS.IContent"
- ... permission="zope.Public"
- ... label="my Label" />
- ... </configure>
- ... """, context)
-
-Get the pagelet for the new content object
-
- >>> import zope.component
- >>> pagelet = zope.component.queryMultiAdapter((Content(), TestRequest()),
- ... name='custom.html')
-
-and check them:
-
- >>> pagelet
- <z3ext.layout.zcml.PageletClass from <class 'z3ext.layout.TESTS.SecondPagelet'> ...>
-
- >>> pagelet.label
- u'my Label'
-
-We also can provide another interface then the IPagelet within the directive.
-Such a interface must be inherited from IPagelet.
-
- >>> class NewPagelet(BrowserPagelet):
- ... """New pagelet"""
-
-Now register the pagelet within a interface.
-
- >>> class INewPagelet(interface.Interface):
- ... """New pagelet interface."""
-
- >>> context = xmlconfig.string("""
- ... <configure xmlns:z3ext="http://namespaces.zope.org/z3ext">
- ... <z3ext:pagelet
- ... name="new.html"
- ... class="z3ext.layout.TESTS.NewPagelet"
- ... permission="zope.Public"
- ... provides="z3ext.layout.TESTS.INewPagelet" />
- ... </configure>
- ... """, context)
-
-And if we get the pagelet, we can see that the object provides the new
-pagelet interface:
-
- >>> pagelet = component.queryMultiAdapter((object(), TestRequest()),
- ... name='new.html')
- >>> pagelet
- <z3ext.layout.zcml.PageletClass from <class 'z3ext.layout.TESTS.NewPagelet'> ...>
-
- >>> INewPagelet.providedBy(pagelet)
- True
-
-We can create pagelet without specific class
-
- >>> context = xmlconfig.string("""
- ... <configure xmlns:z3ext="http://namespaces.zope.org/z3ext">
- ... <z3ext:pagelet
- ... name="noclass.html"
- ... permission="zope.Public" />
- ... </configure>
- ... """, context)
-
- >>> pagelet = component.queryMultiAdapter((object(), TestRequest()),
- ... name='noclass.html')
- >>> pagelet
- <z3ext.layout.zcml.PageletClass from None ...>
-
-
-We can create pagelet with template:
-
- >>> context = xmlconfig.string("""
- ... <configure xmlns:z3ext="http://namespaces.zope.org/z3ext">
- ... <z3ext:pagelet
- ... name="unknown.html"
- ... template="unknown.pt"
- ... permission="zope.Public" />
- ... </configure>
- ... """, context)
- Traceback (most recent call last):
- ...
- ZopeXMLConfigurationError: File "<string>", line 3.2-6.33
- ConfigurationError: ('No such file', ...unknown.pt')
-
- >>> temp_dir = tempfile.mkdtemp()
- >>> template = os.path.join(temp_dir, 'pagelet.pt')
- >>> open(template, 'w').write('''<div>My pagelet</div>''')
-
- >>> context = xmlconfig.string("""
- ... <configure xmlns:z3ext="http://namespaces.zope.org/z3ext">
- ... <z3ext:pagelet
- ... name="template.html"
- ... template="%s"
- ... permission="zope.Public" />
- ... </configure>
- ... """%template, context)
-
- >>> pagelet = component.queryMultiAdapter((object(), TestRequest()),
- ... name='template.html')
- >>> pagelet
- <z3ext.layout.zcml.PageletClass from None ...>
-
- >>> pagelet.template
- <BoundPageTemplateFile of <z3ext.layout.zcml.PageletClass from None ...>>
-
-Pagelet rendering
-
- >>> print pagelet.render()
- <div>My pagelet</div>
- <BLANKLINE>
-
-We should use page template as template for pagelet or we should
-provide IPageTemplate adapter for pagelet
-
- >>> pagelet = component.queryMultiAdapter((object(), TestRequest()),
- ... name='noclass.html')
- >>> pagelet.render()
- Traceback (most recent call last):
- ...
- LookupError: Can't find IPageTemplate for pagelet.
-
- >>> from zope.pagetemplate.interfaces import IPageTemplate
- >>> from zope.app.pagetemplate import ViewPageTemplateFile
- >>> pt = ViewPageTemplateFile(template)
- >>> def getPT(context, request):
- ... return pt
- >>> component.getSiteManager().registerAdapter(
- ... getPT, (pagelet.__class__, interface.Interface), IPageTemplate, '')
-
- >>> print pagelet()
- <div>My pagelet</div>
- <BLANKLINE>
-
-We can redirect during pagelet rendering, in this case render method
-doesn't call.
-
- >>> pagelet = component.queryMultiAdapter((object(), TestRequest()),
- ... name='noclass.html')
- >>> pagelet.redirect('/')
- >>> pagelet.isRedirected
- True
- >>> pagelet()
- u''
-
-We can get default pagelet view for content. First register default view
-
- >>> from zope.component.interfaces import IDefaultViewName
- >>> component.getSiteManager().registerAdapter(
- ... 'index.html', (interface.Interface, interface.Interface),
- ... IDefaultViewName)
-
- >>> view = component.getMultiAdapter(
- ... (object(), TestRequest()), z3ext.layout.interfaces.IPagelet)
-
- >>> view
- <z3ext.layout.zcml.PageletClass from <class 'z3ext.layout.TESTS.MyPagelet'> ...>
-
- >>> view.__name__
- u'index.html'
-
-
-Pagelet without name
-
- >>> class IMyPagelet1(interface.Interface):
- ... pass
-
- >>> class IMyPagelet2(interface.Interface):
- ... pass
-
- >>> template2 = os.path.join(temp_dir, 'pagelet2.pt')
- >>> open(template2, 'w').write('''<div>My pagelet2</div>''')
-
- >>> from z3ext.layout.tests import ITestPagelet
-
- >>> context = xmlconfig.string("""
- ... <configure xmlns:z3ext="http://namespaces.zope.org/z3ext">
- ... <z3ext:pagelet
- ... template="%s"
- ... provides="z3ext.layout.tests.ITestPagelet"
- ... permission="zope.Public" />
- ... <z3ext:pagelet
- ... template="%s"
- ... provides="z3ext.layout.TESTS.IMyPagelet2"
- ... permission="zope.Public" />
- ... <z3ext:pagelet
- ... template="%s"
- ... permission="zope.Public" />
- ... </configure>
- ... """%(template, template2, template2), context)
-
- >>> pagelet = component.queryMultiAdapter(
- ... (object(), TestRequest()), ITestPagelet)
-
- >>> ITestPagelet.providedBy(pagelet)
- True
- >>> pagelet.render()
- u'<div>My pagelet</div>'
-
- >>> request = TestRequest()
- >>> pagelet = component.queryMultiAdapter((object(), request), IMyPagelet2)
- >>> IMyPagelet2.providedBy(pagelet)
- True
- >>> pagelet.render()
- u'<div>My pagelet2</div>'
-
-
-Access nameless pagelet from view
-
- >>> pagelet = component.getMultiAdapter((object(), request), name='pagelet')
-
- >>> print pagelet.publishTraverse(
- ... request, 'test.unknown')
- Traceback (most recent call last):
- ...
- NotFound: Object: ..., name: 'test.unknown'
-
- >>> pagelet.browserDefault(request)
- (..., ('',))
-
-by default IPagelet
-
- >>> print pagelet.publishTraverse(request, '')
- <div>My pagelet2</div>
-
- >>> print pagelet.publishTraverse(
- ... request, 'z3ext.layout.tests.ITestPagelet')
- <div>My pagelet</div>
-
-We can register our marker interface as named utility and use name
-instead of full module path
-
- >>> component.provideUtility(
- ... ITestPagelet, z3ext.layout.interfaces.IPageletType, name='testPageletType')
-
- >>> print pagelet.publishTraverse(request, 'testPageletType')
- <div>My pagelet</div>
Copied: z3ext.layout/tags/1.5.2/src/z3ext/layout/pagelet.txt (from rev 92254, z3ext.layout/trunk/src/z3ext/layout/pagelet.txt)
===================================================================
--- z3ext.layout/tags/1.5.2/src/z3ext/layout/pagelet.txt (rev 0)
+++ z3ext.layout/tags/1.5.2/src/z3ext/layout/pagelet.txt 2008-10-15 18:20:10 UTC (rev 92255)
@@ -0,0 +1,303 @@
+=================
+Pagelet directive
+=================
+
+Show how we can use the pagelet directive. Register the meta configuration for
+the directive.
+
+ >>> import os, tempfile
+ >>> from zope import interface, component
+ >>> from zope.configuration import xmlconfig
+ >>> import z3ext.layout
+ >>> context = xmlconfig.file('meta.zcml', z3ext.layout)
+
+We need also a custom pagelet class:
+
+ >>> from z3ext.layout.pagelet import BrowserPagelet
+ >>> class MyPagelet(BrowserPagelet):
+ ... """Custom pagelet"""
+
+Register a pagelet within the directive with minimal attributes:
+
+ >>> context = xmlconfig.string("""
+ ... <configure xmlns:z3ext="http://namespaces.zope.org/z3ext">
+ ... <z3ext:pagelet
+ ... name="index.html"
+ ... class="z3ext.layout.TESTS.MyPagelet"
+ ... permission="zope.Public"
+ ... />
+ ... </configure>
+ ... """, context)
+
+Let's get the pagelet
+
+ >>> from zope.publisher.browser import TestRequest
+ >>> pagelet = component.queryMultiAdapter((object(), TestRequest()),
+ ... name='index.html')
+
+and check them:
+
+ >>> pagelet
+ <z3ext.layout.zcml.PageletClass from <class 'z3ext.layout.TESTS.MyPagelet'> ...>
+
+ >>> pagelet.context
+ <object object at ...>
+
+Register the pagelet with a different name and more attributes provided from
+the directive. We also use a custom attribute called label here.
+Also we don't use BrowserPagelet as parent class, pagelet directive automaticly
+adds BrowserPagetlet to bases classes. Let's define some more components...
+
+ >>> class SecondPagelet(object):
+ ... label = u''
+
+ >>> import zope.interface
+ >>> class IContent(zope.interface.Interface):
+ ... """Content interface."""
+
+ >>> class Content(object):
+ ... zope.interface.implements(IContent)
+
+ >>> context = xmlconfig.string("""
+ ... <configure xmlns:z3ext="http://namespaces.zope.org/z3ext">
+ ... <z3ext:pagelet
+ ... name="custom.html"
+ ... class="z3ext.layout.TESTS.SecondPagelet"
+ ... for="z3ext.layout.TESTS.IContent"
+ ... permission="zope.Public"
+ ... label="my Label" />
+ ... </configure>
+ ... """, context)
+
+Get the pagelet for the new content object
+
+ >>> import zope.component
+ >>> pagelet = zope.component.queryMultiAdapter((Content(), TestRequest()),
+ ... name='custom.html')
+
+and check them:
+
+ >>> pagelet
+ <z3ext.layout.zcml.PageletClass from <class 'z3ext.layout.TESTS.SecondPagelet'> ...>
+
+ >>> pagelet.label
+ u'my Label'
+
+We also can provide another interface then the IPagelet within the directive.
+Such a interface must be inherited from IPagelet.
+
+ >>> class NewPagelet(BrowserPagelet):
+ ... """New pagelet"""
+
+Now register the pagelet within a interface.
+
+ >>> class INewPagelet(interface.Interface):
+ ... """New pagelet interface."""
+
+ >>> context = xmlconfig.string("""
+ ... <configure xmlns:z3ext="http://namespaces.zope.org/z3ext">
+ ... <z3ext:pagelet
+ ... name="new.html"
+ ... class="z3ext.layout.TESTS.NewPagelet"
+ ... permission="zope.Public"
+ ... provides="z3ext.layout.TESTS.INewPagelet" />
+ ... </configure>
+ ... """, context)
+
+And if we get the pagelet, we can see that the object provides the new
+pagelet interface:
+
+ >>> pagelet = component.queryMultiAdapter((object(), TestRequest()),
+ ... name='new.html')
+ >>> pagelet
+ <z3ext.layout.zcml.PageletClass from <class 'z3ext.layout.TESTS.NewPagelet'> ...>
+
+ >>> INewPagelet.providedBy(pagelet)
+ True
+
+We can create pagelet without specific class
+
+ >>> context = xmlconfig.string("""
+ ... <configure xmlns:z3ext="http://namespaces.zope.org/z3ext">
+ ... <z3ext:pagelet
+ ... name="noclass.html"
+ ... permission="zope.Public" />
+ ... </configure>
+ ... """, context)
+
+ >>> pagelet = component.queryMultiAdapter((object(), TestRequest()),
+ ... name='noclass.html')
+ >>> pagelet
+ <z3ext.layout.zcml.PageletClass from None ...>
+
+
+We can create pagelet with template:
+
+ >>> context = xmlconfig.string("""
+ ... <configure xmlns:z3ext="http://namespaces.zope.org/z3ext">
+ ... <z3ext:pagelet
+ ... name="unknown.html"
+ ... template="unknown.pt"
+ ... permission="zope.Public" />
+ ... </configure>
+ ... """, context)
+ Traceback (most recent call last):
+ ...
+ ZopeXMLConfigurationError: File "<string>", line 3.2-6.33
+ ConfigurationError: ('No such file', ...unknown.pt')
+
+ >>> temp_dir = tempfile.mkdtemp()
+ >>> template = os.path.join(temp_dir, 'pagelet.pt')
+ >>> open(template, 'w').write('''<div>My pagelet</div>''')
+
+ >>> context = xmlconfig.string("""
+ ... <configure xmlns:z3ext="http://namespaces.zope.org/z3ext">
+ ... <z3ext:pagelet
+ ... name="template.html"
+ ... template="%s"
+ ... permission="zope.Public" />
+ ... </configure>
+ ... """%template, context)
+
+ >>> pagelet = component.queryMultiAdapter((object(), TestRequest()),
+ ... name='template.html')
+ >>> pagelet
+ <z3ext.layout.zcml.PageletClass from None ...>
+
+ >>> pagelet.template
+ <BoundPageTemplateFile of <z3ext.layout.zcml.PageletClass from None ...>>
+
+Pagelet rendering
+
+ >>> print pagelet.render()
+ <div>My pagelet</div>
+ <BLANKLINE>
+
+We should use page template as template for pagelet or we should
+provide IPageTemplate adapter for pagelet
+
+ >>> pagelet = component.queryMultiAdapter((object(), TestRequest()),
+ ... name='noclass.html')
+ >>> pagelet.render()
+ Traceback (most recent call last):
+ ...
+ LookupError: Can't find IPageTemplate for pagelet.
+
+ >>> from zope.pagetemplate.interfaces import IPageTemplate
+ >>> from zope.app.pagetemplate import ViewPageTemplateFile
+ >>> pt = ViewPageTemplateFile(template)
+ >>> def getPT(context, request):
+ ... return pt
+ >>> component.getSiteManager().registerAdapter(
+ ... getPT, (pagelet.__class__, interface.Interface), IPageTemplate, '')
+
+ >>> print pagelet()
+ <div>My pagelet</div>
+ <BLANKLINE>
+
+We can redirect during pagelet rendering, in this case render method
+doesn't call.
+
+ >>> pagelet = component.queryMultiAdapter((object(), TestRequest()),
+ ... name='noclass.html')
+ >>> pagelet.redirect('/')
+ >>> pagelet.isRedirected
+ True
+ >>> pagelet()
+ u''
+
+We can get default pagelet view for content. First register default view
+
+ >>> from zope.component.interfaces import IDefaultViewName
+ >>> component.getSiteManager().registerAdapter(
+ ... 'index.html', (interface.Interface, interface.Interface),
+ ... IDefaultViewName)
+
+ >>> view = component.getMultiAdapter(
+ ... (object(), TestRequest()), z3ext.layout.interfaces.IPagelet)
+
+ >>> view
+ <z3ext.layout.zcml.PageletClass from <class 'z3ext.layout.TESTS.MyPagelet'> ...>
+
+ >>> view.__name__
+ u'index.html'
+
+
+Pagelet without name
+
+ >>> class IMyPagelet1(interface.Interface):
+ ... pass
+
+ >>> class IMyPagelet2(interface.Interface):
+ ... pass
+
+ >>> template2 = os.path.join(temp_dir, 'pagelet2.pt')
+ >>> open(template2, 'w').write('''<div>My pagelet2</div>''')
+
+ >>> from z3ext.layout.tests import ITestPagelet
+
+ >>> context = xmlconfig.string("""
+ ... <configure xmlns:z3ext="http://namespaces.zope.org/z3ext">
+ ... <z3ext:pagelet
+ ... template="%s"
+ ... provides="z3ext.layout.tests.ITestPagelet"
+ ... permission="zope.Public" />
+ ... <z3ext:pagelet
+ ... template="%s"
+ ... provides="z3ext.layout.TESTS.IMyPagelet2"
+ ... permission="zope.Public" />
+ ... <z3ext:pagelet
+ ... template="%s"
+ ... permission="zope.Public" />
+ ... </configure>
+ ... """%(template, template2, template2), context)
+
+ >>> pagelet = component.queryMultiAdapter(
+ ... (object(), TestRequest()), ITestPagelet)
+
+ >>> ITestPagelet.providedBy(pagelet)
+ True
+ >>> pagelet.render()
+ u'<div>My pagelet</div>'
+
+ >>> request = TestRequest()
+ >>> pagelet = component.queryMultiAdapter((object(), request), IMyPagelet2)
+ >>> IMyPagelet2.providedBy(pagelet)
+ True
+ >>> pagelet.render()
+ u'<div>My pagelet2</div>'
+
+
+Access nameless pagelet from view
+
+ >>> pagelet = component.getMultiAdapter((object(), request), name='pagelet')
+
+ >>> print pagelet.publishTraverse(
+ ... request, 'test.unknown')
+ Traceback (most recent call last):
+ ...
+ NotFound: Object: ..., name: 'test.unknown'
+
+ >>> pagelet.browserDefault(request)
+ (..., ('',))
+
+by default IPagelet
+
+ >>> print pagelet()
+ <div>My pagelet2</div>
+
+ >>> print pagelet.publishTraverse(request, '')
+ <div>My pagelet2</div>
+
+ >>> print pagelet.publishTraverse(
+ ... request, 'z3ext.layout.tests.ITestPagelet')
+ <div>My pagelet</div>
+
+We can register our marker interface as named utility and use name
+instead of full module path
+
+ >>> component.provideUtility(
+ ... ITestPagelet, z3ext.layout.interfaces.IPageletType, name='testPageletType')
+
+ >>> print pagelet.publishTraverse(request, 'testPageletType')
+ <div>My pagelet</div>
More information about the Checkins
mailing list