espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-01 03:34:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'bugfix/unset-temp-procedure-and-redirect-to-stderr' into 'master'

Browse Source 
Tools: Avoid printing warnings in idf.py when autocompleting

Closes IDFCI-207

See merge request espressif/esp-idf!11159
This commit is contained in:
Ivan Grokhotkov
2020-11-12 05:27:32 +08:00
parent fa1899b071 304cff9f75
commit f5939c9e68
4 changed files with 52 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
export.sh
View File

@@ -140,9 +140,9 @@ enable_autocomplete() {
if [ -n "$ZSH_VERSION" ] if [ -n "$ZSH_VERSION" ]
then then
autoload -Uz compinit && compinit -u autoload -Uz compinit && compinit -u
eval "$(env _IDF.PY_COMPLETE=source_zsh idf.py)" eval "$(env _IDF.PY_COMPLETE=source_zsh idf.py)" || echo "WARNING: Failed to load shell autocompletion!"
else else
eval "$(env _IDF.PY_COMPLETE=source_bash idf.py)" eval "$(env _IDF.PY_COMPLETE=source_bash idf.py)" || echo "WARNING: Failed to load shell autocompletion!"
fi fi
} }
@@ -151,3 +151,4 @@ enable_autocomplete
unset realpath_int unset realpath_int
unset idf_export_main unset idf_export_main
unset enable_autocomplete

24
tools/ci/config/host-test.yml
View File

