From 27862b83712010e4d3f843f74111df260188d321 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 30 Oct 2009 20:06:22 +0000 Subject: Update documentation after root factory changes. --- docs/tutorials/bfgwiki/basiclayout.rst | 10 ++++++---- docs/tutorials/bfgwiki/src/authorization/tutorial/run.py | 4 +++- docs/tutorials/bfgwiki/src/basiclayout/tutorial/run.py | 4 +++- docs/tutorials/bfgwiki/src/models/tutorial/run.py | 4 +++- docs/tutorials/bfgwiki/src/viewdecorators/tutorial/run.py | 4 +++- docs/tutorials/bfgwiki/src/views/tutorial/run.py | 4 +++- docs/tutorials/bfgwiki2/authorization.rst | 4 ++-- docs/tutorials/bfgwiki2/src/authorization/tutorial/models.py | 4 ++-- docs/tutorials/zeo/index.rst | 4 +++- repoze/bfg/paster_templates/alchemy/+package+/models.py | 2 +- repoze/bfg/paster_templates/starter/+package+/models.py | 2 +- repoze/bfg/paster_templates/zodb/+package+/run.py_tmpl | 4 +++- 12 files changed, 33 insertions(+), 17 deletions(-) diff --git a/docs/tutorials/bfgwiki/basiclayout.rst b/docs/tutorials/bfgwiki/basiclayout.rst index 5df7f2487..59545e7cc 100644 --- a/docs/tutorials/bfgwiki/basiclayout.rst +++ b/docs/tutorials/bfgwiki/basiclayout.rst @@ -103,11 +103,13 @@ be in ``run.py`` and its ``app`` function: file's ``[app:main]`` section. This will be a URI (something like ``file:///path/to/Data.fs``). -#. Line *16*. We create a :term:`root factory` using the - ``PersistentApplicationFinder`` helper class, passing it the - ZODB URI and our appmaker. +#. Line *16*. We create a "finder" object using the + ``PersistentApplicationFinder`` helper class, passing it the ZODB + URI and our appmaker. -#. Line *17*. We use the ``repoze.bfg.router.make_app`` to return a +#. *Lines 17 - 18*. We create a :term:`root factory` using the finder. + +#. Line *19*. We use the ``repoze.bfg.router.make_app`` to return a :term:`WSGI` application. The ``make_app`` function takes the root factory (``get_root``), the *package* representing our application, and the keywords parsed by PasteDeploy. diff --git a/docs/tutorials/bfgwiki/src/authorization/tutorial/run.py b/docs/tutorials/bfgwiki/src/authorization/tutorial/run.py index ebe114c6f..dbcd7b99a 100644 --- a/docs/tutorials/bfgwiki/src/authorization/tutorial/run.py +++ b/docs/tutorials/bfgwiki/src/authorization/tutorial/run.py @@ -13,6 +13,8 @@ def app(global_config, **kw): zodb_uri = kw.get('zodb_uri') if zodb_uri is None: raise ValueError("No 'zodb_uri' in application configuration.") - get_root = PersistentApplicationFinder(zodb_uri, appmaker) + finder = PersistentApplicationFinder(zodb_uri, appmaker) + def get_root(request): + return finder(request.environ) return make_app(get_root, tutorial, options=kw) diff --git a/docs/tutorials/bfgwiki/src/basiclayout/tutorial/run.py b/docs/tutorials/bfgwiki/src/basiclayout/tutorial/run.py index 89953e6de..8f021f18e 100644 --- a/docs/tutorials/bfgwiki/src/basiclayout/tutorial/run.py +++ b/docs/tutorials/bfgwiki/src/basiclayout/tutorial/run.py @@ -13,5 +13,7 @@ def app(global_config, **kw): if zodb_uri is None: raise ValueError("No 'zodb_uri' in application configuration.") - get_root = PersistentApplicationFinder(zodb_uri, appmaker) + finder = PersistentApplicationFinder(zodb_uri, appmaker) + def get_root(request): + return finder(request.environ) return make_app(get_root, tutorial, options=kw) diff --git a/docs/tutorials/bfgwiki/src/models/tutorial/run.py b/docs/tutorials/bfgwiki/src/models/tutorial/run.py index 89953e6de..8f021f18e 100644 --- a/docs/tutorials/bfgwiki/src/models/tutorial/run.py +++ b/docs/tutorials/bfgwiki/src/models/tutorial/run.py @@ -13,5 +13,7 @@ def app(global_config, **kw): if zodb_uri is None: raise ValueError("No 'zodb_uri' in application configuration.") - get_root = PersistentApplicationFinder(zodb_uri, appmaker) + finder = PersistentApplicationFinder(zodb_uri, appmaker) + def get_root(request): + return finder(request.environ) return make_app(get_root, tutorial, options=kw) diff --git a/docs/tutorials/bfgwiki/src/viewdecorators/tutorial/run.py b/docs/tutorials/bfgwiki/src/viewdecorators/tutorial/run.py index 89953e6de..8f021f18e 100644 --- a/docs/tutorials/bfgwiki/src/viewdecorators/tutorial/run.py +++ b/docs/tutorials/bfgwiki/src/viewdecorators/tutorial/run.py @@ -13,5 +13,7 @@ def app(global_config, **kw): if zodb_uri is None: raise ValueError("No 'zodb_uri' in application configuration.") - get_root = PersistentApplicationFinder(zodb_uri, appmaker) + finder = PersistentApplicationFinder(zodb_uri, appmaker) + def get_root(request): + return finder(request.environ) return make_app(get_root, tutorial, options=kw) diff --git a/docs/tutorials/bfgwiki/src/views/tutorial/run.py b/docs/tutorials/bfgwiki/src/views/tutorial/run.py index 89953e6de..8f021f18e 100644 --- a/docs/tutorials/bfgwiki/src/views/tutorial/run.py +++ b/docs/tutorials/bfgwiki/src/views/tutorial/run.py @@ -13,5 +13,7 @@ def app(global_config, **kw): if zodb_uri is None: raise ValueError("No 'zodb_uri' in application configuration.") - get_root = PersistentApplicationFinder(zodb_uri, appmaker) + finder = PersistentApplicationFinder(zodb_uri, appmaker) + def get_root(request): + return finder(request.environ) return make_app(get_root, tutorial, options=kw) diff --git a/docs/tutorials/bfgwiki2/authorization.rst b/docs/tutorials/bfgwiki2/authorization.rst index e158b3e87..d2a181281 100644 --- a/docs/tutorials/bfgwiki2/authorization.rst +++ b/docs/tutorials/bfgwiki2/authorization.rst @@ -37,8 +37,8 @@ statements to your ``models.py`` file: class RootFactory(object): __acl__ = [ (Allow, Everyone, 'view'), (Allow, 'editor', 'edit') ] - def __init__(self, environ): - self.__dict__.update(environ['bfg.routes.matchdict']) + def __init__(self, request): + self.__dict__.update(request.matchdict) The ``RootFactory`` class we've just added will be used by :mod:`repoze.bfg` to construct a ``context`` object. The context is diff --git a/docs/tutorials/bfgwiki2/src/authorization/tutorial/models.py b/docs/tutorials/bfgwiki2/src/authorization/tutorial/models.py index 283ddea74..db2095ad1 100644 --- a/docs/tutorials/bfgwiki2/src/authorization/tutorial/models.py +++ b/docs/tutorials/bfgwiki2/src/authorization/tutorial/models.py @@ -33,8 +33,8 @@ class Page(Base): class RootFactory(object): __acl__ = [ (Allow, Everyone, 'view'), (Allow, 'editor', 'edit') ] - def __init__(self, environ): - self.__dict__.update(environ['bfg.routes.matchdict']) + def __init__(self, request): + self.__dict__.update(request.matchdict) def initialize_sql(db, echo=False): engine = create_engine(db, echo=echo) diff --git a/docs/tutorials/zeo/index.rst b/docs/tutorials/zeo/index.rst index 36d681acb..331e13a4d 100644 --- a/docs/tutorials/zeo/index.rst +++ b/docs/tutorials/zeo/index.rst @@ -173,7 +173,9 @@ Configuration serve``""" # paster app config callback zodb_uri = kw['zodb_uri'] - get_root = PersistentApplicationFinder(zodb_uri, appmaker) + finder = PersistentApplicationFinder(zodb_uri, appmaker) + def get_root(request): + return finder(request.environ) import myapp return make_app(get_root, myapp, options=kw) diff --git a/repoze/bfg/paster_templates/alchemy/+package+/models.py b/repoze/bfg/paster_templates/alchemy/+package+/models.py index d086e322e..c3b1eda02 100755 --- a/repoze/bfg/paster_templates/alchemy/+package+/models.py +++ b/repoze/bfg/paster_templates/alchemy/+package+/models.py @@ -61,7 +61,7 @@ class MyApp(object): root = MyApp() -def default_get_root(environ): +def default_get_root(request): return root def populate(): diff --git a/repoze/bfg/paster_templates/starter/+package+/models.py b/repoze/bfg/paster_templates/starter/+package+/models.py index a37762ff4..75dec7505 100644 --- a/repoze/bfg/paster_templates/starter/+package+/models.py +++ b/repoze/bfg/paster_templates/starter/+package+/models.py @@ -3,5 +3,5 @@ class MyModel(object): root = MyModel() -def get_root(environ): +def get_root(request): return root diff --git a/repoze/bfg/paster_templates/zodb/+package+/run.py_tmpl b/repoze/bfg/paster_templates/zodb/+package+/run.py_tmpl index 4d3b98882..ecf78ecf6 100644 --- a/repoze/bfg/paster_templates/zodb/+package+/run.py_tmpl +++ b/repoze/bfg/paster_templates/zodb/+package+/run.py_tmpl @@ -13,5 +13,7 @@ def app(global_config, **kw): if zodb_uri is None: raise ValueError("No 'zodb_uri' in application configuration.") - get_root = PersistentApplicationFinder(zodb_uri, appmaker) + finder = PersistentApplicationFinder(zodb_uri, appmaker) + def get_root(request): + return finder(request.environ) return make_app(get_root, {{package}}, options=kw) -- cgit v1.2.3