using decode('utf8') to get docstrings. devel
authorSandro Knauß <knauss@netzguerilla.net>
Sun, 18 Dec 2011 11:49:12 +0100
branchdevel
changeset 76 9f7da8dc8df8
parent 75 c6a281dafa7a
child 77 7dce6c0f06fb
using decode('utf8') to get docstrings.
createdoc.py
iro/newuser.py
iro/user.py
--- a/createdoc.py	Fri Dec 09 15:39:29 2011 +0100
+++ b/createdoc.py	Sun Dec 18 11:49:12 2011 +0100
@@ -12,6 +12,7 @@
 
 
 
+
 class Link():
     def __init__(self,name,title):
         self.name=name
@@ -59,7 +60,7 @@
 
 
 def keywords(f):
-    doc=f.__doc__
+    doc=f.__doc__.decode('utf8')
     kwds=re.search("Keywords:\n(?P<keywords>(?P<whitespace>\s*)(.+\n)*)\n",doc)
     k=kwds.group("keywords")
     #get rid of beginning whitespaces
@@ -67,7 +68,7 @@
     return section(k)
 
 def ret(f):
-    doc=f.__doc__
+    doc=f.__doc__.decode('utf8')
     kwds=re.search("Return:\n(?P<ret>(?P<whitespace>\s*)(.+\n)*)\n",doc)
     k=kwds.group("ret")
     #get rid of beginning whitespaces
@@ -94,7 +95,7 @@
         (args, varargs, keywords, defaults)=inspect.getargspec(m)
         args= [b for b in args if b is not "self"]
         self.func_line=inspect.formatargspec(args, varargs, keywords, defaults)
-        self.description = m.__doc__.split("\n")[0]
+        self.description = m.__doc__.split("\n")[0].decode("utf8")
         self.args=[Arg(a,m) for a in args]
         _, self.rets=ret(m)
 
--- a/iro/newuser.py	Fri Dec 09 15:39:29 2011 +0100
+++ b/iro/newuser.py	Sun Dec 18 11:49:12 2011 +0100
@@ -12,12 +12,11 @@
 #along with this program; if not, see <http://www.gnu.org/licenses/>.
 
 class User: 
-    '''
-    class for a xmlrpc user
+    '''class for a xmlrpc user
     '''
     
     def status(self, apikey, id=None, detailed=False):
-        u'''Gibt den aktuellen Status eines Auftrages zurück.
+        '''Gibt den aktuellen Status eines Auftrages zurück.
 
         Keywords:
         apikey[string]: Der API Key
@@ -34,7 +33,7 @@
         pass
 
     def stop(self, apikey,id):
-        u'''Stoppt den angegeben Auftrag.
+        '''Stoppt den angegeben Auftrag.
 
         Keywords:
         apikey[string]: Der API Key
@@ -46,7 +45,7 @@
         pass
     
     def sms(self, apikey, message, recipients, route="default"):
-        u'''Versendet eine SMS.
+        '''Versendet eine SMS.
 
         Keywords:
         apikey[string]: Der API Key
@@ -63,7 +62,7 @@
    
     
     def fax(self, apikey, subject, fax, recipients, route="default"):
-        u'''Versendet ein FAX.
+        '''Versendet ein FAX.
 
         Keywords:
         apikey[string]: Der API Key
@@ -80,7 +79,7 @@
         pass
 
     def mail(self, apikey, subject,  body, recipients, frm, route="default"):
-        u'''Versendet eine Email.
+        '''Versendet eine Email.
 
         Keywords:
         apikey[string]: Der API Key
@@ -98,7 +97,7 @@
         pass
        
     def routes(self, apikey, typ):
-        u'''Gibt eine Liste aller verfügbaren Provider zurück.
+        '''Gibt eine Liste aller verfügbaren Provider zurück.
 
         Keywords:
         apikey[string]: Der API Key
@@ -112,7 +111,7 @@
         pass
         
     def defaultRoute(self, apikey, typ):
-        u'''Gibt den Standardprovider zurück.
+        '''Gibt den Standardprovider zurück.
  
         Keywords:
         apikey[string]: Der API Key
@@ -127,7 +126,7 @@
         pass
 
     def statistic(self,apikey):
-        u'''Gibt eine Statik zurück über die versendendeten Nachrichten und des Preises.
+        '''Gibt eine Statik zurück über die versendendeten Nachrichten und des Preises.
 
         Keywords:
         apikey[string]: Der API Key
--- a/iro/user.py	Fri Dec 09 15:39:29 2011 +0100
+++ b/iro/user.py	Sun Dec 18 11:49:12 2011 +0100
@@ -28,8 +28,7 @@
 
 
 class User: 
-    '''
-    class for a xmlrpc user
+    '''class for a xmlrpc user
     '''
     def __init__(self, name, jobqueue):
         self.jobqueue=jobqueue
@@ -38,7 +37,7 @@
         self.features=["mail", "sms", "fax", ]
 
     def status(self,id=None,detailed=False):
-        u'''Gibt den aktuellen Status eines Auftrages zurück.
+        '''Gibt den aktuellen Status eines Auftrages zurück.
 
         Keywords:
         id[hash]: Eine Auftragsnummer
@@ -75,7 +74,7 @@
             return {}
 
     def stop(self,id):
-        u'''Stoppt den angegeben Auftrag.
+        '''Stoppt den angegeben Auftrag.
 
         Keywords:
         id[hash]: Eine Auftragsnummer
@@ -92,7 +91,7 @@
 
     
     def startSMS(self, message, recipients, provider="default"):
-        u'''Versendet eine SMS.
+        '''Versendet eine SMS.
 
         Keywords:
         message[string]: Nachricht
@@ -111,7 +110,7 @@
     
     
     def startFAX(self, subject, fax, recipients, provider="default"):
-        u'''Versendet ein FAX.
+        '''Versendet ein FAX.
 
         Keywords:
         subject[string]: der Betreff
@@ -136,7 +135,7 @@
         return id
 
     def startMail(self, subject,  body, recipients, frm, provider="default"):
-        u'''Versendet eine Email.
+        '''Versendet eine Email.
 
         Keywords:
         subject[string]: der Betreff
@@ -157,7 +156,7 @@
         return id    
        
     def getProvider(self, typ):
-        u'''Gibt eine Liste aller verfügbaren Provider zurück.
+        '''Gibt eine Liste aller verfügbaren Provider zurück.
 
         Keywords:
         typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll
@@ -173,7 +172,7 @@
         return self.jobqueue.providerlist.getProviderlist(typ)
         
     def getDefaultProvider(self, typ):
-        u'''Gibt den Standardprovider zurück.
+        '''Gibt den Standardprovider zurück.
  
         Keywords:
         typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll