# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-import src
+import re
+import os
-import prepare
+import src
# Compatibility python 2/3 for input function
# input stays input for python 3 and input = raw_input for python 2
except NameError:
pass
+
# Define all possible option for the clean command : sat clean <options>
parser = src.options.Options()
parser.add_option('p', 'products', 'list2', 'products',
- _('products to clean. This option can be'
- ' passed several time to clean several products.'))
-parser.add_option('s', 'source', 'boolean', 'source',
- _("Clean the product source directories."))
+ _('Optional: Products to clean. This option accepts a comma separated list.'))
+parser.add_option('s', 'sources', 'boolean', 'sources',
+ _("Optional: Clean the product source directories."))
parser.add_option('b', 'build', 'boolean', 'build',
- _("Clean the product build directories."))
+ _("Optional: Clean the product build directories."))
parser.add_option('i', 'install', 'boolean', 'install',
- _("Clean the product install directories."))
+ _("Optional: Clean the product install directories."))
+parser.add_option('g', 'generated', 'boolean', 'generated',
+ _("Optional: Clean source, build and install directories for generated products."))
+parser.add_option('', 'package', 'boolean', 'package',
+ _("Optional: Clean packages produced by sat package command."))
parser.add_option('a', 'all', 'boolean', 'all',
- _("Clean the product source, build and install directories."))
+ _("Optional: Clean the product source, build and install directories."))
parser.add_option('', 'sources_without_dev', 'boolean', 'sources_without_dev',
- _("do not clean the products in development mode."))
+ _("Optional: do not clean the products in development mode."))
-def get_source_directories(products_infos, without_dev):
- '''Returns the list of directory source paths corresponding to the list of
- product information given as input. If without_dev (bool), then
- the dev products are ignored.
+
+def get_source_directories(config, products_infos, without_dev):
+ """\
+ Returns the list of directory source paths corresponding
+ to the list of product information given as input.
+ If without_dev (bool) the dev products are ignored.
:param products_infos list: The list of (name, config) corresponding to one
product.
:param without_dev boolean: If True, then ignore the dev products.
:return: the list of source paths.
:rtype: list
- '''
+ """
l_dir_source = []
for __, product_info in products_infos:
if product_has_dir(product_info, without_dev):
- l_dir_source.append(src.Path(product_info.source_dir))
+ # we do not clean source dirs of pip products when pip is activated
+ if not ( src.appli_test_property(config,"pip", "yes") and\
+ src.product.product_test_property(product_info,"pip", "yes") ) :
+ l_dir_source.append(src.Path(product_info.source_dir))
return l_dir_source
def get_build_directories(products_infos):
- '''Returns the list of directory build paths corresponding to the list of
- product information given as input.
+ """\
+ Returns the list of directory build paths corresponding to the list of
+ product information given as input.
:param products_infos list: The list of (name, config) corresponding to one
product.
:return: the list of build paths.
:rtype: list
- '''
+ """
l_dir_build = []
for __, product_info in products_infos:
if product_has_dir(product_info):
- l_dir_build.append(src.Path(product_info.build_dir))
+ if "build_dir" in product_info:
+ l_dir_build.append(src.Path(product_info.build_dir))
return l_dir_build
-def get_install_directories(products_infos):
- '''Returns the list of directory install paths corresponding to the list of
- product information given as input.
+def get_install_directories(config, products_infos):
+ """\
+ Returns the list of directory install paths corresponding to the list of
+ product information given as input.
- :param products_infos list: The list of (name, config) corresponding to one
- product.
+ :param products_infos list: The list of (name, config) corresponding to one product.
:return: the list of install paths.
:rtype: list
- '''
+ """
l_dir_install = []
for __, product_info in products_infos:
if product_has_dir(product_info):
- l_dir_install.append(src.Path(product_info.install_dir))
+ # we do not clean pip products installed in python install dir
+ if not ( src.appli_test_property(config,"pip", "yes") and\
+ src.product.product_test_property(product_info, "pip", "yes") and\
+ src.appli_test_property(config,"pip_install_dir", "python") ) :
+ l_dir_install.append(src.Path(product_info.install_dir))
return l_dir_install
+def get_package_directory(config):
+ """\
+ Returns the package directory name corresponding to the sat package command
+
+ :param config Config: The global configuration
+ :return: a list containing the PACKAGE full path.
+ :rtype: list
+ """
+ return [src.Path(os.path.join(config.APPLICATION.workdir, "PACKAGE"))]
+
+def get_generated_directories(config, products_infos):
+ """\
+ Returns the list of directories (source, build, install) corresponding to the
+ list of products information given as input.
+ Nothing is returned for non generated products (those with...)
+
+ :param products_infos list: The list of (name, config) corresponding to one product.
+ :return: the list of install paths.
+ :rtype: list
+ """
+ l_dir_install = []
+ for __, product_info in products_infos:
+ if not src.product.product_is_generated(product_info):
+ continue
+ workdir = config.APPLICATION.workdir
+ compo = product_info.component_name
+ generate_dir = os.path.join(workdir, "GENERATED")
+ source_dir = os.path.join(generate_dir, compo + "_SRC")
+ build_dir = os.path.join(os.path.join(workdir, "BUILD"), compo)
+ install_dir = os.path.join(workdir, config.INTERNAL.config.install_dir,
+ compo)
+ l_dir_install.append(src.Path(source_dir))
+ l_dir_install.append(src.Path(build_dir))
+ l_dir_install.append(src.Path(install_dir))
+
+ return l_dir_install
+
+
+
def product_has_dir(product_info, without_dev=False):
- '''Returns a boolean at True if there is a source, build and install
- directory corresponding to the product described by product_info.
+ """\
+ Returns a boolean at True if there is a source, build and install
+ directory corresponding to the product described by product_info.
:param products_info Config: The config corresponding to the product.
- :return: True if there is a source, build and install
- directory corresponding to the product described by product_info.
+ :return: True if there is a source, build and install directory corresponding to the product described by product_info.
:rtype: boolean
- '''
+ """
if (src.product.product_is_native(product_info) or
src.product.product_is_fixed(product_info)):
return False
return True
def suppress_directories(l_paths, logger):
- '''Suppress the paths given in the list in l_paths.
+ """Suppress the paths given in the list in l_paths.
:param l_paths list: The list of Path to be suppressed
- :param logger Logger: The logger instance to use for the display and
- logging
- '''
+ :param logger Logger: The logger instance to use for the display and logging
+ """
for path in l_paths:
if not path.isdir():
msg = _("Warning: the path %s does not "
logger.write('%s\n' % src.printcolors.printc(src.OK_STATUS), 3)
def description():
- '''method that is called when salomeTools is called with --help option.
+ """method called when salomeTools is called with --help option.
:return: The text to display for the clean command description.
:rtype: str
- '''
- return _("The clean command suppress the source, build, or install "
- "directories of the application products.")
+ """
+ return _("""\
+The clean command suppress the SOURCES, BUILD or INSTALL directories of the application products.
+Use the options to define what directories you want to suppress and to set the list of products
+
+example:
+>> sat clean SALOME-xx --build --install --properties is_SALOME_module:yes
+""")
def run(args, runner, logger):
- '''method that is called when salomeTools is called with clean parameter.
- '''
+ """\
+ method called when salomeTools is called with clean parameter.
+ """
# Parse the options
(options, args) = parser.parse_args(args)
# check that the command has been called with an application
src.check_config_has_application( runner.cfg )
- products_infos = prepare.get_products_list(options, runner.cfg, logger)
+
+ # Get the list of products to threat
+ products_infos = src.product.get_products_list(options, runner.cfg, logger)
# Construct the list of directories to suppress
l_dir_to_suppress = []
if options.all:
- l_dir_to_suppress += (get_source_directories(products_infos,
- options.sources_without_dev) +
+ l_dir_to_suppress += (get_source_directories(runner.cfg, products_infos,
+ options.sources_without_dev) +
get_build_directories(products_infos) +
- get_install_directories(products_infos))
+ get_install_directories(runner.cfg, products_infos) +
+ get_generated_directories(runner.cfg, products_infos) +
+ get_package_directory(runner.cfg) )
else:
if options.install:
- l_dir_to_suppress += get_install_directories(products_infos)
+ l_dir_to_suppress += get_install_directories(runner.cfg, products_infos)
if options.build:
l_dir_to_suppress += get_build_directories(products_infos)
- if options.source:
- l_dir_to_suppress += get_source_directories(products_infos,
+ if options.sources or options.sources_without_dev:
+ l_dir_to_suppress += get_source_directories(runner.cfg, products_infos,
options.sources_without_dev)
+ if options.generated:
+ l_dir_to_suppress += get_generated_directories(runner.cfg, products_infos)
+
+ if options.package:
+ l_dir_to_suppress += get_package_directory(runner.cfg)
+
+ if len(l_dir_to_suppress) == 0:
+ logger.write(src.printcolors.printcWarning(_("Nothing to suppress\n")))
+ logger.write(_("""\
+Please specify what you want to suppress:
+try 'sat --help clean' and 'sat clean ... --products ... --sources --build --install
+"""))
+ return
# Check with the user if he really wants to suppress the directories
if not runner.options.batch:
logger.write(" %s\n" % directory, 1)
rep = input(_("Are you sure you want to continue? [Yes/No] "))
if rep.upper() != _("YES"):
- return
+ return 0
# Suppress the list of paths
suppress_directories(l_dir_to_suppress, logger)
- return
\ No newline at end of file
+ return 0