@@ -291,17 +291,13 @@ test_docs:
- ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh -p 3.6.10 ./test_docs.py - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh -p 3.6.10 ./test_docs.py
- ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh -p 3.6.10 ./test_sphinx_idf_extensions.py - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh -p 3.6.10 ./test_sphinx_idf_extensions.py
test_autocomplete:
test_autocomlete: extends: .host_test_template
stage: host_test image: $CI_DOCKER_REGISTRY/linux-shells:1
image: $CI_DOCKER_REGISTRY/linux-shells:1 artifacts:
tags: when: on_failure
- host_test paths:
dependencies: [] - ${IDF_PATH}/*.out
artifacts: expire_in: 1 week
when: on_failure script:
paths: - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh ${IDF_PATH}/tools/ci/test_autocomplete.py
- ${IDF_PATH}/*.out
expire_in: 1 week
script:
- ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh ${IDF_PATH}/tools/ci/test_autocomplete.py

46
tools/idf.py
View File

@@ -26,6 +26,7 @@
# check_environment() function below. If possible, avoid importing # check_environment() function below. If possible, avoid importing
# any external libraries here - put in external script, or import in # any external libraries here - put in external script, or import in
# their specific function instead. # their specific function instead.
from __future__ import print_function
import codecs import codecs
import json import json
import locale import locale
@@ -56,6 +57,14 @@ os.environ["PYTHON"] = sys.executable
PROG = os.getenv("IDF_PY_PROGRAM_NAME", "idf.py") PROG = os.getenv("IDF_PY_PROGRAM_NAME", "idf.py")
# function prints warning when autocompletion is not being performed
# set argument stream to sys.stderr for errors and exceptions
def print_warning(message, stream=None):
stream = stream or sys.stderr
if not os.getenv('_IDF.PY_COMPLETE'):
print(message, file=stream)
def check_environment(): def check_environment():
""" """
Verify the environment contains the top-level tools we need to operate Verify the environment contains the top-level tools we need to operate
@@ -65,7 +74,7 @@ def check_environment():
checks_output = [] checks_output = []
if not executable_exists(["cmake", "--version"]): if not executable_exists(["cmake", "--version"]):
print_idf_version() debug_print_idf_version()
raise FatalError("'cmake' must be available on the PATH to use %s" % PROG) raise FatalError("'cmake' must be available on the PATH to use %s" % PROG)
# verify that IDF_PATH env variable is set # verify that IDF_PATH env variable is set
@@ -74,12 +83,12 @@ def check_environment():
if "IDF_PATH" in os.environ: if "IDF_PATH" in os.environ:
set_idf_path = realpath(os.environ["IDF_PATH"]) set_idf_path = realpath(os.environ["IDF_PATH"])
if set_idf_path != detected_idf_path: if set_idf_path != detected_idf_path:
print( print_warning(
"WARNING: IDF_PATH environment variable is set to %s but %s path indicates IDF directory %s. " "WARNING: IDF_PATH environment variable is set to %s but %s path indicates IDF directory %s. "
"Using the environment variable directory, but results may be unexpected..." % "Using the environment variable directory, but results may be unexpected..." %
(set_idf_path, PROG, detected_idf_path)) (set_idf_path, PROG, detected_idf_path))
else: else:
print("Setting IDF_PATH environment variable: %s" % detected_idf_path) print_warning("Setting IDF_PATH environment variable: %s" % detected_idf_path)
os.environ["IDF_PATH"] = detected_idf_path os.environ["IDF_PATH"] = detected_idf_path
# check Python dependencies # check Python dependencies
@@ -95,8 +104,8 @@ def check_environment():
checks_output.append(out.decode('utf-8', 'ignore').strip()) checks_output.append(out.decode('utf-8', 'ignore').strip())
except subprocess.CalledProcessError as e: except subprocess.CalledProcessError as e:
print(e.output.decode('utf-8', 'ignore')) print_warning(e.output.decode('utf-8', 'ignore'), stream=sys.stderr)
print_idf_version() debug_print_idf_version()
raise SystemExit(1) raise SystemExit(1)
return checks_output return checks_output
@@ -113,12 +122,12 @@ def _safe_relpath(path, start=None):
return os.path.abspath(path) return os.path.abspath(path)
def print_idf_version(): def debug_print_idf_version():
version = idf_version() version = idf_version()
if version: if version:
print("ESP-IDF %s" % version) print_warning("ESP-IDF %s" % version)
else: else:
print("ESP-IDF version unknown") print_warning("ESP-IDF version unknown")
class PropertyDict(dict): class PropertyDict(dict):
@@ -192,7 +201,7 @@ def init_cli(verbose_output=None):
if deprecation.exit_with_error: if deprecation.exit_with_error:
raise FatalError("Error: %s" % deprecation.full_message('Option "%s"' % option.name)) raise FatalError("Error: %s" % deprecation.full_message('Option "%s"' % option.name))
else: else:
print("Warning: %s" % deprecation.full_message('Option "%s"' % option.name)) print_warning("Warning: %s" % deprecation.full_message('Option "%s"' % option.name))
class Task(object): class Task(object):
def __init__(self, callback, name, aliases, dependencies, order_dependencies, action_args): def __init__(self, callback, name, aliases, dependencies, order_dependencies, action_args):
@@ -277,7 +286,7 @@ def init_cli(verbose_output=None):
if deprecation.exit_with_error: if deprecation.exit_with_error:
raise FatalError("Error: %s" % message) raise FatalError("Error: %s" % message)
else: else:
print("Warning: %s" % message) print_warning("Warning: %s" % message)
self.deprecated = False # disable Click's built-in deprecation handling self.deprecated = False # disable Click's built-in deprecation handling
@@ -530,7 +539,8 @@ def init_cli(verbose_output=None):
[item for item, count in Counter(task.name for task in tasks).items() if count > 1]) [item for item, count in Counter(task.name for task in tasks).items() if count > 1])
if dupplicated_tasks: if dupplicated_tasks:
dupes = ", ".join('"%s"' % t for t in dupplicated_tasks) dupes = ", ".join('"%s"' % t for t in dupplicated_tasks)
print(
print_warning(
"WARNING: Command%s found in the list of commands more than once. " % "WARNING: Command%s found in the list of commands more than once. " %
("s %s are" % dupes if len(dupplicated_tasks) > 1 else " %s is" % dupes) + ("s %s are" % dupes if len(dupplicated_tasks) > 1 else " %s is" % dupes) +
"Only first occurrence will be executed.") "Only first occurrence will be executed.")
@@ -593,7 +603,7 @@ def init_cli(verbose_output=None):
(task.name, dep)) (task.name, dep))
dep_task = ctx.invoke(ctx.command.get_command(ctx, dep)) dep_task = ctx.invoke(ctx.command.get_command(ctx, dep))
# Remove options with global scope from invoke tasks because they are alread in global_args # Remove options with global scope from invoke tasks because they are already in global_args
for key in list(dep_task.action_args): for key in list(dep_task.action_args):
option = next((o for o in ctx.command.params if o.name == key), None) option = next((o for o in ctx.command.params if o.name == key), None)
if option and (option.scope.is_global or option.scope.is_shared): if option and (option.scope.is_global or option.scope.is_shared):
@@ -660,7 +670,7 @@ def init_cli(verbose_output=None):
extensions = {} extensions = {}
for directory in extension_dirs: for directory in extension_dirs:
if directory and not os.path.exists(directory): if directory and not os.path.exists(directory):
print('WARNING: Directory with idf.py extensions doesn\'t exist:\n %s' % directory) print_warning('WARNING: Directory with idf.py extensions doesn\'t exist:\n %s' % directory)
continue continue
sys.path.append(directory) sys.path.append(directory)
@@ -683,7 +693,7 @@ def init_cli(verbose_output=None):
try: try:
all_actions = merge_action_lists(all_actions, extension.action_extensions(all_actions, project_dir)) all_actions = merge_action_lists(all_actions, extension.action_extensions(all_actions, project_dir))
except AttributeError: except AttributeError:
print('WARNING: Cannot load idf.py extension "%s"' % name) print_warning('WARNING: Cannot load idf.py extension "%s"' % name)
# Load extensions from project dir # Load extensions from project dir
if os.path.exists(os.path.join(project_dir, "idf_ext.py")): if os.path.exists(os.path.join(project_dir, "idf_ext.py")):
@@ -691,8 +701,8 @@ def init_cli(verbose_output=None):
try: try:
from idf_ext import action_extensions from idf_ext import action_extensions
except ImportError: except ImportError:
print("Error importing extension file idf_ext.py. Skipping.") print_warning("Error importing extension file idf_ext.py. Skipping.")
print("Please make sure that it contains implementation (even if it's empty) of add_action_extensions") print_warning("Please make sure that it contains implementation (even if it's empty) of add_action_extensions")
try: try:
all_actions = merge_action_lists(all_actions, action_extensions(all_actions, project_dir)) all_actions = merge_action_lists(all_actions, action_extensions(all_actions, project_dir))
@@ -782,7 +792,7 @@ if __name__ == "__main__":
# Trying to find best utf-8 locale available on the system and restart python with it # Trying to find best utf-8 locale available on the system and restart python with it
best_locale = _find_usable_locale() best_locale = _find_usable_locale()
print( print_warning(
"Your environment is not configured to handle unicode filenames outside of ASCII range." "Your environment is not configured to handle unicode filenames outside of ASCII range."
" Environment variable LC_ALL is temporary set to %s for unicode support." % best_locale) " Environment variable LC_ALL is temporary set to %s for unicode support." % best_locale)
@@ -795,5 +805,5 @@ if __name__ == "__main__":
main() main()
except FatalError as e: except FatalError as e:
print(e) print(e, file=sys.stderr)
sys.exit(2) sys.exit(2)

22
tools/test_idf_py/test_idf_py.py
View File

@@ -109,22 +109,22 @@ class TestDependencyManagement(unittest.TestCase):
def test_dupplicated_commands_warning(self): def test_dupplicated_commands_warning(self):
capturedOutput = StringIO() capturedOutput = StringIO()
sys.stdout = capturedOutput sys.stderr = capturedOutput
idf.init_cli()( idf.init_cli()(
args=['--dry-run', 'clean', 'monitor', 'build', 'clean', 'fullclean', 'all'], args=['--dry-run', 'clean', 'monitor', 'build', 'clean', 'fullclean', 'all'],
standalone_mode=False, standalone_mode=False,
) )
sys.stdout = sys.__stdout__ sys.stderr = sys.__stderr__
self.assertIn( self.assertIn(
'WARNING: Commands "all", "clean" are found in the list of commands more than once.', 'WARNING: Commands "all", "clean" are found in the list of commands more than once.',
capturedOutput.getvalue()) capturedOutput.getvalue())
sys.stdout = capturedOutput sys.stderr = capturedOutput
idf.init_cli()( idf.init_cli()(
args=['--dry-run', 'clean', 'clean'], args=['--dry-run', 'clean', 'clean'],
standalone_mode=False, standalone_mode=False,
) )
sys.stdout = sys.__stdout__ sys.stderr = sys.__stderr__
self.assertIn( self.assertIn(
'WARNING: Command "clean" is found in the list of commands more than once.', capturedOutput.getvalue()) 'WARNING: Command "clean" is found in the list of commands more than once.', capturedOutput.getvalue())
@@ -177,18 +177,18 @@ class TestGlobalAndSubcommandParameters(unittest.TestCase):
class TestDeprecations(unittest.TestCase): class TestDeprecations(unittest.TestCase):
def test_exit_with_error_for_subcommand(self): def test_exit_with_error_for_subcommand(self):
try: try:
subprocess.check_output([sys.executable, idf_py_path, "-C%s" % current_dir, "test-2"], env=os.environ) subprocess.check_output([sys.executable, idf_py_path, "-C%s" % current_dir, "test-2"], env=os.environ,
stderr=subprocess.STDOUT)
except subprocess.CalledProcessError as e: except subprocess.CalledProcessError as e:
self.assertIn('Error: Command "test-2" is deprecated and was removed.', e.output.decode('utf-8', 'ignore')) self.assertIn('Error: Command "test-2" is deprecated and was removed.', e.output.decode('utf-8', 'ignore'))
def test_exit_with_error_for_option(self): def test_exit_with_error_for_option(self):
try: try:
subprocess.check_output( subprocess.check_output([sys.executable, idf_py_path, "-C%s" % current_dir, "--test-5=asdf"],
[sys.executable, idf_py_path, "-C%s" % current_dir, "--test-5=asdf"], env=os.environ) env=os.environ, stderr=subprocess.STDOUT)
except subprocess.CalledProcessError as e: except subprocess.CalledProcessError as e:
self.assertIn( self.assertIn('Error: Option "test_5" is deprecated since v2.0 and was removed in v3.0.',
'Error: Option "test_5" is deprecated since v2.0 and was removed in v3.0.', e.output.decode('utf-8', 'ignore'))
e.output.decode('utf-8', 'ignore'))
def test_deprecation_messages(self): def test_deprecation_messages(self):
output = subprocess.check_output( output = subprocess.check_output(
@@ -206,7 +206,7 @@ class TestDeprecations(unittest.TestCase):
"ta", "ta",
"test-1", "test-1",
], ],
env=os.environ).decode('utf-8', 'ignore') env=os.environ, stderr=subprocess.STDOUT).decode('utf-8', 'ignore')
self.assertIn('Warning: Option "test_sub_1" is deprecated and will be removed in future versions.', output) self.assertIn('Warning: Option "test_sub_1" is deprecated and will be removed in future versions.', output)
self.assertIn( self.assertIn(