summaryrefslogtreecommitdiff
path: root/docs/narr/configuration.rst
AgeCommit message (Collapse)Author
2009-12-27Rendering cleanups.Chris McDonough
2009-12-27Latex rendering.Chris McDonough
Documentation licensing.
2009-12-26- Created new top-level documentation section: "ZCML Directives".Chris McDonough
This section contains detailed ZCML directive information, some of which was removed from various narrative chapters.
2009-12-25Fix syntax errors found via manuel, and add manuel-style markers to preventChris McDonough
untestable code blocks from being tested.
2009-12-25Normalize code blocks.Chris McDonough
2009-12-22Use :meth:, :func:, and :class: appropriately for configuration-related docs.Chris McDonough
2009-12-17FeaturesChris McDonough
-------- - The ``Configurator`` object now has two new methods: ``begin`` and ``end``. The ``begin`` method is meant to be called before any "configuration" begins (e.g. before ``add_view``, et. al are called). The ``end`` method is meant to be called after all "configuration" is complete. Previously, before there was imperative configuration at all (1.1 and prior), configuration begin and end was invariably implied by the process of loading a ZCML file. When a ZCML load happened, the threadlocal data structure containing the request and registry was modified before the load, and torn down after the load, making sure that all framework code that needed ``get_current_registry`` for the duration of the ZCML load was satisfied. Some API methods called during imperative configuration, (such as ``Configurator.add_view`` when a renderer is involved) end up for historical reasons calling ``get_current_registry``. However, in 1.2a5 and below, the Configurator supplied no functionality that allowed people to make sure that ``get_current_registry`` returned the registry implied by the configurator being used. ``begin`` now serves this purpose. Inversely, ``end`` pops the thread local stack, undoing the actions of ``begin``. We make this boundary explicit to reduce the potential for confusion when the configurator is used in different circumstances (e.g. in unit tests and app code vs. just in initial app setup). Existing code written for 1.2a1-1.2a5 which does not call ``begin`` or ``end`` continues to work in the same manner it did before. It is however suggested that this code be changed to call ``begin`` and ``end`` to reduce the potential for confusion in the future. - All ``paster`` templates which generate an application skeleton now make use of the new ``begin`` and ``end`` methods of the Configurator they use in their respective copies of ``run.py`` and ``tests.py``. Documentation ------------- - All documentation that makes use of a ``Configurator`` object to do application setup and test setup now makes use of the new ``begin`` and ``end`` methods of the configurator. Bug Fixes --------- - When a ``repoze.bfg.exceptions.NotFound`` or ``repoze.bfg.exceptions.Forbidden`` *class* (as opposed to instance) was raised as an exception within a root factory (or route root factory), the exception would not be caught properly by the ``repoze.bfg.`` Router and it would propagate to up the call stack, as opposed to rendering the not found view or the forbidden view as would have been expected.
2009-12-09typoFernando Correa Neto
2009-12-09typoFernando Correa Neto
2009-12-09- Remove explanation of changing the request type in a new requestChris McDonough
event subscriber, as other predicates are now usually an easier way to get this done.
2009-12-09Refactor.Chris McDonough
2009-12-09(no commit message)Chris McDonough
2009-12-09Use paste.httpserver.Chris McDonough
2009-12-09- General documentation freshening which takes imperativeChris McDonough
configuration into account in more places and uses glossary references more liberally.
2009-11-28More fixes.Chris McDonough
2009-11-28More Rossi fixes.Chris McDonough
2009-11-28Fix mistakes caught by Rossi.Chris McDonough
2009-11-28Docs.Chris McDonough
2009-11-27Get rid of ``zcml_file`` argument in configurator constructor in favor of ↵Chris McDonough
the load_zcml API. Get rid of hook_zca argument in configurator constructor in favor of a ``hook_zca`` method. Provide an ``unhook_zca`` method.
2009-11-24Docs updates.Chris McDonough
2009-11-23(no commit message)Chris McDonough
2009-11-23Filesystem analogy.Chris McDonough
2009-11-23spelingMike Naberezny
2009-11-23Holy circdeps batman.Chris McDonough
2009-11-23Minor tweaks.Chris McDonough
2009-11-23Flesh out configuration chapter.Chris McDonough
2009-11-23(no commit message)Chris McDonough
2009-11-23- The ``repoze.bfg.interfaces.ITemplateRendererFactory`` interface wasChris McDonough
removed; it has become unused. - Change imperative API.
2009-11-23Documentation improvements.Chris McDonough
2009-11-23- The ``repoze.bfg.router.make_app`` function is now nominallyChris McDonough
deprecated. Its import and usage does not throw a warning, nor will it probably ever disappear. However, using a ``repoze.bfg.configuration.Configurator`` class is now the preferred way to generate a WSGI application. - The ``run.py`` module in various ``repoze.bfg`` ``paster`` templates now use a ``repoze.bfg.configuration.Configurator`` class instead of the (now-legacy) ``repoze.bfg.router.make_app`` function to produce a WSGI application.
2009-11-22Renderings.Chris McDonough
2009-11-22Rendering.Chris McDonough
2009-11-22some suggestions for alternative wording on the introduction. The second and ↵Carlos de la Guardia
third paragraphs were very redundant.
2009-11-22Docs tweaks.Chris McDonough
2009-11-22Test load_zcml.Chris McDonough
2009-11-22Murg 2.Chris McDonough
2009-11-22Murg.Chris McDonough
2009-11-21Typo.Chris McDonough
2009-11-21Use a sidebar.Chris McDonough
2009-11-21Beginnings of explaining configuration modes.Chris McDonough