summaryrefslogtreecommitdiff
path: root/docs/narr/hooks.rst
AgeCommit message (Collapse)Author
2013-11-16Enhanced the narrative documentation for tweens.Antti Haapala
2013-09-08- The ``renderer_globals_factory`` argument to theChris McDonough
``pyramid.config.Configurator` constructor and its ``setup_registry`` method has been removed. The ``set_renderer_globals_factory`` method of ``pyramid.config.Configurator`` has also been removed. The (internal) ``pyramid.interfaces.IRendererGlobals`` interface was also removed. These arguments, methods and interfaces had been deprecated since 1.1. Use a ``BeforeRender`` event subscriber as documented in the "Hooks" chapter of the Pyramid narrative documentation instead of providing renderer globals values to the configurator.
2013-09-08Update documentation to reflect the dotted python nameBert JW Regeer
2013-09-07- The ``pyramid.events.NewResponse`` event is now sent **after** responseChris McDonough
callbacks are executed. It previously executed before response callbacks were executed. Rationale: it's more useful to be able to inspect the response after response callbacks have done their jobs instead of before. Closes #1116.
2013-08-15prefer the functionish printPhilip Jenvey
2013-04-21docs/narr/hooks.rst: some improvementsTshepang Lekhonkhobe
* consistency fixes: "not found view" --> "Not Found View" * use comparable code for Imperative and Declarative configuration * remove unused import, HTTPForbidden
2013-04-06fix some cross-referencesTshepang Lekhonkhobe
Also, pyramid_zcml is cross-referenced, so add it to intersphinx_mapping dict.
2013-04-05fix some cross-referencesTshepang Lekhonkhobe
2013-04-01Improve phrasingCatalin Iacob
2013-04-01Remove extra wordCatalin Iacob
2013-04-01Consistently link middleware term to the glossaryCatalin Iacob
2013-04-01Fix typo that broke the reference to pyramid.events.NewRequestCatalin Iacob
2013-04-01Remove extra wordCatalin Iacob
2013-03-12Merge pull request #896 from tshepang/consistencyMichael Merickel
consistency fixes
2013-03-09consistencyTshepang Lekhonkhobe
2013-03-09capitalize; add term roleTshepang Lekhonkhobe
2013-03-05update some links and fix othersTshepang Lekhonkhobe
2013-02-23replace awkward explanationTshepang Lekhonkhobe
2013-02-09fix warning block for newer docutils versionsChris McDonough
2013-02-09Merge pull request #824 from kusut/add_request_methodChris McDonough
narrative docs for add_request_method
2013-01-30use the more appropriate directivesTshepang Lekhonkhobe
2013-01-29enhance!kusut
2013-01-29narrative docs for add_request_methodkusut
2013-01-02eliminate other repeated wordsTshepang Lekhonkhobe
2012-11-12Modified the hooks documentation to currently describe how to access the ↵Robert Jackiewicz
context in a forbidden view.
2012-08-25Subscriber predicates:Chris McDonough
- Add ``add_subscriber_predicate`` method to Configurator. - Allow ``add_subscriber`` and ``subscriber`` venusian decorator to accept ``**predicates`` arguments. - Document subscriber predicate feature. - Share more code between view, route, and subscriber related method wrt predicates.
2012-08-06Merge branch 'master' of github.com:Pylons/pyramidChris McDonough
2012-08-06add as-of-version notesChris McDonough
2012-08-06gardenMichael Merickel
2012-08-06add docs for third-party view predicatesChris McDonough
2012-06-17docs: Add view callable example to section on rendering_val.Jeff Cook
2012-06-07Update documentation to clarify purpose of BeforeRender.rendering_val.Jeff Cook
2012-04-12TyposPatricio Paez
2012-03-05add_traverserChris McDonough
2012-03-02Remove some confusion about finished callbacks.Ruslan Spivak
Rework an example code and remove an incorrect statement about request.exception being set when an exception occurs in a view. The reason for the change is issue #454: https://github.com/Pylons/pyramid/issues/454
2012-02-29fix decoratorsChris McDonough
2012-02-26fix instance creationChris McDonough
2012-02-22- New API: ``pyramid.config.Configurator.add_forbidden_view``. This is aChris McDonough
wrapper for ``pyramid.Config.configurator.add_view`` which does the right thing about permissions. It should be preferred over calling ``add_view`` directly with ``context=HTTPForbidden`` as was previously recommended. - New API: ``pyramid.view.forbidden_view_config``. This is a decorator constructor like ``pyramid.view.view_config`` that calls ``pyramid.config.Configurator.add_forbidden_view`` when scanned. It should be preferred over using ``pyramid.view.view_config`` with ``context=HTTPForbidden`` as was previously recommended. - Updated the "Creating a Not Forbidden View" section of the "Hooks" chapter, replacing explanations of registering a view using ``add_view`` or ``view_config`` with ones using ``add_forbidden_view`` or ``forbidden_view_config``. - Updated all tutorials to use ``pyramid.view.forbidden_view_config`` rather than ``pyramid.view.view_config`` with an HTTPForbidden context.
2012-02-22- New API: ``pyramid.config.Configurator.add_notfound_view``. This is aChris McDonough
wrapper for ``pyramid.Config.configurator.add_view`` which provides easy append_slash support. It should be preferred over calling ``add_view`` directly with ``context=HTTPNotFound`` as was previously recommended. - New API: ``pyramid.view.notfound_view_config``. This is a decorator constructor like ``pyramid.view.view_config`` that calls ``pyramid.config.Configurator.add_notfound_view`` when scanned. It should be preferred over using ``pyramid.view.view_config`` with ``context=HTTPNotFound`` as was previously recommended. - The older deprecated ``set_notfound_view`` Configurator method is now an alias for the new ``add_notfound_view`` Configurator method. This has the following impact: the ``context`` sent to views with a ``(context, request)`` call signature registered via the deprecated ``add_notfound_view``/``set_notfound_view`` will now be the HTTPNotFound exception object instead of the actual resource context found. Use ``request.context`` to get the actual resource context. It's also recommended to disuse ``set_notfound_view`` in favor of ``add_notfound_view``, despite the aliasing. - The API documentation for ``pyramid.view.append_slash_notfound_view`` and ``pyramid.view.AppendSlashNotFoundViewFactory`` was removed. These names still exist and are still importable, but they are no longer APIs. Use ``pyramid.config.Configurator.add_notfound_view(append_slash=True)`` or ``pyramid.view.notfound_view_config(append_slash=True)`` to get the same behavior. - The ``set_forbidden_view`` method of the Configurator was removed from the documentation. It has been deprecated since Pyramid 1.1. - The AppendSlashNotFoundViewFactory used request.path to match routes. This was wrong because request.path contains the script name, and this would cause it to fail in circumstances where the script name was not empty. It should have used request.path_info, and now does. - Updated the "Registering a Not Found View" section of the "Hooks" chapter, replacing explanations of registering a view using ``add_view`` or ``view_config`` with ones using ``add_notfound_view`` or ``notfound_view_config``. - Updated the "Redirecting to Slash-Appended Routes" section of the "URL Dispatch" chapter, replacing explanations of registering a view using ``add_view`` or ``view_config`` with ones using ``add_notfound_view`` or ``notfound_view_config``
2012-02-18dont mention arg by nameChris McDonough
2012-02-18minor wording fixesChris McDonough
2012-02-17FeaturesChris McDonough
-------- - Add ``pyramid.config.Configurator.add_resource_url_adapter`` API method. See the Hooks narrative documentation section entitled "Changing How pyramid.request.Request.resource_url Generates a URL" for more information. This is not a new feature, it just provides an API for adding a resource url adapter without needing to use the ZCA API. - A new interface was added: ``pyramid.interfaces.IResourceURL``. An adapter implementing its interface can be used to override resource URL generation when ``request.resource_url`` is called. This interface replaces the now-deprecated ``pyramid.interfaces.IContextURL`` interface. - The dictionary passed to a resource's ``__resource_url__`` method (see "Overriding Resource URL Generation" in the "Resources" chapter) now contains an ``app_url`` key, representing the application URL generated during ``request.resource_url``. It represents a potentially customized URL prefix, containing potentially custom scheme, host and port information passed by the user to ``request.resource_url``. It should be used instead of ``request.application_url`` where necessary. - The ``request.resource_url`` API now accepts these arguments: ``app_url``, ``scheme``, ``host``, and ``port``. The app_url argument can be used to replace the URL prefix wholesale during url generation. The ``scheme``, ``host``, and ``port`` arguments can be used to replace the respective default values of ``request.application_url`` partially. - A new API named ``request.resource_path`` now exists. It works like ``request.resource_url`` but produces a relative URL rather than an absolute one. - The ``request.route_url`` API now accepts these arguments: ``_app_url``, ``_scheme``, ``_host``, and ``_port``. The ``_app_url`` argument can be used to replace the URL prefix wholesale during url generation. The ``_scheme``, ``_host``, and ``_port`` arguments can be used to replace the respective default values of ``request.application_url`` partially. Backwards Incompatibilities --------------------------- - The ``pyramid.interfaces.IContextURL`` interface has been deprecated. People have been instructed to use this to register a resource url adapter in the "Hooks" chapter to use to influence ``request.resource_url`` URL generation for resources found via custom traversers since Pyramid 1.0. The interface still exists and registering such an adapter still works, but this interface will be removed from the software after a few major Pyramid releases. You should replace it with an equivalent ``pyramid.interfaces.IResourceURL`` adapter, registered using the new ``pyramid.config.Configurator.add_resource_url_adapter`` API. A deprecation warning is now emitted when a ``pyramid.interfaces.IContextURL`` adapter is found when ``request.resource_url`` is called. Misc ---- - Change ``set_traverser`` API name to ``add_traverser``. Ref #438.
2012-02-15- Add ``pyramid.config.Configurator.set_traverser`` API method. See theChris McDonough
Hooks narrative documentation section entitled "Changing the Traverser" for more information. This is not a new feature, it just provides an API for adding a traverser without needing to use the ZCA API.
2012-02-15- Replace all mentions of zope.interface.implements withChris McDonough
zope.interface.implementer.
2011-12-16stamp out paste.httpserver usageChris McDonough
2011-12-15fix importChris McDonough
2011-10-06remove all reference to the paster command-line utilityChris McDonough
2011-09-27typoChris McDonough
2011-09-23fixed up all the warning dealing ..note and ..warnmichr
added a hide toc for glossary to prevent warnings
2011-08-20remove tween aliases as a conceptChris McDonough
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-23 23:43:20 +0000