IASTools.FileSupport
index
/home/ubuntu/IasRoot/lib/python3.10/site-packages/IASTools/FileSupport.py

Created on Sep 23, 2016
 
@author: acaproni

 
Modules
       
logging
posixpath

 
Classes
       
builtins.object
FileSupport

 
class FileSupport(builtins.object)
    FileSupport(fileName, fileType=None)
 
Support method for IAS files and folders
 
  Methods defined here:
__init__(self, fileName, fileType=None)
Constructor
 
@param filename: The mae of the file
@param fileType: The type of the file (one in iasFileType) or None
findFile(self)
Looks for a file named fileName in the hierarchy of IAS folders:
* - build module folders (build/lib or build/bin for example)
* - $IAS_ROOT folders
 
@return: if the file is found The full path name of the file
         otherwise throws a OSError exception
recursivelyLookForFile(self, folder)
Search recursively for a file in the given folder
 
@param folder: The folder to search for the file
@return: the full name of the file if it exists,
         None otherwise

Class methods defined here:
createLogsFolder() from builtins.type
Create the folder of los as defined in IAS_LOGS_FOLDER
if it does not exists ALREADY
 
An exception is thrown in case of error
createTmpFolder() from builtins.type
Create the folder for temporary files as defined in IAS_TMP_FOLDER
if it does not exists ALREADY
 
An exception is thrown in case of error
getClassFolders() from builtins.type
Return the java and scala folders with test classes
 
Class files are only in the local build/test folder
:return:
getIASFolders(fileType=None) from builtins.type
Return the hierarchy of IAS folders.
At the present it contains
- the ./build/lib (typical case for development)
- IAS root.
 
The tuple returned is ordered by priority i.e. current module first
 
 @return A ordered tuple with the hierarchy of IAS folders
         (at the present the current module and IAS_ROOT)
getIASRoot() from builtins.type
@return the IAS_ROOT
isValidType(fileType) from builtins.type
Check if the passed file type is supported.
None is an accepted type
 
:param fileType: the type to check (can be None)
:return: True if the type has been recognized, False otherwise

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Data and other attributes defined here:
iasModFileType = {'bin': 'build/bin', 'config': 'build/config', 'javaTestClasses': 'build/classes/java/test/', 'lib': 'build/lib', 'scalaTestClasses': 'build/classes/scala/test/', 'src': 'src'}
iasRootFileType = {'bin': 'bin', 'config': 'config', 'lib': 'lib', 'src': None}

 
Functions
       
access(path, mode, *, dir_fd=None, effective_ids=False, follow_symlinks=True)
Use the real uid/gid to test for access to a path.
 
  path
    Path to be tested; can be string, bytes, or a path-like object.
  mode
    Operating-system mode bitfield.  Can be F_OK to test existence,
    or the inclusive-OR of R_OK, W_OK, and X_OK.
  dir_fd
    If not None, it should be a file descriptor open to a directory,
    and path should be relative; path will then be relative to that
    directory.
  effective_ids
    If True, access will use the effective uid/gid instead of
    the real uid/gid.
  follow_symlinks
    If False, and the last element of the path is a symbolic link,
    access will examine the symbolic link itself instead of the file
    the link points to.
 
dir_fd, effective_ids, and follow_symlinks may not be implemented
  on your platform.  If they are unavailable, using them will raise a
  NotImplementedError.
 
Note that most operations will use the effective uid/gid, therefore this
  routine can be used in a suid/sgid environment to test if the invoking user
  has the specified access to the path.
getcwd()
Return a unicode string representing the current working directory.

 
Data
        W_OK = 2
X_OK = 1
environ = environ({'SHELL': '/bin/bash', 'JAVA_HOME': '/us...'_': '/home/ubuntu/IasRoot/bin/iasBuildApiDocs'})