summaryrefslogtreecommitdiff
path: root/docs/api
AgeCommit message (Collapse)Author
2013-04-07fix some cross-referencesTshepang Lekhonkhobe
2013-03-14Added an options argument to pyramid.paste.get_appsettings, just like ↵Georges Dubus
get_app, that can be used to get the settings when interpolation is used in the config file.
2013-02-09Merge pull request #836 from davidjb/public-predicate-mismatchChris McDonough
Document PredicateMismatch for exception contexts
2013-02-09grammarTshepang Lekhonkhobe
2013-01-31Document PredicateMismatch for exception contextsDavid\ Beitey
2013-01-30use the more appropriate directivesTshepang Lekhonkhobe
2013-01-29Merge pull request #815 from tshepang/tempTres Seaver
some pyramid.config API documentation improvements
2013-01-29replace 'note' with the more correct 'versionadded' directiveTshepang Lekhonkhobe
2013-01-23pyramid.config: take advantage of some Sphinx directivesTshepang Lekhonkhobe
* versionadded * versionchanged * deprecated
2013-01-15another grammar fixTshepang Lekhonkhobe
2013-01-07redundant statement: the links preceeding the statement target the info ↵Tshepang Lekhonkhobe
referred to
2013-01-02eliminate other repeated wordsTshepang Lekhonkhobe
2013-01-01eliminate repeated "the" wordsTshepang Lekhonkhobe
2013-01-01Small fix for RST misfire.Paul Everitt
2012-11-20coverageChris McDonough
2012-11-04merged SHA512AuthTktAuthenticationPolicy into AuthTktAuthenticationPolicyMichael Merickel
AuthTktAuthenticationPolicy now accepts a hashalg parameter and is no longer deprecated. Docs recommend overriding hashalg and using 'sha512'.
2012-11-04fix docs, upgrade tutorials, add change note, deprecate using ↵Chris McDonough
zope.deprecation instead of a warning, make hashalg arg a kwarg in certain cases in case someone (maybe me) is using nonapi function imports from authentication
2012-11-04Merge branch 'feature.sha512_auth' of git://github.com/iElectric/pyramid ↵Chris McDonough
into iElectric-feature.sha512_auth
2012-10-30updated authentication policy api documentationMichael Merickel
2012-10-14Add BasicAuthAuthenticationPolicy to Sphinx documentation. Move ↵Chris Rossi
Repoze1AuthenticationPolicy lower in the list.
2012-09-23Add SHA512AuthTktAuthenticationPolicy and deprecate AuthTktAuthenticationPolicyDomen Kožar
2012-09-19add check_csrf convenience functionChris McDonough
2012-09-16make use_tweens=False the defaultChris McDonough
2012-09-16make use_tweens=True the default, add some more testsChris McDonough
2012-09-16rename subrequest to invoke_subrequestChris McDonough
2012-09-16docs and testChris McDonough
2012-09-16add docsChris McDonough
2012-09-15merge jinty's testConfig codeChris McDonough
2012-09-15add pyramid.decorator.reify as an API. Closes #682Chris McDonough
2012-09-09rename set_request_method to add_request_method. closes #683Chris McDonough
2012-09-09- The ``pyramid.settings.get_settings()`` API was removed. It had beenChris McDonough
printing a deprecation warning since Pyramid 1.0. If your code depended on this API, use ``pyramid.threadlocal.get_current_registry().settings`` instead or use the ``settings`` attribute of the registry available from the request (``request.registry.settings``).
2012-09-09remove docs for chameleon_zpt and chameleon_text (gone)Chris McDonough
2012-08-16readd set_request_property to docs (just so when people run across it in ↵Chris McDonough
in-the-wild code they're not totally confused); we'll remove it later
2012-08-16docs-deprecated set_request_propertyMichael Merickel
2012-08-15- An ``add_permission`` directive method was added to the Configurator. ThisChris McDonough
directive registers a free-standing permission introspectable into the Pyramid introspection system. Frameworks built atop Pyramid can thus use the the ``permissions`` introspectable category data to build a comprehensive list of permissions supported by a running system. Before this method was added, permissions were already registered in this introspectable category as a side effect of naming them in an ``add_view`` call, this method just makes it possible to arrange for a permission to be put into the ``permissions`` introspectable category without naming it along with an associated view. Here's an example of usage of ``add_permission``:: config = Configurator() config.add_permission('view')
2012-08-06move stuff from config.util to registry so it can be a set of API (which are ↵Chris McDonough
now documented), resolve deferred discriminators in introspectable.register so that a directive can depend on a deferred discriminator, put head-adding code in predicate instead of in add_view itself
2012-08-06add docs for third-party view predicatesChris McDonough
2012-06-16A context manager for test setupBrian Sutherland
2012-04-16docs for json defaultsMichael Merickel
2012-03-28JSON-API rework and Object.__json__ supportWayne Witzel III
2012-03-28intermediate commitMichael Merickel
2012-02-24docs-deprecate tmpl_contextChris McDonough
2012-02-24More trivial typosPaul Winkler
2012-02-22- New APIs: ``pyramid.response.FileResponse`` andChris McDonough
``pyramid.response.FileIter``, for usage in views that must serve files "manually".
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-20recategorize a couple of methodsChris McDonough
2012-02-20remove untruthChris McDonough
2012-02-20FeaturesChris McDonough
-------- - Add an ``introspection`` boolean to the Configurator constructor. If this is ``True``, actions registered using the Configurator will be registered with the introspector. If it is ``False``, they won't. The default is ``True``. Setting it to ``False`` during action processing will prevent introspection for any following registration statements, and setting it to ``True`` will start them up again. This addition is to service a requirement that the debug toolbar's own views and methods not show up in the introspector. Backwards Incompatibilities --------------------------- - Remove ``pyramid.config.Configurator.with_context`` class method. It was never an API, it is only used by ``pyramid_zcml`` and its functionality has been moved to that package's latest release. This means that you'll need to use the latest release of ``pyramid_zcml`` with this release of Pyramid. - The ``introspector`` argument to the ``pyramid.config.Configurator`` constructor API has been removed. It has been replaced by the boolean ``introspection`` flag. - The ``pyramid.registry.noop_introspector`` API object has been removed.
2012-02-18categorized configurator methodsChris McDonough
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-17 17:34:17 +0000