added docstrings

Author: harshadyeola

ee/core/apt_repo.py

@@ -12,6 +12,14 @@ def __init__(self):
         pass
 
     def add(self, repo_url=None, ppa=None):
+        """
+        This function used to add apt repositories and or ppa's
+        If repo_url is provided adds repo file to
+            /etc/apt/sources.list.d/
+        If ppa is provided add apt-repository using
+            add-apt-repository
+        command.
+        """
 
         if repo_url is not None:
             repo_file_path = ("/etc/apt/sources.list.d/"
@@ -43,12 +51,23 @@ def add(self, repo_url=None, ppa=None):
                                            "'{ppa_name}'"
                                      .format(ppa_name=ppa))
 
-    def remove(self, repo_url=None):
+    def remove(self, ppa=None):
+        """
+        This function used to remove ppa's
+        If ppa is provided adds repo file to
+            /etc/apt/sources.list.d/
+        command.
+        """
         EEShellExec.cmd_exec(self, "add-apt-repository -y "
                              "--remove '{ppa_name}'"
                              .format(ppa_name=repo_url))
 
     def add_key(self, keyids, keyserver=None):
+        """
+        This function adds imports repository keys from keyserver.
+        default keyserver is hkp://keys.gnupg.net
+        user can provide other keyserver with keyserver="hkp://xyz"
+        """
         if keyserver is None:
             EEShellExec.cmd_exec(self, "gpg --keyserver {serv}"
                                  .format(serv=(keyserver or

ee/core/aptget.py

@@ -10,6 +10,9 @@ class EEAptGet():
     """Generic apt-get intialisation"""
 
     def update(self):
+        """
+        Similar to `apt-get upgrade`
+        """
         try:
             apt_cache = apt.cache.Cache()
             apt_cache.update()
@@ -22,6 +25,9 @@ def update(self):
             Log.error(self, 'AttributeError: ' + str(e))
 
     def dist_upgrade():
+        """
+        Similar to `apt-get upgrade`
+        """
         apt_cache = apt.cache.Cache()
         apt_cache.update()
         apt_cache.open(None)
@@ -33,7 +39,9 @@ def dist_upgrade():
         return success
 
     def install(self, packages):
-        """Installation of packages"""
+        """
+        Similar to `apt-get install`
+        """
         apt_pkg.init()
         # #apt_pkg.PkgSystemLock()
         global apt_cache
@@ -79,6 +87,10 @@ def install_package(self, package_name):
                 continue
 
     def remove(self, packages, auto=False, purge=False):
+        """
+            Similar to `apt-get remove/purge`
+            purge packages if purge=True
+        """
         apt_pkg.init()
         # apt_pkg.PkgSystemLock()
         global apt_cache
@@ -122,13 +134,19 @@ def remove_package(self, package_name, purge=False):
                 continue
 
     def auto_clean(self):
+        """
+        Similar to `apt-get autoclean`
+        """
         try:
             apt_get.autoclean("-y")
         except ErrorReturnCode as e:
             Log.debug(self, "{0}".format(e))
             Log.error(self, "Unable to apt-get autoclean")
 
     def auto_remove(self):
+        """
+        Similar to `apt-get autoremove`
+        """
         try:
             Log.debug(self, "Running apt-get autoremove")
             apt_get.autoremove("-y")
@@ -137,6 +155,10 @@ def auto_remove(self):
             Log.error(self, "Unable to apt-get autoremove")
 
     def is_installed(self, package_name):
+        """
+        Checks if package is available in cache and is installed or not
+        returns True if installed otherwise returns False
+        """
         apt_cache = apt.cache.Cache()
         apt_cache.open()
         if (package_name.strip() in apt_cache and

ee/core/database.py

@@ -13,6 +13,9 @@
 
 
 def init_db():
+    """
+    Initializes and creates all tables from models into the database
+    """
     # import all modules here that might define models so that
     # they will be registered properly on the metadata.  Otherwise
     # you will have to import them first before calling init_db()

ee/core/domainvalidate.py

@@ -3,6 +3,10 @@
 
 
 def ValidateDomain(url):
+    """
+        This function returns domain name removing http:// and https://
+        returns domain name only with or without www as user provided.
+    """
 
     # Check if http:// or https://  present remove it if present
     domain_name = url.split('/')

ee/core/fileutils.py

@@ -10,11 +10,12 @@
 
 
 class EEFileUtils():
-    """Method to operate on files"""
+    """Utilities to operate on files"""
     def __init__():
         pass
 
     def remove(self, filelist):
+        """remove files from given path"""
         for file in filelist:
             if os.path.isfile(file):
                 Log.info(self, "Removing {0:65}".format(file), end=' ')
@@ -33,6 +34,10 @@ def remove(self, filelist):
                     Log.error(self, 'Unable to Remove file ')
 
     def create_symlink(self, paths, errormsg=''):
+        """
+        Create symbolic links provided in list with first as source
+        and second as destination
+        """
         src = paths[0]
         dst = paths[1]
         if not os.path.islink(dst):
@@ -45,13 +50,21 @@ def create_symlink(self, paths, errormsg=''):
             Log.debug(self, "Destination: {0} exists".format(dst))
 
     def remove_symlink(self, filepath):
+        """
+            Removes symbolic link for the path provided with filepath
+        """
         try:
             os.unlink(filepath)
         except Exception as e:
             Log.debug(self, "{0}".format(e))
             Log.error(self, "Unable to reomove symbolic link ...\n")
 
     def copyfile(self, src, dest):
+        """
+        Copies files:
+            src : source path
+            dest : destination path
+        """
         try:
             shutil.copy2(src, dest)
         except shutil.Error as e:
@@ -64,6 +77,12 @@ def copyfile(self, src, dest):
                       .fromat(src, dest))
 
     def searchreplace(self, fnm, sstr, rstr):
+        """
+            Search replace strings in file
+            fnm : filename
+            sstr: search string
+            rstr: replace string
+        """
         try:
             for line in fileinput.input(fnm, inplace=True):
                 print(line.replace(sstr, rstr), end='')
@@ -74,6 +93,11 @@ def searchreplace(self, fnm, sstr, rstr):
                       .format(fnm, sstr, rstr))
 
     def mvfile(self, src, dst):
+        """
+            Moves file from source path to destination path
+            src : source path
+            dst : Destination path
+        """
         try:
             Log.debug(self, "Moving file from {0} to {1}".format(src, dst))
             shutil.move(src, dst)
@@ -83,13 +107,25 @@ def mvfile(self, src, dst):
                       .format(src, dst))
 
     def chdir(self, path):
+        """
+            Change Directory to path specified
+            Path : path for destination directory
+        """
         try:
             os.chdir(path)
         except OSError as e:
             Log.debug(self, "{err}".format(err=e.strerror))
             Log.error(self, 'Unable to Change Directory {0}'.format(path))
 
     def chown(self, path, user, group, recursive=False):
+        """
+            Change Owner for files
+            change owner for file with path specified
+            user: username of owner
+            group: group of owner
+            recursive: if recursive is True change owner for all
+                       files in directory
+        """
         userid = pwd.getpwnam(user)[2]
         groupid = pwd.getpwnam(user)[3]
         try:
@@ -111,6 +147,12 @@ def chown(self, path, user, group, recursive=False):
             Log.error(self, "Unable to change owner : {0} ".format(path))
 
     def chmod(self, path, perm, recursive=False):
+        """
+            Changes Permission for files
+            path : file path permission to be changed
+            perm : permissions to be given
+            recursive: change permission recursively for all files
+        """
         try:
             if recursive:
                 for root, dirs, files in os.walk(path):
@@ -125,13 +167,21 @@ def chmod(self, path, perm, recursive=False):
             Log.error(self, "Unable to change owner : {0}".format(path))
 
     def mkdir(self, path):
+        """
+            create directories.
+            path : path for directory to be created
+            Similar to `mkdir -p`
+        """
         try:
             os.makedirs(path)
         except OSError as e:
             Log.debug(self, "{0}".format(e.strerror))
             Log.error(self, "Unable to create directory {0} ".format(path))
 
     def isexist(self, path):
+        """
+            Check if file exist on given path
+        """
         try:
             if os.path.exists(path):
                 return (True)
@@ -142,6 +192,9 @@ def isexist(self, path):
             Log.error(self, "Unable to check path {0}".format(path))
 
     def grep(self, fnm, sstr):
+        """
+            Searches for string in file and returns the matched line.
+        """
         try:
             for line in open(fnm):
                 if sstr in line:
@@ -152,6 +205,9 @@ def grep(self, fnm, sstr):
                       .format(sstr, fnm))
 
     def rm(self, path):
