salome.kernel 9.14.0.post3__cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

salome/kernel/salome/kernel/syshelper.py

@@ -0,0 +1,116 @@
+# -*- coding: iso-8859-1 -*-
+# Copyright (C) 2007-2024  CEA, EDF, OPEN CASCADE
+#
+# Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+# CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+__author__="gboulant"
+__date__ ="$21 mai 2010 18:00:23$"
+
+
+def findFiles(rootpath, excludes=None):
+    """
+    This looks after files recursively from the specified rootpath,
+    but without visiting directories whose basename is in the list
+    @param excludes.
+    """
+    if not os.path.exists(rootpath):
+        raise RuntimeError("the path %s does not exists"%rootpath)
+
+    if excludes is None:
+        excludes = []
+    exclude_options=""
+    for excludepath in excludes:
+        exclude_options+="-e %s "%excludepath
+
+    listfiles=[]        
+    stream=os.popen("find %s -type f | grep -v -e '\.svn' %s 2>/dev/null"%(rootpath,exclude_options))
+    for line in stream.readlines():
+        listfiles.append(line.split('\n')[0])
+        
+    return listfiles
+
+import sys
+from stat import ST_MODE, S_ISDIR, S_ISREG
+def walktree(rootpath, callback, **kwargs):
+    '''
+    This recursively descends the directory tree rooted at rootpath,
+    calling the callback function for each regular file
+    '''
+    for f in os.listdir(rootpath):
+        pathname = os.path.join(rootpath, f)
+        try:
+            mode = os.stat(pathname)[ST_MODE]
+        except OSError as e:
+            # It probably means that the file is a broken inode
+            mode = -1
+        if S_ISDIR(mode):
+            # It's a directory, recurse into it
+            walktree(pathname, callback, **kwargs)
+        elif S_ISREG(mode):
+            # It's a file, call the callback function
+            callback(pathname, **kwargs)
+        else:
+            # Unknown file type, print a message
+            print('Skipping %s' % pathname)
+
+
+#
+# =============================================================
+# Use cases and unit test functions
+# =============================================================
+#
+import os
+try:
+    TESTDOCDIR=os.path.join(os.environ["KERNEL_ROOT_DIR"],"share")
+except KeyError:
+    TESTDOCDIR="/tmp"
+    
+def TEST_findFiles():
+    print("########## find 1")
+    rootpath=TESTDOCDIR
+    listfiles=findFiles(rootpath)
+    for filename in listfiles:
+        print(filename)
+
+    print("########## find 2")
+    excludes=[os.path.join(TESTDOCDIR,"doc")]
+    listfiles=findFiles(rootpath,excludes)
+    for filename in listfiles:
+        print(filename)
+
+    return True
+
+# This is the test callback function
+def visitfile_withargs(file, rootid):
+    print('visiting file %s (rootid=%s)'%(file,str(rootid)))
+
+def visitfile_withoutargs(file):
+    print('visiting file %s'%(file))
+
+def TEST_walktree():
+    #walktree(TESTDOCDIR, visitfile_withargs, rootid=2)
+    walktree(TESTDOCDIR, visitfile_withoutargs)
+    return True
+
+if __name__ == "__main__":
+    from . import unittester
+    unittester.run("syshelper", "TEST_findFiles")
+    unittester.run("syshelper", "TEST_walktree")

salome/kernel/salome/kernel/termcolor.py

