- -

Source code for src.init

-#!/usr/bin/env python
-#-*- coding:utf-8 -*-
-#  Copyright (C) 2010-2013  CEA/DEN
-#
-#  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.
-#
-#  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
-
-
-"""\
-initial imports and utilities methods for salomeTools
-"""
-
-import os
-import shutil
-import errno
-import stat
-
-from . import pyconf
-from . import architecture
-from . import printcolors
-from . import options
-from . import system
-from . import ElementTree
-from . import logger
-from . import product
-from . import environment
-from . import fileEnviron
-from . import compilation
-from . import test_module
-from . import template
-
-import platform
-if platform.system() == "Windows" :
-    import colorama
-    colorama.init()
-
-OK_STATUS = "OK"
-KO_STATUS = "KO"
-NA_STATUS = "NA"
-KNOWNFAILURE_STATUS = "KF"
-TIMEOUT_STATUS = "TIMEOUT"
-
-CONFIG_FILENAME = "sat-config.pyconf"
-
-[docs]class SatException(Exception):
-    """rename Exception Class"""
-    pass
-
-[docs]def ensure_path_exists(p):
-    """Create a path if not existing
-    
-    :param p str: The path.
-    """
-    if not os.path.exists(p):
-        os.makedirs(p)
-        
-[docs]def check_config_has_application( config, details = None ):
-    """check that the config has the key APPLICATION. Else raise an exception.
-    
-    :param config class 'common.pyconf.Config': The config.
-    """
-    if 'APPLICATION' not in config:
-        message = _("An APPLICATION is required. Use 'config --list' to get"
-                    " the list of available applications.\n")
-        if details :
-            details.append(message)
-        raise SatException( message )
-
-[docs]def check_config_has_profile( config, details = None ):
-    """\
-    check that the config has the key APPLICATION.profile.
-    else, raise an exception.
-    
-    :param config class 'common.pyconf.Config': The config.
-    """
-    check_config_has_application(config)
-    if 'profile' not in config.APPLICATION:
-        message = _("A profile section is required in your application.\n")
-        if details :
-            details.append(message)
-        raise SatException( message )
-
-[docs]def config_has_application( config ):
-    return 'APPLICATION' in config
-
-[docs]def get_cfg_param(config, param_name, default):
-    """\
-    eearch for param_name value in config.
-    if param_name is not in config 
-    then return default,
-    else return the found value
-       
-    :param config class 'common.pyconf.Config': The config.
-    :param param_name str: the name of the parameter to get the value
-    :param default str: The value to return if param_name is not in config
-    :return: see initial description of the function
-    :rtype: str
-    """
-    if param_name in config:
-        return config[param_name]
-    return default
-
-[docs]def print_info(logger, info):
-    """\
-    Prints the tuples that are in info variable in a formatted way.
-    
-    :param logger Logger: The logging instance to use for the prints.
-    :param info list: The list of tuples to display
-    """
-    # find the maximum length of the first value of the tuples in info
-    smax = max(map(lambda l: len(l[0]), info))
-    # Print each item of info with good indentation
-    for i in info:
-        sp = " " * (smax - len(i[0]))
-        printcolors.print_value(logger, sp + i[0], i[1], 2)
-    logger.write("\n", 2)
-
-[docs]def get_base_path(config):
-    """\
-    Returns the path of the products base.
-    
-    :param config Config: The global Config instance.
-    :return: The path of the products base.
-    :rtype: str
-    """
-    if "base" not in config.LOCAL:
-        local_file_path = os.path.join(config.VARS.salometoolsway,
-                                      "data",
-                                      "local.pyconf")
-        msg = _("Please define a base path in the file %s" % local_file_path)
-        raise SatException(msg)
-        
-    base_path = os.path.abspath(config.LOCAL.base)
-    
-    return base_path
-
-[docs]def get_launcher_name(config):
-    """\
-    Returns the name of salome launcher.
-    
-    :param config Config: The global Config instance.
-    :return: The name of salome launcher.
-    :rtype: str
-    """
-    check_config_has_application(config)
-    if 'profile' in config.APPLICATION and 'launcher_name' in config.APPLICATION.profile:
-        launcher_name = config.APPLICATION.profile.launcher_name
-    else:
-        launcher_name = 'salome'
-
-    return launcher_name
-
-[docs]def get_log_path(config):
-    """\
-    Returns the path of the logs.
-    
-    :param config Config: The global Config instance.
-    :return: The path of the logs.
-    :rtype: str
-    """
-    if "log_dir" not in config.LOCAL:
-        local_file_path = os.path.join(config.VARS.salometoolsway,
-                                      "data",
-                                      "local.pyconf")
-        msg = _("Please define a log_dir in the file %s" % local_file_path)
-        raise SatException(msg)
-      
-    log_dir_path = os.path.abspath(config.LOCAL.log_dir)
-    
-    return log_dir_path
-
-[docs]def get_salome_version(config):
-    if hasattr(config.APPLICATION, 'version_salome'):
-        Version = config.APPLICATION.version_salome
-    else:
-        KERNEL_info = product.get_product_config(config, "KERNEL")
-        VERSION = os.path.join(
-                            KERNEL_info.install_dir,
-                            "bin",
-                            "salome",
-                            "VERSION")
-        if not os.path.isfile(VERSION):
-            return None
-            
-        fVERSION = open(VERSION)
-        Version = fVERSION.readline()
-        fVERSION.close()
-        
-    VersionSalome = int(only_numbers(Version))    
-    return VersionSalome
-
-[docs]def only_numbers(str_num):
-    return ''.join([nb for nb in str_num if nb in '0123456789'] or '0')
-
-[docs]def read_config_from_a_file(filePath):
-        try:
-            cfg_file = pyconf.Config(filePath)
-        except pyconf.ConfigError as e:
-            raise SatException(_("Error in configuration file: %(file)s\n  %(error)s") % \
-                { 'file': filePath, 'error': str(e) })
-        return cfg_file
-
-[docs]def get_tmp_filename(cfg, name):
-    if not os.path.exists(cfg.VARS.tmp_root):
-        os.makedirs(cfg.VARS.tmp_root)
-
-    return os.path.join(cfg.VARS.tmp_root, name)
-
-##
-# Utils class to simplify path manipulations.
-[docs]class Path:
-    def __init__(self, path):
-        self.path = str(path)
-
-    def __add__(self, other):
-        return Path(os.path.join(self.path, str(other)))
-
-    def __abs__(self):
-        return Path(os.path.abspath(self.path))
-
-    def __str__(self):
-        return self.path
-
-    def __eq__(self, other):
-        return self.path == other.path
-
-[docs]    def exists(self):
-        return self.islink() or os.path.exists(self.path)
-
-[docs]    def islink(self):
-        return os.path.islink(self.path)
-
-[docs]    def isdir(self):
-        return os.path.isdir(self.path)
-
-[docs]    def isfile(self):
-        return os.path.isfile(self.path)
-
-[docs]    def list(self):
-        return [Path(p) for p in os.listdir(self.path)]
-
-[docs]    def dir(self):
-        return Path(os.path.dirname(self.path))
-
-[docs]    def base(self):
-        return Path(os.path.basename(self.path))
-
-[docs]    def make(self, mode=None):
-        os.makedirs(self.path)        
-        if mode:
-            os.chmod(self.path, mode)
-        
-[docs]    def chmod(self, mode):
-        os.chmod(self.path, mode)
-
-[docs]    def rm(self):    
-        if self.islink():
-            os.remove(self.path)
-        else:
-            shutil.rmtree( self.path, onerror = handleRemoveReadonly )
-
-[docs]    def copy(self, path, smart=False):
-        if not isinstance(path, Path):
-            path = Path(path)
-
-        if os.path.islink(self.path):
-            return self.copylink(path)
-        elif os.path.isdir(self.path):
-            return self.copydir(path, smart)
-        else:
-            return self.copyfile(path)
-
-[docs]    def smartcopy(self, path):
-        return self.copy(path, True)
-
-[docs]    def readlink(self):
-        if self.islink():
-            return os.readlink(self.path)
-        else:
-            return False
-
-[docs]    def symlink(self, path):
-        try:
-            os.symlink(str(path), self.path)
-            return True
-        except:
-            return False
-
-[docs]    def copylink(self, path):
-        try:
-            os.symlink(os.readlink(self.path), str(path))
-            return True
-        except:
-            return False
-
-[docs]    def copydir(self, dst, smart=False):
-        try:
-            names = self.list()
-
-            if not dst.exists():
-                dst.make()
-
-            for name in names:
-                if name == dst:
-                    continue
-                if smart and (str(name) in [".git", "CVS", ".svn"]):
-                    continue
-                srcname = self + name
-                dstname = dst + name
-                srcname.copy(dstname, smart)
-            return True
-        except:
-            return False
-
-[docs]    def copyfile(self, path):
-        try:
-            shutil.copy2(self.path, str(path))
-            return True
-        except:
-            return False
-
-[docs]def find_file_in_lpath(file_name, lpath, additional_dir = ""):
-    """\
-    Find in all the directories in lpath list the file that has the same name
-    as file_name. 
-    If it is found 
-    then return the full path of the file
-    else return False.
- 
-    The additional_dir (optional) is the name of the directory to add to all 
-    paths in lpath.
-    
-    :param file_name str: The file name to search
-    :param lpath List: The list of directories where to search
-    :param additional_dir str: The name of the additional directory
-    :return: the full path of the file or False if not found
-    :rtype: str
-    """
-    for directory in lpath:
-        dir_complete = os.path.join(directory, additional_dir)
-        if not os.path.isdir(directory) or not os.path.isdir(dir_complete):
-            continue
-        l_files = os.listdir(dir_complete)
-        for file_n in l_files:
-            if file_n == file_name:
-                return os.path.join(dir_complete, file_name)
-    return False
-
-[docs]def handleRemoveReadonly(func, path, exc):
-    excvalue = exc[1]
-    if func in (os.rmdir, os.remove) and excvalue.errno == errno.EACCES:
-        os.chmod(path, stat.S_IRWXU| stat.S_IRWXG| stat.S_IRWXO) # 0777
-        func(path)
-    else:
-        raise
-
-[docs]def deepcopy_list(input_list):
-    """\
-    Do a deep copy of a list
-    
-    :param input_list List: The list to copy
-    :return: The copy of the list
-    :rtype: List
-    """
-    res = []
-    for elem in input_list:
-        res.append(elem)
-    return res
-
-[docs]def remove_item_from_list(input_list, item):
-    """\
-    Remove all occurences of item from input_list
-    
-    :param input_list List: The list to modify
-    :return: The without any item
-    :rtype: List
-    """
-    res = []
-    for elem in input_list:
-        if elem == item:
-            continue
-        res.append(elem)
-    return res
-
-[docs]def parse_date(date):
-    """\
-    Transform YYYYMMDD_hhmmss into YYYY-MM-DD hh:mm:ss.
-    
-    :param date str: The date to transform
-    :return: The date in the new format
-    :rtype: str
-    """
-    if len(date) != 15:
-        return date
-    res = "%s-%s-%s %s:%s:%s" % (date[0:4],
-                                 date[4:6],
-                                 date[6:8],
-                                 date[9:11],
-                                 date[11:13],
-                                 date[13:])
-    return res
-
-[docs]def merge_dicts(*dict_args):
-    """\
-    Given any number of dicts, shallow copy and merge into a new dict,
-    precedence goes to key value pairs in latter dicts.
-    """
-    result = {}
-    for dictionary in dict_args:
-        result.update(dictionary)
-    return result
-
-[docs]def replace_in_file(filein, strin, strout):
-    """Replace <strin> by <strout> in file <filein>"""
-    shutil.move(filein, filein + "_old")
-    fileout= filein
-    filein = filein + "_old"
-    fin = open(filein, "r")
-    fout = open(fileout, "w")
-    for line in fin:
-        fout.write(line.replace(strin, strout))
-
-[docs]def get_property_in_product_cfg(product_cfg, pprty):
-    if not "properties" in product_cfg:
-        return None
-    if not pprty in product_cfg.properties:
-        return None
-    return product_cfg.properties[pprty]
-
-[docs]def activate_mesa_property(config):
-    """Add mesa property into application properties
-    
-    :param config Config: The global configuration. It must have an application!
-    """
-    # Verify the existence of the file
-    if not 'properties' in config.APPLICATION:
-        config.APPLICATION.addMapping( 'properties', src.pyconf.Mapping(), None )
-    config.APPLICATION.properties.use_mesa="yes"
-
-

