src/KERNEL_PY/kernel/__init__.py

   1 # -*- coding: iso-8859-1 -*-
   2 # Copyright (C) 2007-2021  CEA/DEN, EDF R&D, OPEN CASCADE
   3 #
   4 # This library is free software; you can redistribute it and/or
   5 # modify it under the terms of the GNU Lesser General Public
   6 # License as published by the Free Software Foundation; either
   7 # version 2.1 of the License, or (at your option) any later version.
   8 #
   9 # This library is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 # Lesser General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Lesser General Public
  15 # License along with this library; if not, write to the Free Software
  16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 #
  18 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  19 #
  20
  21 ## \defgroup salome_kernel salome.kernel
  22 #  \{
  23 #  \details Package containing the KERNEL python utilities
  24 #  \defgroup deprecation
  25 #  \defgroup termcolor
  26 #  \defgroup logger
  27 #  \defgroup enumerate
  28 #  \defgroup uiexception
  29 #  \defgroup datamodeler
  30 #  \defgroup diclookup
  31 #  \defgroup service
  32 #  \defgroup studyedit
  33 #  \defgroup unittester
  34 #  \defgroup pyunittester
  35 #  \}
  36
  37 __all__ = [ "deprecation", "logger", "termcolor", "logconfig" ]
  38 __version__ = "@SALOMEKERNEL_GIT_SHA1@"
  39
  40 # WARN: This file SHOULD NOT import salome stuff so that modules of the
  41 # package could be used outside of a SALOME session context when
  42 # possible. For example logger.py, datamodeler.py, enumerate.py,
  43 # diclookup.py, ... does not need a SALOME running application.
  44
  45 #
  46 # ==============================================================================
  47 # Generic serialization functions for the module datamodeler
  48 # ==============================================================================
  49 #
  50 import pickle
  51
  52 def serialize(dataToSerialize):
  53     """
  54     Creates a string description of the specified data.
  55     .. attribute:: dataToSerialize
  56     a data object to serialize
  57     """
  58     serialstring = pickle.dumps(dataToSerialize)
  59     return serialstring
  60
  61 def unserialize(stringToUnserialize):
  62     """
  63     Creates a data object from its string description. The string description
  64     is supposed to be obtained by a call to serialize.
  65     .. attribute:: stringToUnserialize
  66     a string description of the object
  67     """
  68     data = pickle.loads(stringToUnserialize)
  69     return data
  70
  71 class Callable:
  72     """
  73     This class is used to create class-method (see MetaData)
  74     """
  75     def __init__(self, anycallable):
  76         self.__call__ = anycallable
  77 #
  78 # ==============================================================================
  79 # Basic use cases and unit tests
  80 # ==============================================================================
  81 #
  82
  83 def TEST_serialization():
  84     from .testdata import TestData
  85     ref_name = "my study case"
  86     studyData = TestData()
  87     studyData.setName(ref_name)
  88
  89     print("serialize data ...")
  90     serialString = serialize(studyData)
  91     print("unserialize data ...")
  92     unserialData = unserialize(serialString)
  93
  94     res_name = unserialData.getName()
  95     print(res_name)
  96     if ( ref_name != res_name ):
  97         return False
  98
  99     unserialData.log()
 100     unserialData.setName("an other name")
 101
 102     return True
 103
 104 if __name__ == "__main__":
 105     from . import unittester
 106     unittester.run("salome/kernel/__init__","TEST_serialization")