+        """
+            Remove files
+        """
         if EEFileUtils.isexist(self, path):
             try:
                 if os.path.isdir(path):

ee/core/git.py

@@ -11,6 +11,10 @@ def ___init__():
         pass
 
     def add(self, paths, msg="Intializating"):
+        """
+            Initializes Directory as repository if not already git repo.
+            and adds uncommited changes automatically
+        """
         for path in paths:
             global git
             git = git.bake("--git-dir={0}/.git".format(path),
@@ -40,6 +44,9 @@ def add(self, paths, msg="Intializating"):
                 Log.debug(self, "EEGit: Path {0} not present".format(path))
 
     def checkfilestatus(self, repo, filepath):
+        """
+            Checks status of file, If its tracked or untracked.
+        """
         global git
         git = git.bake("--git-dir={0}/.git".format(repo),
                        "--work-tree={0}".format(repo))

ee/core/logging.py

@@ -2,6 +2,10 @@
 
 
 class Log:
+    """
+        Logs messages with colors for different messages
+        according to functions
+    """
     HEADER = '\033[95m'
     OKBLUE = '\033[94m'
     OKGREEN = '\033[92m'
@@ -12,16 +16,28 @@ class Log:
     UNDERLINE = '\033[4m'
 
     def error(self, msg):
+        """
+        Logs error into log file
+        """
         print(Log.FAIL + msg + Log.ENDC)
         self.app.log.error(Log.FAIL + msg + Log.ENDC)
         self.app.close(1)
 
     def info(self, msg, end='\n'):
+        """
+        Logs info messages into log file
+        """
         print(Log.OKBLUE + msg + Log.ENDC, end=end)
         self.app.log.info(Log.OKBLUE + msg + Log.ENDC)
 
     def warn(self, msg):
+        """
+        Logs warning into log file
+        """
         self.app.log.warn(Log.BOLD + msg + Log.ENDC)
 
     def debug(self, msg):
+        """
+        Logs debug messages into log file
+        """
         self.app.log.debug(Log.HEADER + msg + Log.ENDC)

ee/core/models.py

@@ -3,6 +3,9 @@
 
 
 class SiteDB(Base):
+    """
+        Databse model for site table
+    """
     __tablename__ = 'sites'
     id = Column(Integer, primary_key=True)
     sitename = Column(String, unique=True)