This article explains the new features in Pyramid version 1.4 as compared to its predecessor, Pyramid 1.3. It also documents backwards incompatibilities between the two versions and deprecations added to Pyramid 1.4, as well as software dependency changes and notable documentation additions.
The major feature additions in Pyramid 1.4 follow.
Third-party custom view, route, and subscriber predicates can now be added for use by view authors via pyramid.config.Configurator.add_view_predicate(), pyramid.config.Configurator.add_route_predicate() and pyramid.config.Configurator.add_subscriber_predicate(). So, for example, doing this:
Might allow a view author to do this in an application that configured that predicate:
Similar features exist for pyramid.config.Configurator.add_route(), and pyramid.config.Configurator.add_subscriber(). See Adding A Third Party View, Route, or Subscriber Predicate for more information.
pyramid.authentication.AuthTktAuthenticationPolicy has been updated to support newer hashing algorithms such as sha512. Existing applications should consider updating if possible for improved security over the default md5 hashing.
pyramid.config.Configurator.add_directive() now accepts arbitrary callables like partials or objects implementing __call__ which don’t have __name__ and __doc__ attributes. See https://github.com/Pylons/pyramid/issues/621 and https://github.com/Pylons/pyramid/pull/647.
As of this release, the request_method view/route predicate, when used, will also imply that HEAD is implied when you use GET. For example, using @view_config(request_method='GET') is equivalent to using @view_config(request_method=('GET', 'HEAD')). Using @view_config(request_method=('GET', 'POST') is equivalent to using @view_config(request_method=('GET', 'HEAD', 'POST'). This is because HEAD is a variant of GET that omits the body, and WebOb has special support to return an empty body when a HEAD is used.
pyramid.config.Configurator.add_request_method() has been introduced to support extending request objects with arbitrary callables. This method expands on the now documentation-deprecated pyramid.config.Configurator.set_request_property() by supporting methods as well as properties. This method also causes less code to be executed at request construction time than set_request_property().
The static view machinery now raises rather than returns pyramid.httpexceptions.HTTPNotFound and pyramid.httpexceptions.HTTPMovedPermanently exceptions, so these can be caught by the notfound view (and other exception views).
When there is a predicate mismatch exception (seen when no view matches for a given request due to predicates not working), the exception now contains a textual description of the predicate which didn’t match.
An pyramid.config.Configurator.add_permission() directive method was added to the Configurator. This directive registers a free-standing permission introspectable into the Pyramid introspection system. Frameworks built atop Pyramid can thus use 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 pyramid.config.Configurator.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')
The pyramid.session.UnencryptedCookieSessionFactoryConfig() function now accepts signed_serialize and signed_deserialize hooks which may be used to influence how the sessions are marshalled (by default this is done with HMAC+pickle).
pyramid.testing.DummyRequest now supports methods supplied by the pyramid.util.InstancePropertyMixin class such as set_property.
Request properties and methods added via pyramid.config.Configurator.add_request_method() or pyramid.config.Configurator.set_request_property() are now available to tweens.
Request properties and methods added via pyramid.config.Configurator.add_request_method() or pyramid.config.Configurator.set_request_property() are now available in the request object returned from pyramid.paster.bootstrap().
request.context of environment request during pyramid.paster.bootstrap() is now the root object if a context isn’t already set on a provided request.
pyramid.decorator.reify is now an API, and was added to the API documentation.
Added the pyramid.testing.testConfig() context manager, which can be used to generate a configurator in a test, e.g. with testing.testConfig(...):.
A new pyramid.session.check_csrf_token() convenience API function was added.
A check_csrf view predicate was added. For example, you can now do config.add_view(someview, check_csrf=True). When the predicate is checked, if the csrf_token value in request.params matches the csrf token in the request’s session, the view will be permitted to execute. Otherwise, it will not be permitted to execute.
Add Base.metadata.bind = engine to alchemy scaffold, so that tables defined imperatively will work.
Comments with references to documentation sections placed in scaffold .ini files.
Allow multiple values to be specified to the request_param view/route predicate as a sequence. Previously only a single string value was allowed. See https://github.com/Pylons/pyramid/pull/705
Added an HTTP Basic authentication policy at pyramid.authentication.BasicAuthAuthenticationPolicy.
The pyramid.config.Configurator.testing_securitypolicy() method now returns the policy object it creates.
The DummySecurityPolicy created by pyramid.config.testing_securitypolicy() now sets a forgotten value on the policy (the value True) when its forget method is called.
The DummySecurityPolicy created by pyramid.config.testing_securitypolicy() now sets a remembered value on the policy, which is the value of the principal argument it’s called with when its remember method is called.
New physical_path view predicate. If specified, this value should be a string or a tuple representing the physical traversal path of the context found via traversal for this predicate to match as true. For example: physical_path='/' or physical_path='/a/b/c' or physical_path=('', 'a', 'b', 'c'). It’s useful when you want to always potentially show a view when some object is traversed to, but you can’t be sure about what kind of object it will be, so you can’t use the context predicate.
Added an effective_principals route and view predicate.
Do not allow the userid returned from the pyramid.security.authenticated_userid() or the userid that is one of the list of principals returned by pyramid.security.effective_principals() to be either of the strings system.Everyone or system.Authenticated when any of the built-in authorization policies that live in pyramid.authentication are in use. These two strings are reserved for internal usage by Pyramid and they will no longer be accepted as valid userids.
Allow a _depth argument to pyramid.view.view_config, which will permit limited composition reuse of the decorator by other software that wants to provide custom decorators that are much like view_config.
Allow an iterable of decorators to be passed to pyramid.config.Configurator.add_view(). This allows views to be wrapped by more than one decorator without requiring combining the decorators yourself.
pyramid.security.view_execution_permitted() used to return True if no view could be found. It now raises a TypeError exception in that case, as it doesn’t make sense to assert that a nonexistent view is execution-permitted. See https://github.com/Pylons/pyramid/issues/299.
Small microspeed enhancement which anticipates that a pyramid.response.Response object is likely to be returned from a view. Some code is shortcut if the class of the object returned by a view is this class. A similar microoptimization was done to pyramid.request.Request.is_response().
Make it possible to use variable arguments on all p* commands (pserve, pshell, pviews, etc) in the form a=1 b=2 so you can fill in values in parameterized .ini file, e.g. pshell etc/development.ini http_port=8080.
In order to allow people to ignore unused arguments to subscriber callables and to normalize the relationship between event subscribers and subscriber predicates, we now allow both subscribers and subscriber predicates to accept only a single event argument even if they’ve been subscribed for notifications that involve multiple interfaces.
Allow config.add_route_predicate and config.add_view_predicate to accept an importable dotted-string for the factory argument.
Fix an exception in package_name() when resolving the package name for namespace packages.