src/daComposant/daCore/PlatformInfo.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Copyright (C) 2008-2022 EDF R&D
   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 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  20 #
  21 # Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
  22
  23 """
  24     Informations sur le code et la plateforme, et mise à jour des chemins.
  25
  26     La classe "PlatformInfo" permet de récupérer les informations générales sur
  27     le code et la plateforme sous forme de strings, ou d'afficher directement
  28     les informations disponibles par les méthodes. L'impression directe d'un
  29     objet de cette classe affiche les informations minimales. Par exemple :
  30         print(PlatformInfo())
  31         print(PlatformInfo().getVersion())
  32         created = PlatformInfo().getDate()
  33
  34     La classe "PathManagement" permet de mettre à jour les chemins système pour
  35     ajouter les outils numériques, matrices... On l'utilise en instanciant
  36     simplement cette classe, sans meme récupérer d'objet :
  37         PathManagement()
  38
  39     La classe "SystemUsage" permet de  sous Unix les différentes tailles
  40     mémoires du process courant. Ces tailles peuvent être assez variables et
  41     dépendent de la fiabilité des informations du système dans le suivi des
  42     process.
  43 """
  44 __author__ = "Jean-Philippe ARGAUD"
  45 __all__ = []
  46
  47 import os
  48 import sys
  49 import platform
  50 import locale
  51 import logging
  52 import re
  53
  54 # ==============================================================================
  55 class PlatformInfo(object):
  56     """
  57     Rassemblement des informations sur le code et la plateforme
  58     """
  59     def __init__(self):
  60         "Sans effet"
  61         pass
  62
  63     def getName(self):
  64         "Retourne le nom de l'application"
  65         import daCore.version as dav
  66         return dav.name
  67
  68     def getVersion(self):
  69         "Retourne le numéro de la version"
  70         import daCore.version as dav
  71         return dav.version
  72
  73     def getDate(self):
  74         "Retourne la date de création de la version"
  75         import daCore.version as dav
  76         return dav.date
  77
  78     def getYear(self):
  79         "Retourne l'année de création de la version"
  80         import daCore.version as dav
  81         return dav.year
  82
  83     def getSystemInformation(self, __prefix=""):
  84         __msg  = ""
  85         __msg += "\n%s%30s : %s" %(__prefix,"platform.system",platform.system())
  86         __msg += "\n%s%30s : %s" %(__prefix,"sys.platform",sys.platform)
  87         __msg += "\n%s%30s : %s" %(__prefix,"platform.version",platform.version())
  88         __msg += "\n%s%30s : %s" %(__prefix,"platform.platform",platform.platform())
  89         __msg += "\n%s%30s : %s" %(__prefix,"platform.machine",platform.machine())
  90         if len(platform.processor())>0:
  91             __msg += "\n%s%30s : %s" %(__prefix,"platform.processor",platform.processor())
  92         #
  93         if sys.platform.startswith('linux'):
  94             if hasattr(platform, 'linux_distribution'):
  95                 __msg += "\n%s%30s : %s" %(__prefix,
  96                     "platform.linux_distribution",str(platform.linux_distribution()))
  97             elif hasattr(platform, 'dist'):
  98                 __msg += "\n%s%30s : %s" %(__prefix,"platform.dist",str(platform.dist()))
  99         elif sys.platform.startswith('darwin'):
 100             if hasattr(platform, 'mac_ver'):
 101                 __macosxv = {
 102                     '0' : 'Cheetah',      '1' : 'Puma',        '2' : 'Jaguar',
 103                     '3' : 'Panther',      '4' : 'Tiger',       '5' : 'Leopard',
 104                     '6' : 'Snow Leopard', '7' : 'Lion',        '8' : 'Mountain Lion',
 105                     '9' : 'Mavericks',    '10': 'Yosemite',    '11': 'El Capitan',
 106                     '12': 'Sierra',       '13': 'High Sierra', '14': 'Mojave',
 107                     '15': 'Catalina',     '16': 'Big Sur',     '17': 'Monterey',
 108                     }
 109                 for key in __macosxv:
 110                     if (platform.mac_ver()[0].split('.')[1] == key):
 111                         __msg += "\n%s%30s : %s" %(__prefix,
 112                             "platform.mac_ver",str(platform.mac_ver()[0]+"(" + __macosxv[key]+")"))
 113             elif hasattr(platform, 'dist'):
 114                 __msg += "\n%s%30s : %s" %(__prefix,"platform.dist",str(platform.dist()))
 115         elif os.name == 'nt':
 116             __msg += "\n%s%30s : %s" %(__prefix,"platform.win32_ver",platform.win32_ver()[1])
 117         #
 118         __msg += "\n"
 119         __msg += "\n%s%30s : %s" %(__prefix,"platform.python_implementation",platform.python_implementation())
 120         __msg += "\n%s%30s : %s" %(__prefix,"sys.executable",sys.executable)
 121         __msg += "\n%s%30s : %s" %(__prefix,"sys.version",sys.version.replace('\n',''))
 122         __msg += "\n%s%30s : %s" %(__prefix,"sys.getfilesystemencoding",str(sys.getfilesystemencoding()))
 123         __msg += "\n%s%30s : %s" %(__prefix,"locale.getdefaultlocale",str(locale.getdefaultlocale()))
 124         __msg += "\n"
 125         __msg += "\n%s%30s : %s" %(__prefix,"os.cpu_count",os.cpu_count())
 126         if hasattr(os, 'sched_getaffinity'):
 127             __msg += "\n%s%30s : %s" %(__prefix,"len(os.sched_getaffinity(0))",len(os.sched_getaffinity(0)))
 128         else:
 129             __msg += "\n%s%30s : %s" %(__prefix,"len(os.sched_getaffinity(0))","Unsupported on this platform")
 130         __msg += "\n"
 131         __msg += "\n%s%30s : %s" %(__prefix,"platform.node",platform.node())
 132         __msg += "\n%s%30s : %s" %(__prefix,"os.path.expanduser",os.path.expanduser('~'))
 133         return __msg
 134
 135     def getPythonVersion(self):
 136         "Retourne la version de python disponible"
 137         return ".".join([str(x) for x in sys.version_info[0:3]]) # map(str,sys.version_info[0:3]))
 138
 139     def getNumpyVersion(self):
 140         "Retourne la version de numpy disponible"
 141         import numpy.version
 142         return numpy.version.version
 143
 144     def getScipyVersion(self):
 145         "Retourne la version de scipy disponible"
 146         if has_scipy:
 147             __version = scipy.version.version
 148         else:
 149             __version = "0.0.0"
 150         return __version
 151
 152     def getMatplotlibVersion(self):
 153         "Retourne la version de matplotlib disponible"
 154         if has_matplotlib:
 155             __version = matplotlib.__version__
 156         else:
 157             __version = "0.0.0"
 158         return __version
 159
 160     def getGnuplotVersion(self):
 161         "Retourne la version de gnuplotpy disponible"
 162         if has_gnuplot:
 163             __version = Gnuplot.__version__
 164         else:
 165             __version = "0.0"
 166         return __version
 167
 168     def getSphinxVersion(self):
 169         "Retourne la version de sphinx disponible"
 170         if has_sphinx:
 171             __version = sphinx.__version__
 172         else:
 173             __version = "0.0.0"
 174         return __version
 175
 176     def getNloptVersion(self):
 177         "Retourne la version de nlopt disponible"
 178         if has_nlopt:
 179             __version = "%s.%s.%s"%(
 180                 nlopt.version_major(),
 181                 nlopt.version_minor(),
 182                 nlopt.version_bugfix(),
 183                 )
 184         else:
 185             __version = "0.0.0"
 186         return __version
 187
 188     def getSdfVersion(self):
 189         "Retourne la version de sdf disponible"
 190         if has_sdf:
 191             __version = sdf.__version__
 192         else:
 193             __version = "0.0.0"
 194         return __version
 195
 196     def getCurrentMemorySize(self):
 197         "Retourne la taille mémoire courante utilisée"
 198         return 1
 199
 200     def MaximumPrecision(self):
 201         "Retourne la precision maximale flottante pour Numpy"
 202         import numpy
 203         try:
 204             numpy.array([1.,], dtype='float128')
 205             mfp = 'float128'
 206         except Exception:
 207             mfp = 'float64'
 208         return mfp
 209
 210     def MachinePrecision(self):
 211         # Alternative sans module :
 212         # eps = 2.38
 213         # while eps > 0:
 214         #     old_eps = eps
 215         #     eps = (1.0 + eps/2) - 1.0
 216         return sys.float_info.epsilon
 217
 218     def __str__(self):
 219         import daCore.version as dav
 220         return "%s %s (%s)"%(dav.name,dav.version,dav.date)
 221
 222 # ==============================================================================
 223 try:
 224     import scipy
 225     import scipy.version
 226     import scipy.optimize
 227     has_scipy = True
 228 except ImportError:
 229     has_scipy = False
 230
 231 try:
 232     import matplotlib
 233     has_matplotlib = True
 234 except ImportError:
 235     has_matplotlib = False
 236
 237 try:
 238     import Gnuplot
 239     has_gnuplot = True
 240 except ImportError:
 241     has_gnuplot = False
 242
 243 try:
 244     import sphinx
 245     has_sphinx = True
 246 except ImportError:
 247     has_sphinx = False
 248
 249 try:
 250     import nlopt
 251     has_nlopt = True
 252 except ImportError:
 253     has_nlopt = False
 254
 255 try:
 256     import sdf
 257     has_sdf = True
 258 except ImportError:
 259     has_sdf = False
 260
 261 has_salome = bool( "SALOME_ROOT_DIR" in os.environ )
 262 has_yacs   = bool(   "YACS_ROOT_DIR" in os.environ )
 263 has_adao   = bool(   "ADAO_ROOT_DIR" in os.environ )
 264 has_eficas = bool( "EFICAS_ROOT_DIR" in os.environ )
 265
 266 # ==============================================================================
 267 def uniq( __sequence ):
 268     """
 269     Fonction pour rendre unique chaque élément d'une liste, en préservant l'ordre
 270     """
 271     __seen = set()
 272     return [x for x in __sequence if x not in __seen and not __seen.add(x)]
 273
 274 def isIterable( __sequence, __check = False, __header = "" ):
 275     """
 276     Vérification que l'argument est un itérable interne.
 277     Remarque : pour permettre le test correct en MultiFonctions,
 278     - Ne pas accepter comme itérable un "numpy.ndarray"
 279     - Ne pas accepter comme itérable avec hasattr(__sequence, "__iter__")
 280     """
 281     if  isinstance( __sequence, (list, tuple, map, dict) ):
 282         __isOk = True
 283     elif type(__sequence).__name__ in ('generator','range'):
 284         __isOk = True
 285     elif "_iterator" in type(__sequence).__name__:
 286         __isOk = True
 287     else:
 288         __isOk = False
 289     if __check and not __isOk:
 290         raise TypeError("Not iterable or unkown input type%s: %s"%(__header, type(__sequence),))
 291     return __isOk
 292
 293 def date2int( __date, __lang="FR" ):
 294     """
 295     Fonction de secours, conversion pure : dd/mm/yy hh:mm ---> int(yyyymmddhhmm)
 296     """
 297     __date = __date.strip()
 298     if __date.count('/') == 2 and __date.count(':') == 0 and __date.count(' ') == 0:
 299         d,m,y = __date.split("/")
 300         __number = (10**4)*int(y)+(10**2)*int(m)+int(d)
 301     elif __date.count('/') == 2 and __date.count(':') == 1 and __date.count(' ') > 0:
 302         part1, part2 = __date.split()
 303         d,m,y = part1.strip().split("/")
 304         h,n   = part2.strip().split(":")
 305         __number = (10**8)*int(y)+(10**6)*int(m)+(10**4)*int(d)+(10**2)*int(h)+int(n)
 306     else:
 307         raise ValueError("Cannot convert \"%s\" as a D/M/Y H:M date"%d)
 308     return __number
 309
 310 def strvect2liststr( __strvect ):
 311     """
 312     Fonction de secours, conversion d'une chaîne de caractères de
 313     représentation de vecteur en une liste de chaînes de caractères de
 314     représentation de flottants
 315     """
 316     for s in ("array", "matrix", "list", "tuple", "[", "]", "(", ")"):
 317         __strvect = __strvect.replace(s,"")  # Rien
 318     for s in (",", ";"):
 319         __strvect = __strvect.replace(s," ") # Blanc
 320     return __strvect.split()
 321
 322 def strmatrix2liststr( __strvect ):
 323     """
 324     Fonction de secours, conversion d'une chaîne de caractères de
 325     représentation de matrice en une liste de chaînes de caractères de
 326     représentation de flottants
 327     """
 328     for s in ("array", "matrix", "list", "tuple", "[", "(", "'", '"'):
 329         __strvect = __strvect.replace(s,"")  # Rien
 330     __strvect = __strvect.replace(","," ") # Blanc
 331     for s in ("]", ")"):
 332         __strvect = __strvect.replace(s,";") # "]" et ")" par ";"
 333     __strvect = re.sub(r';\s*;',r';',__strvect)
 334     __strvect = __strvect.rstrip(";") # Après ^ et avant v
 335     __strmat = [__l.split() for __l in __strvect.split(";")]
 336     return __strmat
 337
 338 def checkFileNameConformity( __filename, __warnInsteadOfPrint=True ):
 339     if sys.platform.startswith("win") and len(__filename) > 256:
 340         __conform = False
 341         __msg = (" For some shared or older file systems on Windows, a file "+\
 342             "name longer than 256 characters can lead to access problems."+\
 343             "\n  The name of the file in question is the following:"+\
 344             "\n  %s")%(__filename,)
 345         if __warnInsteadOfPrint: logging.warning(__msg)
 346         else:                    print(__msg)
 347     else:
 348         __conform = True
 349     #
 350     return __conform
 351
 352 def checkFileNameImportability( __filename, __warnInsteadOfPrint=True ):
 353     if str(__filename).count(".") > 1:
 354         __conform = False
 355         __msg = (" The file name contains %i point(s) before the extension "+\
 356             "separator, which can potentially lead to problems when "+\
 357             "importing this file into Python, as it can then be recognized "+\
 358             "as a sub-module (generating a \"ModuleNotFoundError\"). If it "+\
 359             "is intentional, make sure that there is no module with the "+\
 360             "same name as the part before the first point, and that there is "+\
 361             "no \"__init__.py\" file in the same directory."+\
 362             "\n  The name of the file in question is the following:"+\
 363             "\n  %s")%(int(str(__filename).count(".")-1), __filename)
 364         if __warnInsteadOfPrint is None: pass
 365         elif __warnInsteadOfPrint:       logging.warning(__msg)
 366         else:                            print(__msg)
 367     else:
 368         __conform = True
 369     #
 370     return __conform
 371
 372 # ==============================================================================
 373 class PathManagement(object):
 374     """
 375     Mise à jour du path système pour les répertoires d'outils
 376     """
 377     def __init__(self):
 378         "Déclaration des répertoires statiques"
 379         parent = os.path.abspath(os.path.join(os.path.dirname(__file__),".."))
 380         self.__paths = {}
 381         self.__paths["daNumerics"]  = os.path.join(parent,"daNumerics")
 382         #
 383         for v in self.__paths.values():
 384             if os.path.isdir(v): sys.path.insert(0, v )
 385         #
 386         # Conserve en unique exemplaire chaque chemin
 387         sys.path = uniq( sys.path )
 388         del parent
 389
 390     def getpaths(self):
 391         """
 392         Renvoie le dictionnaire des chemins ajoutés
 393         """
 394         return self.__paths
 395
 396 # ==============================================================================
 397 class SystemUsage(object):
 398     """
 399     Permet de récupérer les différentes tailles mémoires du process courant
 400     """
 401     #
 402     # Le module resource renvoie 0 pour les tailles mémoire. On utilise donc
 403     # plutôt : http://code.activestate.com/recipes/286222/ et Wikipedia
 404     #
 405     _proc_status = '/proc/%d/status' % os.getpid()
 406     _memo_status = '/proc/meminfo'
 407     _scale = {
 408         'o'  : 1.0,     # Multiples SI de l'octet
 409         'ko' : 1.e3,
 410         'Mo' : 1.e6,
 411         'Go' : 1.e9,
 412         'kio': 1024.0,  # Multiples binaires de l'octet
 413         'Mio': 1024.0*1024.0,
 414         'Gio': 1024.0*1024.0*1024.0,
 415         'B':     1.0,   # Multiples binaires du byte=octet
 416         'kB' : 1024.0,
 417         'MB' : 1024.0*1024.0,
 418         'GB' : 1024.0*1024.0*1024.0,
 419         }
 420     #
 421     def __init__(self):
 422         "Sans effet"
 423         pass
 424     #
 425     def _VmA(self, VmKey, unit):
 426         "Lecture des paramètres mémoire de la machine"
 427         try:
 428             t = open(self._memo_status)
 429             v = t.read()
 430             t.close()
 431         except IOError:
 432             return 0.0           # non-Linux?
 433         i = v.index(VmKey)       # get VmKey line e.g. 'VmRSS:  9999  kB\n ...'
 434         v = v[i:].split(None, 3) # whitespace
 435         if len(v) < 3:
 436             return 0.0           # invalid format?
 437         # convert Vm value to bytes
 438         mem = float(v[1]) * self._scale[v[2]]
 439         return mem / self._scale[unit]
 440     #
 441     def getAvailablePhysicalMemory(self, unit="o"):
 442         "Renvoie la mémoire physique utilisable en octets"
 443         return self._VmA('MemTotal:', unit)
 444     #
 445     def getAvailableSwapMemory(self, unit="o"):
 446         "Renvoie la mémoire swap utilisable en octets"
 447         return self._VmA('SwapTotal:', unit)
 448     #
 449     def getAvailableMemory(self, unit="o"):
 450         "Renvoie la mémoire totale (physique+swap) utilisable en octets"
 451         return self._VmA('MemTotal:', unit) + self._VmA('SwapTotal:', unit)
 452     #
 453     def getUsableMemory(self, unit="o"):
 454         """Renvoie la mémoire utilisable en octets
 455         Rq : il n'est pas sûr que ce décompte soit juste...
 456         """
 457         return self._VmA('MemFree:', unit) + self._VmA('SwapFree:', unit) + \
 458                self._VmA('Cached:', unit) + self._VmA('SwapCached:', unit)
 459     #
 460     def _VmB(self, VmKey, unit):
 461         "Lecture des paramètres mémoire du processus"
 462         try:
 463             t = open(self._proc_status)
 464             v = t.read()
 465             t.close()
 466         except IOError:
 467             return 0.0           # non-Linux?
 468         i = v.index(VmKey)       # get VmKey line e.g. 'VmRSS:  9999  kB\n ...'
 469         v = v[i:].split(None, 3) # whitespace
 470         if len(v) < 3:
 471             return 0.0           # invalid format?
 472         # convert Vm value to bytes
 473         mem = float(v[1]) * self._scale[v[2]]
 474         return mem / self._scale[unit]
 475     #
 476     def getUsedMemory(self, unit="o"):
 477         "Renvoie la mémoire résidente utilisée en octets"
 478         return self._VmB('VmRSS:', unit)
 479     #
 480     def getVirtualMemory(self, unit="o"):
 481         "Renvoie la mémoire totale utilisée en octets"
 482         return self._VmB('VmSize:', unit)
 483     #
 484     def getUsedStacksize(self, unit="o"):
 485         "Renvoie la taille du stack utilisé en octets"
 486         return self._VmB('VmStk:', unit)
 487     #
 488     def getMaxUsedMemory(self, unit="o"):
 489         "Renvoie la mémoire résidente maximale mesurée"
 490         return self._VmB('VmHWM:', unit)
 491     #
 492     def getMaxVirtualMemory(self, unit="o"):
 493         "Renvoie la mémoire totale maximale mesurée"
 494         return self._VmB('VmPeak:', unit)
 495
 496 # ==============================================================================
 497 if __name__ == "__main__":
 498     print('\n AUTODIAGNOSTIC\n')