summaryrefslogtreecommitdiff
AgeCommit message (Collapse)Author
2009-05-21Tweaks.Chris McDonough
2009-05-21Prep for 0.8.1.Chris McDonough
2009-05-21Disambiguate.Chris McDonough
2009-05-21Disambiguate.Chris McDonough
2009-05-21- Class objects may now be used as view callables (both via ZCML andChris McDonough
via use of the ``bfg_view`` decorator in Python 2.6 as a class decorator). The calling semantics when using a class as a view callable is similar to that of using a class as a Zope "browser view": the class' ``__init__`` must accept two positional parameters (conventionally named ``context``, and ``request``). The resulting instance must be callable (it must have a ``__call__`` method). When called, the instance should return a response. For example:: from webob import Response class MyView(object): def __init__(self, context, request): self.context = context self.request = request def __call__(self): return Response('hello from %s!' % self.context) See the "Views" chapter in the documentation and the ``repoze.bfg.view`` API documentation for more information.
2009-05-21Remove cacheability voodoo.Chris McDonough
2009-05-21- Removed the pickling of ZCML actions (the code that wroteChris McDonough
``configure.zcml.cache`` next to ``configure.zcml`` files in projects). The code which managed writing and reading of the cache file was a source of subtle bugs when users switched between imperative (e.g. ``@bfg_view``) registrations and declarative registrations (e.g. the ``view`` directive in ZCML) on the same project. On a moderately-sized project (535 ZCML actions and 15 ZCML files), executing actions read from the pickle was saving us only about 200ms (2.5 sec vs 2.7 sec average). On very small projects (1 ZCML file and 4 actions), startup time was comparable, and sometimes even slower when reading from the pickle, and both ways were so fast that it really just didn't matter anyway.
2009-05-20Docs tweak.Chris McDonough
2009-05-18Fix typo in docstring.Chris Rossi
2009-05-18Prep for 0.8.Chris McDonough
2009-05-18FeaturesChris McDonough
-------- - Added a ``traverse`` function to the ``repoze.bfg.traversal`` module. This function may be used to retrieve certain values computed during path resolution. See the Traversal API chapter of the documentation for more information about this function. Deprecations ------------ - Internal: ``ITraverser`` callables should now return a dictionary rather than a tuple. Up until 0.7.0, all ITraversers were assumed to return a 3-tuple. In 0.7.1, ITraversers were assumed to return a 6-tuple. As (by evidence) it's likely we'll need to add further information to the return value of an ITraverser callable, 0.8 assumes that an ITraverser return a dictionary with certain elements in it. See the ``repoze.bfg.interfaces.ITraverser`` interface for the list of keys that should be present in the dictionary. ``ITraversers`` which return tuples will still work, although a deprecation warning will be issued. Backwards Incompatibilities --------------------------- - If your code used the ITraverser interface directly (not via an API function such as ``find_model``) via an adapter lookup, you'll need to change your code to expect a dictionary rather than a 3- or 6-tuple if your code ever gets return values from the default ModelGraphTraverser or RoutesModelTraverser adapters.
2009-05-16``get_options`` no longer exists.Chris McDonough
2009-05-16Back to dev.Chris McDonough
2009-05-16Indenting.Chris McDonough
2009-05-16Prep for a7.Chris McDonough
2009-05-16Speed up common case (use default factory).Chris McDonough
2009-05-16These are useless to explain; I don't even understand them.Chris McDonough
2009-05-16Don't do an alsoProvides if it's already a default routes context.Chris McDonough
2009-05-16Remove non-sequitur.Chris McDonough
2009-05-16Unnecessary.Chris McDonough
2009-05-16Removed this reference.Chris McDonough
2009-05-16This feature was removed.Chris McDonough
2009-05-16- The ``RoutesMapper`` class in ``repoze.bfg.urldispatch`` has beenChris McDonough
removed, as well as its documentation. It had been deprecated since 0.6.3. Code in ``repoze.bfg.urldispatch.RoutesModelTraverser`` which catered to it has also been removed. - The semantics of the ``route`` ZCML directive have been simplified. Previously, it was assumed that to use a route, you wanted to map a route to an externally registered view. The new ``route`` directive instead has a ``view`` attribute which is required, specifying the dotted path to a view callable. When a route directive is processed, a view is *registered* using the name attribute of the route directive as its name and the callable as its value. The ``view_name`` and ``provides`` attributes of the ``route`` directive are therefore no longer used. Effectively, if you were previously using the ``route`` directive, it means you must change a pair of ZCML directives that look like this:: <route name="home" path="" view_name="login" factory=".models.root.Root" /> <view for=".models.root.Root" name="login" view=".views.login_view" /> To a ZCML directive that looks like this:: <route name="home" path="" view=".views.login_view" factory=".models.root.Root" /> In other words, to make old code work, remove the ``view`` directives that were only there to serve the purpose of backing ``route`` directives, and move their ``view=`` attribute into the ``route`` directive itself. This change also necessitated that the ``name`` attribute of the ``route`` directive is now required. If you were previously using ``route`` directives without a ``name`` attribute, you'll need to add one (the name is arbitrary, but must be unique among all ``route`` and ``view`` statements). The ``provides`` attribute of the ``route`` directive has also been removed. This directive specified a sequence of interface types that the generated context would be decorated with. Since route views are always generated now for a single interface (``repoze.bfg.IRoutesContext``) as opposed to being looked up arbitrarily, there is no need to decorate any context to ensure a view is found. - The Routes ``Route`` object used to resolve the match is now put into the environment as ``bfg.route`` when URL dispatch is used.
2009-05-14Docs rendering tweaks.Chris McDonough
2009-05-14Rendering.Chris McDonough
2009-05-14General cleanup.Chris McDonough
2009-05-14Update test coverage output.Chris McDonough
2009-05-14- Update "Templates" narrative chapter in docs (expand to show aChris McDonough
sample template and correct macro example).
2009-05-14Typo.Chris McDonough
2009-05-14It was merged.Chris McDonough
2009-05-14Platform testing history.Chris McDonough
2009-05-14- Noted existence of ``repoze.bfg.pagetemplate`` template bindings inChris McDonough
"Available Add On Template System Bindings" in Templates chapter in narrative docs. - Noted existence of ``alchemy`` paster template.
2009-05-14Back to dev.Chris McDonough
2009-05-14- Added API docs for the ``repoze.bfg.testing`` methodsChris McDonough
``registerAdapter``, ``registerUtiity``, ``registerSubscriber``, and ``cleanUp``. - Added glossary entry for "root factory".
2009-05-14Typo.Chris McDonough
2009-05-12added a template for a simple SQLAlchemy traversal applicationCarlos de la Guardia
2009-05-11Prep for 0.8a6.Chris McDonough
2009-05-112.4 doesn't ship with pysqlite.Chris McDonough
2009-05-11Nobody knows how to test this yet.Chris McDonough
2009-05-11- Added a ``routesalchemy`` Paster template. This paster templateChris McDonough
sets up a BFG project that uses SQAlchemy (with SQLite) and uses Routes exclusively to resolve URLs (no traversal root factory is used). This template can be used via ``paster create -t bfg_routesalchemy``.
2009-05-10Docs tweaks.Chris McDonough
2009-05-10- Added documentation to the URL Dispatch chapter about how to performChris McDonough
a cleanup function at the end of a request (e.g. close the SQL connection).
2009-05-10Minor speed and docs tweaks.Chris McDonough
2009-05-10Add a test for unnamed root Route.Chris McDonough
2009-05-10- Added documentation to the URL Dispatch chapter about how to catchChris McDonough
the root URL.
2009-05-10- In version 0.6.3, passing a ``get_root`` callback (a "root factory")Chris McDonough
to ``repoze.bfg.router.make_app`` became optional if any ``route`` declaration was made in ZCML. The intent was to make it possible to disuse traversal entirely, instead relying entirely on URL dispatch (Routes) to resolve all contexts. However a compound set of bugs prevented usage of a Routes-based root view (a view which responds to "/"). One bug existed in `repoze.bfg.urldispatch``, another existed in Routes itself. To resolve this issue, the urldispatch module was fixed, and a fork of the Routes trunk was put into the "dev" index named ``Routes-1.11dev-chrism-home``. The source for the fork exists at `http://bitbucket.org/chrism/routes-home/ <http://bitbucket.org/chrism/routes-home/>`_; its contents have been reported to the upstream Routes developers and will hopefully be a part of the final Routes 1.11 release.
2009-05-10Less awkward sentence.Chris McDonough
2009-05-09Typos.Chris McDonough
2009-05-08Back to dev.Chris McDonough
2009-05-08Prep for 0.8a5 release.Chris McDonough