summaryrefslogtreecommitdiff
path: root/docs/api
AgeCommit message (Collapse)Author
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
2012-02-17docs rearranging / fixingChris 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-07add asset descriptor interfaceChris McDonough
2012-01-21Added set_request_property to the docs.Michael Merickel
2012-01-11Renamed the func to callable in the docs.Michael Merickel
2012-01-08gardenMichael Merickel
2011-12-30Documented Request.set_property.Michael Merickel
2011-12-14- Changed scaffolding machinery around a bit to make it easier for people whoChris McDonough
want to have extension scaffolds that can work across Pyramid 1.0.X, 1.1.X, 1.2.X and 1.3.X. See the new "Creating Pyramid Scaffolds" chapter in the narrative documentation for more info. - Added an API docs chapter for ``pyramid.scaffolds``. - Added a narrative docs chapter named "Creating Pyramid Scaffolds". - The ``template_renderer`` method of ``pyramid.scaffolds.PyramidScaffold`` was renamed to ``render_template``. If you were overriding it, you're a bad person, because it wasn't an API before now. But we're nice so we're letting you know.
2011-12-14Flesh out new view_defaults feature and add docs, change notes, and add to ↵Chris McDonough
whatsnew.
2011-12-08provide caller_path support for both asset resolver and dotted name ↵Chris McDonough
resolver, make it the default
2011-12-08- New APIs: ``pyramid.path.AssetResolver`` andChris McDonough
``pyramid.path.DottedNameResolver``. The former can be used to resolve asset specifications, the latter can be used to resolve dotted names to modules or packages.
2011-12-05add whatsnew-1.3; gardenChris McDonough
2011-12-03add a noop introspector (allow introspection to be turned off)Chris McDonough
2011-11-30add tests for introspectable; add more interface docs and expose actioninfoChris McDonough
2011-11-30docs; todo; coverage for IntrospectorChris McDonough
2011-11-28docsChris McDonough
2011-11-27- Added ``setup_logging`` API function to the ``pyramid.paster`` module.Chris McDonough
This function sets up Python logging according to the logging configuration in a PasteDeploy ini file.
2011-11-27add get_appsettings API to pasterChris McDonough
2011-11-17Made pyramid.settings.aslist public.Michael Merickel
2011-11-11alphabetizeChris McDonough
2011-11-11- New ``pyramid.compat`` module and API documentation which provides PythonChris McDonough
2/3 straddling support for Pyramid add-ons and development environments.
2011-09-12explain NO_PERMISSION_REQUIRED constant in API docsDaniel Haaker
2011-08-25Added docs for some missing HTTP status' supported in httpexceptions.Michael Merickel
2011-08-20add static_path function to url and static_path method to requestChris McDonough
2011-08-20- New request methods: ``current_route_url``, ``current_route_path``.Chris McDonough
- New function in ``pyramid.url``: ``current_route_path``.
2011-08-19review and fix configurator docs in random placesChris McDonough
2011-08-18- Pyramid no longer eagerly commits some default configuration statements atChris McDonough
Configurator construction time, which permits values passed in as constructor arguments (e.g. ``authentication_policy`` and ``authorization_policy``) to override the same settings obtained via an "include".
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-12 07:07:07 +0000