pyams_pagelet package ⊞

PyAMS_pagelet package

PyAMS pagelets management package

pyams_pagelet.includeme(config)[source]

pyams_pagelet features include

pyams_pagelet.metaconfigure

PyAMS_pagelet.metaconfigure module

This module provides handlers for ZCML directives.

pyams_pagelet.metaconfigure.PageletDirective(_context, name, view, context=<InterfaceClass zope.interface.Interface>, permission=None, layer=<InterfaceClass pyramid.interfaces.IRequest>, **kwargs)[source]

Pagelet ZCML directive

pyams_pagelet.metadirectives

PyAMS_paget.metadirectives module

This module provides interface of ZCML directives.

interface pyams_pagelet.metadirectives.IPageletDirective[source]

Pagelet ZCML directive interface

name

The name of the view

Shows up in URLs/paths. For example “foo” or “foo.html”

Implementation:zope.schema.TextLine
Read Only:False
Required:True
Default Value:None
Allowed Type:str
context

The interface or class this view is for

Implementation:zope.configuration.fields.GlobalObject
Read Only:False
Required:False
Default Value:None
layer

The request interface or class this pagelet is for

Defaults to pyramid.interfaces.IRequest

Implementation:zope.configuration.fields.GlobalObject
Read Only:False
Required:False
Default Value:None
view

View class

The view function or class

Implementation:zope.configuration.fields.GlobalObject
Read Only:False
Required:True
Default Value:None
permission

Permission

The permission needed to use the view

Implementation:zope.schema.TextLine
Read Only:False
Required:False
Default Value:None
Allowed Type:str

pyams_pagelet.pagelet

PyAMS_pagelet.pagelet module

This module provides the core pagelet implementation, and a “pagelet_config” decorator which can be use to register pagelets instead of ZCML directives.

class pyams_pagelet.pagelet.Pagelet(context, request)[source]

Bases: object

Content provider with layout support

layout = None
permission = None
render()[source]

See zope.contentprovider.interfaces.IContentProvider

template = None
update()[source]

See zope.contentprovider.interfaces.IContentProvider

class pyams_pagelet.pagelet.PageletRenderer(context, request, pagelet)[source]

Bases: object

Pagelet renderer

render()[source]

See zope.contentprovider.interfaces.IContentProvider

update()[source]

See zope.contentprovider.interfaces.IContentProvider

class pyams_pagelet.pagelet.pagelet_config(**settings)[source]

Bases: object

Function or class decorator used to declare a pagelet

venusian = <module 'venusian' from '/home/docs/checkouts/readthedocs.org/user_builds/pyams/envs/latest/lib/python3.7/site-packages/venusian/__init__.py'>