[gnue] r8587 - in trunk/gnue-common/src: definitions logic logic/adapters printing/pdftable rpc rpc/drivers rpc/drivers/hessian utils

[reinhard]

Author: reinhard
Date: 2006-08-22 06:43:41 -0500 (Tue, 22 Aug 2006)
New Revision: 8587

Modified:
   trunk/gnue-common/src/definitions/GObjects.py
   trunk/gnue-common/src/definitions/GParserHelpers.py
   trunk/gnue-common/src/logic/GTriggerCore.py
   trunk/gnue-common/src/logic/NamespaceCore.py
   trunk/gnue-common/src/logic/adapters/Base.py
   trunk/gnue-common/src/logic/language.py
   trunk/gnue-common/src/printing/pdftable/pdftable.py
   trunk/gnue-common/src/rpc/client.py
   trunk/gnue-common/src/rpc/drivers/Base.py
   trunk/gnue-common/src/rpc/drivers/hessian/SimpleHessianServer.py
   trunk/gnue-common/src/rpc/drivers/hessian/hessianlib.py
   trunk/gnue-common/src/utils/tree.py
   trunk/gnue-common/src/utils/uuid.py
Log:
Epydoc fixes.


Modified: trunk/gnue-common/src/definitions/GObjects.py
===================================================================
--- trunk/gnue-common/src/definitions/GObjects.py       2006-08-22 08:53:59 UTC 
(rev 8586)
+++ trunk/gnue-common/src/definitions/GObjects.py       2006-08-22 11:43:41 UTC 
(rev 8587)
@@ -580,7 +580,7 @@
   # Build a difference-tree to the given object tree
   # 
----------------------------------------------------------------------------
 
-  def diff (self, goal, maxIdLength):
+  def diff (self, goal, maxIdLength=None):
     """
     Build an object tree representing the difference between two object trees.
 

Modified: trunk/gnue-common/src/definitions/GParserHelpers.py
===================================================================
--- trunk/gnue-common/src/definitions/GParserHelpers.py 2006-08-22 08:53:59 UTC 
(rev 8586)
+++ trunk/gnue-common/src/definitions/GParserHelpers.py 2006-08-22 11:43:41 UTC 
(rev 8587)
@@ -630,7 +630,7 @@
   # Don't merge contents instances
   # ---------------------------------------------------------------------------
 
-  def merge (self, other):
+  def merge (self, other, maxIdLength=None):
     """
     Content objects cannot be merged together
     """

Modified: trunk/gnue-common/src/logic/GTriggerCore.py
===================================================================
--- trunk/gnue-common/src/logic/GTriggerCore.py 2006-08-22 08:53:59 UTC (rev 
8586)
+++ trunk/gnue-common/src/logic/GTriggerCore.py 2006-08-22 11:43:41 UTC (rev 
8587)
@@ -119,10 +119,10 @@
     def create_namespace_object(self, global_namespace, namespace_name):
         """
         Construct a namespace object tree from an XML
-        (L{definitions.GObject.GObj}) object tree.
+        (L{definitions.GObjects.GObj}) object tree.
 
         This function creates a L{NamespaceElement} object for each
-        L{definitions.GObject.GObj} in the object.
+        L{definitions.GObjects.GObj} in the object.
         """
 
         # Create dictionary with methods as defined

Modified: trunk/gnue-common/src/logic/NamespaceCore.py
===================================================================
--- trunk/gnue-common/src/logic/NamespaceCore.py        2006-08-22 08:53:59 UTC 
(rev 8586)
+++ trunk/gnue-common/src/logic/NamespaceCore.py        2006-08-22 11:43:41 UTC 
(rev 8587)
@@ -70,8 +70,8 @@
 
     def constructTriggerObject(self, xml_object):
         """
