#!/usr/bin/env python
-#-*- coding:utf-8 -*-
+# -*- coding:utf-8 -*-
# Copyright (C) 2010-2012 CEA/DEN
#
# This library is free software; you can redistribute it and/or
# 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 re
import os
-
import src
# Compatibility python 2/3 for input function
# input stays input for python 3 and input = raw_input for python 2
-try:
+try:
input = raw_input
-except NameError:
+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',
- _('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',
- _("Optional: Clean the product build directories."))
-parser.add_option('i', 'install', 'boolean', 'install',
- _("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',
- _("Optional: Clean the product source, build and install directories."))
-parser.add_option('', 'sources_without_dev', 'boolean', 'sources_without_dev',
- _("Optional: do not clean the products in development mode."))
+parser.add_option(
+ "p",
+ "products",
+ "list2",
+ "products",
+ _("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",
+ _("Optional: Clean the product build directories."),
+)
+parser.add_option(
+ "i",
+ "install",
+ "boolean",
+ "install",
+ _("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",
+ _("Optional: Clean the product source, build and install directories."),
+)
+parser.add_option(
+ "",
+ "sources_without_dev",
+ "boolean",
+ "sources_without_dev",
+ _("Optional: do not clean the products in development mode."),
+)
def get_source_directories(config, products_infos, without_dev):
for __, product_info in products_infos:
if product_has_dir(product_info, without_dev):
# 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") ) :
+ 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
l_dir_build.append(src.Path(product_info.build_dir))
return l_dir_build
+
def get_install_directories(config, products_infos):
"""\
Returns the list of directory install paths corresponding to the list of
for __, product_info in products_infos:
if product_has_dir(product_info):
# 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") ) :
+ 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
"""
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
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)
+ 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
+ return l_dir_install
def product_has_dir(product_info, without_dev=False):
: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)):
+ if src.product.product_is_native(product_info) or src.product.product_is_fixed(
+ product_info
+ ):
return False
if without_dev:
if src.product.product_is_dev(product_info):
return False
return True
-
+
+
def suppress_directories(l_paths, logger):
"""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
- """
+ """
for path in l_paths:
if not path.isdir():
- msg = _("Warning: the path %s does not "
- "exists (or is not a directory)\n" % path.__str__())
+ msg = _(
+ "Warning: the path %s does not "
+ "exists (or is not a directory)\n" % path.__str__()
+ )
logger.write(src.printcolors.printcWarning(msg), 1)
else:
logger.write(_("Removing %s ...") % path.__str__())
path.rm()
- logger.write('%s\n' % src.printcolors.printc(src.OK_STATUS), 3)
+ logger.write("%s\n" % src.printcolors.printc(src.OK_STATUS), 3)
+
def description():
"""method called when salomeTools is called with --help option.
-
+
:return: The text to display for the clean command description.
:rtype: str
"""
- return _("""\
+ 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 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 )
-
+ src.check_config_has_application(runner.cfg)
# 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(runner.cfg, products_infos,
- options.sources_without_dev) +
- get_build_directories(products_infos) +
- get_install_directories(runner.cfg, products_infos) +
- get_generated_directories(runner.cfg, products_infos) +
- get_package_directory(runner.cfg) )
+ l_dir_to_suppress += (
+ get_source_directories(
+ runner.cfg, products_infos, options.sources_without_dev
+ )
+ + get_build_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(runner.cfg, products_infos)
-
+
if options.build:
l_dir_to_suppress += get_build_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)
+ 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(_("""\
+ 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(_("Remove the following directories ?\n"), 1)
rep = input(_("Are you sure you want to continue? [Yes/No] "))
if rep.upper() != _("YES"):
return 0
-
+
# Suppress the list of paths
suppress_directories(l_dir_to_suppress, logger)
-
+
return 0