@@ -0,0 +1,239 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2007-2024  CEA, EDF, OPEN CASCADE
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+#  Author : Renaud Barate (EDF R&D)
+#  Date   : August 2009
+
+## \defgroup termcolor termcolor
+#  \{ 
+#  \details
+#  This module provides utility functions to display colored text in the
+#  terminal. It is based on ISO 6429 standard that defines control codes to
+#  change characters representation in color-capable ASCII terminals.
+#
+#  In this module, colors are represented as lists of codes, so they can be added
+#  to obtain special effects (e.g. RED + GREEN_BG to display red text on green
+#  background). Several constants are defined for the most usual codes to
+#  facilitate the use of colors, but it is also possible to define colors
+#  directly from the corresponding code from ISO 6429 standard. In fact it is
+#  even necessary for less usual codes that don't have an associated constant
+#  (e.g. PURPLE + ['09'] can be used to display a crossed-out purple text).
+#
+#  \code
+#  import sys
+#  from salome.kernel import termcolor
+#  if termcolor.canDisplayColor(sys.stdout):
+#      print(termcolor.makeColoredMessage("Hello world!", termcolor.BLUE))
+#  else:
+#      print("Hello world!")
+#  \endcode
+#  \}
+
+"""
+This module provides utility functions to display colored text in the
+terminal. It is based on ISO 6429 standard that defines control codes to
+change characters representation in color-capable ASCII terminals.
+
+In this module, colors are represented as lists of codes, so they can be added
+to obtain special effects (e.g. RED + GREEN_BG to display red text on green
+background). Several constants are defined for the most usual codes to
+facilitate the use of colors, but it is also possible to define colors
+directly from the corresponding code from ISO 6429 standard. In fact it is
+even necessary for less usual codes that don't have an associated constant
+(e.g. PURPLE + ['09'] can be used to display a crossed-out purple text).
+
+Example::
+
+    import sys
+    from salome.kernel import termcolor
+    if termcolor.canDisplayColor(sys.stdout):
+        print(termcolor.makeColoredMessage("Hello world!", termcolor.BLUE))
+    else:
+        print("Hello world!")
+
+"""
+
+# Constants for color codes
+## Default color for the terminal
+#  \ingroup termcolor
+DEFAULT    = ['00']
+"""Default color for the terminal"""
+## Bold text and brighter colors
+#  \ingroup termcolor
+BOLD       = ['01']
+"""Bold text and brighter colors"""
+## Underlined text
+#  \ingroup termcolor
+UNDERLINED = ['04']
+"""Underlined text"""
+## Black foreground
+#  \ingroup termcolor
+BLACK_FG   = ['30']
+"""Black foreground"""
+## Red foreground
+#  \ingroup termcolor
+RED_FG     = ['31']
+"""Red foreground"""
+## Green foreground
+#  \ingroup termcolor
+GREEN_FG   = ['32']
+"""Green foreground"""
+## Yellow foreground
+#  \ingroup termcolor
+YELLOW_FG  = ['33']
+"""Yellow foreground"""
+## Blue foreground
+#  \ingroup termcolor
+BLUE_FG    = ['34']
+"""Blue foreground"""
+## Purple foreground
+#  \ingroup termcolor
+PURPLE_FG  = ['35']
+"""Purple foreground"""
+## Cyan foreground
+#  \ingroup termcolor
+CYAN_FG    = ['36']
+"""Cyan foreground"""
+## White foreground
+#  \ingroup termcolor
+WHITE_FG   = ['37']
+"""White foreground"""
+## Black background
+#  \ingroup termcolor
+BLACK_BG   = ['40']
+"""Black background"""
+## Red background
+#  \ingroup termcolor
+RED_BG     = ['41']
+"""Red background"""
+## Green background
+#  \ingroup termcolor
+GREEN_BG   = ['42']
+"""Green background"""
+## Yellow background
+#  \ingroup termcolor
+YELLOW_BG  = ['43']
+"""Yellow background"""
+## Blue background
+#  \ingroup termcolor
+BLUE_BG    = ['44']
+"""Blue background"""
+## Purple background
+#  \ingroup termcolor
+PURPLE_BG  = ['45']
+"""Purple background"""
+## Cyan background
+#  \ingroup termcolor
+CYAN_BG    = ['46']
+"""Cyan background"""
+## White background
+#  \ingroup termcolor
+WHITE_BG   = ['47']
+"""White background"""
+
+# Constants for common colored text
+## Black text (equivalent to BLACK_FG)
+#  \ingroup termcolor
+BLACK      = BLACK_FG
+"""Black text (equivalent to BLACK_FG)"""
+## Red text (equivalent to BOLD + RED_FG)
+#  \ingroup termcolor
+RED        = BOLD + RED_FG
+"""Red text (equivalent to BOLD + RED_FG)"""
+## Green text (equivalent to BOLD + GREEN_FG)
+#  \ingroup termcolor
+GREEN      = BOLD + GREEN_FG
+"""Green text (equivalent to BOLD + GREEN_FG)"""
+## Yellow text (equivalent to BOLD + YELLOW_FG)
+#  \ingroup termcolor
+YELLOW     = BOLD + YELLOW_FG
+"""Yellow text (equivalent to BOLD + YELLOW_FG)"""
+## Blue text (equivalent to BOLD + BLUE_FG)
+#  \ingroup termcolor
+BLUE       = BOLD + BLUE_FG
+"""Blue text (equivalent to BOLD + BLUE_FG)"""
+## Purple text (equivalent to BOLD + PURPLE_FG)
+#  \ingroup termcolor
+PURPLE     = BOLD + PURPLE_FG
+"""Purple text (equivalent to BOLD + PURPLE_FG)"""
+## Cyan text (equivalent to BOLD + CYAN_FG)
+#  \ingroup termcolor
+CYAN       = BOLD + CYAN_FG
+"""Cyan text (equivalent to BOLD + CYAN_FG)"""
+## White text (equivalent to WHITE_FG)
+#  \ingroup termcolor
+WHITE      = WHITE_FG
+"""White text (equivalent to WHITE_FG)"""
+
+## Return True if the stream can display colored text, False otherwise.
+#  \ingroup termcolor
+def canDisplayColor(stream):
+    """
+    Return True if the stream can display colored text, False otherwise.
+    """
+    return hasattr(stream, "isatty") and stream.isatty()
+
+## Return the control sequence for the color in parameter, i.e. the string
+#  telling the terminal to display the following text in the given color.
+#  \ingroup termcolor
+def getControlSequence(color):
+    """
+    Return the control sequence for the color in parameter, i.e. the string
+    telling the terminal to display the following text in the given color.
+    """
+    seq = "\x1b["
+    for i in range(len(color)):
+        seq += color[i]
+        if i < len(color)-1:
+            seq += ";"
+    seq += "m"
+    return seq
+
+## Return a string that can be used to display the message in parameter with
+#  the given color.
+#  \ingroup termcolor
+def makeColoredMessage(message, color):
+    """
+    Return a string that can be used to display the message in parameter with
+    the given color.
+    """
+    return (getControlSequence(color) +
+            str(message) +
+            getControlSequence(DEFAULT))
+
+## Test function for termcolor module.
+#  \ingroup termcolor
+def TEST_termcolor():
+    """Test function for termcolor module."""
+    import sys
+    if not canDisplayColor(sys.stdout):
+        print("Standard output does not support colors.")
+        return
+    print(makeColoredMessage("This message must appear in blue.", BLUE))
+    print(makeColoredMessage("This message must appear in red on green " +
+                             "background.", RED + GREEN_BG))
+    print(makeColoredMessage("This message must appear in magenta and " +
+                             "crossed-out.", PURPLE + ['09']))
+
+
+# Main function only used to test the module
+if __name__ == "__main__":
+    TEST_termcolor()