-        Construct a namespace object tree from an XML (L{GObject.GObj}) object
-        tree. DEPRECIATED.
+        Construct a namespace object tree from an XML
+        (L{definitions.GObjects.GObj}) object tree. DEPRECIATED.
 
         Depreciated. Use xml_object.create_namespace_object instead.
         """

Modified: trunk/gnue-common/src/logic/adapters/Base.py
===================================================================
--- trunk/gnue-common/src/logic/adapters/Base.py        2006-08-22 08:53:59 UTC 
(rev 8586)
+++ trunk/gnue-common/src/logic/adapters/Base.py        2006-08-22 11:43:41 UTC 
(rev 8587)
@@ -29,8 +29,8 @@
 
 Language adapters are python modules that allow external, user provided code in
 a given language to be executed within Python. In GNU Enterprise, language
-adapters are used to execute L{actions}, L{GTrigger} triggers, and server side
-methods in GNUe-AppServer.
+adapters are used to execute L{usercode.action} actions, L{GTrigger.GTrigger}
+triggers, and server side methods in GNUe-AppServer.
 
 Each language adapter implements this feature for a specific language. An
 implementation of a language adapter consists of three classes that are derived
@@ -268,9 +268,7 @@
 
     def buildFunction(self, name, code, parameters = None):
         """
-        Create a new instance of a L{Function} and compile its code.
-
-        Descendants must implement this.
+        Build a Function and compile its code.
         """
         if parameters is None:
             params = []

Modified: trunk/gnue-common/src/logic/language.py
===================================================================
--- trunk/gnue-common/src/logic/language.py     2006-08-22 08:53:59 UTC (rev 
8586)
+++ trunk/gnue-common/src/logic/language.py     2006-08-22 11:43:41 UTC (rev 
8587)
@@ -78,7 +78,7 @@
     Error in user code compilation.
 
     An error occured when trying to compile user code. Details of the error are
-    available through the L{getName}, L{getDatail}, and L{getMessage}
+    available through the L{getName}, L{getDetail}, and L{getMessage}
     methods.
     """
     pass
@@ -90,7 +90,7 @@
     Error in user code execution.
 
     An error occured when trying to execute user code. Details of the error are
-    available through the L{getName}, L{getDatail}, and L{getMessage}
+    available through the L{getName}, L{getDetail}, and L{getMessage}
     methods.
     """
     pass

Modified: trunk/gnue-common/src/printing/pdftable/pdftable.py
===================================================================
--- trunk/gnue-common/src/printing/pdftable/pdftable.py 2006-08-22 08:53:59 UTC 
(rev 8586)
+++ trunk/gnue-common/src/printing/pdftable/pdftable.py 2006-08-22 11:43:41 UTC 
(rev 8587)
@@ -124,7 +124,7 @@
       - Automatic adjustments of the data when it is unable to fit on one page.
       - Multiple sections of a report handled automatically.
     
-    @param file: A python file handle used for output
+    @param destination: A python file handle used for output
     @param parameterBox: Unused?
     """
     self._titleList = ['Your Report','Your Report']

Modified: trunk/gnue-common/src/rpc/client.py
===================================================================
--- trunk/gnue-common/src/rpc/client.py 2006-08-22 08:53:59 UTC (rev 8586)
+++ trunk/gnue-common/src/rpc/client.py 2006-08-22 11:43:41 UTC (rev 8587)
@@ -42,7 +42,8 @@
   """
   Create a new ClientAdapter of a given rpc driver.
 
-  @param interface: name of the driver to create a L{ClientAdapter} for
+  @param interface: name of the driver to create a L{drivers.Base.Client}
+  instance for
   @param params: dictionary of parameters to pass to the ClientAdapter
 
   @return: a L{drivers.Base.ServerProxy} instance ready for accessing the

Modified: trunk/gnue-common/src/rpc/drivers/Base.py
===================================================================
--- trunk/gnue-common/src/rpc/drivers/Base.py   2006-08-22 08:53:59 UTC (rev 
8586)
+++ trunk/gnue-common/src/rpc/drivers/Base.py   2006-08-22 11:43:41 UTC (rev 
8587)
@@ -232,7 +232,7 @@
   # perform a remote procedure call
   # ---------------------------------------------------------------------------
 
-  def _callMethod_ (self, method, *args, **kwargs):
+  def _callMethod_ (self, method, *args, **params):
     """
     Call a method with the given arguments on the remote side. Descendants
     override this function to do the actual remote procedure call.
@@ -263,7 +263,7 @@
 
   def __init__ (self, adapter, methodname):
     """
-    @param adapter: L{Client} instance implementing a L{_callMethod_} function
+    @param adapter: L{Client} instance implementing a C{_callMethod_} function
     @param methodname: name of the method be called
     """
 

