Merge branch 'bugfix/check_dependencies_msys_v3.2' into 'release/v3.2'

tools: Be more helpful to MSYS32 users with package installation & check if current python is inside virtual environment (backport v3.2)

See merge request idf/esp-idf!4063
This commit is contained in:
Ivan Grokhotkov 2019-01-11 15:42:20 +08:00
commit 64b46ff1d9

View File

@ -14,9 +14,10 @@
# See the License for the specific language governing permissions and
# limitations under the License.
import argparse
import os
import sys
import argparse
try:
import pkg_resources
except Exception:
@ -34,6 +35,13 @@ def escape_backslash(path):
return path
def is_virtualenv():
"""Detects if current python is inside virtualenv, pyvenv (python 3.4-3.5) or venv"""
return (hasattr(sys, 'real_prefix') or
(hasattr(sys, 'base_prefix') and sys.base_prefix != sys.prefix))
if __name__ == "__main__":
idf_path = os.getenv("IDF_PATH")
@ -43,27 +51,6 @@ if __name__ == "__main__":
default=os.path.join(idf_path, 'requirements.txt'))
args = parser.parse_args()
# Special case for MINGW32 Python, needs some packages
# via MSYS2 not via pip or system breaks...
if sys.platform == "win32" and \
os.environ.get("MSYSTEM", None) == "MINGW32" and \
"/mingw32/bin/python" in sys.executable:
failed = False
try:
import cryptography # noqa: intentionally not used - imported for testing its availability
except ImportError:
print("Please run the following command to install MSYS2's MINGW Python cryptography package:")
print("pacman -S mingw-w64-i686-python%d-cryptography" % (sys.version_info[0],))
failed = True
try:
import setuptools # noqa: intentionally not used - imported for testing its availability
except ImportError:
print("Please run the following command to install MSYS2's MINGW Python setuptools package:")
print("pacman -S mingw-w64-i686-python%d-setuptools" % (sys.version_info[0],))
failed = True
if failed:
sys.exit(1)
not_satisfied = []
with open(args.requirements) as f:
for line in f:
@ -77,9 +64,33 @@ if __name__ == "__main__":
print('The following Python requirements are not satisfied:')
for requirement in not_satisfied:
print(requirement)
if sys.platform == "win32" and os.environ.get("MSYSTEM", None) == "MINGW32" and "/mingw32/bin/python" in sys.executable:
print("The recommended way to install a packages is via \"pacman\". Please run \"pacman -Ss <package_name>\" for"
" searching the package database and if found then "
"\"pacman -S mingw-w64-i686-python{}-<package_name>\" for installing it.".format(sys.version_info[0],))
print("NOTE: You may need to run \"pacman -Syu\" if your package database is older and run twice if the "
"previous run updated \"pacman\" itself.")
print("Please read https://github.com/msys2/msys2/wiki/Using-packages for further information about using "
"\"pacman\"")
# Special case for MINGW32 Python, needs some packages
# via MSYS2 not via pip or system breaks...
for requirement in not_satisfied:
if requirement.startswith('cryptography'):
print("WARNING: The cryptography package have dependencies on system packages so please make sure "
"you run \"pacman -Syu\" followed by \"pacman -S mingw-w64-i686-python{}-cryptography\"."
"".format(sys.version_info[0],))
continue
elif requirement.startswith('setuptools'):
print("Please run the following command to install MSYS2's MINGW Python setuptools package:")
print("pacman -S mingw-w64-i686-python{}-setuptools".format(sys.version_info[0],))
continue
else:
print('Please refer to the Get Started section of the ESP-IDF Programming Guide for setting up the required'
'packages. Alternatively, you can run "{} -m pip install --user -r {}" for resolving the issue.'
''.format(escape_backslash(sys.executable), escape_backslash(args.requirements)))
' packages.')
print('Alternatively, you can run "{} -m pip install {}-r {}" for resolving the issue.'
''.format(escape_backslash(sys.executable),
'' if is_virtualenv() else '--user ',
escape_backslash(args.requirements)))
sys.exit(1)
print('Python requirements from {} are satisfied.'.format(args.requirements))