Changeset 2902

Timestamp:

Nov 17, 2016, 3:00:24 PM (4 years ago)

Author:

kbut

Message:

add documentation

File:

• lliurex-up/trunk/fuentes/LliurexUpCore.py (modified) (10 diffs)

lliurex-up/trunk/fuentes/LliurexUpCore.py

@@ -22 +22 @@
                 
         def prepareEnvironment(self):
+                '''
+                        This funcion delete all environment and rebuild environment
+                '''
                 if os.path.exists(self.processPath):
                         shutil.rmtree(os.path.join(self.processPath))
@@ -36 +39 @@
 
         def getPackageVersionAvailable(self,package,options=""):
+                '''
+                        Args :
+                                package String
+                                options String
+
+                        return dictionary => result
+                        result : {'installed':String,'candidate':String}
+
+                        Options are Apt options 
+                '''
                 command = "LANG=C apt-cache policy {package} {options}".format(package=package,options=options)
                 p = subprocess.Popen(command,shell=True,stdout=subprocess.PIPE)
@@ -48 +61 @@
                 return {"installed":installed,"candidate":candidate}
 
-        def checkLliurexUpIsUpdated(self):
+        def isLliurexUpIsUpdated(self):
+                '''
+                        return Boolean 
+                '''
                 sourceslistDefaultPath = os.path.join(self.processSourceslist,'default')
                 options = ""
@@ -58 +74 @@
 
                 if result['installed'] != result['candidate']:
-                        return "install"
-                return "nothing"
-
-        def installLliurexUp(self):
+                        return False
+                return True
+
+        def installLliurexUp(self,options=""):
+                '''
+                        Args :
+                                options String
+                        return dictionary => result
+                        result : {'returncode':Int,'stdout':String,'stderr':String}
+
+                        options are Apt options
+                        
+
+                        This function install lliurex-up
+                '''
                 command = "LANG=C apt-get install lliurex-up {options}".format(options=options)
                 p = subprocess.Popen(command,shell=True,stdout=subprocess.PIPE)
-                p.communicate()
+                poutput,perror = p.communicate()
+                return {'returncode':p.returncode,'stdout':poutput,'stderrs':perror}
 
         def lliurexMirrorIsUpdated(self):
+                '''
+                        return None | dictionary => result
+                        result : {'status':Boolean,'msg':String,'action':String}
+                        result.msg : message of status
+                        result.action : Action to launch
+                '''
                 if self.haveLliurexMirror and 'server' in self.flavours :
                         result = self.n4d.is_update_available('','MirrorManager',self.defaultMirror)
@@ -73 +107 @@
 
         def lliurexMirrorIsRunning(self):
+                '''
+                        return Boolean
+                '''
                 if self.haveLliurexMirror and 'server' in self.flavours :
                         result = self.n4d.is_alive('','MirrorManager')
@@ -79 +116 @@
 
         def getPercentageLliurexMirror(self):
+                '''
+                        return int | None
+                '''
                 if self.haveLliurexMirror and 'server' in self.flavours:
                         result = self.n4d.get_percentage('','MirrorManager',self.defaultMirror)
@@ -86 +126 @@
         
         def checkFlavour(self):
+                '''
+                        return None|String
+                        If metapackages has been uninstalled, this function return 
+                        package to must install. If return None, you are ok and don't need 
+                        install anything.
+                '''
                 targetMetapackage = None
                 if 'None' in self.flavours:
@@ -101 +147 @@
 
         def canConnectToLliurexNet(self):
+                '''
+                        return Boolean
+                '''
                 s =  socket.socket(socket.AF_INET, socket.SOCK_STREAM)
                 host = socket.gethostbyname('lliurex.net')
@@ -110 +159 @@
 
         def getLliurexVersion(self):
+                '''
+                        return dictionary => result
+                        result : {'installed':String,'candidate':String}
+                '''
                 sourceslistDefaultPath = os.path.join(self.processSourceslist,'default')
                 options = ""
@@ -119 +172 @@
 
         def getPackagesToUpdate(self):
+                '''
+                        packageInfo definition
+                        {
+                                'PACKAGENAME' : {
+                                                'install' : 'INSTALLEDVERSION',
+                                                'candidate' : 'CANDIDATEVERSION',
+                                                'icon' : 'ICONNAME',
+                                                'changelog' : 'CHANGELOGTEXT'
+                                }
+                        }
+                '''
                 packageInfo = {}
                 subprocess.Popen("LANG=C apt-get update",shell=True).communicate()
-                p = subprocess.Popen('LANG=C apt-get dist-upgrade -sV',shell=True,stdout=subprocess.PIPE)
-                z = p.stdout.readlines()
-                y = [ x.strip() for x in z if x.startswith('Inst') ]
-                r = [ w.replace('Inst ','') for w in y ]
+                psimulate = subprocess.Popen('LANG=C apt-get dist-upgrade -sV',shell=True,stdout=subprocess.PIPE)
+                rawoutputpsimulate = psimulate.stdout.readlines()
+                rawpackagestoinstall = [ aux.strip() for aux in rawoutputpsimulate if aux.startswith('Inst') ]
+                r = [ aux.replace('Inst ','') for aux in rawpackagestoinstall ]
                 for allinfo in r :
-                        packageInfo[allinfo.split(' ')[0]] = ' '.join(allinfo.split(' ')[1:])
-                
-
-
+                        packageInfo[allinfo.split(' ')[0]] = {}
+                        packageInfo[allinfo.split(' ')[0]]['raw'] = ' '.join(allinfo.split(' ')[1:])
+
+                for package in packageInfo:
+                        raw = packageInfo[package]['raw'].split(' ')
+                        if raw[0].startswith('['):
+                                packageInfo[package]['install'] = raw[0][1:-1]
+                                packageInfo[package]['candidate'] = raw[1][1:]
+                        elif raw[0].startswith('('):
+                                packageInfo[package]['install'] = None
+                                packageInfo[package]['candidate'] = raw[0][1:]
+                        packageInfo[package].pop('raw')