- -

Parameters:	List (input_list) â The list to copy
Returns:	The copy of the list
Return type:	List

Parameters:	str (key) â the environment variable
Parameters:	str (key) -- the environment variable

Parameters:	- str (for_package) â the file path - dict (additional_env) â a dictionary of additional variables + str (for_package) -- the file path + dict (additional_env) -- a dictionary of additional variables to add to the environment - str â If not None, produce a relative environment + str -- If not None, produce a relative environment designed for a package.
Parameters:	- str (shell) â the file path - bool (forBuild) â if true, the build environment - str â the type of file wanted (.sh, .bat) + str (shell) -- the file path + bool (forBuild) -- if true, the build environment + str -- the type of file wanted (.sh, .bat)
Parameters:	str (comment) â the commentary to add
Parameters:	str (comment) -- the commentary to add

Parameters:	str (key) â the environment variable
Parameters:	str (key) -- the environment variable

Parameters:	list (lProducts) â List of products to potentially add
Parameters:	list (lProducts) -- List of products to potentially add

Parameters:	- str (value) â the environment variable to set - str â the value + str (value) -- the environment variable to set + str -- the value
Parameters:	- str (product) â The product name - Logger (logger) â The logger instance to display messages + str (product) -- The product name + Logger (logger) -- The logger instance to display messages
Parameters:	Logger (logger) â The logger instance to display messages
Parameters:	Logger (logger) -- The logger instance to display messages

