Source code for UseCases.FileSysObjects.createAndUseSearchLists.from_glob.CallCase

"""Create a plist, find a matching relative filepathname in directory tree.

"""
from __future__ import absolute_import
from __future__ import print_function
import glob
import filesysobjects

__author__ = 'Arno-Can Uestuensoez'
__license__ = "Artistic-License-2.0 + Forced-Fairplay-Constraints"
__copyright__ = "Copyright (C) 2010-2016 Arno-Can Uestuensoez @Ingenieurbuero Arno-Can Uestuensoez"
__version__ = '0.0.1'
__uuid__='af90cc0c-de54-4a32-becd-06f5ce5a3a75'

__docformat__ = "restructuredtext en"

import unittest
import os,sys

from filesysobjects.FileSysObjects import setUpperTreeSearchPath
from filesysobjects.FileSysObjects import findRelPathInSearchPath
from filesysobjects.FileSysObjects import clearPath

#
#######################
#

class UseCase(unittest.TestCase):

    def testCase100(self):
        """The scope of the start node is literal+glob(LG). 

        Calling elementary functions.
        
        * **Data**:
          ::
          
            see 'testdata.examples'
          
          refer also to the manual `[filesystem-elements-as-objects] <path_syntax.html#filesystem-elements-as-objects>`_
        
        * **Call**:
          ::
        
            import testdata
            import filesysobjects.FileSysObjects
              
            # start of upward search - file is converted into it's containing directory node
            s = os.sep
            
            any_sub_path = os.path.normpath('examples/a/b[0-9]/c/?/b?/*c/F*')
            spath  = testdata.mypath
            spath += any_sub_path
            spath = glob.glob(spath)
            assert len(spath) == 1
            spath = spath[0]
            #
            # should result in the same single entry as the previous case for: 
            #
            #     any_sub_path = os.path.normpath('examples/a/b0/c/a/b0/c/F')
            #
        
            # Here an empty list is used for search only. The function adds 
            # entries to the provided list storage, thus e.g. to 'sys.path' too.
            _plist = []
        
            # 0. build a search path list - if not yet available
            #    adds each directory from spath to its matching 
            #    subnode  "a/b"
            #
            setUpperTreeSearchPath(spath,os.path.normpath('a/b0'), _plist)
        
            # 1. make it canonical - optional, here just a demo
            clearPath(_plist,**{'redundant':True,'shrink':True}) # and clear them immediately
        
            # 2.a. find the requested entry
            rp = findRelPathInSearchPath("F[0-5]*",_plist)
        
            # 2.b. find the requested entry - here as demo with a relative path
            rp = findRelPathInSearchPath("c/*/b0/F[0-5]*",_plist)
        
            
        * **Result**:
          ::
        
            expected = os.path.normpath(testdata.mypath+'/examples/a/b0/c/a/b0/F1')
        
        """
        _s = sys.path[:]

        import testdata
        import filesysobjects.FileSysObjects
          
        s = os.sep
        
        # start of upward search - file is converted into it's containing directory node
        # Here the usage of a glob as a starting point is demonstrated.
        # It results here in one element only. 
        any_sub_path = os.path.normpath('examples/a/b[0-9]/c/?/b?/*c/F*')
        spath  = testdata.mypath
        spath += s+ any_sub_path
        spath = glob.glob(spath)
        
        any_sub_pathRef = os.path.normpath('examples/a/b0/c/a/b0/c/F')
        spathRef  = testdata.mypath
        spathRef += s+ any_sub_pathRef
         

        assert spath == [spathRef]
        spath = spath[0]
        
        # check environment, should obviously exist
        assert os.path.exists(spath)
                
        # store new search list, here without required sys.path
        _plist = []


        # 0. build a search path list - if not yet available
        #    adds each directory from spath to its matching 
        #    subnode  "a/b"
        #
        setUpperTreeSearchPath(spath,os.path.normpath('a/b0'), _plist)
        _plist_ref = [ # expected plist
            os.path.normpath(testdata.mypath+'/examples/a/b0/c/a/b0/c'),
            os.path.normpath(testdata.mypath+'/examples/a/b0/c/a/b0'),
            os.path.normpath(testdata.mypath+'/examples/a/b0/c/a'),
            os.path.normpath(testdata.mypath+'/examples/a/b0/c'),
            os.path.normpath(testdata.mypath+'/examples/a/b0'),
        ]
        assert _plist_ref == _plist 

        # 1. make it canonical - optional, here just a demo
        _chk_ref = _plist[:]
        _plist.extend(_plist[:]) # duplicate all for demonstration
        assert _plist != _chk_ref
        clearPath(_plist,**{'redundant':True,'shrink':True}) # and clear them immediately
        assert _plist == _chk_ref

        # 2.a. find the requested entry
        rp = findRelPathInSearchPath("F[0-5]*",_plist)
        expected = os.path.normpath(testdata.mypath+'/examples/a/b0/c/a/b0/F1')
        assert expected == rp 

        # 2.b. find the requested entry - here as demo with a relative path
        rp = findRelPathInSearchPath("c/*/b0/F[0-5]*",_plist)
        expected = os.path.normpath(testdata.mypath+'/examples/a/b0/c/a/b0/F1')
        assert expected == rp 


if __name__ == '__main__':
    unittest.main()