[Checkins] SVN: grok/trunk/doc/reference/components.rst add summaries for GlobalUtility and LocalUtility.

Kevin Teague kevin at bud.ca
Sun Mar 8 14:06:51 EDT 2009


Log message for revision 97667:
  add summaries for GlobalUtility and LocalUtility.

Changed:
  U   grok/trunk/doc/reference/components.rst

-=-
Modified: grok/trunk/doc/reference/components.rst
===================================================================
--- grok/trunk/doc/reference/components.rst	2009-03-08 14:09:12 UTC (rev 97666)
+++ grok/trunk/doc/reference/components.rst	2009-03-08 18:06:51 UTC (rev 97667)
@@ -353,7 +353,7 @@
 
 The object providing the existing interface is passed to the Adapter
 in the constructor, and is stored in an attribute named 'context.
-The source code for the `grok.Adapter` base class is simply::
+The source code for the `grok.Adapter` base class is simply:
 
 .. code-block:: python
 
@@ -588,6 +588,13 @@
 :class:`grok.GlobalUtility`
 ===========================
 
+A global utility is an object which provides an interface, and can be
+looked-up by that interface and optionally the component name. The
+attributes provided by a global utility are not persistent.
+
+Examples of global utilities are database connections, XML parsers,
+and web service proxies.
+
 .. class:: grok.GlobalUtility
 
     Base class to define a globally registered utility. Global utilities are
@@ -614,6 +621,16 @@
 :class:`grok.LocalUtility`
 ==========================
 
+A local utility is an object which provides an interface, and can be 
+looked-up by that interface and optionally the component name. The attributes
+provided by a local utility are transparently stored in the database (ZODB).
+This means that configuration changes to a local utility lasts between
+server restarts.
+
+An example is for database connections or web service proxies, 
+where you need to dynamically provide the connection settings
+so that they can be edited through-the-web.
+
 .. class:: grok.LocalUtility
 
     Base class to define a utility that will be registered local to a



More information about the Checkins mailing list