Parameters:	- Logger (logger) â The logger instance to display messages - list (env_info) â the list of products + Logger (logger) -- The logger instance to display messages + list (env_info) -- the list of products
Parameters:	- Logger (logger) â The logger instance to display messages - src (src_root) â the application working directory + Logger (logger) -- The logger instance to display messages + src (src_root) -- the application working directory
Parameters:	Config (pi) â The product description
Parameters:	Config (pi) -- The product description

Parameters:	- str (command) â the environment variable - str â the command to execute + str (command) -- the environment variable + str -- the command to execute
Parameters:	bool (required) â Do nothing if required is False
Parameters:	bool (required) -- Do nothing if required is False

Parameters:	str (text) â the text to echo
Parameters:	str (text) -- the text to echo

Parameters:	str (warning) â the text to echo
Parameters:	str (warning) -- the text to echo

Parameters:	str (name) â The name of the variable to find the separator
Parameters:	str (name) -- The name of the variable to find the separator

Parma full_launched_command str:
Parameters:	- str (command_res) â The file name of the link. - str â The name of the command linked. - str â The result of the command linked. â0â or â1â + str (helpString) -- The short name of the option +(ex "l" for level option). + str -- The long name of the option +(ex "level" for level option). + str -- The type of the option (ex "int"). + str -- The name that will be used in the code. + str -- The text to display +when user ask for help on a command.
	The full lanch command -(âsat command â¦â) +
