alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

fix(tools): catch more general errors in python dependency checker

Browse Source
This commit is contained in:
Peter Dragun 2024-02-14 12:52:52 +01:00
parent 07980dba2f
commit 5f798eb78b
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
tools/check_python_dependencies.py
View File

@ -1,8 +1,7 @@
#!/usr/bin/env python #!/usr/bin/env python
# #
# SPDX-FileCopyrightText: 2018-2023 Espressif Systems (Shanghai) CO LTD # SPDX-FileCopyrightText: 2018-2024 Espressif Systems (Shanghai) CO LTD
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
import argparse import argparse
import os import os
import re import re
@ -18,11 +17,11 @@ except ImportError:
sys.exit(1) sys.exit(1)
try: try:
from importlib.metadata import PackageNotFoundError, requires from importlib.metadata import requires
from importlib.metadata import version as get_version from importlib.metadata import version as get_version
except ImportError: except ImportError:
# compatibility for python <=3.7 # compatibility for python <=3.7
from importlib_metadata import PackageNotFoundError, requires # type: ignore from importlib_metadata import requires # type: ignore
from importlib_metadata import version as get_version # type: ignore from importlib_metadata import version as get_version # type: ignore
try: try:
@ -92,8 +91,10 @@ if __name__ == '__main__':
if not req.marker or req.marker.evaluate(): if not req.marker or req.marker.evaluate():
try: try:
version_check(req) version_check(req)
except PackageNotFoundError as e: except Exception as e:
not_satisfied.append(f"'{e}' - was not found and is required by the application") # Catch general exception, because get_version may return None (https://github.com/python/cpython/issues/91216)
# log package name alongside the error message for easier debugging
not_satisfied.append(f"Error while checking requirement '{req}'. Package was not found and is required by the application: {e}")
new_req_list.remove(req) new_req_list.remove(req)
else: else:
new_req_list.remove(req) new_req_list.remove(req)
@ -120,8 +121,10 @@ if __name__ == '__main__':
# version is taken into account as well because packages can have different requirements for a given # version is taken into account as well because packages can have different requirements for a given
# Python package. The dependencies need to be checked for all of them because they can be different. # Python package. The dependencies need to be checked for all of them because they can be different.
new_req_list.extend(dependency_requirements - already_checked) new_req_list.extend(dependency_requirements - already_checked)
except PackageNotFoundError as e: except Exception as e:
not_satisfied.append(f"'{e}' - was not found and is required by the application") # Catch general exception, because get_version may return None (https://github.com/python/cpython/issues/91216)
# log package name alongside the error message for easier debugging
not_satisfied.append(f"Error while checking requirement '{req}'. Package was not found and is required by the application: {e}")
if len(not_satisfied) > 0: if len(not_satisfied) > 0:
print('The following Python requirements are not satisfied:') print('The following Python requirements are not satisfied:')