src/KERNEL_PY/kernel/syshelper.py

   1 # -*- coding: iso-8859-1 -*-
   2 # Copyright (C) 2007-2024  CEA, EDF, OPEN CASCADE
   3 #
   4 # Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   5 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   6 #
   7 # This library is free software; you can redistribute it and/or
   8 # modify it under the terms of the GNU Lesser General Public
   9 # License as published by the Free Software Foundation; either
  10 # version 2.1 of the License, or (at your option) any later version.
  11 #
  12 # This library is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 # Lesser General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU Lesser General Public
  18 # License along with this library; if not, write to the Free Software
  19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  20 #
  21 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  22 #
  23
  24 __author__="gboulant"
  25 __date__ ="$21 mai 2010 18:00:23$"
  26
  27
  28 def findFiles(rootpath, excludes=None):
  29     """
  30     This looks after files recursively from the specified rootpath,
  31     but without visiting directories whose basename is in the list
  32     @param excludes.
  33     """
  34     if not os.path.exists(rootpath):
  35         raise RuntimeError("the path %s does not exists"%rootpath)
  36
  37     if excludes is None:
  38         excludes = []
  39     exclude_options=""
  40     for excludepath in excludes:
  41         exclude_options+="-e %s "%excludepath
  42
  43     listfiles=[]
  44     stream=os.popen("find %s -type f | grep -v -e '\.svn' %s 2>/dev/null"%(rootpath,exclude_options))
  45     for line in stream.readlines():
  46         listfiles.append(line.split('\n')[0])
  47
  48     return listfiles
  49
  50 import sys
  51 from stat import ST_MODE, S_ISDIR, S_ISREG
  52 def walktree(rootpath, callback, **kwargs):
  53     '''
  54     This recursively descends the directory tree rooted at rootpath,
  55     calling the callback function for each regular file
  56     '''
  57     for f in os.listdir(rootpath):
  58         pathname = os.path.join(rootpath, f)
  59         try:
  60             mode = os.stat(pathname)[ST_MODE]
  61         except OSError as e:
  62             # It probably means that the file is a broken inode
  63             mode = -1
  64         if S_ISDIR(mode):
  65             # It's a directory, recurse into it
  66             walktree(pathname, callback, **kwargs)
  67         elif S_ISREG(mode):
  68             # It's a file, call the callback function
  69             callback(pathname, **kwargs)
  70         else:
  71             # Unknown file type, print a message
  72             print('Skipping %s' % pathname)
  73
  74
  75 #
  76 # =============================================================
  77 # Use cases and unit test functions
  78 # =============================================================
  79 #
  80 import os
  81 try:
  82     TESTDOCDIR=os.path.join(os.environ["KERNEL_ROOT_DIR"],"share")
  83 except KeyError:
  84     TESTDOCDIR="/tmp"
  85
  86 def TEST_findFiles():
  87     print("########## find 1")
  88     rootpath=TESTDOCDIR
  89     listfiles=findFiles(rootpath)
  90     for filename in listfiles:
  91         print(filename)
  92
  93     print("########## find 2")
  94     excludes=[os.path.join(TESTDOCDIR,"doc")]
  95     listfiles=findFiles(rootpath,excludes)
  96     for filename in listfiles:
  97         print(filename)
  98
  99     return True
 100
 101 # This is the test callback function
 102 def visitfile_withargs(file, rootid):
 103     print('visiting file %s (rootid=%s)'%(file,str(rootid)))
 104
 105 def visitfile_withoutargs(file):
 106     print('visiting file %s'%(file))
 107
 108 def TEST_walktree():
 109     #walktree(TESTDOCDIR, visitfile_withargs, rootid=2)
 110     walktree(TESTDOCDIR, visitfile_withoutargs)
 111     return True
 112
 113 if __name__ == "__main__":
 114     from . import unittester
 115     unittester.run("syshelper", "TEST_findFiles")
 116     unittester.run("syshelper", "TEST_walktree")