Returns:	Nothing. +
Return type:	NA

Parameters:	dict (attribute) â the attribute to add to the node âSiteâ.
Returns:	colored string
Return type:	NA

Parameters:	str (message) â The message to print.
Parameters:	list (argList) -- the raw list of arguments that were passed
Returns:	optResult, args : optResult is the option instance +to manipulate in the code. args +is the full raw list of passed options
Return type:	(class 'common.options.OptResult',list)

Parameters:	- str (message) â The message to print. - int (level) â The output level corresponding -to the message 0 < level < 6. - boolean (screenOnly) â if True, do not write in log file. +
Parameters:	+ Config (product_info) -- The global configuration + str (prod_dir) -- The product installation directory path +(without config-<i>) + Config -- The configuration specific to +the product
Returns:	True or false is the installation is found or not +and if it is found, the path of the found installation +
Return type:	(boolean, str) +

Parameters:	str (date) â The date in format YYYYMMDD_HHMMSS
Parameters:	Config (product_info) -- The configuration specific to +the product
Returns:	the same date and time in separate variables.
Returns:	True if it is well installed
Return type:	(str,str,str,str,str,str)
Return type:	boolean

Parameters:	- str (expression) â the directory where to search the files - str â the regular expression of files to find + Config (product_info) -- The global configuration + Config -- The configuration specific to +the product + str (version) -- The version of the product
Returns:	the list of files path and informations about it +
Returns:	The path of the product installation
Return type:	list +
Return type:	str

