summaryrefslogtreecommitdiff
path: root/docs/narr/viewconfig.rst
diff options
context:
space:
mode:
authorÉric Araujo <earaujo@caravan.coop>2020-01-07 14:33:31 -0500
committerÉric Araujo <earaujo@caravan.coop>2020-01-07 14:33:31 -0500
commit26d2d87bc2865a431b5eb30552c3eac4108b3a0c (patch)
tree2bcecba6b70e79eb8d732d8eceeb5e3ff1d46ef1 /docs/narr/viewconfig.rst
parent5702c3c3a4357a6071c9ba624a89655209548336 (diff)
downloadpyramid-26d2d87bc2865a431b5eb30552c3eac4108b3a0c.tar.gz
pyramid-26d2d87bc2865a431b5eb30552c3eac4108b3a0c.tar.bz2
pyramid-26d2d87bc2865a431b5eb30552c3eac4108b3a0c.zip
rewrite docs for custom predicates
Diffstat (limited to 'docs/narr/viewconfig.rst')
-rw-r--r--docs/narr/viewconfig.rst18
1 files changed, 11 insertions, 7 deletions
diff --git a/docs/narr/viewconfig.rst b/docs/narr/viewconfig.rst
index 6a49e02a5..eb5233e84 100644
--- a/docs/narr/viewconfig.rst
+++ b/docs/narr/viewconfig.rst
@@ -317,6 +317,8 @@ Non-Predicate Arguments
.. versionadded:: 1.8
+.. _predicate_view_args:
+
Predicate Arguments
+++++++++++++++++++
@@ -506,20 +508,22 @@ configured view.
``custom_predicates``
If ``custom_predicates`` is specified, it must be a sequence of references to
- custom predicate callables. Use custom predicates when no set of predefined
- predicates do what you need. Custom predicates can be combined with
+ custom predicate callables. Custom predicates can be combined with
predefined predicates as necessary. Each custom predicate callable should
accept two arguments, ``context`` and ``request``, and should return either
``True`` or ``False`` after doing arbitrary evaluation of the context
resource and/or the request. If all callables return ``True``, the
associated view callable will be considered viable for a given request.
+ This parameter is kept around for backward compatibility.
- If ``custom_predicates`` is not specified, no custom predicates are used.
+ .. deprecated:: 1.5
+ See section below for new-style custom predicates.
-``predicates``
- Pass a key/value pair here to use a third-party predicate registered via
- :meth:`pyramid.config.Configurator.add_view_predicate`. More than one
- key/value pair can be used at the same time. See
+``**predicates``
+ Extra keyword parameters are used to invoke custom predicates, defined
+ in your app or by third-party packages extending Pyramid and registered via
+ :meth:`pyramid.config.Configurator.add_view_predicate`. Use custom predicates
+ when no set of predefined predicates do what you need. See
:ref:`view_and_route_predicates` for more information about third-party
predicates.