Updated with doc strings

ee/cli/plugins/debug.py

@@ -53,6 +53,7 @@ class EEDebugController(CementBaseController):
 
     @expose(hide=True)
     def debug_nginx(self):
+        """Start/Stop Nginx debug"""
         # start global debug
         if self.start and not self.app.pargs.site_name:
             try:
@@ -134,6 +135,7 @@ class EEDebugController(CementBaseController):
 
     @expose(hide=True)
     def debug_php(self):
+        """Start/Stop PHP debug"""
         # PHP global debug start
         if self.start:
             if not (EEShellExec.cmd_exec(self, "sed -n \"/upstream php"
@@ -173,6 +175,7 @@ class EEDebugController(CementBaseController):
 
     @expose(hide=True)
     def debug_fpm(self):
+        """Start/Stop PHP5-FPM debug"""
         # PHP5-FPM start global debug
         if self.start:
             if not EEShellExec.cmd_exec(self, "grep \"log_level = debug\" "
@@ -214,6 +217,7 @@ class EEDebugController(CementBaseController):
 
     @expose(hide=True)
     def debug_mysql(self):
+        """Start/Stop MySQL debug"""
         # MySQL start global debug
         if self.start:
             if not EEShellExec.cmd_exec(self, "mysql -e \"show variables like"
@@ -262,6 +266,7 @@ class EEDebugController(CementBaseController):
 
     @expose(hide=True)
     def debug_wp(self):
+        """Start/Stop WordPress debug"""
         if self.start and self.app.pargs.site_name:
             wp_config = ("{0}{1}/wp-config.php"
                          .format(EEVariables.ee_webroot,
@@ -332,6 +337,7 @@ class EEDebugController(CementBaseController):
 
     @expose(hide=True)
     def debug_rewrite(self):
+        """Start/Stop Nginx rewrite rules debug"""
         # Start Nginx rewrite debug globally
         if self.start and not self.app.pargs.site_name:
             if not EEShellExec.cmd_exec(self, "grep \"rewrite_log on;\" "
@@ -396,6 +402,7 @@ class EEDebugController(CementBaseController):
 
     @expose(hide=True)
     def signal_handler(self, signal, frame):
+        """Handle Ctrl+c hevent for -i option of debug"""
         self.start = False
         if self.app.pargs.nginx:
             self.debug_nginx()
@@ -421,6 +428,7 @@ class EEDebugController(CementBaseController):
 
     @expose(hide=True)
     def default(self):
+        """Default function of debug"""
         self.start = True
         self.interactive = False
         self.msg = []

ee/cli/plugins/import_slow_log.py

@@ -19,6 +19,7 @@ class EEImportslowlogController(CementBaseController):
 
     @expose(hide=True)
     def default(self):
+        """Default function for import slow log"""
         if os.path.isdir("{0}22222/htdocs/db/anemometer"
                          .format(EEVariables.ee_webroot)):
             if os.path.isfile("/var/log/mysql/mysql-slow.log"):

ee/cli/plugins/info.py

@@ -36,6 +36,7 @@ class EEInfoController(CementBaseController):
 
     @expose(hide=True)
     def info_nginx(self):
+        """Display Nginx information"""
         version = os.popen("nginx -v 2>&1 | cut -d':' -f2 | cut -d' ' -f2 | "
                            "cut -d'/' -f2 | tr -d '\n'").read()
         allow = os.popen("grep ^allow /etc/nginx/common/acl.conf | "
@@ -65,6 +66,7 @@ class EEInfoController(CementBaseController):
 
     @expose(hide=True)
     def info_php(self):
+        """Display PHP information"""
         version = os.popen("php -v | head -n1 | cut -d' ' -f2 |"
                            " cut -d'+' -f1 | tr -d '\n'").read
         config = configparser.ConfigParser()
@@ -138,6 +140,7 @@ class EEInfoController(CementBaseController):
 
     @expose(hide=True)
     def info_mysql(self):
+        """Display MySQL information"""
         version = os.popen("mysql -V | awk '{print($5)}' | cut -d ',' "
                            "-f1 | tr -d '\n'").read()
         host = "localhost"
@@ -165,6 +168,7 @@ class EEInfoController(CementBaseController):
 
     @expose(hide=True)
     def default(self):
+        """default function for info"""
         if (not self.app.pargs.nginx and not self.app.pargs.php
            and not self.app.pargs.mysql):
             self.app.pargs.nginx = True

ee/cli/plugins/stack.py

@@ -68,11 +68,12 @@ class EEStackController(CementBaseController):
 
     @expose(hide=True)
     def default(self):
-        # TODO Default action for ee stack command
+        """default action of ee stack command"""
         self.app.args.print_help()
 
     @expose(hide=True)
     def pre_pref(self, apt_packages):
+        """Pre settings to do before installation packages"""
         if set(EEVariables.ee_postfix).issubset(set(apt_packages)):
             Log.info(self, "Pre-seeding Postfix")
             EEShellExec.cmd_exec(self, "echo \"postfix postfix"
@@ -143,6 +144,7 @@ class EEStackController(CementBaseController):
 
     @expose(hide=True)
     def post_pref(self, apt_packages, packages):
+        """Post activity after installation of packages"""
         if len(apt_packages):
             if set(EEVariables.ee_postfix).issubset(set(apt_packages)):
                 EEGit.add(self, ["/etc/postfix"],
@@ -1033,6 +1035,7 @@ class EEStackController(CementBaseController):
 
     @expose(help="Install packages")
     def install(self, packages=[], apt_packages=[], disp_msg=True):
+        """Start installation of packages"""
         self.msg = []
         try:
             # Default action for stack installation
@@ -1225,6 +1228,7 @@ class EEStackController(CementBaseController):
 
     @expose(help="Remove packages")
     def remove(self):
+        """Start removal of packages"""
         apt_packages = []
         packages = []
 
@@ -1312,6 +1316,7 @@ class EEStackController(CementBaseController):
 
     @expose(help="Purge packages")
     def purge(self):
+        """Start purging of packages"""
         apt_packages = []
         packages = []
 

ee/cli/plugins/stack_services.py

@@ -19,6 +19,7 @@ class EEStackStatusController(CementBaseController):
 
     @expose(help="Start stack services")
     def start(self):
+        """Start services"""
         services = []
         if self.app.pargs.nginx:
             Log.debug(self, "nginx service start")
@@ -46,6 +47,7 @@ class EEStackStatusController(CementBaseController):
 
     @expose(help="Stop stack services")
     def stop(self):
+        """Stop services"""
         services = []
         if self.app.pargs.nginx:
             Log.debug(self, "nginx service stop")
@@ -73,6 +75,7 @@ class EEStackStatusController(CementBaseController):
 
     @expose(help="Restart stack services")
     def restart(self):
+        """Restart services"""
         services = []
         if self.app.pargs.nginx:
             Log.debug(self, "nginx service restart")
@@ -100,6 +103,7 @@ class EEStackStatusController(CementBaseController):
 
     @expose(help="Get stack status")
     def status(self):
+        """Status of services"""
         services = []
         if self.app.pargs.nginx:
             Log.debug(self, "nginx service status")
@@ -128,6 +132,7 @@ class EEStackStatusController(CementBaseController):
 
     @expose(help="Reload stack services")
     def reload(self):
+        """Reload service"""
         services = []
         if self.app.pargs.nginx:
             Log.debug(self, "nginx service reload")

ee/core/addswap.py

@@ -13,6 +13,7 @@ class EESwap():
         pass
 
     def add(self):
+        """Swap addition with EasyEngine"""
         if EEVariables.ee_ram < 512:
             if EEVariables.ee_swap < 1000:
                 Log.info(self, "Adding SWAP")

ee/core/checkfqdn.py

@@ -4,6 +4,7 @@ import os
 
 
 def check_fqdn(self, ee_host):
+    """FQDN check with EasyEngine, for mail server hostname must be FQDN"""
     #ee_host=os.popen("hostname -f | tr -d '\n'").read()
     if '.' in ee_host:
         EEVariables.ee_fqdn = ee_host

ee/core/download.py

@@ -11,6 +11,8 @@ class EEDownload():
         pass
 
     def download(self, packages):
+        """Download packages, packges must be list in format of
+        [url, path, package name]"""
         for package in packages:
             url = package[0]
             filename = package[1]
@@ -21,7 +23,8 @@ class EEDownload():
                     os.makedirs(directory)
                 Log.info(self, "Downloading {0:20}".format(pkg_name), end=' ')
                 urllib.request.urlretrieve(url, filename)
-                Log.info(self, "{0}".format("[" + Log.ENDC + "Done" + Log.OKBLUE + "]"))
+                Log.info(self, "{0}".format("[" + Log.ENDC + "Done"
+                                            + Log.OKBLUE + "]"))
             except urllib.error.URLError as e:
                 Log.debug(self, "[{err}]".format(err=str(e.reason)))
                 Log.error(self, "Unable to donwload file, {0}"

ee/core/extract.py

@@ -8,6 +8,7 @@ class EEExtract():
     """Method to extract from tar.gz file"""
 
     def extract(self, file, path):
+        """Function to extract tar.gz file"""
         try:
             tar = tarfile.open(file)
             tar.extractall(path=path)

ee/core/mysql.py

@@ -10,6 +10,7 @@ class EEMysql():
     """Method for MySQL connection"""
 
     def execute(self, statement, errormsg=''):
+        """Get login details from ~/.my.cnf & Execute MySQL query"""
         config = configparser.RawConfigParser()
         cnfpath = expanduser("~")+"/.my.cnf"
         if [cnfpath] == config.read(cnfpath):

ee/core/shellexec.py

@@ -12,6 +12,7 @@ class EEShellExec():
         pass
 
     def cmd_exec(self, command, errormsg=''):
+        """Run shell command from Python"""
         try:
             Log.debug(self, "Running command: {0}".format(command))
             retcode = subprocess.getstatusoutput(command)