summaryrefslogtreecommitdiff
path: root/docs/api
AgeCommit message (Collapse)Author
2011-05-13- Added documentation for a "multidict" (e.g. the API of ``request.POST``) asChris McDonough
interface API documentation.
2011-04-19renderingChris McDonough
2011-04-19renderingChris McDonough
2011-04-19clarifyChris McDonough
2011-04-18- Deprecated all assignments to ``request.response_*`` attributes such asChris McDonough
``request.response_content_type = 'foo'``. Assignments and mutations of the following request attributes that were considered by the framework for response influence are now deprecated: ``response_content_type``, ``response_headerlist``, ``response_status``, ``response_charset``, and ``response_cache_for``. Instead of assigning these to the request object for detection by the rendering machinery, users should use the appropriate API of the Response object created by accessing ``request.response`` (e.g. ``request.response_content_type = 'abc'`` -> ``request.response.content_type = 'abc'``). - Custom request objects are now required to have a ``response`` attribute (or reified property) if they are meant to be used with renderers. This ``response`` attribute should be an instance of the class ``pyramid.response.Response``. - The JSON and string renderer factories now use ``request.response.content_type`` rather than ``request.response_content_type``. They determine whether they should set the content type of the response by comparing the response's content type against the default (usually ``text/html``); if the content type is not the default, the renderer changes the content type (to ``application/json`` or ``text/plain`` for JSON and string renderers respectively). - Made it possible to assign to and delete ``pyramid.testing.DummyRequest.registry`` (bugfix).
2011-04-13- Add missing docs reference toChris McDonough
``pyramid.config.Configurator.set_view_mapper`` and refer to it within Hooks chapter section named "Using a View Mapper".
2011-04-13- Make ``pyramid.interfaces.IAuthenticationPolicy`` andChris McDonough
``pyramid.interfaces.IAuthorizationPolicy`` public interfaces, and refer to them within the ``pyramid.authentication`` and ``pyramid.authorization`` API docs. - Render the function definitions for each exposed interface in ``pyramid.interfaces``. Closes #167.
2011-03-28branch coverageChris McDonough
2011-03-09leave some breadcrumbs for finding renderered response attribute settingsChris McDonough
2011-02-12Add make_localizer function & docs & testsChristopher Lambacher
2011-01-29extend description of settingsChris McDonough
2011-01-28- Removed API documentation for ``pyramid.testing`` APIs namedChris McDonough
``registerDummySecurityPolicy``, ``registerResources``, ``registerModels``, ``registerEventListener``, ``registerTemplateRenderer``, ``registerDummyRenderer``, ``registerView``, ``registerUtility``, ``registerAdapter``, ``registerSubscriber``, ``registerRoute``, and ``registerSettings``. - Deprecated-since-BFG-1.2 APIs from ``pyramid.testing`` now properly emit deprecation warnings.
2011-01-21- Add docs for ``add_finished_callback``, ``add_response_callback``,Chris McDonough
``route_path``, ``route_url``, and ``static_url`` methods to ``pyramid.request.Request`` API docs.
2011-01-19- Added "Adding Methods to the Configurator via ``add_directive``" section toChris McDonough
Advanced Configuration narrative chapter.
2011-01-18- The ``make_app`` function has been removed from the ``pyramid.router``Chris McDonough
module. It continues life within the ``pyramid_zcml`` package. This leaves the ``pyramid.router`` module without any API functions. - The ``configure_zcml`` setting within the deployment settings (within ``**settings`` passed to a Pyramid ``main`` function) has ceased to have any meaning. - The ``starter_zcml`` paster template has been moved to the ``pyramid_zcml`` package. - The ``bfg2pyramid`` script now converts ZCML include tags that have ``repoze.bfg.includes`` as a package attribute to the value ``pyramid_zcml``. For example, ``<include package="repoze.bfg.includes">`` will be converted to ``<include package="pyramid_zcml">``. - The ``load_zcml`` method of a Configurator has been removed from the Pyramid core. Loading ZCML is now a feature of the ``pyramid_zcml`` package, which can be downloaded from PyPI. Documentation for the package should be available via http://pylonsproject.org, which describes how to get this method back after depending upon ``pyramid_zcml`` as an ``install_requires`` dependency. - The ``pyramid.includes`` subpackage has been removed. ZCML files which use include the package ``pyramid.includes`` (e.g. ``<include package="pyramid.includes">``) now must include the ``pyramid_zcml`` package instead (e.g. ``<include package="pyramid_zcml"/>). - The "Declarative Configuration" narrative chapter has been removed (it was moved to the ``pyramid_zcml`` pakcage). - The add_directive method now accepts an "action_wrap" flag. - Fix some orphaned references. - Remove some docstring references to ZCML directives. - All integration test fixtures have been changed to use imperative configuration rather than ZCML configuration.
2011-01-16Remove configurator.add_handler, handler-related functions and methods from ↵Chris McDonough
pyramid.view, handler ZCML directive. This functionality is to be moved to a "pyramid_handlers" package. Fix add_directive to properly persist directives across configurator creations.
2011-01-16simplify slightlyChris McDonough
2011-01-03- Add a new API ``pyramid.url.current_route_url``, which computes a URL basedChris McDonough
on the "current" route (if any) and its matchdict values.
2011-01-01- The class ``pyramid.authentication.AuthTktCookieHelper`` is now an API.Chris McDonough
This class can be used by third-party authentication policy developers to help in the mechanics of authentication cookie-setting.
2010-12-31- The ``pyramid.interfaces.IAuthenticationPolicy`` interface now specifies anChris McDonough
``unauthenticated_userid`` method. This method supports an important optimization required by people who are using persistent storages which do not support object caching and whom want to create a "user object" as a request attribute. - A new API has been added to the ``pyramid.security`` module named ``unauthenticated_userid``. This API function calls the ``unauthenticated_userid`` method of the effective security policy. - An ``unauthenticated_userid`` method has been added to the dummy authentication policy returned by ``pyramid.config.Configurator.testing_securitypolicy``. It returns the same thing as that the dummy authentication policy's ``authenticated_userid`` method. - Since the ``pyramid.interfaces.IAuthenticationPolicy`` interface now specifies that a policy implementation must implement an ``unauthenticated_userid`` method, all third-party custom authentication policies now must implement this method. It, however, will only be called when the global function named ``pyramid.security.unauthenticated_userid`` is invoked, so if you're not invoking that, you will not notice any issues. - The (non-API) method of all internal authentication policy implementations previously named ``_get_userid`` is now named ``unauthenticated_userid``, promoted to an API method. If you were overriding this method, you'll now need to override it as ``unauthenticated_userid`` instead.
2010-12-29factor deriver from mapperChris McDonough
2010-12-24- Fix API documentation rendering for ``pyramid.view.static``Chris McDonough
2010-12-22- Added CSRF token generation, as described in the narrative chapter entitledChris McDonough
"Preventing Cross-Site Request Forgery Attacks".
2010-12-22change flash API as per email convo with Ben and MikeChris McDonough
2010-12-22- Added flash messaging, as described in the "Flash Messaging" narrativeChris McDonough
documentation chapter.
2010-12-19unnecessary static arglistsChris McDonough
2010-12-18resource/asset normalizationChris McDonough
2010-12-18resource -> assetChris McDonough
2010-12-18resource -> assetChris McDonough
2010-12-09fix docs: pyramid.configuration -> pyramid.configChris McDonough
2010-11-21- Add ``pyramid.interfaces.ITemplateRenderer`` interface to Interfaces APIChris McDonough
chapter (has ``implementation()`` method, required to be used when getting at Chameleon macros).
2010-11-17- Add a ``pyramid.url.route_path`` API, allowing folks to generate relativeChris McDonough
URLs. Calling ``route_path`` is the same as calling ``pyramid.url.route_url`` with the argument ``_app_url`` equal to the empty string. - Add a ``pyramid.request.Request.route_path`` API. This is a convenience method of the request which calls ``pyramid.url.route_url``.
2010-11-11commit forgotten fileChris McDonough
2010-11-10- New API methods for ``pyramid.request.Request``: ``model_url`` andChris McDonough
``route_url``. These are simple passthroughs for their respective functions in ``pyramid.url``. - Documented the ``matchdict`` and ``matched_route`` attributes of the request object in the Request API documentation.
2010-11-10- New API method: ``pyramid.settings.asbool``.Chris McDonough
2010-11-09- All references to Pyramid-the-application were changed from :mod:`pyramid`Chris McDonough
to :app:`Pyramid`. A custom role setting was added to ``docs/conf.py`` to allow for this. (internal)
2010-11-05personality module no longer existsChris McDonough
2010-11-04fix docs for pylons renderer global factoryChris McDonough
2010-11-02Insecure -> UnencryptedChris McDonough
2010-11-02- Remove references to 'WebOb' Response and just call it 'Response', and noteChris McDonough
that it is imported from pyramid. API docs can mention its inheritance from webob (aka "Provide a webob.Response class facade for forward compat").
2010-11-02- New event type: ``pyramid.interfaces.IBeforeRender``. An object of this typeChris McDonough
is sent as an event before a renderer is invoked (but after the application-level renderer globals factory added via ``pyramid.configurator.configuration.set_renderer_globals_factory``, if any, has injected its own keys). Applications may now subscribe to the ``IBeforeRender`` event type in order to introspect the and modify the set of renderer globals before they are passed to a renderer. The event object iself has a dictionary-like interface that can be used for this purpose. For example:: from repoze.events import subscriber from pyramid.interfaces import IRendererGlobalsEvent @subscriber(IRendererGlobalsEvent) def add_global(event): event['mykey'] = 'foo' If a subscriber attempts to add a key that already exist in the renderer globals dictionary, a ``KeyError`` is raised. This limitation is due to the fact that subscribers cannot be ordered relative to each other. The set of keys added to the renderer globals dictionary by all subscribers and app-level globals factories must be unique.
2010-11-01document IRendererInfo in API docsChris McDonough
2010-10-29- New API methods in ``pyramid.session``: ``signed_serialize`` andChris McDonough
``signed_deserialize``.
2010-10-29bfg_view -> view_configChris McDonough
2010-10-29pylons paster templatesChris McDonough
2010-10-28sessioning docsChris McDonough
2010-10-28add sessioning interfaces, configuration API, and a sample implementation ↵Chris McDonough
that uses cookies
2010-10-28merge static view bugfixes/features from bfg trunkChris McDonough
2010-10-26add handler codeChris McDonough
2010-10-26readd make_app (karl depends on it)Chris McDonough