Parameters:	- str (application) â the path to the command xml log file - str â the command of the log file - str â the application passed as parameter -to the salomeTools command - list (notShownCommands) â the list of commands -that are not shown by default + Config (product_info) -- The global configuration + str (version) -- This corresponds to the value given by user in its application.pyconf for the specific product. If "yes", the user wants the product to be in base. If "no", he wants the product to be in the application workdir + str -- The version of the product + Config -- The configuration specific to the product
Returns:	True if cmd is not in notShownCommands and the application -in the log file corresponds to application +
Returns:	The path of the product installation
Return type:	boolean +
Return type:	str

Parameters:	datetime.timedelta (timedelta) â The delta between two dates
Parameters:	Config (product_info) -- The configuration specific to +the product
Returns:	The number of seconds corresponding to timedelta.
Returns:	The list of names of the components
Return type:	float
Return type:	List

Parameters:	- str (application) â the directory to parse - str â the name of the application if there is any - -
Parameters:	+ Config (config) -- The global configuration + str (product_name) -- The name of the product + boolean (with_install_dir) -- If false, do not provide an install +directory (at false only for internal use +of the function check_config_exists) + +
Returns:	the specific configuration of the product +
Return type:	Config +

Parameters:	- str (helpString) â The short name of the option -(ex âlâ for level option). - str â The long name of the option -(ex âlevelâ for level option). - str â The type of the option (ex âintâ). - str â The name that will be used in the code. - str â The text to display -when user ask for help on a command. + Config (product_info) -- The global configuration + Config -- The configuration specific to +the product
Returns:	Nothing. +
Returns:	the list of products in dependence
Return type:	NA +
Return type:	list