Modified: trunk/gnue-common/src/rpc/drivers/hessian/SimpleHessianServer.py
===================================================================
--- trunk/gnue-common/src/rpc/drivers/hessian/SimpleHessianServer.py    
2006-08-22 08:53:59 UTC (rev 8586)
+++ trunk/gnue-common/src/rpc/drivers/hessian/SimpleHessianServer.py    
2006-08-22 11:43:41 UTC (rev 8587)
@@ -57,7 +57,8 @@
     return u.keys()
 
 class SimpleHessianDispatcher:
-    """Mix-in class that dispatches Hessian requests.
+    """
+    Mix-in class that dispatches Hessian requests.
 
     This class is used to register Hessian method handlers
     and then to dispatch them. There should never be any
@@ -69,7 +70,8 @@
         self.instance = None
 
     def register_instance(self, instance, allow_dotted_names=False):
-        """Registers an instance to respond to Hessian requests.
+        """
+        Registers an instance to respond to Hessian requests.
 
         Only one instance can be installed at a time.
 
@@ -92,13 +94,12 @@
         containing dots are supported and resolved, as long as none of
         the name segments start with an '_'.
 
-            *** SECURITY WARNING: ***
+        *** SECURITY WARNING: ***
 
-            Enabling the allow_dotted_names options allows intruders
-            to access your module's global variables and may allow
-            intruders to execute arbitrary code on your machine.  Only
-            use this option on a secure, closed network.
-
+        Enabling the allow_dotted_names options allows intruders
+        to access your module's global variables and may allow
+        intruders to execute arbitrary code on your machine.  Only
+        use this option on a secure, closed network.
         """
 
         self.instance = instance

Modified: trunk/gnue-common/src/rpc/drivers/hessian/hessianlib.py
===================================================================
--- trunk/gnue-common/src/rpc/drivers/hessian/hessianlib.py     2006-08-22 
08:53:59 UTC (rev 8586)
+++ trunk/gnue-common/src/rpc/drivers/hessian/hessianlib.py     2006-08-22 
11:43:41 UTC (rev 8587)
@@ -542,13 +542,12 @@
     In addition to the data object, the following options can be given
     as keyword arguments:
 
-        methodname: the method name for a call packet
+    @param methodname: the method name for a call packet
+        Unicode strings are automatically converted, where necessary.
 
-        methodresponse: true to create a reply packet.
+    @param methodresponse: true to create a reply packet.
         If this option is used with a tuple, the tuple must be
         a singleton (i.e. it can contain only one element).
-
-    Unicode strings are automatically converted, where necessary.
     """
 
     assert isinstance(params, TupleType) or isinstance(params, Fault),\
@@ -705,7 +704,7 @@
 
     The following options can be given as keyword arguments:
 
-        transport: a transport factory
+    transport: a transport factory
     """
 
     def __init__(self, uri, transport=None, verbose=0):

Modified: trunk/gnue-common/src/utils/tree.py
===================================================================
--- trunk/gnue-common/src/utils/tree.py 2006-08-22 08:53:59 UTC (rev 8586)
+++ trunk/gnue-common/src/utils/tree.py 2006-08-22 11:43:41 UTC (rev 8587)
@@ -30,6 +30,7 @@
 import locale
 
 from gnue.common.apps import errors
+from gnue.common.apps.i18n import utranslate as u_      # for epydoc
 
 __all__ = ['CircularReferenceError', 'DuplicateChildNameError',
         'DuplicateDescendantNameError', 'NodeDictNotAvailableError',

Modified: trunk/gnue-common/src/utils/uuid.py
===================================================================
--- trunk/gnue-common/src/utils/uuid.py 2006-08-22 08:53:59 UTC (rev 8586)
+++ trunk/gnue-common/src/utils/uuid.py 2006-08-22 11:43:41 UTC (rev 8587)
@@ -92,7 +92,7 @@
     No namespace given for SHA1-/MD5-based UUIDs.
 
     MD5- and SHA1-based UUIDs must have a namespace defined. Use
-    L{set_namespace} to define this value.
+    L{Generator.set_namespace} to define this value.
     """
     def __init__(self):
         msg = u_("No namespace given for namebased UUID generation")