ansible-collections/community.docker
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.docker.git synced 2025-12-16 11:58:43 +00:00
Code Packages Projects Releases Wiki Activity

Improve error message on import errors. (#188)

Browse Source
This commit is contained in:
Felix Fontein 2021-08-02 21:04:25 +02:00 committed by GitHub
parent 46bffd2f36
commit 930f9d1bcd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
changelogs/fragments/188-improve-import-errors.yml Normal file
View File

@ -0,0 +1,2 @@
minor_changes:
- "docker_* modules - include ``ImportError`` traceback when reporting that Docker SDK for Python could not be found (https://github.com/ansible-collections/community.docker/pull/188)."

7
plugins/module_utils/common.py
View File

@ -10,6 +10,7 @@ import os
import platform import platform
import re import re
import sys import sys
import traceback
from datetime import timedelta from datetime import timedelta
from distutils.version import LooseVersion from distutils.version import LooseVersion
@ -25,6 +26,7 @@ HAS_DOCKER_PY = True
HAS_DOCKER_PY_2 = False HAS_DOCKER_PY_2 = False
HAS_DOCKER_PY_3 = False HAS_DOCKER_PY_3 = False
HAS_DOCKER_ERROR = None HAS_DOCKER_ERROR = None
HAS_DOCKER_TRACEBACK = None
try: try:
from requests.exceptions import SSLError from requests.exceptions import SSLError
@ -44,10 +46,11 @@ try:
except ImportError as exc: except ImportError as exc:
HAS_DOCKER_ERROR = str(exc) HAS_DOCKER_ERROR = str(exc)
HAS_DOCKER_TRACEBACK = traceback.format_exc()
HAS_DOCKER_PY = False HAS_DOCKER_PY = False
# The next 2 imports ``docker.models`` and ``docker.ssladapter`` are used # The next two imports ``docker.models`` and ``docker.ssladapter`` are used
# to ensure the user does not have both ``docker`` and ``docker-py`` modules # to ensure the user does not have both ``docker`` and ``docker-py`` modules
# installed, as they utilize the same namespace are are incompatible # installed, as they utilize the same namespace are are incompatible
try: try:
@ -288,7 +291,7 @@ class AnsibleDockerClientBase(Client):
"docker before 5.0.0 (Python 2.7) or docker-py (Python 2.6)") "docker before 5.0.0 (Python 2.7) or docker-py (Python 2.6)")
msg = msg + ", for example via `pip install docker` (Python >= 3.6) or `pip install docker==4.4.4` (Python 2.7) " \ msg = msg + ", for example via `pip install docker` (Python >= 3.6) or `pip install docker==4.4.4` (Python 2.7) " \
+ "or `pip install docker-py` (Python 2.6). The error was: %s" + "or `pip install docker-py` (Python 2.6). The error was: %s"
self.fail(msg % HAS_DOCKER_ERROR) self.fail(msg % HAS_DOCKER_ERROR, exception=HAS_DOCKER_TRACEBACK)
if self.docker_py_version < LooseVersion(min_docker_version): if self.docker_py_version < LooseVersion(min_docker_version):
msg = "Error: Docker SDK for Python version is %s (%s's Python %s). Minimum version required is %s." msg = "Error: Docker SDK for Python version is %s (%s's Python %s). Minimum version required is %s."