#!/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
# Define all possible option for the init command : sat init <options>
parser = src.options.Options()
-parser.add_option('b', 'base', 'string', 'base',
- _('Optional: The path to the products base'))
-parser.add_option('w', 'workdir', 'string', 'workdir',
- _('Optional: The path to the working directory '
- '(where to install the applications'))
-parser.add_option('a', 'archive_dir', 'string', 'archive_dir',
- _('Optional: The path to the local archive directory '
- '(where to install local source archives'))
-parser.add_option('', 'add_project ', 'string', 'add_project',
- _('Optional: The path of the project to add'))
-parser.add_option('', 'reset_projects', 'boolean', 'reset_projects',
- _('Optional: Reset the list of projects'))
-parser.add_option('v', 'VCS', 'string', 'VCS',
- _('Optional: The address of the repository of SAT '
- '(only informative)'))
-parser.add_option('t', 'tag', 'string', 'tag',
- _('Optional: The tag of SAT (only informative)'))
-parser.add_option('l', 'log_dir', 'string', 'log_dir',
- _('Optional: The directory where to put all the logs of SAT'))
+parser.add_option(
+ "b", "base", "string", "base", _("Optional: The path to the products base")
+)
+parser.add_option(
+ "w",
+ "workdir",
+ "string",
+ "workdir",
+ _(
+ "Optional: The path to the working directory "
+ "(where to install the applications"
+ ),
+)
+parser.add_option(
+ "a",
+ "archive_dir",
+ "string",
+ "archive_dir",
+ _(
+ "Optional: The path to the local archive directory "
+ "(where to install local source archives"
+ ),
+)
+parser.add_option(
+ "",
+ "add_project ",
+ "string",
+ "add_project",
+ _("Optional: The path of the project to add"),
+)
+parser.add_option(
+ "",
+ "reset_projects",
+ "boolean",
+ "reset_projects",
+ _("Optional: Reset the list of projects"),
+)
+parser.add_option(
+ "v",
+ "VCS",
+ "string",
+ "VCS",
+ _("Optional: The address of the repository of SAT " "(only informative)"),
+)
+parser.add_option(
+ "t", "tag", "string", "tag", _("Optional: The tag of SAT (only informative)")
+)
+parser.add_option(
+ "l",
+ "log_dir",
+ "string",
+ "log_dir",
+ _("Optional: The directory where to put all the logs of SAT"),
+)
+
def set_local_value(config, key, value, logger):
- """ Edit the site.pyconf file and change a value.
+ """Edit the site.pyconf file and change a value.
- :param config Config: The global configuration.
+ :param config Config: The global configuration.
:param key Str: The key from which to change the value.
:param value Str: The path to change.
:param logger Logger: The logger instance.
try:
local_cfg = src.pyconf.Config(local_file_path)
local_cfg.LOCAL[key] = value
- ff = open(local_file_path, 'w')
+ ff = open(local_file_path, "w")
local_cfg.__save__(ff, 1)
ff.close()
if key != "log_dir":
msg = _("Unable to update the local.pyconf file: %s\n" % err)
logger.write(msg, 1)
return 1
-
+
return 0
-
+
+
def add_local_project(config, project_file, logger):
- """ Add a project in local configuration (file data/local.pyconf).
+ """Add a project in local configuration (file data/local.pyconf).
- :param config Config: The global configuration.
+ :param config Config: The global configuration.
:param new_project Str: The project pyconf file to add in local config.
:param logger Logger: The logger instance.
:return: 0 if all is OK, else 1
:rtype: int
"""
if not os.path.isfile(project_file):
- logger.write("Unable to add a project in local configuration, project file %s does not exist\n" % project_file, 1)
+ logger.write(
+ "Unable to add a project in local configuration, project file %s does not exist\n"
+ % project_file,
+ 1,
+ )
return 1
# check that the project file exists
try:
local_cfg = src.pyconf.Config(local_file_path)
local_cfg.PROJECTS.project_file_paths.append(project_file, "")
- ff = open(local_file_path, 'w')
+ ff = open(local_file_path, "w")
local_cfg.__save__(ff, 1)
ff.close()
config.PROJECTS.project_file_paths.append(project_file, "")
def reset_local_projects(config, logger):
- """ Reinitialise the list of projects in local configuration (file data/local.pyconf).
+ """Reinitialise the list of projects in local configuration (file data/local.pyconf).
- :param config Config: The global configuration.
+ :param config Config: The global configuration.
:param logger Logger: The logger instance.
:return: 0 if all is OK, else 1
:rtype: int
# Update the local.pyconf file
try:
local_cfg = src.pyconf.Config(local_file_path)
- local_cfg.PROJECTS.project_file_paths=src.pyconf.Sequence(local_cfg.PROJECTS)
- ff = open(local_file_path, 'w')
+ local_cfg.PROJECTS.project_file_paths = src.pyconf.Sequence(local_cfg.PROJECTS)
+ ff = open(local_file_path, "w")
local_cfg.__save__(ff, 1)
ff.close()
- config.PROJECTS.project_file_paths=src.pyconf.Sequence(config.PROJECTS)
+ config.PROJECTS.project_file_paths = src.pyconf.Sequence(config.PROJECTS)
except Exception as e:
err = str(e)
def display_local_values(config, logger):
- """ Display the base path
+ """Display the base path
:param config Config: The global configuration.
:param key Str: The key from which to change the value.
:param logger Logger: The logger instance.
"""
- info = [("base", config.LOCAL.base),
- ("workdir", config.LOCAL.workdir),
- ("log_dir", config.LOCAL.log_dir),
- ("archive_dir", config.LOCAL.archive_dir),
- ("VCS", config.LOCAL.VCS),
- ("tag", config.LOCAL.tag),
- ("projects", config.PROJECTS.project_file_paths)]
+ info = [
+ ("base", config.LOCAL.base),
+ ("workdir", config.LOCAL.workdir),
+ ("log_dir", config.LOCAL.log_dir),
+ ("archive_dir", config.LOCAL.archive_dir),
+ ("VCS", config.LOCAL.VCS),
+ ("tag", config.LOCAL.tag),
+ ("projects", config.PROJECTS.project_file_paths),
+ ]
src.print_info(logger, info)
return 0
+
def check_path(path_to_check, logger):
- """ Verify that the given path is not a file and can be created.
-
+ """Verify that the given path is not a file and can be created.
+
:param path_to_check Str: The path to check.
:param logger Logger: The logger instance.
"""
if path_to_check == "default":
return 0
-
+
# Get the path
path = src.Path(path_to_check)
-
+
# If it is a file, do nothing and return error
if path.isfile():
- msg = _("Error: The given path is a file. Please provide a path to "
- "a directory")
+ msg = _(
+ "Error: The given path is a file. Please provide a path to " "a directory"
+ )
logger.write(src.printcolors.printcError(msg), 1)
return 1
-
+
# Try to create the given path
try:
src.ensure_path_exists(str(path))
except Exception as e:
err = src.printcolors.printcError(str(e))
- msg = _("Unable to create the directory %s: %s\n" % (str(path),
- err))
+ msg = _("Unable to create the directory %s: %s\n" % (str(path), err))
logger.write(msg, 1)
return 1
-
+
return 0
+
def description():
- '''method that is called when salomeTools is called with --help option.
-
+ """method that is called when salomeTools is called with --help option.
+
:return: The text to display for the init command description.
:rtype: str
- '''
+ """
return _("The init command Changes the local settings of SAT.")
-
+
+
def run(args, runner, logger):
- '''method that is called when salomeTools is called with init parameter.
- '''
-
+ """method that is called when salomeTools is called with init parameter."""
+
# Parse the options
(options, args) = parser.parse_args(args)
-
+
# Print some informations
- logger.write(_('Local Settings of SAT %s\n\n') %
- src.printcolors.printcLabel(runner.cfg.VARS.salometoolsway), 1)
+ logger.write(
+ _("Local Settings of SAT %s\n\n")
+ % src.printcolors.printcLabel(runner.cfg.VARS.salometoolsway),
+ 1,
+ )
res = 0
-
# Set the options corresponding to a directory
- for opt in [("base" , options.base),
- ("workdir", options.workdir),
- ("log_dir", options.log_dir),
- ("archive_dir", options.archive_dir)]:
+ for opt in [
+ ("base", options.base),
+ ("workdir", options.workdir),
+ ("log_dir", options.log_dir),
+ ("archive_dir", options.archive_dir),
+ ]:
key, value = opt
if value:
res_check = check_path(value, logger)
# set the options corresponding to projects file names
if options.add_project:
- res_add=add_local_project(runner.cfg, options.add_project, logger)
+ res_add = add_local_project(runner.cfg, options.add_project, logger)
res += res_add
if options.reset_projects:
- res_rem=reset_local_projects(runner.cfg, logger)
+ res_rem = reset_local_projects(runner.cfg, logger)
res += res_rem
- # Set the options corresponding to an informative value
+ # Set the options corresponding to an informative value
for opt in [("VCS", options.VCS), ("tag", options.tag)]:
key, value = opt
if value:
res_set = set_local_value(runner.cfg, key, value, logger)
res += res_set
-
+
display_local_values(runner.cfg, logger)
-
+
return res
