Kommentare hinzugefügt

src/ems.py

@@ -14,6 +14,13 @@ c = Config()
 conf = c.readConf()
 
 def startSwitch():
+    '''
+    Create a thread of the switch with the Module MYSQL
+
+    @return switch: Obejct of the switch
+    @return queue: Queue object for results
+    @retunn query: Queue object for querys
+    '''
     switch = Switch(MYSQL)
     queue, query = switch.initialisiere()
 
@@ -26,14 +33,21 @@ def startSwitch():
     return switch, queue, query
 
 def update_device(query, queue, buf):
-        keys = buf.system['device'].keys()
-        for key in keys:
-            if key.startswith("000"):
-                continue
-            query.put('/device/%s' % key)
-            get = buf.update_buffer(queue.get())
-            #print 'GET:\t', get
-        #sleep(0.1)
+    '''
+    update all devices witch have tables in the DB
+
+    @param query: queue for querys
+    @param queue: queue for results
+    @param buf: Buffer object witch is updated
+    '''
+    keys = buf.system['device'].keys()
+    for key in keys:
+        if key.startswith("000"):
+            continue
+        query.put('/device/%s' % key)
+        get = buf.update_buffer(queue.get())
+        #print 'GET:\t', get
+    #sleep(0.1)
 
 class ems(Thread):
     def __init__(self, buf):
@@ -67,6 +81,8 @@ class ems(Thread):
         return tmp
 
     def getRequest(self):
+        '''
+        '''
         try:
             req = self.buffer.system['request'].pop()
             self.query.put(req.content)

src/pCharger.py

@@ -1,7 +1,7 @@
 '''
 Created on 16.01.2014
 
-@author: rauchp
+@author: Philipp Rauch
 '''
 import csv
 from datetime import datetime
@@ -12,12 +12,24 @@ sqlnor = "INSERT INTO %s (DateTime,Type,cardnumber,customernumber,plug,meterread
 folder = 'pCharger'
 
 def clean(list):
+    '''
+    Cleans every strings in a list with the strip() Method
+
+    @param list: all elements musst strings
+    @return list: a list with clean strings
+    '''
     for i in range(0, len(list)):
         list[i] = list[i].strip()
         #list[i] = list[i].strip('\xef\xbb\xbf')
     return list
 
 def makeDatetime(time):
+    '''
+    create a datetime object from a string
+
+    @param: time: string with timeformat(dd.mm.yyy HH:MM:SS)
+    @return: datetime object
+    '''
     tmp = []
     time = time.split(' ')
     time[0] = time[0].split('.')
@@ -32,6 +44,11 @@ def makeDatetime(time):
     return datetime(tmp[0], tmp[1], tmp[2], tmp[3], tmp[4], tmp[5]).__str__()
 
 def generateSQL(folder):
+    '''
+    generate SQL commands of all pCarger csv documents in a folder
+
+    @param folder: path to the folder containing pCarger csv files
+    '''
     ordner = os.listdir(folder)
     for datei in ordner:
         path = "%s/%s" % (folder, datei)