src/__init__.py

   1 #!/usr/bin/env python
   2 #-*- coding:utf-8 -*-
   3 #  Copyright (C) 2010-2013  CEA/DEN
   4 #
   5 #  This library is free software; you can redistribute it and/or
   6 #  modify it under the terms of the GNU Lesser General Public
   7 #  License as published by the Free Software Foundation; either
   8 #  version 2.1 of the License.
   9 #
  10 #  This library is distributed in the hope that it will be useful,
  11 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 #  Lesser General Public License for more details.
  14 #
  15 #  You should have received a copy of the GNU Lesser General Public
  16 #  License along with this library; if not, write to the Free Software
  17 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18
  19 import os
  20 import shutil
  21 import errno
  22 import stat
  23
  24 from . import pyconf
  25 from . import architecture
  26 from . import printcolors
  27 from . import options
  28 from . import system
  29 from . import ElementTree
  30 from . import logger
  31 from . import product
  32
  33 OK_STATUS = "OK"
  34 KO_STATUS = "KO"
  35 NA_STATUS = "NA"
  36
  37 class SatException(Exception):
  38     '''rename Exception Class
  39     '''
  40     pass
  41
  42 def ensure_path_exists(p):
  43     '''Create a path if not existing
  44
  45     :param p str: The path.
  46     '''
  47     if not os.path.exists(p):
  48         os.makedirs(p)
  49
  50 def check_config_has_application( config, details = None ):
  51     '''check that the config has the key APPLICATION. Else raise an exception.
  52
  53     :param config class 'common.pyconf.Config': The config.
  54     '''
  55     if 'APPLICATION' not in config:
  56         message = _("An APPLICATION is required. Use 'config --list' to get"
  57                     " the list of available applications.\n")
  58         if details :
  59             details.append(message)
  60         raise SatException( message )
  61
  62 def config_has_application( config ):
  63     return 'APPLICATION' in config
  64
  65 def print_info(logger, info):
  66     '''Prints the tuples that are in info variable in a formatted way.
  67
  68     :param logger Logger: The logging instance to use for the prints.
  69     :param info list: The list of tuples to display
  70     '''
  71     # find the maximum length of the first value of the tuples in info
  72     smax = max(map(lambda l: len(l[0]), info))
  73     # Print each item of info with good indentation
  74     for i in info:
  75         sp = " " * (smax - len(i[0]))
  76         printcolors.print_value(logger, sp + i[0], i[1], 2)
  77     logger.write("\n", 2)
  78
  79 ##
  80 # Utils class to simplify path manipulations.
  81 class Path:
  82     def __init__(self, path):
  83         self.path = str(path)
  84
  85     def __add__(self, other):
  86         return Path(os.path.join(self.path, str(other)))
  87
  88     def __abs__(self):
  89         return Path(os.path.abspath(self.path))
  90
  91     def __str__(self):
  92         return self.path
  93
  94     def __eq__(self, other):
  95         return self.path == other.path
  96
  97     def exists(self):
  98         return self.islink() or os.path.exists(self.path)
  99
 100     def islink(self):
 101         return os.path.islink(self.path)
 102
 103     def isdir(self):
 104         return os.path.isdir(self.path)
 105
 106     def list(self):
 107         return [Path(p) for p in os.listdir(self.path)]
 108
 109     def dir(self):
 110         return Path(os.path.dirname(self.path))
 111
 112     def base(self):
 113         return Path(os.path.basename(self.path))
 114
 115     def make(self, mode=None):
 116         os.makedirs(self.path)
 117         if mode:
 118             os.chmod(self.path, mode)
 119
 120     def chmod(self, mode):
 121         os.chmod(self.path, mode)
 122
 123     def rm(self):
 124         if self.islink():
 125             os.remove(self.path)
 126         else:
 127             shutil.rmtree( self.path, onerror = handleRemoveReadonly )
 128
 129     def copy(self, path, smart=False):
 130         if not isinstance(path, Path):
 131             path = Path(path)
 132
 133         if os.path.islink(self.path):
 134             return self.copylink(path)
 135         elif os.path.isdir(self.path):
 136             return self.copydir(path, smart)
 137         else:
 138             return self.copyfile(path)
 139
 140     def smartcopy(self, path):
 141         return self.copy(path, True)
 142
 143     def readlink(self):
 144         if self.islink():
 145             return os.readlink(self.path)
 146         else:
 147             return False
 148
 149     def symlink(self, path):
 150         try:
 151             os.symlink(str(path), self.path)
 152             return True
 153         except:
 154             return False
 155
 156     def copylink(self, path):
 157         try:
 158             os.symlink(os.readlink(self.path), str(path))
 159             return True
 160         except:
 161             return False
 162
 163     def copydir(self, dst, smart=False):
 164         try:
 165             names = self.list()
 166
 167             if not dst.exists():
 168                 dst.make()
 169
 170             for name in names:
 171                 if name == dst:
 172                     continue
 173                 if smart and (str(name) in [".git", "CVS", ".svn"]):
 174                     continue
 175                 srcname = self + name
 176                 dstname = dst + name
 177                 srcname.copy(dstname, smart)
 178             return True
 179         except:
 180             return False
 181
 182     def copyfile(self, path):
 183         try:
 184             shutil.copy2(self.path, str(path))
 185             return True
 186         except:
 187             return False
 188
 189 def handleRemoveReadonly(func, path, exc):
 190     excvalue = exc[1]
 191     if func in (os.rmdir, os.remove) and excvalue.errno == errno.EACCES:
 192         os.chmod(path, stat.S_IRWXU| stat.S_IRWXG| stat.S_IRWXO) # 0777
 193         func(path)
 194     else:
 195         raise