salome/kernel/salome/kernel/testdata.py

@@ -0,0 +1,159 @@
+# -*- coding: iso-8859-1 -*-
+# Copyright (C) 2007-2024  CEA, EDF, OPEN CASCADE
+#
+# Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+# CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+#
+# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+#
+
+__author__="gboulant"
+__date__ ="$17 avr. 2010 19:44:36$"
+
+from .enumerate import Enumerate
+from .datamodeler import DataModeler, TypeString, TypeInteger
+from salome.kernel import Callable
+
+class TestData(DataModeler):
+    """
+    This class is the placeholder for meta data associated to a study case.
+    The meta-data are used for organisation and indexing purposes
+    """
+    TYPES_LIST=Enumerate([
+        'SEP',
+        'OTHER'
+    ])
+
+    def __init__(self):
+        DataModeler.__init__(self)
+        self.addAttribute(
+            name  = "NAME",
+            type  = TypeString,
+            range = None
+            )
+        self.addAttribute(
+            name  = "TYPE",
+            type  = TypeInteger,
+            range = self.TYPES_LIST.listvalues()
+            )
+
+    def setName(self, value):
+        self.NAME = value
+
+    def getName(self):
+        return self.NAME
+
+    def setType(self, value):
+        self.TYPE = value
+
+    def getType(self):
+        return self.TYPE
+
+    def getDefault():
+        """
+        Create a default instance of TestData
+        @class-method
+        """
+        testdata = TestData()
+        testdata.NAME = "my case"
+        testdata.TYPE = TestData.TYPES_LIST.SEP
+        return testdata
+
+    getDefault = Callable(getDefault)
+#
+# ==============================================================================
+# Basic use cases and unit tests
+# ==============================================================================
+#
+from .uiexception import UiException
+
+def TEST_getName():
+    testdata = TestData()
+    testdata.setName("Sous-epaisseur")
+    testdata.setType(TestData.TYPES_LIST.SEP)
+    if ( testdata.NAME != "Sous-epaisseur" ):
+        return False
+    return True
+
+
+def TEST_useBadKey():
+    testdata = TestData()
+    try:
+        testdata.unknown = "unknown"
+        # This should not arrive here
+        return False
+    except UiException as err:
+        print(err)
+        return True
+
+def TEST_useBadType():
+    testdata = TestData()
+    try:
+        testdata.TYPE = "unknown"
+        # This should not arrive here
+        return False
+    except UiException as err:
+        print(err)
+        return True
+
+def TEST_useBadRange():
+    testdata = TestData()
+
+    try:
+        testdata.TYPE = TestData.TYPES_LIST.SEP
+        testdata.setType(TestData.TYPES_LIST.SEP)
+        # This should arrive here
+    except UiException as err:
+        # And not here
+        print(err)
+        return False
+
+    try:
+        testdata.TYPE = 9999 # a type that does not exist in the range
+        # This should not arrive here
+        return False
+    except UiException as err:
+        print(err)
+        return True
+
+def TEST_serialize():
+    import salome.kernel
+    ref_testdata = TestData()
+    ref_testdata.setName("The first name")
+    res_testdata = salome.kernel.unserialize(salome.kernel.serialize(ref_testdata))
+
+    print(res_testdata.getName())
+
+    if res_testdata.getName() != ref_testdata.getName():
+        return False
+
+    # Is the unserialized data still functional?
+    try:
+        res_testdata.setName("An other name")
+        print(res_testdata.getName())
+    except Exception:
+        print(e)
+        return False
+    return True
+
+if __name__ == "__main__":
+    from .unittester import run
+    run("salome/kernel/testdata","TEST_getName")
+    run("salome/kernel/testdata","TEST_useBadKey")
+    run("salome/kernel/testdata","TEST_useBadType")
+    run("salome/kernel/testdata","TEST_useBadRange")
+    run("salome/kernel/testdata","TEST_serialize")