Parameters:	list (argList) â the raw list of arguments that were passed
Parameters:	+ Config (config) -- The global configuration + str (section) -- The product name + str -- The version of the product + str -- The searched section (if not None, the section is +explicitly given + +
Returns:	optResult, args : optResult is the option instance -to manipulate in the code. args -is the full raw list of passed options
Returns:	The product description +
Return type:	(class âcommon.options.OptResultâ,list)
Return type:	Config +

Returns:	Nothing.
Parameters:	+ List (lproducts) -- The list of product names + Config (config) -- The global configuration + +
Return type:	NA
Returns:	the list of tuples +(product name, specific configuration of the product) +
Return type:	[(str, Config)] +

Parameters:	str (message) â The text to be cleaned.
Parameters:	Config (product_info) -- The configuration specific to +the product
Returns:	The cleaned text.
Returns:	True if the product compiles, else False
Return type:	str
Return type:	boolean

Parameters:	- int (end) â The smaller value. - int â The bigger value. - -
Parameters:	Config (product_info) -- The configuration specific to +the product
Returns:	True if the product it has an environment script, else False
Return type:	boolean

All modules for which code is available

Quick search

Quick search

Source code for src.__init__

Quick search

Source code for src.catchAll

Quick search

Quick search

Quick search

Quick search

Quick search

Source code for src.coloringSat

Quick search

Source code for src.configManager

Quick search

Quick search

Source code for src.environs

Source code for src.example.essai_logging_1

Source code for src.example.essai_logging_2

Source code for src.exceptionSat

Quick search

Quick search

Source code for src.logger

Source code for src.loggingSat

Quick search

Source code for src.printcolors

Quick search

Quick search

Source code for src.returnCode

Source code for src.salomeTools

Quick search

Quick search

Source code for src.test_module

Quick search

Source code for src.utilsSat

Quick search

srcÂ¶

This Page

Quick search

colorama PackageÂ¶

colorama PackageÂ¶

src.colorama packageÂ¶

SubmodulesÂ¶

ansi ModuleÂ¶

src.colorama.ansi moduleÂ¶

ansitowin32 ModuleÂ¶

src.colorama.ansitowin32 moduleÂ¶

initialise ModuleÂ¶

src.colorama.initialise moduleÂ¶

win32 ModuleÂ¶

src.colorama.win32 moduleÂ¶

winterm ModuleÂ¶

src.colorama.winterm moduleÂ¶

Module contentsÂ¶

Table Of Contents

This Page

Quick search

src.example packageÂ¶

SubmodulesÂ¶

src.example.essai_logging_1 moduleÂ¶

src.example.essai_logging_2 moduleÂ¶

Module contentsÂ¶

src PackageÂ¶

src PackageÂ¶

src packageÂ¶

SubpackagesÂ¶

SubmodulesÂ¶

src.ElementTree moduleÂ¶

src.architecture moduleÂ¶

src.catchAll moduleÂ¶

src.coloringSat moduleÂ¶

ElementTree ModuleÂ¶

src.compilation moduleÂ¶

architecture ModuleÂ¶

src.configManager moduleÂ¶

compilation ModuleÂ¶

debug ModuleÂ¶

src.debug moduleÂ¶

environment ModuleÂ¶

src.environment moduleÂ¶

Source code for src.init

`colorama` PackageÂ¶

`ansi` ModuleÂ¶

`ansitowin32` Module Â¶

`initialise` ModuleÂ¶

`win32` ModuleÂ¶

`winterm` ModuleÂ¶

`src` PackageÂ¶

`ElementTree` ModuleÂ¶

`architecture` ModuleÂ¶

`compilation` ModuleÂ¶

`debug` ModuleÂ¶

`environment` ModuleÂ¶

`fileEnviron` ModuleÂ¶

`fork` ModuleÂ¶

`logger` ModuleÂ¶

`options` ModuleÂ¶

`printcolors` ModuleÂ¶

`product` ModuleÂ¶

`pyconf` ModuleÂ¶

`system` ModuleÂ¶

`template` ModuleÂ¶

`test_module` ModuleÂ¶

`xmlManager` ModuleÂ¶

Parameters:	- class logger (logger) â the logger instance. - int (level) â the label to print. - str (suffix) â the value to print. - int â the level of verboseness. - str â the suffix to add at the end. - -
Parameters:	Config (product_info) -- The configuration specific to +the product
Returns:	The path of the logo if the product has a logo, else False
Return type:	Str

Parameters:	- str (code) â The text to be printed. - str â The color to use. - -
Parameters:	Config (product_info) -- The configuration specific to +the product
Returns:	The colored text. -
Returns:	True if the product has one or more patches
Return type:	str -
Return type:	boolean

Parameters:	str (txt) â The text to be printed.
Parameters:	Config (product_info) -- The configuration specific to +the product
Returns:	The colored text.
Returns:	True if the product has a SALOME gui, else False
Return type:	str
Return type:	Boolean

Parameters:	- Config (product_info) â The global configuration - str (prod_dir) â The product installation directory path -(without config-<i>) - Config â The configuration specific to -the product - -
Parameters:	Config (product_info) -- The configuration specific to +the product
Returns:	True or false is the installation is found or not -and if it is found, the path of the found installation -
Returns:	True if the product is in dev mode, else False
Return type:	(boolean, str) -
Return type:	boolean

Parameters:	Config (product_info) â The configuration specific to +
Parameters:	Config (product_info) -- The configuration specific to the product
Returns:	True if it is well installed
Returns:	True if the product is fixed, else False
Return type:	boolean

Parameters:	- Config (config) â The global configuration - str (product_name) â The name of the product - boolean (with_install_dir) â If false, do not provide an install -directory (at false only for internal use -of the function check_config_exists) - -
Parameters:	Config (product_info) -- The configuration specific to +the product
Returns:	the specific configuration of the product -
Returns:	True if the product has the sample type, else False
Return type:	Config -
Return type:	boolean

Parameters:	- List (lproducts) â The list of product names - Config (config) â The global configuration - -
Returns:	the list of tuples -(product name, specific configuration of the product) -
Return type:	[(str, Config)] -

Parameters:	str (dirPath) -- The directory path where to search the commands
Returns:	cmd_list : the list containing the commands name
Return type:	list

Parameters:	+ str (where) -- The path to the archive. + str -- The path where to extract. + Logger (logger) -- The logger instance to use. + +
Returns:	True if the extraction is successful +
Return type:	boolean +

Parameters:	+ str (where) -- The cvs protocol. + str -- The user to be used. + str -- The remote cvs server. + str -- . + + str -- The tag. + str -- The product. + str -- The path where to extract. + Logger (logger) -- The logger instance to use. + boolean (checkout) -- If true use checkout cvs. + src.environment.Environ (environment) -- The environment to source when +extracting. + +
Returns:	True if the extraction is successful +
Return type:	boolean +