Changeset 127

Timestamp:

12/27/05 05:23:32

Author:

fenix

Message:

add docstrings to all classes and functions

Files:

• ShortMessage/trunk/Extensions/Install.py (modified) (3 diffs)
• ShortMessage/trunk/Extensions/Sm_Workflow.py (modified) (5 diffs)
• ShortMessage/trunk/HISTORY.txt (modified) (1 diff)
• ShortMessage/trunk/INSTALL.txt (modified) (1 diff)
• ShortMessage/trunk/README.txt (modified) (1 diff)
• ShortMessage/trunk/ShortMessage.py (modified) (2 diffs)
• ShortMessage/trunk/__init__.py (modified) (2 diffs)
• ShortMessage/trunk/tests/testSm.py (modified) (1 diff)
• ShortMessage/trunk/validators.py (modified) (1 diff)
• ShortMessage/trunk/version.txt (modified) (1 diff)

ShortMessage/trunk/Extensions/Install.py

@@ +1 @@
+# Author: Melnychuk Taras
+# Contact: fenix@quintagroup.com
+# Date: $Date: 2005-11-23 13:10:10 +0200 (Thu, 23 Nov 2005) $
+# Copyright: quintagroup.com
+
+"""
+This module is created for installing ShortMessage product to Plone site.
+ It has such functions:
+
+     - `install`: this function sets all types in ShortMessage product, also install skin directory and other
+     - `install_workflow`: this function create new workflow and sets it to ShortMessage type
+     - `setPortalFactoryType`: sets ShortMessage type to PortalFactory
+"""
+__docformat__ = 'restructuredtext'
+
-from Products.Archetypes.public import listTypes
-from Products.Archetypes.Extensions.utils import installTypes, install_subskin
@@ -9 +24 @@
-
-def setPortalFactoryType(self, out,):
+    """sets ShortMessage type to PortalFactory"""
-    pf=getToolByName(self, 'portal_factory')
-    ftypes=list(pf.getFactoryTypes())
@@ -20 +36 @@
-
-def install_workflow(self, out):
-
+
-    setupWorkflow(self)
-    print >> out, "Installed workflow..."
-
-def install(self):
-
+
-    out=StringIO();
-

ShortMessage/trunk/Extensions/Sm_Workflow.py

@@ +1 @@
+# Author: Melnychuk Taras
+# Contact: fenix@quintagroup.com
+# Date: $Date: 2005-11-23 13:33:15 +0200 (Thu, 23 Nov 2005) $
+# Copyright: quintagroup.com
+
+"""
+This is workflow for ShortMessage type that sends SMS upon object publishing.
+This module define the following functions:
+
+    - `createWorkflow`: create new workflow.
+    - `fillWorkflow`: takes created workflow and add to it state, transitions, permissions and etc.
+    - `addWorkflowScripts`: add ExternalMethod named send_publishedMessage to the workflow
+    - `setupWorkflow`: setup created workflow to portal and set it to ShortMessage type
+    - `send_publishedMessage`: Send message if it is published
+"""
+__docformat__ = 'restructuredtext'
+
-from Products.DCWorkflow.DCWorkflow import DCWorkflowDefinition
-from Products.CMFCore.CMFCorePermissions import ModifyPortalContent
@@ -9 +26 @@
-from Products import ShortMessage
-
-#add ExternalMethod named 'send_publishedMessage'
-def addWorkflowScripts(wf):
+    """add ExternalMethod named send_publishedMessage to the workflow"""
-    if 'send_publishedMessage' not in wf.scripts.objectIds():
-        wf.scripts.manage_addProduct['ExternalMethod'].manage_addExternalMethod('send_publishedMessage', 'Send Message', 'ShortMessage.Sm_Workflow', 'send_publishedMessage')
-
-def fillWorkflow(wf):
+    """takes created workflow and add to it state, transitions, permissions and etc"""
-    for state in  ('pending', 'visible', 'published',):
-        wf.states.addState(state)
@@ -35 +53 @@
-    wf_visible.setPermission(p_modify, 0, (r_manager, r_owner))
-
-#    wf.permissions+=(CMFCorePermissions.ListFolderContents, )
-#    wf.states.private.permission_roles[CMFCorePermissions.ListFolderContents]=['Authenticated', r_manager]
-
-    wf_visible = wf.states['pending']
@@ -54 +70 @@
-    wf_published.setPermission(p_modify, 0, (r_manager, ))
-
-#    wf.states.published.permission_roles[CMFCorePermissions.ListFolderContents]=[r_anon,]
-
-    tdef = wf.transitions['submit']
@@ -102 +117 @@
-
-def send_publishedMessage(self, state_change):
-ing
+
-    message_obj = state_change.object
-    #send message to user(s)
-    state_change.getPortal().portal_smsCommunicator.send_Request(message_obj.getSender(), message_obj.getRecipient(), message_obj.getBody())
-
-#create workflow
-def createWorkflow(id):
+    """create new workflow"""
-    wf = DCWorkflowDefinition(id)
-    fillWorkflow(wf)

