From 0b0e74764fa0f2a3d6daa8f8ce70112419ea6981 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 7 Jan 2011 22:53:05 -0500 Subject: - Allow ``decorator`` and ``mapper`` arguments to view ZCML directive. - Document ``decorator`` and ``mapper`` arguments in various places. --- docs/narr/views.rst | 16 ++++++++++++++++ docs/zcml/view.rst | 14 ++++++++++++++ 2 files changed, 30 insertions(+) (limited to 'docs') diff --git a/docs/narr/views.rst b/docs/narr/views.rst index 81f3e644f..813c54bee 100644 --- a/docs/narr/views.rst +++ b/docs/narr/views.rst @@ -658,6 +658,22 @@ Non-Predicate Arguments If ``wrapper`` is not supplied, no wrapper view is used. +``decorator`` + A :term:`dotted Python name` to function (or the function itself) which + will be used to decorate the registered :term:`view callable`. The + decorator function will be called with the view callable as a single + argument. The view callable it is passed will accept ``(context, + request)``. The decorator must return a replacement view callable which + also accepts ``(context, request)``. + +``mapper`` + A Python object or :term:`dotted Python name` which refers to a :term:`view + mapper`, or ``None``. By default it is ``None``, which indicates that the + view should use the default view mapper. This plug-point is useful for + Pyramid extension developers, but it's not very useful for 'civilians' who + are just developing stock Pyramid applications. Pay no attention to the man + behind the curtain. + Predicate Arguments +++++++++++++++++++ diff --git a/docs/zcml/view.rst b/docs/zcml/view.rst index b4fabdc2c..ba5c7bf23 100644 --- a/docs/zcml/view.rst +++ b/docs/zcml/view.rst @@ -213,6 +213,20 @@ Predicate Attributes associated view callable will be considered viable for a given request. +``decorator`` + A :term:`dotted Python name` to a function that will be used to decorate + the registered :term:`view callable`. The decorator function will be + called with the view callable as a single argument. The view callable it + is passed will accept ``(context, request)``. The decorator must return a + replacement view callable which also accepts ``(context, request)``. + +``mapper`` + A :term:`dotted Python name` which refers to a :term:`view mapper`, or + ``None``. By default it is ``None``, which indicates that the view should + use the default view mapper. This plug-point is useful for Pyramid + extension developers, but it's not very useful for 'civilians' who are just + developing stock Pyramid applications. + Examples ~~~~~~~~ -- cgit v1.2.3