Chris McDonough
2010-12-15 ec88337c99e84ba17a45a1f6695f6174da4a9172
commit | author | age
ec8833 1 1.0a5 (2010-12-14)
CM 2 ==================
aedc21 3
957f61 4 Features
CM 5 --------
6
e8edd5 7 - Add a ``handler`` ZCML directive.  This directive does the same thing as
CM 8   ``pyramid.configuration.add_handler``.
9
d7f259 10 - A new module named ``pyramid.config`` was added.  It subsumes the duties of
f360d9 11   the older ``pyramid.configuration`` module.
d7f259 12
CM 13 - The new ``pyramid.config.Configurator` class has API methods that the older
14   ``pyramid.configuration.Configurator`` class did not: ``with_context`` (a
15   classmethod), ``include``, ``action``, and ``commit``.  These methods exist
16   for imperative application extensibility purposes.
e16ab0 17
CM 18 - The ``pyramid.testing.setUp`` function now accepts an ``autocommit``
19   keyword argument, which defaults to ``True``.  If it is passed ``False``,
20   the Config object returned by ``setUp`` will be a non-autocommiting Config
21   object.
957f61 22
CM 23 - Add logging configuration to all paster templates.
24
25 - ``pyramid_alchemy``, ``pyramid_routesalchemy``, and ``pylons_sqla`` paster
26   templates now use idiomatic SQLAlchemy configuration in their respective
27   ``.ini`` files and Python code.
28
0cb7ac 29 - ``pyramid.testing.DummyRequest`` now has a class variable,
CM 30   ``query_string``, which defaults to the empty string.
c5f557 31
e880a4 32 - Add support for json on GAE by catching NotImplementedError and importing
CM 33   simplejson from django.utils.
34
a9f17c 35 - The Mako renderer now accepts a resource specification for
CM 36   ``mako.module_directory``.
37
81e648 38 - New boolean Mako settings variable ``mako.strict_undefined``.  See `Mako
CM 39   Context Variables
40   <http://www.makotemplates.org/docs/runtime.html#context-variables>`_ for
41   its meaning.
42
43 Dependencies
44 ------------
45
46 - Depend on Mako 0.3.6+ (we now require the ``strict_undefined`` feature).
47
b44b93 48 Bug Fixes
CM 49 ---------
50
a56564 51 - When creating a Configurator from within a ``paster pshell`` session, you
CM 52   were required to pass a ``package`` argument although ``package`` is not
53   actually required.  If you didn't pass ``package``, you would receive an
54   error something like ``KeyError: '__name__'`` emanating from the
55   ``pyramid.path.caller_module`` function.  This has now been fixed.
56
b44b93 57 - The ``pyramid_routesalchemy`` paster template's unit tests failed
CM 58   (``AssertionError: 'SomeProject' != 'someproject'``).  This is fixed.
59
76e48b 60 - Make default renderer work (renderer factory registered with no name, which
CM 61   is active for every view unless the view names a specific renderer).
62
a9f17c 63 - The Mako renderer did not properly turn the ``mako.imports``,
CM 64   ``mako.default_filters``, and ``mako.imports`` settings into lists.
65
66 - The Mako renderer did not properly convert the ``mako.error_handler``
67   setting from a dotted name to a callable.
68
2197ff 69 Documentation
CM 70 -------------
71
ec8833 72 - Merged many wording, readability, and correctness changes to narrative
CM 73   documentation chapters from https://github.com/caseman/pyramid (up to and
74   including "Models" narrative chapter).
75
2197ff 76 - "Sample Applications" section of docs changed to note existence of Cluegun,
CM 77   Shootout and Virginia sample applications, ported from their repoze.bfg
78   origin packages.
79
d0e2f6 80 - SQLAlchemy+URLDispatch tutorial updated to integrate changes to
CM 81   ``pyramid_routesalchemy`` template.
82
e26903 83 - Add ``pyramid.interfaces.ITemplateRenderer`` interface to Interfaces API
CM 84   chapter (has ``implementation()`` method, required to be used when getting
85   at Chameleon macros).
86
aa3306 87 - Add a "Modifying Package Structure" section to the project narrative
CM 88   documentation chapter (explain turning a module into a package).
aedc21 89
4d660d 90 - Documentation was added for the new ``handler`` ZCML directive in the ZCML
CM 91   section.
92
f360d9 93 Deprecations
CM 94 ------------
95
96 - ``pyramid.configuration.Configurator`` is now deprecated.  Use
97   ``pyramid.config.Configurator``, passing its constructor
98   ``autocommit=True`` instead.  The ``pyramid.configuration.Configurator``
99   alias will live for a long time, as every application uses it, but its
100   import now issues a deprecation warning.  The
101   ``pyramid.config.Configurator`` class has the same API as
102   ``pyramid.configuration.Configurator`` class, which it means to replace,
103   except by default it is a *non-autocommitting* configurator. The
104   now-deprecated ``pyramid.configuration.Configurator`` will autocommit every
105   time a configuration method is called.
106
107   The ``pyramid.configuration`` module remains, but it is deprecated.  Use
108   ``pyramid.config`` instead.
109
7eb4ad 110 1.0a4 (2010-11-21)
CM 111 ==================
745a61 112
2c9d14 113 Features
CM 114 --------
115
e84116 116 - URL Dispatch now allows for replacement markers to be located anywhere
BB 117   in the pattern, instead of immediately following a ``/``.
47c9f8 118
4018ad 119 - URL Dispatch now uses the form ``{marker}`` to denote a replace marker in
7eb4ad 120   the route pattern instead of ``:marker``. The old colon-style marker syntax
CM 121   is still accepted for backwards compatibility. The new format allows a
122   regular expression for that marker location to be used instead of the
123   default ``[^/]+``, for example ``{marker:\d+}`` is now valid to require the
124   marker to be digits.
47c9f8 125
2c9d14 126 - Add a ``pyramid.url.route_path`` API, allowing folks to generate relative
CM 127   URLs.  Calling ``route_path`` is the same as calling
128   ``pyramid.url.route_url`` with the argument ``_app_url`` equal to the empty
129   string.
130
131 - Add a ``pyramid.request.Request.route_path`` API.  This is a convenience
132   method of the request which calls ``pyramid.url.route_url``.
133
85ee02 134 - Make test suite pass on Jython (requires PasteScript trunk, presumably to
CM 135   be 1.7.4).
136
29b7aa 137 - Make test suite pass on PyPy (Chameleon doesn't work).
CM 138
614f00 139 - Surrounding application configuration with ``config.begin()`` and
CM 140   ``config.end()`` is no longer necessary.  All paster templates have been
141   changed to no longer call these functions.
142
35ce2a 143 - Fix configurator to not convert ``ImportError`` to ``ConfigurationError``
CM 144   if the import that failed was unrelated to the import requested via a
145   dotted name when resolving dotted names (such as view dotted names).
146
614f00 147 Documentation
CM 148 -------------
149
150 - SQLAlchemy+URLDispatch and ZODB+Traversal tutorials have been updated to
151   not call ``config.begin()`` or ``config.end()``.
152
111a6f 153 Bug Fixes
CM 154 ---------
155
156 - Add deprecation warnings to import of ``pyramid.chameleon_text`` and
157   ``pyramid.chameleon_zpt`` of ``get_renderer``, ``get_template``,
158   ``render_template``, and ``render_template_to_response``.
159
34f44d 160 - Add deprecation warning for import of ``pyramid.zcml.zcml_configure`` and
CM 161   ``pyramid.zcml.file_configure``.
162
1e00f3 163 - The ``pyramid_alchemy`` paster template had a typo, preventing an import
CM 164   from working.
165
a66593 166 - Fix apparent failures when calling ``pyramid.traversal.find_model(root,
CM 167   path)`` or ``pyramid.traversal.traverse(path)`` when ``path`` is
168   (erroneously) a Unicode object. The user is meant to pass these APIs a
169   string object, never a Unicode object.  In practice, however, users indeed
170   pass Unicode.  Because the string that is passed must be ASCII encodeable,
171   now, if they pass a Unicode object, its data is eagerly converted to an
172   ASCII string rather than being passed along to downstream code as a
173   convenience to the user and to prevent puzzling second-order failures from
174   cropping up (all failures will occur within ``pyramid.traversal.traverse``
7eb4ad 175   rather than later down the line as the result of calling e.g.
a66593 176   ``traversal_path``).
CM 177
34f44d 178 Backwards Incompatibilities
CM 179 ---------------------------
180
181 - The ``pyramid.testing.zcml_configure`` API has been removed.  It had been
406259 182   advertised as removed since repoze.bfg 1.2a1, but hadn't actually been.
34f44d 183
b68aad 184 Deprecations
CM 185 ------------
186
187 - The ``pyramid.settings.get_settings`` API is now deprecated.  Use
84df81 188   ``pyramid.threadlocals.get_current_registry().settings`` instead or use the
b68aad 189   ``settings`` attribute of the registry available from the request
CM 190   (``request.registry.settings``).
745a61 191
cb96e2 192 Documentation
CM 193 -------------
194
195 - Removed ``zodbsessions`` tutorial chapter.  It's still useful, but we now
196   have a SessionFactory abstraction which competes with it, and maintaining
197   documentation on both ways to do it is a distraction.
198
dbaa08 199 Internal
CM 200 --------
201
202 - Replace Twill with WebTest in internal integration tests (avoid deprecation
203   warnings generated by Twill).
204
3fa994 205 1.0a3 (2010-11-16)
CM 206 ==================
f4d693 207
9cca72 208 Features
CM 209 --------
210
ae60ba 211 - Added Mako TemplateLookup settings for ``mako.error_handler``,
BB 212   ``mako.default_filters``, and ``mako.imports``.
213
9cca72 214 - Normalized all paster templates: each now uses the name ``main`` to
CM 215   represent the function that returns a WSGI application, each now uses
216   WebError, each now has roughly the same shape of development.ini style.
217
51c305 218 - Added class vars ``matchdict`` and ``matched_route`` to
CR 219   ``pyramid.request.Request``.  Each is set to ``None``.
220
fe4172 221 - New API method: ``pyramid.settings.asbool``.
CM 222
9e2e1c 223 - New API methods for ``pyramid.request.Request``: ``model_url``,
CM 224   ``route_url``, and ``static_url``.  These are simple passthroughs for their
225   respective functions in ``pyramid.url``.
4eafaa 226
5a972b 227 - The ``settings`` object which used to be available only when
CM 228   ``request.settings.get_settings`` was called is now available as
229   ``registry.settings`` (e.g. ``request.registry.settings`` in view code).
230
9cca72 231 Bug Fixes
CM 232 ---------
233
234 - The pylons_* paster templates erroneously used the ``{squiggly}`` routing
235   syntax as the pattern supplied to ``add_route``.  This style of routing is
236   not supported.  They were replaced with ``:colon`` style route patterns.
f4d693 237
7bd14c 238 - The pylons_* paster template used the same string
CM 239   (``your_app_secret_string``) for the ``session.secret`` setting in the
240   generated ``development.ini``.  This was a security risk if left unchanged
241   in a project that used one of the templates to produce production
242   applications.  It now uses a randomly generated string.
243
1ad856 244 Documentation
CM 245 -------------
246
247 - ZODB+traversal wiki (``wiki``) tutorial updated due to changes to
248   ``pyramid_zodb`` paster template.
249
40eb89 250 - SQLAlchemy+urldispach wiki (``wiki2``) tutorial updated due to changes to
CM 251   ``pyramid_routesalchemy`` paster template.
252
4eafaa 253 - Documented the ``matchdict`` and ``matched_route`` attributes of the
CM 254   request object in the Request API documentation.
255
5a972b 256 Deprecations
CM 257 ------------
258
259 - Obtaining the ``settings`` object via
260   ``registry.{get|query}Utility(ISettings)`` is now deprecated.  Instead,
261   obtain the ``settings`` object via the ``registry.settings`` attribute.  A
262   backwards compatibility shim was added to the registry object to register
263   the settings object as an ISettings utility when ``setattr(registry,
264   'settings', foo)`` is called, but it will be removed in a later release.
265
266 - Obtaining the ``settings`` object via ``pyramid.settings.get_settings`` is
267   now deprecated.  Obtain it as the ``settings`` attribute of the registry
268   now (obtain the registry via ``pyramid.threadlocal.get_registry`` or as
269   ``request.registry``).
270
76d7eb 271 Behavior Differences
CM 272 --------------------
273
274 - Internal: ZCML directives no longer call get_current_registry() if there's
275   a ``registry`` attribute on the ZCML context (kill off use of
276   threadlocals).
277
7b8d65 278 - Internal: Chameleon template renderers now accept two arguments: ``path``
CM 279   and ``lookup``.  ``Lookup`` will be an instance of a lookup class which
280   supplies (late-bound) arguments for debug, reload, and translate.  Any
281   third-party renderers which use (the non-API) function
282   ``pyramid.renderers.template_renderer_factory`` will need to adjust their
283   implementations to obey the new callback argument list.  This change was to
284   kill off inappropriate use of threadlocals.
285
3d4e56 286 1.0a2 (2010-11-09)
CM 287 ==================
0af394 288
c721fd 289 Documentation
CM 290 -------------
291
292 - All references to events by interface
293   (e.g. ``pyramid.interfaces.INewRequest``) have been changed to reference
294   their concrete classes (e.g. ``pyramid.events.NewRequest``) in
295   documentation about making subscriptions.
296
3d4e56 297 - All references to Pyramid-the-application were changed from mod-`pyramid`
CM 298   to app-`Pyramid`.  A custom role setting was added to ``docs/conf.py`` to
fd5ae9 299   allow for this.  (internal)
CM 300
fcc3d1 301 1.0a1 (2010-11-05)
CM 302 ==================
5bbc23 303
fcc3d1 304 Features (delta from BFG 1.3)
2e6905 305 -------------------------------
CM 306
07437c 307 - Mako templating renderer supports resource specification format for
BB 308   template lookups and within Mako templates. Absolute filenames must
a62cc2 309   be used in Pyramid to avoid this lookup process.
07437c 310
2e6905 311 - Add ``pyramid.httpexceptions`` module, which is a facade for the
CM 312   ``webob.exc`` module.
313
9b8d0c 314 - Direct built-in support for the Mako templating language.
CM 315
316 - A new configurator method exists: ``add_handler``.  This method adds
317   a Pylons-style "view handler" (such a thing used to be called a
318   "controller" in Pylons 1.0).
319
968209 320 - New argument to configurator: ``session_factory``.
CM 321
322 - New method on configurator: ``set_session_factory``
323
324 - Using ``request.session`` now returns a (dictionary-like) session
325   object if a session factory has been configured.
14dc81 326
CM 327 - The request now has a new attribute: ``tmpl_context`` for benefit of
328   Pylons users.
329
197f0c 330 - The decorator previously known as ``pyramid.view.bfg_view`` is now
CM 331   known most formally as ``pyramid.view.view_config`` in docs and
332   paster templates.  An import of ``pyramid.view.bfg_view``, however,
333   will continue to work "forever".
334
6a3184 335 - New API methods in ``pyramid.session``: ``signed_serialize`` and
CM 336   ``signed_deserialize``.
337
1dad60 338 - New interface: ``pyramid.interfaces.IRendererInfo``.  An object of this type
CM 339   is passed to renderer factory constructors (see "Backwards
340   Incompatibilities").
341
a76e99 342 - New event type: ``pyramid.interfaces.IBeforeRender``.  An object of this type
CM 343   is sent as an event before a renderer is invoked (but after the
344   application-level renderer globals factory added via
345   ``pyramid.configurator.configuration.set_renderer_globals_factory``, if any,
346   has injected its own keys).  Applications may now subscribe to the
347   ``IBeforeRender`` event type in order to introspect the and modify the set of
348   renderer globals before they are passed to a renderer.  The event object
349   iself has a dictionary-like interface that can be used for this purpose.  For
350   example::
351
352     from repoze.events import subscriber
353     from pyramid.interfaces import IRendererGlobalsEvent
354
355     @subscriber(IRendererGlobalsEvent)
356     def add_global(event):
357         event['mykey'] = 'foo'
358
359   If a subscriber attempts to add a key that already exist in the renderer
360   globals dictionary, a ``KeyError`` is raised.  This limitation is due to the
361   fact that subscribers cannot be ordered relative to each other.  The set of
362   keys added to the renderer globals dictionary by all subscribers and
363   app-level globals factories must be unique.
364
e65e5b 365 - New class: ``pyramid.response.Response``.  This is a pure facade for
CM 366   ``webob.Response`` (old code need not change to use this facade, it's
94b889 367   existence is mostly for vanity and documentation-generation purposes).
CM 368
a3dc13 369 - All preexisting paster templates (except ``zodb``) now use "imperative"
CM 370   configuration (``starter``, ``routesalchemy``, ``alchemy``).
371
372 - A new paster template named ``pyramid_starter_zcml`` exists, which uses
373   declarative configuration.
374
2e6905 375 Documentation (delta from BFG 1.3)
CM 376 -----------------------------------
377
378 - Added a ``pyramid.httpexceptions`` API documentation chapter.
379
14dc81 380 - Added a ``pyramid.session`` API documentation chapter.
CM 381
382 - Added a ``Session Objects`` narrative documentation chapter.
383
384 - Added an API chapter for the ``pyramid.personality`` module.
385
94b889 386 - Added an API chapter for the ``pyramid.response`` module.
CM 387
388 - All documentation which previously referred to ``webob.Response`` now uses
389   ``pyramid.response.Response`` instead.
390
7a3465 391 - The documentation has been overhauled to use imperative configuration,
CM 392   moving declarative configuration (ZCML) explanations to a separate
393   narrative chapter ``declarative.rst``.
394
b3b713 395 - The ZODB Wiki tutorial was updated to take into account changes to the
CM 396   ``pyramid_zodb`` paster template.
397
b2adfe 398 - The SQL Wiki tutorial was updated to take into account changes to the
CM 399   ``pyramid_routesalchemy`` paster template.
6067de 400
fcc3d1 401 Backwards Incompatibilities (with BFG 1.3)
CM 402 ------------------------------------------
2d7993 403
c81aad 404 - There is no longer an ``IDebugLogger`` registered as a named utility
CM 405   with the name ``repoze.bfg.debug``.
406
407 - The logger which used to have the name of ``repoze.bfg.debug`` now
408   has the name ``pyramid.debug``.
409
588733 410 - The deprecated API ``pyramid.testing.registerViewPermission``
CM 411   has been removed.
412
51c305 413 - The deprecated API named ``pyramid.testing.registerRoutesMapper``
588733 414   has been removed.
CM 415
c81aad 416 - The deprecated API named ``pyramid.request.get_request`` was removed.
CM 417
418 - The deprecated API named ``pyramid.security.Unauthorized`` was
419   removed.
420
421 - The deprecated API named ``pyramid.view.view_execution_permitted``
422   was removed.
423
424 - The deprecated API named ``pyramid.view.NotFound`` was removed.
6a3184 425
CM 426 - The ``bfgshell`` paster command is now named ``pshell``.
427
cba2e1 428 - The Venusian "category" for all built-in Venusian decorators
CM 429   (e.g. ``subscriber`` and ``view_config``/``bfg_view``) is now
430   ``pyramid`` instead of ``bfg``.
3d9dd0 431
CM 432 - ``pyramid.renderers.rendered_response`` function removed; use
433   ``render_pyramid.renderers.render_to_response`` instead.
434
1dad60 435 - Renderer factories now accept a *renderer info object* rather than an
CM 436   absolute resource specification or an absolute path.  The object has the
437   following attributes: ``name`` (the ``renderer=`` value), ``package`` (the
438   'current package' when the renderer configuration statement was found),
439   ``type``: the renderer type, ``registry``: the current registry, and
440   ``settings``: the deployment settings dictionary.
3d9dd0 441
CM 442   Third-party ``repoze.bfg`` renderer implementations that must be ported to
443   Pyramid will need to account for this.
444
f5fa3f 445   This change was made primarily to support more flexible Mako template
CM 446   rendering.
2876a8 447
CM 448 - The presence of the key ``repoze.bfg.message`` in the WSGI environment when
449   an exception occurs is now deprecated.  Instead, code which relies on this
450   environ value should use the ``exception`` attribute of the request
451   (e.g. ``request.exception[0]``) to retrieve the message.
8129f9 452
CM 453 - The values ``bfg_localizer`` and ``bfg_locale_name`` kept on the request
454   during internationalization for caching purposes were never APIs.  These
455   however have changed to ``localizer`` and ``locale_name``, respectively.
456
968f46 457 - The default ``cookie_name`` value of the ``authtktauthenticationpolicy`` ZCML
CM 458   now defaults to ``auth_tkt`` (it used to default to ``repoze.bfg.auth_tkt``).
459
460 - The default ``cookie_name`` value of the
461   ``pyramid.authentication.AuthTktAuthenticationPolicy`` constructor now
462   defaults to ``auth_tkt`` (it used to default to ``repoze.bfg.auth_tkt``).
7a3465 463
a3dc13 464 - The ``request_type`` argument to the ``view`` ZCML directive, the
CM 465   ``pyramid.configuration.Configurator.add_view`` method, or the
466   ``pyramid.view.view_config`` decorator (nee ``bfg_view``) is no longer
467   permitted to be one of the strings ``GET``, ``HEAD``, ``PUT``, ``POST`` or
468   ``DELETE``, and now must always be an interface.  Accepting the
469   method-strings as ``request_type`` was a backwards compatibility strategy
470   servicing repoze.bfg 1.0 applications.  Use the ``request_method``
471   parameter instead to specify that a view a string request-method predicate.