ShortMessage/trunk/HISTORY.txt

@@ +1 @@
+0.1.4 2005-12-27
+================
+
+ - add docstring to all classes and functions
+ 
-0.1.3 2005-11-14
-================

ShortMessage/trunk/INSTALL.txt

@@ +1 @@
+
+   Product installation
+   ====================
+
+   For installation you must first off all copy ShortMessage
+   to your Products directory, second restart your instance 
+   then go to plone setup->Add/Remove Products and install ShortMessage.

ShortMessage/trunk/README.txt

@@ +1 @@
+Quintagroup ShortMessage
+
+    This product lets you create your own short message in Plone websites.
+    It consists of sender, recipient or recipients, and body(message text).
+    But if you want to send this short message you also need to install
+    PloneSMSCommunicator on your Plone site. If you installed PloneSMSCommunicator
+    then you can send your message to somebody. For that you must do three things:
+        - you must create new short message or select old one
+        - change state from visible to submit
+        - and the last step that is sending message to recipient is:
+          you have to publish your message and for that you must have manager rights

ShortMessage/trunk/ShortMessage.py

@@ +1 @@
+# Author: Melnychuk Taras
+# Contact: fenix@quintagroup.com
+# Date: $Date: 2005-11-23 12:57:23 +0200 (Thu, 23 Nov 2005) $
+# Copyright: quintagroup.com
+
+"""ShortMessage is Archetypes-based content type. It has Workflow that sends Short message upon object publishing.
+   This module defines the following classes:
+
+    - `ShortMessage`, a ShortMessage type that allows you to create your own short message
+   Methods:
+    - `ShortMessage.setDefaultSender`: sets none to Sender field if policy is free and enforceOriginator in other case"""
+
+__docformat__ = 'restructuredtext'
+
-from Products.CMFCore.utils import getToolByName
-from Products.Archetypes.public import *
@@ -36 +50 @@
-
-class ShortMessage(BaseContent):
-
+
-    schema = schema
-    archetype_name=ARCHETYPE_NAME
-
-    def setDefaultSender(self):
+        """ sets none to Sender field if policy is free and enforceOriginator in other case"""
-        communicator = getToolByName(self, 'portal_smsCommunicator')
-        policy = communicator.getProperty('policy')

ShortMessage/trunk/__init__.py

@@ +1 @@
+# Author: Melnychuk Taras
+# Contact: fenix@quintagroup.com
+# Date: $Date: 2005-11-23 13:10:22 +0200 (Thu, 23 Nov 2005) $
+# Copyright: quintagroup.com
+
+"""
+This is the init module for ShortMessage product that will initialize all
+types in product.
+"""
+__docformat__ = 'restructuredtext'
+
-from Products.Archetypes.public import *
-from Products.CMFCore import utils
@@ -4 +15 @@
-from config import *
-
-#registerDirectory(SKINS_DIR, GLOBALS)
-
-def initialize(context):

ShortMessage/trunk/tests/testSm.py

@@ +1 @@
+# Author: Melnychuk Taras
+# Contact: fenix@quintagroup.com
+# Date: $Date: 2005-11-23 13:47:40 +0200 (Thu, 23 Nov 2005) $
+# Copyright: quintagroup.com
+
+"""This module contains class that tests short message """
+
-from Testing import ZopeTestCase
-from Products.Archetypes.tests import ArchetypesTestCase

ShortMessage/trunk/validators.py

@@ +1 @@
+# Author: Melnychuk Taras
+# Contact: fenix@quintagroup.com
+# Date: $Date: 2005-11-23 13:15:21 +0200 (Thu, 23 Nov 2005) $
+# Copyright: quintagroup.com
+
+"""In this module define MaxSmValidator class that validate text block not more then 160 symbols"""
+
+__docformat__ = 'restructuredtext'
+
-from Products.validation.interfaces.IValidator import IValidator
-
-class MaxSmValidator:
-    """validator for short message"""
-
-    __implements__ = IValidator

ShortMessage/trunk/version.txt

@@ -1 @@
-3
+4