[Checkins] SVN: grokcore.message/trunk/ The utility function ``send`` now takes a ``name`` argument.

Souheil CHELFOUH souheil at chelfouh.com
Wed Mar 3 17:04:18 EST 2010


Log message for revision 109630:
  The utility function ``send`` now takes a ``name`` argument.
  Made it release ready
  

Changed:
  U   grokcore.message/trunk/CHANGES.txt
  U   grokcore.message/trunk/setup.py
  U   grokcore.message/trunk/src/grokcore/message/README.txt
  U   grokcore.message/trunk/src/grokcore/message/utils.py

-=-
Modified: grokcore.message/trunk/CHANGES.txt
===================================================================
--- grokcore.message/trunk/CHANGES.txt	2010-03-03 22:02:30 UTC (rev 109629)
+++ grokcore.message/trunk/CHANGES.txt	2010-03-03 22:04:18 UTC (rev 109630)
@@ -1,13 +1,14 @@
 CHANGES
 *******
 
-0.2 (unreleased)
+0.2 (2010-03-03)
 ================
 
-* ...
+* The utility function ``send`` now takes a ``name`` argument,
+  allowing the choice of the target message source.
 
 0.1 (2010-03-03)
 ================
 
-Factored out from former versions of ``grokui.admin``, ``grok`` and
-``megrok.layout`` respectively.
+* Factored out from former versions of ``grokui.admin``, ``grok`` and
+  ``megrok.layout`` respectively.

Modified: grokcore.message/trunk/setup.py
===================================================================
--- grokcore.message/trunk/setup.py	2010-03-03 22:02:30 UTC (rev 109629)
+++ grokcore.message/trunk/setup.py	2010-03-03 22:04:18 UTC (rev 109630)
@@ -1,7 +1,7 @@
 import os
 from setuptools import setup, find_packages
 
-version = '0.2dev'
+version = '0.2'
 
 readme = open(os.path.join('src', 'grokcore', 'message', 'README.txt')).read()
 changes = open("CHANGES.txt").read()

Modified: grokcore.message/trunk/src/grokcore/message/README.txt
===================================================================
--- grokcore.message/trunk/src/grokcore/message/README.txt	2010-03-03 22:02:30 UTC (rev 109629)
+++ grokcore.message/trunk/src/grokcore/message/README.txt	2010-03-03 22:04:18 UTC (rev 109630)
@@ -123,9 +123,9 @@
 ``grokcore.message`` provides a couple of convenience functions to
 feed sources or get data from them.
 
-**grokcore.message.send(message[, type='message'])**
+**grokcore.message.send(message[, type='message'[, name='session']])**
 
-  Send ``message`` to the session based source (named 'session').
+  Send ``message`` to the message source ``name``.
 
   Returns ``True`` if the message could be sent
   successfully. Otherwise ``False`` is returned:
@@ -134,6 +134,9 @@
     >>> grokcore.message.send('Meet at dawn!')
     True
 
+    >>> grokcore.message.send('grok sucks', name='doesnotexist')
+    False
+
 **grokcore.message.get_from_source([name=''])**
 
   Get a list of messages stored at message source registered under

Modified: grokcore.message/trunk/src/grokcore/message/utils.py
===================================================================
--- grokcore.message/trunk/src/grokcore/message/utils.py	2010-03-03 22:02:30 UTC (rev 109629)
+++ grokcore.message/trunk/src/grokcore/message/utils.py	2010-03-03 22:04:18 UTC (rev 109630)
@@ -4,13 +4,13 @@
 from grokcore.message import IMessageSource, IMessageReceiver
 
 
-def send(message, type='message'):
+def send(message, type='message', name='session'):
     """Adds a short message to a given source.
 
     If the message has been sent with success, True is returned.
     Otherwise, False is returned.
     """
-    source = queryUtility(IMessageSource, name='session')
+    source = queryUtility(IMessageSource, name=name)
     if source is None:
         return False
     source.send(message, type)



More information about the checkins mailing list